As most of you know, the knowledge base on SUMO is a wiki. Those of you who are familiar with wikis are probably most familiar with mediawiki syntax, which is used on wikipedia and wiki.mozilla.org. On SUMO, we use tikiwiki, which integrates a wiki with forums and more. The wiki syntax is a little different than mediawiki, so I thought I would go through some examples to help everyone better understand tikiwiki syntax.
Some things, like lists are the same:
Numbered lists:
# list item 1
# list item 2
# list item 3
Unordered lists:
* list item 1
* list item 2
* list item 3
One of the most common uses of tikiwiki syntax is linking to other articles in the KB. To do that, we just put two parenthesis around an article name.
e.g. ((articlename))
To link different text to an article, just separate it with a pipe.
e.g. ((articlename|linked text))
You can even link straight to an anchor in another article.
e.g. ((articlename|#anchor name|linked text))
Note: If you are translating an article, you do not need to translate article titles, because our system will automatically translate links to other KB articles.
Finally, links to URLs outside of SUMO should be surrounded with one square bracket on each side.
e.g. [http://www.mozilla.com/|linked text]
There are instances where you might see special tags that we use for cases like keyboard keys, buttons, and menus. These look like the following examples (respectively):
{TAG(tag=kbd)}text{TAG}
{DIV(class=button,type=span)}text{DIV}
{MENU()}text{MENU}
As you can see, tikiwiki syntax is only slightly different from mediawiki. It is very easy to learn; and if you ever need help remembering tikiwiki markup when editing an article, we have a markup chart available you can reference. If you have any questions or suggestions, we would love to hear them! Just post them in the Contributors forum.