Return to doc.sitecore.com

Documentation

Wiki is a piece of server software that allows users to freely create and edit the Web page content using any Web browser. Wiki supports hyperlinks and has simple text syntax for creating new pages and crosslinks between internal pages on the fly.

Wiki is unusual among group communication mechanisms in that it allows the organization of contributions to be edited in addition to the content itself.

Like many simple concepts, "open editing" has some profound and subtle effects on Wiki usage. Allowing everyday users to create and edit any page in a Web site is exciting in that it encourages democratic use of the Web and promotes content composition by nontechnical users.

( http://wiki.org/wiki.cgi?WhatIsWiki )

/upload/shared source/modules/modules 1.jpg

1.  Installation

The Wiki module is distributed as a standard Sitecore package. Thus to start using it, you should install the package. Please refer to the Installing Modules and Packages article if you are not familiar with the standard Sitecore Packager tool.

The SitecoreWiki package adds the following Items:

You don’t need to change web.config file.

Publishing is obligatory after installation.

Enter the address of the WikiFolder or WikiPage Item in the browser’s address bar to access Wiki from the front-end. For example: http://localhost/sitecorewiki.html

2.  User Guide

This section shows how to use Sitecore Wiki from the front-end and how to manage articles in the Sitecore Client.

Enter the address of the WikiFolder or WikiPage Item in the browser’s address bar to access Wiki from the front-end. For example: http://localhost/sitecorewiki.html

3.  Creating a First Article

The default clean Sitecore Wiki starts with a prompt to create a new Wiki article.

/upload/sdn5/modules/wiki/wiki2.png

Type in the article title and click Create.

4.  Wiki Editor

An Editor window is shown below:

/upload/sdn5/modules/wiki/wiki 3.png

Below is the description of the Editor functionality:

Left menu Items:

Editor buttons:

/upload/sdn5/modules/wiki/wiki4.png - Insert bold text;

/upload/sdn5/modules/wiki/wiki 5.png - Insert italic text;

/upload/sdn5/modules/wiki/wiki 6.png - Insert underlined text;

/upload/sdn5/modules/wiki/wiki 7.png - Insert strikethrough text;

/upload/sdn5/modules/wiki/wiki 8.png - Insert small text;

/upload/sdn5/modules/wiki/wiki 9.png - Insert Heading 2 or Heading 3;

/upload/sdn5/modules/wiki/wiki 10.png - Insert external link;

Refer to the Valid Tags table for a list of tags you can use in the editor. 

/upload/sdn5/modules/wiki/wiki 11.png - Save the article;

/upload/sdn5/modules/wiki/wiki 12.png - Preview the article; 

When you save a new version of the page, previous version is not lost. Please see the Managing Sitecore Wiki from the back-endsection for details.

5.  Valid Sitecore Wiki Tags

=== Text ===

Heading 2 (must be at the beginning of the line)

==== Text ====

Heading 3 (must be at the beginning of the line)

''' text  '''

Bold text

'' text ''

Italic text

<u> text </u>

Underlined text

<strike> text </strike>

Strikethrough text

<small> text </small>

Small text

[[http://www.Link.com Text]]

External link

[[ text ]]

Internal link to Wiki article.

----

Horizontal line

<br>

Line break

* Text

List tag (the tag must be at the beginning of the line)

# Text

Numbered list (the tag must be at the beginning of the line)

You can use html entities such as lt;   > and other to format text.

Wiki formatting rules are not applied to article titles .

6.  Manage Wiki from Backend

All Wiki pages and page variants are stored under the SitecoreWiki Item:

/upload/sdn5/modules/wiki/wiki 13.png

New page variant is created every time a User saves a Wiki article. Select any variant and click the ‘Set’ button to the left of the ‘Set variant as current’ title. This variant of the page will become active (that is will be shown on the front-end).  

Select any page and click the ‘Set’ button to the left of the ‘Set page as first’ title. This page will become the main page.

/upload/sdn5/modules/wiki/wiki 14.png

If there is no page set as main page, the Create Article page will appear as default main page.  

A ny changes in the back-end are applied on the front-end only after publishing .