This topic discusses advanced methods for Wiki content authors.

You can create links between different Wikis without specifying the exact URL. For example, [Wikipedia:JSPWiki] points to a Wikipedia topic (Wikipedia:JSPWiki). The list of supported interwiki prefixes is set by the server administrator and cannot be changed by content authors. However, please do make a request by email if you need additional settings.

Current
system
settings:
WikiWikiWeb --> http://c2.com/cgi/wiki?%s, JSPWiki --> http://www.ecyrd.com/JSPWiki/Wiki.jsp?page=%s, Doc --> http://doc.jspwiki.org/2.6/wiki/%s, Wikipedia --> http://www.wikipedia.org/wiki/%s, TWiki --> http://twiki.org/cgi-bin/view/TWiki/%s, Google --> http://www.google.com/search?q=%s, MeatballWiki --> http://usemod.com/cgi-bin/mb.pl?%s, Edit --> Edit.jsp?page=%s

Interwiki links are case sensitive; e.g., [wikipedia:JSPWiki] will create an error like the following: "No InterWiki reference defined in properties for Wiki called "wikipedia"!". (Please do not correct this error, it is purposely present here!)

Footnotes#

By using only a number inside two brackets (like [1]), you create a footnote link. The actual footnote is created by placing a '#' in front of the corresponding number ([#1]). You can also create named footnotes by using the display text feature. For example, [RefX|2] may point to: [RefX|#2].

When using simple numbered footnotes, currently (JSPWiki 2.2.28, Sept. 2005) only the footnote marker in the main text is formatted as superscript. The marker in front of the footnote is displayed literally, including the '#' sign. Using named footnotes is therefore recommended.

Tables#

Simple tables may be created using pipe symbols ('|'). Double pipe symbols in the first rows create table heading rows, single pipe symbols create data rows. Each row must be on a single line. You can use inline formatting rules, and line breaks (\\), but no block level (heading, paragraph, list, definition) markup. For example:

|| Column 1 || Column 2
| Data | ''data'' \\ second line created with line break
| [Main]     | [PageIndex]
Creates:
Column 1 Column 2
Data data
second line created with line break
Main PageIndex

With standard table markup it is not possible to create row or column spans. A table plugin is under development and available as contributed code, but not yet included in the standard installation of JSPWiki.

Variables#

You can define and reuse variables on pages, for example, to increase the consistency of a page and simplify updating. Writing on a Wiki page: [{SET RecentVersion='2.5'}] Current version is "[{$RecentVersion}])" results in: Current version is "2.5)".

Some additional predefined variables are always available. Most useful are [{$pagename}] (here = Template4WikiAdvancedFormatting) and [{$applicationname}] (here = JSPWiki.

However, you cannot refer to variables defined on other pages (compare HowToUseAVariable for possible updates).

Tip: As of JSPWiki 2.2.28, no internal annotating/commenting method is available (visible during editing, but not during page view). Such a method is often useful to document decisions or create progress/to-do comments). You may, however, create a variable like: [{SET Note='GH: continue revision here'}].

Plugins#

A plugin is a function that generates dynamic page content. All JSPWiki Core Plugins are available to you. Many of these have specific functionality used on a single page like Index, RecentChanges, UnusedPages, etc. The following plugins are perhaps most likely to be used by general content authors:

  • Image plugin: Normally, an image may simply be embedded by creating a link to it. If the image ends in one of the image extensions recognized by this JSPWiki installation, an image will be displayed instead of a hyperlink. However, if more complex formatting is desired, the image plugin is very powerful. It enables you to add a hyperlink behind an image, a caption below the image, define alt-text, width and height, align position, etc. Example: [{Image src='http://xyz.net/img/234.png' link='http://me.my.com/index.html' height='80' width='30' align='right' }].
  • Table of contents plugin: All headings (marked with !, !!, or !!! in first line) are displayed as a short, hyperlinked table of contents. Optionally a title may be set: Example: [{TableOfContents title='Contents'}].
  • Insert page plugin: This plugin allows you to include the content of one page into another page. Example: [{InsertPage page='CommonDisclaimer'}]. The plugin offers a number of formatting parameters and also an option to only include sections [as of 2005-09-05 the use of the section parameter was undocumented, however, please update once documentation arrives!].
  • Referring pages plugin: This plugin (depending on your template this may also be visible in the bottom of the left menu or when you display the page information page) shows all pages that link to your current page (using [{ReferringPagesPlugin}]) or to a specified page (using [{ReferringPagesPlugin page='ProjectX'}]).
    • The catch with this plugin is that you can set up specific pages to organize your Wiki content. For example, creating a page [NewIdea] that contains this plugin, and then adding "This is a [NewIdea]" to pages containing new ideas, you automatically generate a cross-indexing system.
    • The plugin has some additional parameters that allow you to customize the display. Very useful is: [{INSERT ReferringPagesPlugin max=100 maxwidth=150 before='#' after='\n'}] to display the results in a numbered list (or use before='*' to create a bulleted list).

If you require additional contributed plugins, please contact your local Wiki server maintainer whether it is possible to install them.


Continue with WikiHelp or WikiFormattingQuickReference

Add new attachment

Only authorized users are allowed to upload new attachments.
« This page (revision-4) was last changed on 11-Oct-2007 14:38 by JanneJalkanen