Wiki

A wiki is a web site where any users with access can collaborate and edit the web site directly using a simplified markup language. You create and modify wiki topics in a simple markup language within a web browser.

In AEM, a single wiki page is called a topic and a collection of topics is called a wiki space. You can create multiple wiki spaces. Permissions determine who can read or change the content of the wiki space. You can search across a wiki space as well as create topics on the fly. In addition, you can add attachments to wiki topics.

This section describes wiki concepts and describes how to use the provided wiki functionality.

To add a wiki to your website, simply go to the Website Console and copy the Wiki Content (/content/wiki) to the location in your site structure where you want to start the new wiki space.

1. Open the Websites Console.
2. Copy the Wiki Content structure from /content/wiki to where you want to create a wiki.
3. Rename the newly created wiki space by changing its title as appropriate.
4. Open the main page of the newly created wiki. 

After you create a wiki space you can edit the main topic (or any new topics you may have created).

To modify a wiki topic:

1. In the Websites Console, navigate to the page where you have started your wiki.
2. Click the Edit tab and edit the wiki page, using the wiki syntax for simple formatting.
   
   • You can switch between Wysiwyg and Wiki text edit mode by clicking Convert to Wysiwyg/WIKI-text in Advanced Operations. Both edit modes provide formatting shortcuts.
     
   • Optionally, in the topic title field you can enter a new name for the topic. If you do not type a name, the title will automatically be used as topic name for this wiki page.
3. Click Save to persist your changes or, to save the page without notifying subscribed users of the change, click Quiet Save. Click Preview to see what your page looks like before saving (all changes are saved in the wiki page's history).

After you create a wiki space you can also create new topics by either:

• linking when modifying wiki topics. See Wiki Syntax for ways to create links.
• using the Create Topic option; this will prompt for the topic name.

You can delete wiki topics and spaces by either entirely removing them from the system or archiving them in the attic.

To delete a wiki topic or space:

1. Navigate to the wiki topic that you want to delete.
2. Click the Edit tab.
3. Below the textarea, under Advanced Operations, click Delete. AEM requests confirmation that you want to delete and recommends that you archive the topic in the attic.
4. To move the topic to the attic, click Delete. To delete the page entirely, clear the Attic check box and click Delete. You can also click Cancel to keep the topic.

To rename or move a wiki topic:

1. Navigate to the wiki topic that you want to rename or move.
2. Click the Edit tab.
3. Below the textarea, under Advanced Operations, click Move/Rename.
4. To change the name of the topic, type a new name in the New Name field.
5. To move a topic, select a new parent from the New Topic Parent list. To move subtopics with the main topic, select the Move subtopics check box.
6. Click Rename to make the change. If you make a mistake, you can click Reset to revert to current settings or click Cancel to close the Rename page.

To modify topic properties:

1. Navigate to the wiki topic that you want to modify properties for.
2. Click the Edit tab.
3. Below the textarea, under Advanced Operations, click Edit topic properties.
4. Make changes to the topic properties and click Apply to save them or Cancel to ignore them. See Environment Variables for information on how to use and include environment variables in topic pages.

To add an attachment to a topic:

1. Navigate to the wiki topic that you want to attach files to.
2. Click the Attachments tab.
3. Click Browse to upload a local file.
   • If you want the attachments to be listed on the topic page, select the check box in Display Options.
   • If you want to create a link to the attached file, select the check box in the Attach new file.
4. Click Upload to upload the attachment.

To view changes made to a particular wiki topic:

1. Navigate to the wiki topic that you want to view the history for.
2. Click the History tab. AEM displays any changes that were made to the topic and saved.
   

To subscribe to a topic whenever changes are made:

1. Navigate to the wiki topic you want to subscribe to.
2. Click the History tab.
3. Click the subscribe to this topic link. If you are subscribed to a topic, the link changes to unsubscribe from this topic. Click the link to unsubscribe.

The following section describes wiki syntax, including the following:

• Simple Formatting
• Linking and Images
  
• Lists
• Headings
• Tables

Simple formatting includes the commands you need to format your wiki text.

For a new paragraph, just insert an empty line. So this is on a new paragraph. For an explicit\\ line break, add two {{\\}}.

displays as:

For a new paragraph, just insert an empty line.

So this is on a new paragraph. For an explicit

line break, add two \\.

This is **bold text**.

displays as:

This is bold text.

This is //italic text//.

displays as:

This is italic text.

This is __underlined text__.

displays as:

This is underlined text.

This is --deleted text--.

displays as:

This is deleted text.

Water is also known as H,,2,,O. Einstein says: E = mc^^2^^.

displays as:

Water is also known as H₂O.

Einstein says: E = mc².

This is ((small text)).

displays as:

This is small text.

Please delete the file ==test.bak==.

displays as:

Please delete the file test.bak.

This is **//bold and italic text//**. Einstein says: ==**e = mc^^2^^**==.

displays as:

This is bold and italic text.

Einstein says: e = mc².

This is a {{{single **line** escape}}} {{{ And this **is** a multiline __escape__. }}} Further, a tilde ~~ escapes all special formattings, like ~**bold~** or ~WikiWords.

displays as:

This is a single **line** escape

And this **is** a multiline __escape__.

Further, a tilde ~ escapes all special formattings, like **bold** or WikiWords.

If you use the multiline escaping mentioned previously ({{{...}}}), the output is a simple <pre>...</pre> with no special style.

If you want to display a code example, use the @@ formatting. This generates a <pre><code>...</code></pre> block with a box around it. For convenience, the first linefeed after the @@ marker is removed from the output.

displays as:

If the @@ pair is on a single line, the <pre> is omitted:

Example: In java, @@System.out.println("Hello, world");@@ outputs ==Hello, world== on the console.

displays as:

Example: In java, System.out.println("Hello, world"); outputs Hello, world on the console.

If you just need a box, use the @@@ formatting.

@@@ This example is surrounded by a box,\\ that also can span multiple paragraphs. @@@

displays as:

Lines with starting > characters are blockwise indented: > This is indented once, >> and this is indented twice, >>> and so on... > Of course this is properly nested. : Alternatively, you can use colons ":" for :: indentation.

displays as:

Lines with starting > characters are blockwise indented:

This is indented once,

and this is indented twice,

and so on...

Of course this is properly nested.

Alternatively, you can use colons ":" for

indentation.

To insert a horizontal rule, just put 3 or more dahes on a single line: ---

displays as:

This section describes the various ways you can link in the wiki including using WikiWords, internal linking, external linking, and anchors. Images and images with links are also described.

The easiest way to link topics is to use WikiWords. WikiWords must start with an uppercase letter and then have either consecutive uppercase letters terminated with a lowercase letter or have a "camelcase" letter, that is, they have intercaps. Numbers count as both lower- and uppercase letters.

Valid Wiki Words:

• TestCase
• TESTCase
• TestCase1
• CQ355
• Test1

Not Wiki Words:

• testcase
• TEST
• Testcase
• cq355
• com.day.wiki.parser.Test.Case
• No

You can escape WikiWords by either preceeding them with a ~ or an !. If you need an ! before a wiki word, you need to escape it.

~NoLinking or !NoLinking. But ~!YesLinking.

displays as:

NoLinking or NoLinking. But !YesLinking.

If the name of a topic is not a wiki word, you can explicitly link to it, using the link markup. There are alternative link markup styles to comply with most of other wiki syntaxes. Internal links can also contain a WikiSpace reference.

This links [to_here].

This links [[to_here]].

This links to another space [Sandbox.TestTopic].

This links [to_here|Here].

This links [[to_here|Here]].

This links [[to_here][Here]].

displays as:

To create an anchor, preceed a word by a # sign.

In the [#Anchor1|section] mentioned below...

#Anchor1 The section with the anchor.

displays as:

External links follow the same syntax as internal ones. just use a full qualified URL or an absolute path to a resource.

Welcome to [http://www.day.com|DAY].

Click [/admin|here] for the servlet engine console.

displays as:

Use double curly brackets to specify an image source.

Smiley: {{smiley.jpg}}

Image with alt text: {{corrupt.jpg|Corrupt Image}}

displays as:

Consequently, you can use images in links:

Click here for a smile [http://en.wikipedia.org/wiki/Smile|{{smiley.jpg}}]

displays as:

Sent mail to [mailto:sheriff@day.com].

Sent mail to [mailto:sheriff@day.com|the sheriff.]

displays as:

Sent mail to sheriff@day.com.

Sent mail to the sheriff.

This section describes the syntax for ordered, unordered, and definition lists.

Unordered list items start with consecutive asterisks * followed by a whitespace. The number of asterisks indicate the indentation level. Preceeding whitespaces are ignored and can be used to indent the lists nicely in wiki-text. To create a multiline item, use the linebreak \\ markup.

displays as:

Ordered lists work the same way as unordered lists, but they use the hash # character for indentation. Ordered and unordered lists can also be combined.

# Item 1
# Item 2
## Item 2.1
## Item 2.2
### Item 2.2.1
**** Unordered Item
**** Unordered Item
# Item 3

displays as:

Definition list terms start with a semicolon ; followed by a colon : followed by the definition.

; Coffee : Black hot drink ; Milk : White cold drink

displays as:

Headings start with consecutive equal = characters. The number of characters specify the heading level. Closing equal characters are nice but unnecessary. Alternatively you can use TWiki syntax. If the heading markup is directly followed by 2 !!, the heading does not appear in the TOC.

==== Heading 4 Example ====
---++++ ~TWiki Heading 4 Example

====!! Heading 4 Example (no toc) ====
---++++!! ~TWiki Heading 4 Example (no toc)

displays as:

Heading 4 Example

TWiki Heading 4 Example

Heading 4 Example (no toc)

TWiki Heading 4 Example (no toc)

Tables are built with bar | characters. Each table cell is built with the contents between 2 bars. To create cells that span several columns use consecutive bars. To create cells that span several rows, use a ^ character in the empty rows. Table headers are either created with * markup around the text or by a = that directly follows the |.

| *A* | *B* | *C* | *D* |
| A1 | B1 | C1 | D1 |
|| AB2 | C2 | D2 |
| A3 | B3 | C345 | D3 |
| A4 | B4 |^ | D4 |
| A567 | B5 |^ | D5 |
|^ | B6 | C6 | D6 |
|^ || BC789 | D7 |
| A8 ||^ | D89 |
| A9 ||^ |^ |

displays as:

The alignment of the cell is determined by the spacing between the | and the cell text. Use 0 or 1 space to align the cell left, 2 spaces to center the cell and 3 or more spaces to right align the cell.

|= Country |= Population | 

| Switzerland | 7.5 Mio | 

| Italy | 58.1 Mio | 

| Germany | 82.4 Mio |

displays as:

There are four environment scopes that define variables:

1. text - The text scope contains the variables that are defined just within the wiki text. 
2. topic - The topic scope contains the variables that are defined for that topic.
3. space - The space scope contains the variables of this topic and all ancestor topics up to the topic-space, that is, all the properties of all topics you see in the trail.
   
4. global - The global scope contains the variables of globally defined properties.
   
5. all - Not really a scope, just represents a holistic view of all scopes, where the global is overlayed by the space by the topic by the text scope.

To define a variable, use the <wiki:set/> tag. This variable will always be defined in the text scope.

<wiki:set name="myvar">Hello **world**.</wiki:set>

To dump an environment, use the <wiki:env/> tag.

__**Text Scope**__\\
<wiki:env scope="text"/>\\
__**Topic Scope**__\\
<wiki:env scope="topic"/>\\
__**Space Scope**__\\
<wiki:env scope="space"/>\\
__**Global Scope**__\\
<wiki:env scope="global"/>\\
__**//all// Scope**__\\
<wiki:env scope="all"/>

displays as:

To dump one variable, use the <wiki:get/> tag:

<wiki:get name="myvar"/>

displays as:

Hello **world**.

If you want to use a variable in an HTML argument, you can reference it by using the ${var} syntax. To include the variable in the wiki-text, that is, if you want the variable to be parsed again, use the % syntax:

myvar is: %myvar%

Illegal vars: %test$ 50% %%\\
Empty vars: "%foo.bar%"\\

displays as:

myvar is: Hello world.

Illegal vars: %test$ 50% %
Empty vars: ""

Variables can contain other variables:

<wiki:set name="product.copy">&copy; 2010 by %product.company%</wiki:set>
<wiki:set name="product.company">Day Software </wiki:set>
<wiki:set name="loop">Recursive %loop%</wiki:set>
//%product.copy%//
//%loop%// test.

displays as:

© 2010 by Day Software
Recursive test.

Variables can contain arguments (see also BUG definition in previous tables):

<wiki:set name="GOOGLE">[http://www.google.com/search?q=%var.args%|%var.args%]</wiki:set>
View google results for %GOOGLE{jcr}%.

<wiki:set name="LINK"><a href="%var.args.0%">%var.args.1%</a></wiki:set>
%LINK{http://www.day.com,Day Software}%

displays as:

View google results for jcr.

Day Software

The wiki can also be extended through a plugin API.