Wiki Configuration

Configuration of the current Wiki

If your are an editor or administrator of the current Wiki, you are welcome to change the following variables. All other user please refrain from doing so!

Syntax: Any text except lines starting with a single "*" will be ignored and may be used for notes or explanations. List lines starting with a single "*" must contain a pair of "variablename = value". The amount of blank spaces between the "*", the "=" or the end of line is irrelevant; both the variable name and its value will be trimmed. Where a string purposely needs a leading or trailing blank, use an underscore ("_"), in first and last position this will be interpreted as a blank space. Wiki variables in plugin syntax (like [{$baseurl}] or [{$jspwiki.templateDir}]) may be used as part of the values (right hand side after the "=") and will be expanded. Note: These settings are currently used only with the JSPWiki:ConfigurableTemplate.

Name of Wiki web

Each wiki web has a unique name that may be different from the name used in the URI. In the JSPWiki standard variables, this name is stored as "application name". For the current wiki it is: "LIAS Glossary".

Wiki Names may be shown in three places: 1. Header before Page name, 2, Header below page name, 3. Top of Side Menu. If you run only a single wiki and the wiki identity is unambiguous from your domain name itself, you may not want to display the wiki name at all.

• ShowWikiNameBelowHeader = false
  • Show the Wiki-web name below the page/topic name. This feature is relevant in a multi-wiki setup where multiple webs are running under the same domain name. If the domainname already identifies the wiki web, or if your wiki-web is identified through an icon/logo image, the display may be turned off.
• ShowWikiNameBeforePage = false
  • Show the Wiki-web name in front of the page/topic name. This is especially desirable for glossaries and dictionaries.
• ShowWikiNameSideMenu = true
  • Show the Wiki-web name on top of side menu / favorites bar (below the image/icon if present)

• LinkBehindWikiNameTitle = About this Wiki
• LinkBehindWikiName = About
  • If this is defined, a link to this page or url is created behind the wiki name (in any position defined above).

For wiki names in the header, a prefix and suffix string (= text output before and after name) may be defined. If you want a space between name and pre/suffix, add a "_" to the string. With Tomcat 5.5 the JSP page itself produces no blanks on its own; other servlet containers may differ, however.

• WikiNameBeforePagePrefix =
• WikiNameBeforePageSuffix = :_
• WikiNameBelowHeaderPrefix = From_
• WikiNameBelowHeaderSuffix =

Wiki icon or logo

Icon or logo may be shown in two places, usually only one is selected:

• ShowWikiImageInSideMenu = false
  • (top of left menu)
• ShowWikiImageInHeader = false
  • (top-left of header area, above page content)
• LinkBehindWikiImage = About
  • If this is defined, a link to this page or url is created behind the image.

• WikiImage =
  • Old Example: WikiImage = http://www.DiversityCampus.net/LiasGlossary/templates/Configurable/SpecialImages/LiasGlossary95_62.png
  • Further LIAS logos in Special images: LIAS85-62.png, LiasGlossaryAufBlau132_84.gif, LiasGlossary303_194.gif, LiasGlossary95_62.png, LiasGlossary95_62_nontransparent.png
  • Note: New icon or logo images may be attached to this or any other page!
  • Example: if Image Logo.gif is attached to the WikiConfiguration page, you may change the above to: WikiImage=http://www.DiversityCampus.net/LiasGlossary//attach/WikiConfiguration/Logo.gif
• WikiImageHeight = 62
  • Height is optional, used only for display optimization (no layout change while loading)
• WikiImageWidth = 95
  • Width is required when using image in header left of page title (rather than above side menu). To achieve a layout most compatible with most browsers, the width is *required* (used for image width + padding defining width of td element!).
• WikiImageTitle = About this Wiki
  • Tool tip displayed when mouse hovers over the image.
  • WikiImageMouseover = http://www.DiversityCampus.net/LiasGlossary/templates/Configurable/img/jspwiki-logo.png
  • Effect: image changes when user moves mouse over it.
  • The image should have the same size as WikiImage; else other parts of page layout move during mouseover.
  • The mouseover effect is active only together with a link behind the image, see setting above

• WikiFavoriteIcon = http://www.DiversityCampus.net/LiasGlossary//images/favicon.png
  • used in header meta data: link rel="icon"

Wiki decoration

Currently a right hand border image may be defined. Later, a main area background image could be added as well. With the configurable template, this setting currently works only when table layout is active!

Not yet used / not re-tested: -* ShowRightBorderImage = -* RightBorderImageURL = -* RightBorderImageWidth = -* RightBorderImageHeight =

Overall layout (side menu or not)

The following layout options are supported:
- Plain page (no menu) (= LAYOUT_HEADER_FIRST false, LAYOUT_SIDEMENU false)
- Header-top/left-menu-below/right-content-below (= LAYOUT_HEADER_FIRST true, LAYOUT_SIDEMENU true)
- Left-menu-below/right-header-plus-content (= LAYOUT_HEADER_FIRST false, LAYOUT_SIDEMENU true)
They can be achieved either through CSS positioning or through table layout. So far only table layout has been tested, but preparations for CSS-only positioning layout have been made.

• LayoutShowSidemenu = false
  • use a left or right side menu? Currently (using table layout) only left side supported. LayoutShowSidemenu: false disables all parts of the left menu, incl. the layout table itself.
• LayoutHeaderFirst = false
  • displays header with full page width, above optional side menu. If LayoutShowSidemenu is false, LayoutHeaderFirst is best set to false as well.
• LayoutUseTable = true
  • When setting this to false, i.e. CSS-only positioning, set LayoutHeaderFirst false even if you are going to achieve this through CSS.

Only if LayoutUseTable and LayoutShowSidemenu are true, the width of the menu column and main/page columns must be defined. Default is 15% and 85%.

• LayoutSidemenuColWidth = 15%
• LayoutSidemenuColWidthComplement = 85%

• LayoutIncludeCustomHeader = true

Header settings

• ShowPageNameInHeader = true
  • Similar to the Wiki name, the page name may be displayed in the header. Normally this is true, but for some glossaries where a Wiki-ized page name is misleading, not showing the page name may be preferable.
• ShowTopMenu = true
  • Header tools may appear in the upper right corner, in front of the search box. Typical topics are "Main, Index, Changes". If set to true, the header tool content will be obtain from a wiki page (e.g. WikiTopMenu). "Edit" and "Find" links and a direct search box may be enabled in addition:
• ShowHeaderEditLink = true
  • As of JSPWiki 2.2, edit links are difficult to add in page content (possible only through interwiki links), therefore difficult to add to header tools wiki page. A separate option to add a link for editing the current-page link is therefore provided.
• ShowHeaderSearchLink = true
• ShowHeaderSearchBox = true
  • Note: the Search link in front of the input box is commonly used also as label for the direct search box. Nevertheless, it is possible to have a search link (going to separate page) alone, or a direct search box without label in front.

In many Wiki an alphabetical sequence of topics is close to meaningless, but for glossary-Wikis this may be turned on:

• ShowAlphabeticalNavigation = true
• AlphabeticalNavigationPrevLabel = Previous
• AlphabeticalNavigationNextLabel = Next Page
• AlphabeticalNavigationLinkType = icon
  • valid values are text or icon
• AlphabeticalNavigationPrevIconURL = http://www.DiversityCampus.net/LiasGlossary/templates/Configurable/img/prev.png
• AlphabeticalNavigationNextIconURL = http://www.DiversityCampus.net/LiasGlossary/templates/Configurable/img/next.png
• AlphabeticalNavigationIconWidth = 16
• AlphabeticalNavigationIconHeight = 16

Find search settings (Header tools and Found pages report)

The standard Find/Search page action link and button in the page view header:

• SearchLinkLabel = Find:
  • Set label to nothing to disable the header search link. Non-breaking space may be important here. 2.2 default template used "Search Wiki:"
• SearchLinkTitle = Click here to open the search page
• SearchLinkButton = Go
  • this is for direct search action. 2.2 default template: "Find!"
• SearchReportMaxItems = 100
  • number of found pages shown at most

Wiki broadcasts, breadcrumbs, page-footer resources

• ShowBroadcasts = true
  • if true, the content of special broadcast wiki pages is displayed at the top/bottom of each view.
• ShowBreadcrumbsTop = false
• ShowBreadcrumbsBottom = true
  • normally only one is true, or both set to false.
• BreadcrumbsLabel = Your trail:_
• BreadcrumbsSeparator = _»_
  • Examples: greater sign: > (must be escaped as _>_) or right angle quotes (_»_)
  • Known Bug: The separator setting currently can not be configured due to a bug in JSPWiki.

• ShowReferringPagesFooter = true
  • Special footer wiki page containing the layout of the referring pages plugin. By default, the side menu footer contains this plugin as well, but many templates do not use a side menu. Alternative: the tools at the foot of a page provide a ref-by link opening the info page in a mode showing only the referencing pages.
• ShowResourceFooter = true
  • Special Resource footer wiki page, may contain placeholder to be replaced with page name for direct search links.

Similarly, for layout including a (left) side menu, a footer may be turned on there, typically containing a ReferringPage plugin.

• ShowSidemenuFooter = true

Revision info in page view footer

Revision data may be shown in first line of footer. Revision number and author may be separately suppressed with ShowRevisionVersion/ShowRevisionAuthor. If both are false, only the date is shown.

• ShowRevisionInfo = true
• ShowRevisionVersion = true
• ShowRevisionAuthor = true

Some additional formatting options:

• RevisionVersionPrefix = Revision_
  • e.g. "Revision_" or "Page version_". You may have to include the trailing blank as an underscore!
• RevisionVersionSuffix = _-_
  • e.g. "_-_", connecting version to date. */
• RevisionDatePrefix =
  • e.g. empty, "Last Updated: " or "Page Updated: ", "published on "
• RevisionDateSuffix =
• RevisionDateFormat = yyyy-MM-dd
  • e.g. "yyyy-MM-dd", formats as defined for wiki:PageDate
• RevisionAuthorPrefix = _-_
  • e.g. "_-_" or "_by_"
• RevisionAuthorSuffix = .
  • e.g. "." to close revision data statement.

Copyright/licensing info in page view footer

Copyright/licensing is treated separately from other meta data links for two reasons: 1. the copyright and licensing statement itself is often relatively long, requiring space in layout, and 2. The label itself is obtained from a WIKI page and not from the settings here.

• ShowCopyright = true
• CopyrightTitle = (copyright and availability of content)
  • (title attribute, displayed as tooltip)

Page view footer / actions

Page action links at bottom of view page. Implicitly, by setting a label to empty string, the display of an optional element may be suppressed. For example, by setting the edit link label to empty, all editing options in a wiki will be suppressed. (Note that without additional measures like deleting the edit-related jsp pages, this is not safe. Users could type a url leading to the edit pages)

• ActionLinkSeparator = _|_
  • String inserted between the action links. Examples: "", "_|_", " - ".
• EditActionLabel = Edit
  • 2.2 default template: "Edit this page"
• EditActionTitle = click to edit this topic (access key: e)
• EditActionAccesskey = e
• AttachActionLabel = Attach
  • 2.2 default template: "Attach file..."
• AttachActionTitle = attach images or documents
• RefByActionLabel = Ref-by
• RefByActionTitle = view topics referencing this topic
• MoreInfoActionLabel = More
  • 2.2 default template: "More info..."
• MoreInfoActionTitle = detailed information, attachments, history, other options (access key: m)
• MoreInfoActionAccesskey = m

The page view footer shows a history / sequence of most recent revisions ("> r.6 > r.5 > r.4 > r.3"). Revision numbers are directly linked to the versions, the ">" to Diff-comparisons of the neighboring versions.

• HistoryActionLabel = History
• HistoryActionTitle = view revision history of topic

• HistoryList_MaxSize = 4
  • The number of revisions shown. Setting this to 2 results in the two most recent revisions. Recommended values are between 1 and 5. Setting this to 0 disables the history list in the footer.
• ShowFastHistoryList = true;
  • Two methods for a history footer are available. The fast method initially avoids any history queries, but may display revisions that have been deleted. The exact method queries all revisions (even if displaying only the HistoryList_MaxSize first). The exact method is also more informative, showing revision date and author as a tooltip.

Meta data links (contact, legal, disclaimer, privacy, version)

Such links are supported separately in the side menu and in the page view footer. The page view footer is not displayed during editing. Setting the ...Label to nothing/empty string disables a link!

Page view footer:

-* ViewFooterLinkSeparator =

• ViewFooterMeta1Label = Contact and Disclaimers
  • e.g. "Contact", "Impressum" */
• ViewFooterMeta1Page = Contact
• ViewFooterMeta1Title =

• ViewFooterMeta2Label = Privacy
• ViewFooterMeta2Page = WikiPrivacyPolicy
• ViewFooterMeta2Title = Privacy Policy

-* ViewFooterMeta3Label = -** e.g. "Disclaimer" -* ViewFooterMeta3Page = -* ViewFooterMeta3Title =

-* ViewFooterMeta4Label = -* ViewFooterMeta4Page = -* ViewFooterMeta4Title =

• ViewFooterMeta5Label = JSPWiki v2.2.33
• ViewFooterMeta5Page = WikiSystemInfo
• ViewFooterMeta5Title = Click for system info and software copyright

Menu footer: Similarly, 4 meta data links are support at bottom of Side menu (Left Menu):

• MenuFooterMeta1Label = Contact and Disclaimers
• MenuFooterMeta1Page = Contact
• MenuFooterMeta1Title =

-* MenuFooterMeta2Label = -* MenuFooterMeta2Page = -* MenuFooterMeta2Title =

-* MenuFooterMeta3Label = -* MenuFooterMeta3Page = -* MenuFooterMeta3Title =

-* MenuFooterMeta4Label = -* MenuFooterMeta4Page = -* MenuFooterMeta4Title =

• MenuFooterMeta5Label = JSPWiki v2.2.33
• MenuFooterMeta5Page = WikiSystemInfo
• MenuFooterMeta5Title = Click for system info and software copyright

Plain-text editor configuration

A signature template (name / date of current used) is provided, this may be copied manually or using javascript)

• ShowEditorSignatureTemplate = true;

The info messages/notes (displayed inline in editor) may be suppressed (not advised, legal problems may arise if EditorSuppressSubmissionMsg is suppressed)

• EditorSuppressFormattingMsg = false
• EditorSuppressSubmissionMsg = false

Up to 5 links opening popup-window (esp. for help pages) are supported in the editor footer. Setting the ...Label to nothing/empty string disables a link!

• EditorPopupHelpPrompt =More help (open new windows):_
• EditorPopupHelpSeparator = _|_

• EditorPopupHelp1Label = Quick Reference
• EditorPopupHelp1Page = WikiFormattingQuickReference
• EditorPopupHelp1Title = New window: Quick reference of formatting rules

• EditorPopupHelp2Label = General Help
• EditorPopupHelp2Page = WikiHelp
• EditorPopupHelp2Title = New window: General overview on help topics

• EditorPopupHelp3Label = Character Map
• EditorPopupHelp3Page = WikiCharacterMap
• EditorPopupHelp3Title = New window: characters or symbols missing on many keyboards

• EditorPopupHelp4Label = Advanced Help
• EditorPopupHelp4Page = WikiAdvancedFormattingHelp
• EditorPopupHelp4Title = New window: Advanced topics (interwiki links, footnotes, tables, plugins, variables)

Currently no fifth: -* EditorPopupHelp5Label = -* EditorPopupHelp5Page = -* EditorPopupHelp5Title =

Messages

Some messages may already be localized to other languages:

• MsgPageMissing = This page does not exist. You may want to create it:_
• MsgRestoreVersion = You are about to restore version %1$. Click on "Save" to restore. You may also edit the page before restoring it.
• MsgLockingNote = User '%1$' has started to edit this page, but has not yet saved. You may edit this page anyway, but be aware that you may overwrite the other user's changes, or the other user may overwrite your changes. It would be best to wait for her or his lock to expire or until she or he stops editing the page. The lock expires in %2$ minutes.

• MsgAbovePreview = This is a PREVIEW! Your changes are not yet saved and will be lost if you follow a link from the preview!
• MsgBelowPreview = You may continue editing in the window below. Click "Save" to submit your edits or "Continue editing" to return to the primary page editor.

Note that several messages remain in English, these are either produced by the Wiki engine itself, or are currently difficult to localize (because they contain a mixture of text and special links).

Page name customization/translation

One goal of the configurable template was to keep the page name space relatively clean and name most "system pages" starting with "Wiki". This required some changes relative to the default 2.2.28 template (on which the design of configurable template was based). Furthermore, the configurable template supports many additional features (legal/IPR/help/CSS), requiring dozens of extra pages. To remain flexible and allow Wiki editors to choose the page names (including names in different languages and scripts), a translation feature is active in the configurable template.

With the default pages of the configurable template, no page names need to be translated. If you already use JSPWiki, you may want to activate the following settings (by removing the leading "-" in each line) if you want to continue using the menu page names used in the JSPWiki default template:

-* WikiSideMenu = LeftMenu -* WikiSideMenuFooter = LeftMenuFooter

Other translatable pages are: Main (note: name of "Main" page is also settable in properties file, but unfortunately that setting applies only if "Wiki.jsp" is called without a page name, it does not affect the html header meta data link @rel="start"), WikiHelp, WikiSystemInfo (an improved version of "SystemInfo"), CopyrightNotice (a short copyright statement/label/notice, usually linking to CopyrightDetails; in contrast to Privacy and Disclaimer copyright labels may be desired to be formatted or including graphics, therefore stored in a Wiki page rather than a setting here), WikiBroadcastHeader, WikiBroadcastFooter WikiCSSExtensions, WikiEditorQuickReference, WikiEditorSubmissionContract, WikiHeaderTools, WikiReferringPagesFooter, WikiResourceFooter, WikiRetrievalNotice, WikiSearchFormNotes. - Note: FindPage and UserPreferences do not point to names in the wiki content. They are virtual names pointing to jsp pages, and are settable in the properties files as of JSPWiki 2.2.28.