Papaya Wiki Users' Manual

From PapayaCMS

The papaya Wiki is a free (GNU GPL) papaya module package that provides a Wiki to be used within your papaya CMS installation. Most of the wiki markup is compatible with the widespread MediaWiki system.

Note This is the Users' Manual for the papaya Wiki module. If you want to know how to set up the Wiki in your papaya CMS installation, please refer to the Administration manual.

Contents 1 Using the wiki pages 1.1 Using the index page 1.2 Using the article page 1.2.1 Editing articles 1.2.2 Comparing article versions 1.3 Using the upload page 2 Wiki syntax supported by the papaya CMS Wiki 2.1 Paragraphs 2.2 Headlines 2.3 Links 2.4 Lists 2.5 Definition lists 2.6 Indentation 2.7 Tables 2.8 Text markup 2.9 Structure 2.9.1 Category Entries 2.9.2 Language Links 2.10 Redirections 2.11 Nowiki Areas 2.12 Files 2.13 References 2.14 Source code

Using the wiki pages

The papaya wiki consists of three different pages:

• The index page contains an overview of all articles and categories
• The article page can be used to read and edit articles and to compare their versions
• The upload page allows logged-in users to upload media files that they can use in articles

Using the index page

The index page consists basically of article and category links.

The topmost element is the article search dialog. Enter an article title and click on Go or simply hit Return to read the article. If it does not exist, the wiki will use it as a search term and output articles that match in either title or text. Additionally, you will see a link offering you to create a new article with the desired title. If no search results are found, you will immediately be in edit mode to create the article.

Below the dialog, you can see the index page's main navigation. There are three kinds of links:

• Categories displays the list of categories in the wiki.
• Recently modified shows a list of articles that have been recently created or modified, in descending modification time order. The number of articles in this list can be set by a wiki administrator. The default maximum is 15.
• Articles. You will either see a simple Articles link or one link for each starting letter (including '#' for articles starting with numbers or punctuation), depending on the page's configuration

If you select Categories or one of the articles links (Articles or a starting letter), you may also see paging links when the number of elements exceeds a limit that can be set in the page's configuration. The default values are 10 categories or 25 articles per page.

Note: For details on how to change settings for the index page, see Setting up the wiki index page in the Wiki admin manual.

Using the article page

Right below the wiki's title you can see the article search dialog that was already described for the index page.

Next up is the main navigation that offers the following links (note: Not all of the links are visible in some situations):

• Index: Navigate to the wiki index page
• Article: Read the current article and follow its links
• Edit: Edit the current article
• Versions: View and compare versions of the current article
• Random article: Read a random article

If you enter the page without selecting an article, you will either see an error message or an article teaser, depending on the page's configuration.

Note: For details on how to change settings for the index page, see Setting up the wiki article page in the Wiki admin manual.

Editing articles

To edit an existing article, search it using the index page or enter its title into the Article dialog field. Then click on the Edit link above the article. If you cannot see this link, editing has been restricted to logged-in users and you need to log in first.

To create a new article, just enter a title into the Article dialog field. If the article does not exist yet, you will either see search results and the Create link, or the editor. You will have no chance to create the article if editing is restricted to logged-in users and you are not logged in.

Make whatever changes you like to the article's wiki code. The syntax supported by the papaya wiki is detailed further down this page. When you're done, you can optionally enter a Comment summarizing your changes. Then click on Save article to save your changes. You can also click on Preview to see your changes in effect without saving them. Note that currently links, media, and categories do not work in preview mode.

Privacy note: When you edit articles without being logged in, your current IP address will be stored as author information.

Comparing article versions

To view the list of versions for the current article, click on the Versions list. The versions will be shown in a table with the following columns:

• Version: Time stamp of each version. If you click on one of those links, you can read and edit this version of the article. Note: If you click on Save, the latest version of the article will be based on that particular version.
• (Compare): Select the radio buttons for two different versions to view the changes. The comparison will be displayed in plain text mode, in a two-column table. Modified paragraphs are highlighted by colored backgrounds: Green for added paragraphs, pink for removed paragraphs, and yellow for modified paragraphs.
• Auhtor: When a user making a change was logged in, his or her name will appear her. Otherwise, the IP address of their Internet connection is shown.
• Comment: If a user added a comment when saving the article, the comment will be shown in this column.

Using the upload page

Click on the Upload link on the article page to go to the upload page. If the link is not displayed, you are probably not logged in and should do so. If you enter this page without being logged in, an error message will be displayed.

The upload form contains four fields:

• Upload file (mandatory): Select an upload file by clicking on Browse.
• Alternate file name (optional): Enter a name under which you want to refer to the file in the wiki. If you leave this field blank, the original file name will be used.
• Title (optional): Enter a title for the file. It will be displayed on the file detail page or in the file box if you use certain kinds of formating in your wiki code. It will also be used as the link title when your file is not a displayable image.
• Description (optional): Enter a description for the file. It will be displayed on the file detail page or in the file box if you use certain kinds of formating in your wiki code.

Click on Upload to perform the actual upload and store the meta data. You can view the file by entering File:Filename into the Article field.

Note: For details on how to change settings for the index page, see Setting up the wiki upload page in the Wiki admin manual.

Wiki syntax supported by the papaya CMS Wiki

The papaya CMS wiki supports a subset of the MediaWiki syntax, described in the following subsections.

Paragraphs

If you leave a line completely blank, this will start a new paragraph (a simple line break is not sufficient).

Example:

This is a paragraph.
This is part of the first paragraph.

This is a new paragraph.

Headlines

Depending on the headline level, a different number of = signs is used. Examples:

== Level 2 headline ==
=== Level 3 headline ===

When you read an article, a table of contents is automatically built from the hierarchy of headlines.

Notice: The article's title itself is the main headline, so there are no level 1 headlines.

Links

There are two different kinds of links:

• Wiki links (internal, referring to other articles)
• External links to web URLs

You can create a wiki link like this:

[[Article title|Caption]]

The caption is optional; if you leave it out, the linked article's title is used as a caption. This is often what you want, but for grammar or context reasons you might like to use a different caption. Here are two examples, one with and one without a caption:

[[USA|US]] president [[Barack Obama]]

External hyperlinks use the following syntax:

[URL caption]

Here, too, the caption is optional. If you leave it out, the URL itself will be the link text. Examples:

The papaya Wiki Administrators' Manual can be found at [http://en.wiki.papaya-cms.com/].

Please refer to the [http://en.wiki.papaya-cms.com/ Admin Manual] for more information.

Lists

There are two kinds of lists: Enumerations and plain lists. You can create an enumeration like this:

# First item
# Second item

A plain list can be created like this:

* First item
* Second item

Both kinds of lists can be nested, even mixed with each other. Example:

* First main item
** First sub item
** Second sub item
* Second main item
** First sub item
** Second sub item

Definition lists

Definition lists with unindented topic and indented definition are created like this:

; Topic : Definition

Indentation

A colon at a paragraph's start indents the paragraph by one step; more than one colon creates deeper indentations. Example:

Normal paragraph
: Paragraph with single indentation
:: Paragraph with double indentation

Tables

You can create tables using this syntax:

{|
 |+ Table caption
 |-
 !Headline cell
 !Headline cell
 |-
 |Normal cell
 |Normal cell
 |}

The table start can contain attributes for the whole table. The following example creates a table with a border of two pixels and a grey background:

{|border=2 bgcolor=#999999

You can also use attributes for rows and cells. For cells, you need to separate the attributes and the cell contents using |. The following cell, for instance, has got a range of two rows and two columns (please note that you have to leave out the cells in the areas covered by this cell):

|rowspan=2 colspan=2|Content of the "Four-cells-cell"

Text markup

To highlight text, you can mark parts of your text as bold or italic. You can do this by using three or two single quotes before and after the area to be highlighted, respectively:

'''bold'''
 ''italic''
 '''''bold and italic'''''

Structure

At the end of an article you should use special structure links, each of them in a line of its own: category entries and links for versions of the current article in other languages.

Category Entries

A category entry works like this:

[[Category:Name of the category]]

The categories that an article belongs to are displayed as a list at the end of the article; if you enter an article title of "Category:Name of the category", a list of all articles from this category will be displayed.

Note: To link to a category, put another colon before the Category keyword, like so:

The USS Enterprise NCC-1701-D is a [[:Category:Spaceships|Spaceship]] built
for the United Federation of Planets' Starfleet in the 24th century.

Language Links

You can create language links as follows:

[[ISO language code:Article title]]

Assuming you are on an English page with the title "Democracy". Then you could add the links for German and French like this:

[[de:Demokratie]]
[[fr:Démocracie]]

If language links are set for the current article, they are automatically used as page translation links. If there isn't a matching language link, the Wiki index page (alphabetical list of all articles) in that language will be used instead.

Redirections

If you think that a keyword should redirect to an existing article, create the article by entering that keyword and enter the following wiki code:

#Redirect [[Title of the article you want to redirect to]]

Any subsequent wiki code on a page like this will be ignored. Assume you've got a page with the title Personal Computer and you want to create a new entry called PC that redirects to it. Enter "PC" into the article field and write the following wiki code:

#Redirect [[Personal Computer]]

Nowiki Areas

For code blocks or to describe wiki code (like in this article), you can use nowiki areas. This works as follows:

<nowiki>
 ... arbitrary text ...
</nowiki>

Important: HTML special characters such as < or > have to be escaped in nowiki areas as well (e.g. &gt; for >).

Files

Use the Wiki upload page to upload files. You can either keep the original file name or enter your own. After the upload, you can add a file to a wiki page using the following syntax:

[[File:Filename|options]]

Options are any of the following, separated by | signs:

• border: Display a border around the file area. Will also display the file's title and description.
• left, right, or center: Alignment of the file area on the page. Using left or right will automatically float contents around the file area; headlines break the floating behavior.
• mxnpx, mpx, or xnpx will set the file's width and height, only width, or only height, respectively. Only works if the file is an image.
• thumb[nail]: Display the file as a thumbnail if it's an image. Specifying the width and/or height will create a thumbnail automatically; if you use thumb without specifying the dimensions, the default dimensions from the page settings will be used.

References

If you enclose Wiki markup within a line using <ref> and </ref>, the content will be displayed as a reference: At the original position, a numbered link in superscript will appear. The list of references is automatically displayed at the page's bottom. If you click on a reference link, the browser jumps down to the matching footnote. References come in handy when you need to mark the sources for your articles, just like the footnote references in scientific papers.

Source code

The papaya Wiki can automatically syntax-highlight source code using the GeSHi Syntax Highlighter shipped with papaya CMS. To mark a section as source code, use code like this:

<source lang="Language">
...arbitrary source code...
</source>

The list of supported languages can be found on the GeSHi website.