TweetFollow Us on Twitter

Installing and Using a Wiki

Volume Number: 22 (2006)
Issue Number: 6
Column Tag: Wiki

Installing and Using a Wiki

What are Wikis and how to use TWiki

by Mihalis Tsoukalos

The idea for this article came after reading the "Time Management for System Administrators", an excellent book by Thomas Limoncelli. In the book, Limoncelli states that although he has heard about Wikis, he has not had a good opinion about their usefulness because of their strange and somehow funny name. The same thing happened to me. I thought that I should not deal with Wikis because of their humorous name. Limoncelli's book changed my mind, and therefore I decided to learn more about Wikis. I'm writing this article because I find Wikis so useful.

What Are Wikis?

A Wiki is an environment based on Web technologies that allows its users not only to read, but also to change HTML pages in an uncomplicated and simple manner. This makes Wikis very practical for groups and individuals that work using text and hypertext. The more you use and add to a Wiki, the more useful it becomes, and the more useful it becomes, the more you want to add new and more accurate information.

The word Wiki has its roots in the Hawaiian word "Wikiwiki" that means "quick" or "hurry up". The first Wiki was made by Ward Cunningham back in 1995.

The Wiki Philosophy

Every Wiki that respects itself supports, more or less, certain functionalities, while some Wikis support more advanced features. The principles that Wikis conform to, include the following:

  • Editing capabilities. This is the most distinguishing functionality. Only in special and rare situations, certain pages cannot be edited. The edition prohibition should be avoided as it is against the Wiki philosophy.

  • The capability of connecting (linking) a certain Wiki page with another. This functionality creates new structures. As you are going to find out, this feature is supported by what is called a WikiWord. If the referenced Wiki page is not present, and you try to click it from your Web browser with your mouse, this page is going to be automatically created, ready for editing!

  • The capability of keeping historical information about every page in a Wiki. This feature actually stores all previous page versions for all Wiki pages. This makes it easy to find the changes that happened in a page. This is an extremely critical feature because it can protect us from both malicious users and users that change information by mistake on a Wiki page.

  • The capability of examining recent changes. This is a separate informational page that is automatically created by the Wiki itself, and either lists a given number of changes in a page or the changes that happened in a page for a given period of time.

  • The SandBox or PlayGround capability. This capability is similar to the testing grounds in a rally race or like your piece of paper for keeping notes. Using Sandbox, you will learn how to use the whole Wiki system by creating experimental Wiki pages that are later going to be deleted by the system. Experiment in PlayGround as much as you like without fear!

  • The search capability. Last but not least, is the Wikis' capability of searching either whole pages or page titles by keywords. In Wikis with many users and many pages this is an extremely important tool.

Installing TWiki on Mac OS X Tiger

Our Wiki of choice is called TWiki, and is a high- performance, advanced Wiki with many capabilities. In this section you are going to learn how to successfully install TWiki and start working with it. By using it more, you are going to feel more comfortable with it, and therefore you are going to be more productive. What you should have already installed in your Mac are the following:

    1. Apache Web Server: this is installed by default. This article assumes a clean install of Apache and its config files. If Apache is not already running, the following command, executed at the Terminal, will start it running:

    big:~ mtsouk$ apachectl start

    2. The Perl programming language: Tiger installs Perl by default, so, you should not have any problems unless something is terribly wrong with your installation. The Perl executable is located in/usr/bin/perl. The current Perl version, at the time of writing, is 5.8.6.

    3. Various UNIX command line tools: Tiger installs by default most of the required UNIX tools, so you will not probably have any problems.

    4. The RCS software that mainly supports and administers changes in text files. If you have already installed Developer Tools you have RCS already installed. On my Tiger 10.4.6 the rcs binary is installed in /usr/bin/rcs. If, for some reason, you do not have it, you should download the latest Xcode Tools installation package and install it from there.

Most of the installation work must be done inside the main configuration file of the Apache Web server. It is not a particularly difficult job, but you should concentrate while making the changes, as a small typo can make Apache not work at all. Let's see analytically.what the required steps for installing TWiki are:

    1. You should download and install the latest version of TWiki from the URL <http://www.twiki.org/>. At the time of writing this article, the latest TWiki version (Production Release as it is called) is 4.0.1 <http://twiki.org/p/pub/Codev/Release/TWiki-4.0.1.tgz>.

    2. You should now give the following command from a Terminal application in order to uncompress TWiki's files:

    tar zxvf TWiki-4.0.1.tgz

Before executing the above command, it would really useful to be in a separate subdirectory that you created somewhere inside your home directory. The execution of the tar command creates many subdirectories and files as can be seen in figure 1.



Figure 1: The root directory structure of TWiki

    3. You should now give the following command:

    sudo vi /etc/httpd/users/mtsouk.conf

      given that your username is mtsouk. Depending on your own username, you should give the respective command. Also, instead of using the vi editor, you can launch your favorite text editor. [Ed. Note - If you know what you're doing, you can make this change in your global httpd.conf file, too...but if you know what you're doing, you probably already knew that] In the above Apache configuration file, the following text was added:

    # Added for TWiki :
    ScriptAlias /wiki/bin/ "/Users/mtsouk/Sites/TWIKI/bin/"
    Alias /wiki/ "/Users/mtsouk/Sites/TWIKI/"
    <Directory "/Users/mtsouk/Sites/TWIKI/bin">
        AllowOverride all
        Options +ExecCGI
        Allow from all
    </Directory>
    <Directory "/Users/mtsouk/Sites/TWIKI/data">
        Deny from all
    </Directory>
    <Directory "/Users/mtsouk/Sites/TWIKI/lib">
        Deny from all
    </Directory>
    <Directory "/Users/mtsouk/Sites/TWIKI/templates">
        Deny from all
    </Directory>

    4. After setting up your Apache Web server, you should also make a small change in a file called /Users/mtsouk/Sites/TWIKI/bin/setlib.cfg. You should change the value of the twikiLibPath variable as follows:

    $twikiLibPath = "/Users/mtsouk/Sites/TWIKI/lib";

    5. Then you should also run the following command:

    sudo chown -R www /Users/mtsouk/Sites/TWIKI

    6. You should now make sure that the "Personal Web Sharing" service is turned on. It is located at the Sharing collection of settings inside System Preferences.

    7. The last thing you should do is, to restart Apache in order to activate the changes you made to its configuration file. This can be done using the command that follows:

    sudo apachectl graceful

That's all! Now you are ready to use TWiki from within your own browser! Start at URL <http://localhost/ wiki/bin/configure>, where you should define some primitive parameters. Figure 2 shows how your own picture should look like.



Figure 2: The http://localhost/wiki/bin/configure URL of TWiki

Currently, you should not worry about the displayed error messages, as this is the initial execution of TWiki. By pressing the "General path settings" button, and then going near the end of the displayed page, you will be able to adjust some parameters that are related to directories. The good thing is that TWiki makes proposals about most of the parameters, so you will not have to write them manually. Chances are that most of the proposals are correct! Now, please press the Next button at the end of the page, and you will get a page similar to the one shown in figure 3.



Figure 3: Giving the new password after pressing the "Next" button

You should now define your password by giving it twice, so that the system knows that you typed it correctly. You then press the "Set Password and Save changes" button to tell TWiki to store the new password, and you are directed to a new page that shows the committed changes. You should now press the "Return to configuration" button, at the end of the page. You will then return to your starting configuration page. This TWiki page will contain some warnings or errors, but you can ignore them. Then, you will have to make some changes at the "Store Settings"option. The changes you have to do must be analogous to the settings that are presented in figure 4. Given that your username as well as the installation directory are different from mine, you should adjust your settings accordingly.



Figure 4: Fixing some of the TWiki parameters

You will also need to copy an icon file named favicon.ico inside directory /Library/ WebServer/Documents. favicon.ico is the small icon that is sometimes displayed on the left of the web address field in your web browser. It is also necessary to have the CGI::Session perl module correctly installed. I prefer to utilize the CPAN Perl module, when I want to install a new Perl module, because I find it very handy and easy to use.

You are almost ready to start using the actual capabilities of TWiki. By directing your web browser to the URL <http://localhost/wiki/bin/view>, you will see figure 5.



Figure 5: Using Twiki

Administering TWiki

After successfully installing TWiki, you should now learn how to administer it. In this section, I will speak about the most important administrative tasks, as mentioning all of them would probably require a dedicated book chapter!

Creating a new Web

A Web is an autonomous independent area in TWiki that collects similar pages. It is a good practice to create Webs that have no logical relation to each other.

If you want to create a new Web with TWiki, you should go to the http://localhost/wiki/bin/view/TWiki/ManagingWebs URL. This is illustrated in figure 6. The reason for creating a new Web is mainly for separating logically different areas.



Figure 6: Creating a new Web.

As the text in figure 6 reads, you can rename a web by using the Tools section in its WebPreferences topic, whereas, you can delete a web by moving it into a Trash web.

Administering Users

There are mainly three important tasks that are user-related, and require an administrator to act on:

    1. Resetting a password. You should be a member of the TWikiAdminGroup, have a valid email address and go to the http://localhost/ wiki/bin/view/TWiki/ResetPassword URL in order to reset a password. The instructions inside the email that TWiki sends, will inform the user about the required actions that she needs to take.

    2. Blocking out a user. Although, blocking out a user does not conform to the Wiki philosophy, it is sometimes required to protect the other users. You should not use it very often though. The way to block out a malicious user is to reset his password, for a period of time, without telling him. At the end of the period, you will tell the user his new password and allow him to use TWiki again.

    3. Deleting a user. By describing how "difficult" it is to delete a user, you should understand, well, how often (or rarely) this should happen J. You should first locate a file named .htpasswd. This file holds the passwords of the TWiki users. You should delete the line that begins with the name of the user you want to remove. On my system, this file is located inside directory /Users/mtsouk/Sites/TWIKI/data. Then, you should go to the TWiki page, found in <http://localhost/wiki/bin/view/Main/TWikiUsers>. This page holds the list with all registered users. Figure 7 shows that page on my setup. You should now edit that TWiki page, and remove the user you want. Finally, for security reasons, you should delete any granted special rights the user might have.



Figure 7: The list of all registered TWiki users.

Backing up TWiki

The last important task that I want to mention is how to take a backup of your TWiki data. On my setup, data files are located inside the data directory. I prefer to use tar in combination to gzip, to take backups, so that is what I will show you. Give the "tar czvf ../TWIKIdata.tgz ." command inside the data directory and you are done! If for some reason you do not have the required user permissions to execute a command, put "sudo" in front of the command and try it again.

Using TWiki

In this section, I will only mention the basic procedures of TWiki, and therefore you should look at the extensive TWiki documentation if you want to look for more information.

WikiWords

A WikiWord is two or more words put together without spaces between the words, each of the words being written with an Initial Capital. Each WikiWord represents a topic name and it is advisable to insert WikiWords as often as you can. Correct examples of WikiWords are MacTech, MihalisTsoukalos, MacIntel, and PowerMac, whereas faulty examples of WikiWords are macTech, Powermac, Macbook, and Powerbook.

User Registration in TWiki

The first thing you have to do after the setup is to register yourself in TWiki. Registration can be done from the http://localhost/wiki/bin/view/TWiki/TWikiRegistration URL. If you want to make yourself an administrator, you have to manually access the http://localhost/wiki/bin/view/Main/TWikiAdminGroup TWiki page, and alter the line that says "Set GROUP =" by editing it and adding you own name.

As User Management and Authentication policies are complex issues, it is advisable to check the http://localhost/wiki/bin/view/TWiki/ManagingUsers URL for more information.

Editing Pages

Figure 8 shows an example of editing a new Wiki page in Sandbox whereas figure 9 presents the HTML output of the page. You can see that a Wiki offers many facilities for making your job easier, when creating new Wiki pages. You can even create HTML tables the Wiki way, insert HTML code, insert JavaScript code, and make use of Wiki plugins like the Spreadsheet Plugin. By pressing the question marks on the upper left of the AppleInc, HardWare and SoftWare WikiWords, you can simply create (and edit) new pages for those WikiWords! When we say that ease of use is built in the philosophy of Wikis, we mean it!



Figure 8: Creating a new TWiki page.



Figure 9: The HTML output of Figure 8 input.

If you do not want to create a link for a word that is by nature in a WikiWord format, you should put an exclamation mark in front of it, like !ToDo.

You can find more information about editing TWiki pages at <http://localhost/wiki/bin/view/TWiki/TextFormattingRules>.

A Criticism on Wikis

I will now briefly mention some concerns about Wikis. Please keep in mind that the actual problem comes from users and not from the Wiki philosophy itself. The possible Wiki problems are:

    1. You cannot be forced to use a Wiki, and therefore a Wiki that is not frequently updated will become obsolete.

    2. Wikis are Open Source systems. Therefore, a company must accept the use of Open Source software in order to also accept and use Wikis.

    3. For any information to be useful, it must also be neutral. Biased information does not help the success of a Wiki.

    4. Malicious users may cause problems, although, it is observed that vandalism is fixed very fast.

    5. Flame wars and trolls can occur in Wikis.

Conclusions

It should be clear by now that using a Wiki has many advantages. Their simplicity offers ease of use, and makes many of your jobs simpler. Wikis can also be used for taking simple notes or for writing down certain procedures.

You should practice and keep working with TWiki in order to be able to use it efficiently. At first glance, it seems a little complicated to learn how to efficiently use TWiki. Nevertheless, frequent use will make you feel more relaxed.

You should understand by now the Wiki philosophy, be able to install TWiki, and make the most essential actions on your installed TWiki. Keep on practicing in order to become a Wiki guru!

Bibliography and References


Mihalis Tsoukalos lives in Greece with his wife Eugenia. He is currently writing, "Widget Recipes: A Problem-Solution Approach" that will be published by APress. You can reach him at <tsoukalos@sch.gr>.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Herald 5.0.2 - Notification plugin for M...
Note: Versions 2.1.3 (for OS X 10.7), 3.0.6 (for OS X 10.8), and 4.0.8 (for OS X 10.9) are no longer supported by the developer. Herald is a notification plugin for Mail.app, Apple's Mac OS X email... Read more
DEVONthink Pro 2.8.3 - Knowledge base, i...
Save 10% with our exclusive coupon code: MACUPDATE10 DEVONthink Pro is your essential assistant for today's world, where almost everything is digital. From shopping receipts to important research... Read more
Boom 2 1.0.1 - System-wide pro audio app...
Boom 2 is a system-wide volume booster and equalizer app that is designed especially for OS X 10.10 Yosemite. It comes with a smart interface, self-calibrates itself according to your Mac, offers... Read more
Apple Security Update 2015-001 - For OS...
Apple Security Update 2015-001 is recommended for all users and improves the security of OS X. For detailed information about the security content of this update, please visit: http://support.apple.... Read more
Drive Genius 4.0.1 - Powerful system uti...
Drive Genius 4 gives you faster performance from your Mac while also protecting it. The award-winning and improved DrivePulse feature alerts you to hard drive issues before they become major problems... Read more
Yosemite Cache Cleaner 9.0.3 - Clear cac...
Yosemite Cache Cleaner is an award-winning general purpose tool for OS X. YCC makes system maintenance simple with an easy point-and-click interface to many OS X functions. Novice and expert users... Read more
xScope 4.1.1 - Onscreen graphic measurem...
xScope is powerful set of tools that are ideal for measuring, inspecting, and testing on-screen graphics and layouts. Its tools float above your desktop windows and can be accessed via a toolbar,... Read more
OS X Yosemite 10.10.2 - Apple's lat...
OS X Yosemite is Apple's newest operating system for Mac. An elegant design that feels entirely fresh, yet inherently familiar. The apps you use every day, enhanced with new features. And a... Read more
Apple iOS 8.1.3 - The latest version of...
The latest version of iOS can be downloaded through iTunes. Apple iOS 8 comes with big updates to apps you use every day, like Messages and Photos. A whole new way to share content with your family.... Read more
SpamSieve 2.9.19 - Robust spam filter fo...
SpamSieve is a robust spam filter for major email clients that uses powerful Bayesian spam filtering. SpamSieve understands what your spam looks like in order to block it all, but also learns what... Read more

Storm & Skye – Magical Adventure Sto...
Storm & Skye – Magical Adventure Story For Kids Review By Amy Solomon on January 28th, 2015 Our Rating: iPhone App - Designed for the iPhone, compatible with the iPad The first book in the Storm & Skye series includes... | Read more »
New WOTA: U-Boat Compass ‘Wets’ Your App...
New WOTA: U-Boat Compass ‘Wets’ Your Appetite for WOTA: Wolves of the Atlantic. Posted by Jessica Fisher on January 27th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Warship Solitaire Review
Warship Solitaire Review By Nadia Oxford on January 27th, 2015 Our Rating: :: A WAR OF NUMBERSUniversal App - Designed for iPhone and iPad Warship Solitaire might lack frills and looks, but it offers some thought provoking... | Read more »
Keep Track of Your Hectic Work Schedule...
Keep Track of Your Hectic Work Schedule With Shifts Posted by Jessica Fisher on January 27th, 2015 [ permalink ] iPhone App - Designed for the iPhone, compatible with the iPad | Read more »
All Star Quarterback Review
All Star Quarterback Review By Campbell Bird on January 27th, 2015 Our Rating: :: PLAY YOUR PARTUniversal App - Designed for iPhone and iPad Train your way to the Super Bowl in this free-to-play sports management game.   | Read more »
Sentinel 4: Dark Star Adds New Campaign...
Sentinel 4: Dark Star Adds New Campaign and More Posted by Ellis Spice on January 27th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Wheel & Deal Review
Wheel & Deal Review By Tre Lawrence on January 27th, 2015 Our Rating: :: SIMPLE FUNUniversal App - Designed for iPhone and iPad A simple arcade shooter that has a retro feel.   | Read more »
Join the NAVY in a Big New Update for WW...
Join the NAVY in a Big New Update for WW2: Sandbox. Strategy & Tactics Posted by Jessica Fisher on January 27th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Earthworm Alchemy Review
Earthworm Alchemy Review By Campbell Bird on January 27th, 2015 Our Rating: :: FEED THE WORMUniversal App - Designed for iPhone and iPad Feed this funny looking worm and dodge bombs in this charming, free-to-play arcade game.   | Read more »
Graphic Novel App netwars – The Butterfl...
Graphic Novel App netwars – The Butterfly Attack has Received Some New Episodes Posted by Jessica Fisher on January 27th, 2015 [ permalink ] | Read more »

Price Scanner via MacPrices.net

New Good Management Suite Simplifies Enterpri...
Good Technology has announced the availability of the Good Management Suite, a comprehensive cross-platform solution for organizations getting started with mobile business initiatives. Built on the... Read more
15-inch 2.0GHz Retina MacBook Pro (refurbishe...
The Apple Store has Apple Certified Refurbished previous-generation 15″ 2.0GHz Retina MacBook Pros available for $1489 including free shipping plus Apple’s standard one-year warranty. Their price is... Read more
15-inch 2.5GHz Retina MacBook Pro on sale for...
Amazon has the 15″ 2.5GHz Retina MacBook Pro on sale for $2319.99 including free shipping. Their price is $180 off MSRP, and it’s the lowest price available for this model from any reseller. Read more
iPad Turns Five – The ”Book Mystique
Five years ago this week, the late Steve Jobs took the stage at an Apple special press event to unveil the first Apple iPad — a slab-shaped, hand-holdable device that was to shake the personal... Read more
Sale! 15-inch Retina MacBook Pros for up to $...
B&H Photo has the new 2014 15″ Retina MacBook Pros on sale for $150 off MSRP for a limited time. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1889.99... Read more
Apple refurbished Mac minis for up to $150 of...
The Apple Store has restocked Apple Certified Refurbished 2014 Mac minis, with models available starting at $419. Apple’s one-year warranty is included with each mini, and shipping is free: - 1.4GHz... Read more
Apple Releases New Tranche Of OS Updates For...
Apple has released incremental bugfix and security updates for its most recent Mac and iOS versions. OS X Yosemite 10.10.2 Update Apple says this update includes the following improvements: Resolves... Read more
Samsung To Be Main Supplier Of A9 Chips For i...
Korea’s Maeil Business Newspaper reports that Samsung has beat out its chipmaking rivals, Taiwan’s Qualcomm and TSMC, as supplier of chipsets for the next generations of both its own Galaxy S6 and... Read more
Save up to $340 on iMacs with Apple Certified...
The Apple Store has Apple Certified Refurbished iMacs available for up to $340 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free. These are the best prices on... Read more
AppleCare Protection Plans on sale for up to...
B&H Photo has 3-Year AppleCare Warranties on sale for up to $105 off MSRP including free shipping plus NY sales tax only: - Mac Laptops 15″ and Above: $244 $105 off MSRP - Mac Laptops 13″ and... Read more

Jobs Board

*Apple* Systems Engineer - Pre Sales, Educat...
…is responsible for proactively providing technical expertise to drive sales of Apple solutions into assigned accounts. The SE architects, validates, and assists in Read more
*Apple* Solutions Consultant - Retail Sales...
As an ambassador of the Apple brand, the ASC is accountable for driving sales performance by: Connecting with customers. Discovering customers' needs and values. Showing Read more
*Apple* Solutions Consultant - Retail Sales...
As an ambassador of the Apple brand, the ASC is accountable for driving sales performance by: Connecting with customers. Discovering customers' needs and values. Showing Read more
*Apple* Tree Children's Center is hirin...
Apple Tree Learning Center is Hiring Preschool Teachers! Phoenix Childrens Academy is a national leader in the early childhood education industry and we are currently Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.