How to Build a Wiki - Documentation topics on: confluence,deprecated,howto,mediawiki,textile,tracwiki,tutorials,twiki,velocity,velocity tools,wiki,.

How to Build a Wiki
Deprecated

This feature has been deprecated, and may no longer be supported in future dotCMS versions.

You will need to understand the following items before starting the construction of your Wiki:

Wiki Viewtool

This viewtool provides a series of methods that will allow you to display your content as wiki pages. You can choose among 5 different markups: MediaWiki, Confluence, Textile, TracWiki, and TWiki. You will see examples of those markups later in this document.

For detailed class and method descriptions, please check Velocity and dotCMS - WikiTool.

Submit/Edit Content Macro

The pages in your wiki are actually pieces of content in dotCMS. Whenever a user creates a new page, a new piece of content will be added to the content type that you have selected to store the information of your Wiki; this is what you need the submitContent macro for. To allow your users to make modifications to previously created pages, you will need to use the submitContentEdit macro.

For information about the submitContent macro, please check Front End Submit Content.

For information about the submitContentEdit macro, please check Front End Content Editing.

 

Step by Step Guide to Create your Wiki Site

1. Create the content content type where the information of your Wiki will be stored

In our example, this content type is called "Wiki" and has the fields shown in the image bellow. You can build this content type to your needs and use the parameters provided by he Submit/Edit Content macro to control what and how its fields are displayed in the front end for users to create/edit pages in your Wiki.

While creating the content type, you must set the URL Map Pattern to make sure that every piece of content matches the path of the pages in your Wiki.


2. Create a unique detail page to display all the content in your Wiki content type (pages of your Wiki)

As mentioned before, there are five different markups provided by dotCMS WikiTool: MediaWiki, Confluence, Textile, TracWiki, and TWiki.

You will find bellow examples on how those different markups are used and the different outputs they will return.

The code shown below can be placed in your detail Wiki page in different ways: containers, dotparse from a vtl file, or application widget.

MediaWiki Markup

  $mediaWikiWebAPI.mediaWikiToHTML($URLMapContent.story)

Confluence Markup

  $mediaWikiWebAPI.confluenceToHTML($URLMapContent.story)

Textile Markup

  $mediaWikiWebAPI.textileToHTML($URLMapContent.story)

TracWiki Markup

  $mediaWikiWebAPI.tracWikiToHTML($URLMapContent.story)

TWiki Markup

  $mediaWikiWebAPI.tWikiToHTML($URLMapContent.story)

3. Create a listing page

You can create your listing page (the index for your Wiki) by simply pulling content from your Wiki content type.




4. Add the ability to add/edit pages to your Wiki (add/edit content)

Your listing page, for example, can include a button to add new pages to your Wiki.


This button should link to a page displaying the submitContent macro. To allow users to also edit the content of Wiki items, you will need to use the submitContentEdit macro.

You can see bellow the code used in our example to create a new page and the front end overlay that allows user to enter the information required by our Wiki content content type.








In conclusion, a listing page with links to add/edit wiki pages, a detail page displaying the content under your Wiki content type, and a page using the submit/edit content macros are all the elements you need to start creating your own Wiki site.