Login | Register
My pages Projects Community openCollabNet

php-svn-client
Wiki: FrequentlyAskedQuestions

Edit this page | Links to this page | Page information | Attachments | Refresh page

 

Index

"What is a Wiki?" questions

What is a ''Wiki''?

A Wiki is a collection of pages that can be collaboratively edited using a web browser. They are open and free for anyone to edit as they wish. The system creates cross-reference hyperlinks between pages automatically.

The CollabNet wiki feature is based on the open-source MoinMoin wiki application. For more information about MoinMoin, see http://moinmoin.wikiwikiweb.de/.

What is this good for?

It is good for reducing noise and increasing the amount of information available to your project members. The information is structured and easier to find than in some other media. You can put up a wiki on your internal web site with many pages, which describe various projects, architectures, ideas, etc. for people to comment on. Some pages just sit there and convey information. Other pages are an open invitation for discussion and commentary. For example, you could set up a wiki for a simple skills database.

In general, a wiki is very much a free-form tool, whose value derives from the use to which it is put. For instance, a page in a wiki can serve the same purpose as a discussion thread. You could use a wiki page to collaboratively work on a project.

What are the major features of a Wiki?

Here are some important wiki features:

  • editability by anyone - a wiki page is editable by anyone with a web browser
  • ability to view recent changes
  • ability to search pages (several ways)
  • ability to very easily add new pages
  • ability to see the change history for a document
  • ability to add new information or modify existing information

What about Wiki security? Isn't a Wiki subject to complete wipeout or nastiness from a saboteur?

This is an important question. In general, wikis used to have NO security. (That's right!)

For MoinMoin this has changed with the introduction of Access Control Lists. (See HelpOnAccessControlLists.)

But, assuming you do not use ACLs, the possibility exists for accidental or conscious destruction or corruption of the current page revisions in the wiki.

There are two main ways to devalue a wiki. One is through erasure and the other is through corruption. Dealing with erasure is not terribly difficult, because there is a change log (and back versions) of every page, and they can be reverted easily. Thus, when page deletions or major content erasures are detected (which should be fairly quickly), pages can be restored to their previous good state.

Explicit and intentional corruption is more difficult to deal with. The possibility exists that someone can enter incorrect information onto a page, or edit pages to intentionally change the information so it is incorrect. (For example, people can change the attributions on a page to make it look like a different person made a particular comment, or someone can change the content of a paragraph to alter its meaning in a detrimental way.) In practice, wiki corruption is an extremely rare event, and one that can be dealt with (if needed) with the notification feature (to a fixed auditor) for new material submission.

In other words, the philosophy of wiki is one of dealing manually with the rare case of a saboteur, rather than designing in features and overhead (both in implementation and in usage) to avoid the damage caused by a saboteur.

Questions about MoinMoin in general

Finding and accessing information in the wiki

How can I search the wiki?

There are several ways to search or scan the wiki:

  • Use the search box or FindPage, where you can search by keyword in title, by full text, with normal words or wildcards (regular expressions).

  • Click TitleIndex. This will show you an alphabetized list of all pages by title.

  • Click WordIndex. This shows an alphabetized list of every word in every title (i.e. a page named BlueTooth is listed under B / Blue as well as T / Tooth).

  • Use the LikePages action. This shows pages that have words in their titles that are similar to the current page.

  • Click the page title at the very top of the page. This shows what pages link to the current page (which may help you find related pages).

How do I see what's been going on recently in the wiki?

Click the RecentChanges link at the top of any page.

How can I get RecentChanges to go farther back in time than it goes by default?

Log in and select up to 90 days back.

What are these weird different-colored links I keep finding all over the place?

Any mixed-case name that doesn't have a page will show up as a different-colored link.

Editing in the wiki

How do add something to the wiki, or change something that's wrong?

If you see something you'd like to comment on, add to, or change, click the EditText link, or click the icon at the top of the page. The page is brought up in a text-edit pane in your browser, where you make the changes. The wiki formatter will generally "do the right thing" with any text you enter. If you want to get fancy, you can do most of the same types of formatting that HTML allows you to do. See the HelpOnFormatting page for some tips and examples.

Are there any conventions I should follow when adding information?

Not very many. It helps to keep certain types of information formatted in a consistent way. One important convention that will help with consistency is the use of "Template" pages.

A list of templates appears when you create a new page. If you click one of these, then that page will have a structure similar to others of the same type. For example, when creating your own Wiki homepage, you should use the HomepageTemplate page, which is available when you create a new page in the wiki.

How can I add non-text information to the Wiki?

If the content already exists on a web site, then just add a link to a wiki page. Follow these steps:

  • Get the URL for the document,
  • Edit the Wiki page (go to the Wiki page and click the EditText link)

  • Type in the URL where you want it in the document
  • Save the changes.

The wiki will automatically make a hypertext link from the text you type in.

You can make the link "prettier" by putting "cover" wording for the link in brackets. The cover wording will appear on the page, but the link will take the user to the URL when clicked on. Here's an example:

  [http://your.domain.example/foo.html This will be the link text]

produces:

This will be the link text

How can I avoid the use of [[BR]] and use normal newline characters instead?

Use { { { and } } } to bracket your preformatted text into a preformatted paragraph.

How do I add an image to a page?

You can include a URL to the image in the page. Example:

http://c2.com/sig/inter/wikibase.gif

produces

wikibase

How do I create a new Template page?

Templates are pages that show up automatically as options when you create a blank page. Any page that ends in the word Template (see page_template_regex) will automatically show up in the list. Hence, if you want certain types of pages to have a similar format (similar headings, organization, etc.), you just define a page that ends in Template, and when creating pages of this type, select that template and edit it. The wiki fills in the starting content for you. Templates are editable wiki pages like any other.

To create a Template page, just create a new page called <something>Template.

Adding documents in an intranet

If you're using MoinMoin on an intranet, it may be useful to make links to documents on file shares available to everyone reading your wiki. For example:

[file://///servername/sharename/full/path/to/file/filename.txt Click here to read filename.txt]

You can also link to files with spaces in the filenames by manually entering the URL encoding for spaces(%20):

[file://///servername/sharename/full/path/to/file/filename%20with%20spaces.txt Click here to read filename with spaces.txt]

More and important info about this is on FileLinks.

Another obvious and maybe better option is to use the AttachFile action.

Should I ''sign'' my changes?

If they are significant, or you want people to know that you made them, then yes. Just put @SIG@ after your comment. It is not uncommon to indent your comment under the statement you are commenting on. Also, it helps to italicize your comment to make it stand off from the main body of the page you are commenting on.

However, in some cases it may be appropriate to just make your change anonymously. Correcting spelling, formatting, or trivial word changes are some examples where it is not necessary (and even discouraged) for you to sign your modification.

What if I delete entries in pages, and you think you need them? Is it erased completely?

If you need to, you can revert your changes.

Adding other document formats to the wiki

Can I add HTML to the wiki?

Note: All of this only works if the unsecure HTML extensions (HTML macro and parser) are installed.

If you want to add a single line of HTML, use the HTML macro. This is done by putting your HTML text as a parameter to the HTML macro, like so:

[[HTML(<font size=+12>This is large font</font>)]]

This would show up on the page as: [[HTML(<font size=+12>This is large font</font>)]]

It's also possible to place an HTML document into a page by adding #format html as the first line in the page. If that line is there then the whole page will be interpreted as HTML (thus making links to other pages becomes a bit more difficult!) Make sure that you only add the body portion of the page (not the HTML headers or anything else outside of the body, including the <BODY> tag itself).

Linking in the wiki

How do I link to something outside my wiki, as with an html a tag?

Installation & Configuration

Note: See HelpOnAdministration for general help on this topic

Administering the Wiki

How do I administer the wiki?

There is a lot of administration information on the SystemInfo page, including the number of pages, and the macros and actions that are installed.

One approach is to set up an "AdminPage", where you can put macros for these, as well as information about the real physical location of the pages, and macros for orphan pages or other things an adminstrator for the wiki might want to look at.

Can I restore a page from an older version?

  1. click Page information (or the little "i" icon) in the top-right corner.

  2. click revert link of the version you want to restore.


If your question is not answered on this page, see MoinMoinQuestions.

FrequentlyAskedQuestions (last modified 2008-12-02 07:51:22 -0800)