« Back to Portlets

Wiki Portlet

Introduction #

Liferay includes in its bundle a portlet that allows creation of contents in the Wiki collaboration style. The Wiki Wiki concept was invented by Ward Cunningham and has seen since then lots of different implementations.

Nodes #

Liferay allows the organization of pages in groups called nodes. Each node acts as a whole wiki with its own set of permissions, recent changes list and listing of all pages.

With the introduction of the new permissions system in Liferay 4, the Wiki was gained a very powerful functionality that allows you either to use the wiki in the traditional way (open to anyone) or use it also as a tool to organize private information to certain organizations, locations or groups of people.

A node is created by clicking on the Add node button and filling the title and optionally the description. After creating a node an initial page called FrontPage is automatically created and can be edited clicking on the 'Edit Page' link in the bottom of the wiki window.

To create new pages you have to edit an existing page and use the CamelCase syntax as described next to create a link to the new page. Until the page is created instead of being converted to a link, the name of the new page will be preceeded by a question mark. Clinking on the question mark will create the page. Once it is created the page can be edited regularly and its name on the originating page will be converted to a link. Please note : This does not work inside the HTML Editor.

Editing modes #

Liferay wiki comes with three editing modes: Creole, HTML, and Classic.

Creole #

Creole was a syntax that came about through a growing dissatisfaction in the Wiki community of a non-standard language. Headed by Ward Cunningham, who invented the Wiki technology with C2, the Creole design team believed that "... markup should be easy to learn and easy to teach, as well as fast to type and should use readable markup which is non-destructive" (see article).

Creole syntax has been added into the suite of Wiki languages supported by Liferay since version 5.0. Some examples of its basic syntax include:

Text Styles

//italics//
**bold**

Headers

== Large heading ==
=== Medium heading ===
==== Small heading ===

Links

[[Link to a page]]
[[http://www.liferay.com|Link to website]]

Lists

* Item
** Subitem
# Ordered Item
## Ordered Subitem

Images

{{attached-image.png}}
{{Page Name/other-image.jpg|label}}

In-line CSS injection(Note: this is not officially part of the Creole 1.0 specification, but it works because Liferay's wiki is based on the JSPWiki engine. Used it only if you absolutely must)

%%(color:red) red%%  %%(color:blue)blue%%  %%(color:green)green%%

%%(color:red) red%% %%(color:blue)blue%% %%(color:green)green%%

%%(text-align:center)
**This line is centered**
%%

%%(text-align:center) This line is centered %%
Tables with more complex CSS injection:

||%%(text-align:left;display:block;)Left Heading%% ||%%(text-align:center;display:block;)Center Heading%% 
(break added for readability) ||%%(text-align:right;display:block;)Right Heading%%
|%%(text-align:left;display:block;)Left Cell 11%% |%%(text-align:center;display:block;)Center Cell 12%% 
(line break added for readability) |%%(text-align:right;display:block;)Right Cell 13%%
|%%(text-align:left;display:block;)Left Cell 21%% |%%(text-align:center;display:block;)Center Cell 22 
(line break added for readability) (longer for illustration)%% |%%(text-align:right;display:block;)Right Cell 23%%
|%%(text-align:left;display:block;)left%% |%%(text-align:center;display:block;)center%% 
(line break added for readability)|%%(text-align:right;color:red;display:block;)combine alignment and color%% 
%%(text-align:left;display:block;)Left Heading%% %%(text-align:center;display:block;)Center Heading%% %%(text-align:right;display:block;)Right Heading%%
%%(text-align:left;display:block;)Left Cell 11%% %%(text-align:center;display:block;)Center Cell 12%% %%(text-align:right;display:block;)Right Cell 13%%
%%(text-align:left;display:block;)Left Cell 21%% %%(text-align:center;display:block;)Center Cell 22 (longer for illustration)%% %%(text-align:right;display:block;)Right Cell 23%%
%%(text-align:left;display:block;)left%% %%(text-align:center;display:block;)center%% %%(text-align:right;color:red;display:block;)combine alignment and color%%

Other

<<TableOfContents>>
{{{ Preformatted }}}

For full syntax rules can be found at the Creole 1.0 spec.

HTML #

In this mode the text area incorporates an embedded HTML editor (by default FCKEditor) that allows the user to write the document in a WYSIWYG similar to how they work in Ms Word or Open Office (although somewhat more limited, of course).

Please note: When switching back and forth from Creole to HTML the format will not be converted automatically. You'll have to do it manually.

Classic #

The classic editing mode is the most usual for wikis and uses text conventions to format the text. The text is later converted to HTML to be presented. Liferay uses the Friki engine to do this conversion. It's syntax is described in:

This syntax is inspired and pretty much the same to that of the original Wiki. Documentation about that syntax can be found in:

Links are created by writting two or more words together (without spaces between them) and uppercasing the first letter of each of the words. This is known as CamelCase syntax.

 LinkExample

To create monospaced text write a blank or more spaces at the beginning of the line

 {{{   This would be converted to monospaced font}}}

To write italics put two single quotes at the beginning and at the end of the text

 {{{''italics''}}}

To write bold put three single quotes at the beginning and at the end of the text

 {{{'''bold'''}}}

Four dashes by themselves on a single text line create an horizontal line

 ----

Classic (Enhanced in 4.3.1+) #

While awaiting the integration of an alternative wiki engine (as has been discussed and often requested), we've made a few changes for the 'Classic Wiki' mode such that it's usability and familiarity should be much greater.

Instead of going the 'Classic Wiki' syntax direction, we've taken this 'Enhanced' version in the MediaWiki direction.

Here is a snapshot of the rules as they are now:

Added Media Wiki style internal links

 [ Page Name | Link Text ]

Features not shown are the same as they were.

References #

Image Gallery is one of Liferay's Out of The Box Portlets

0 Attachments
86849 Views
Average (1 Vote)
The average rating is 2.0 stars out of 5.
Comments
Threaded Replies Author Date
How can I remove FRONT PAGE from each wiki... K Pink April 10, 2009 11:37 AM
Same question... Dmitry Babain May 29, 2009 1:47 AM
I used redirection for that purpose. Lorinc Nyitrai August 6, 2009 7:14 AM
It seems that it is not possible to switch back... Per Spilling June 11, 2009 10:43 AM
see http://issues.liferay.com/browse/LPS-5221 Claas Ruschmeyer October 3, 2009 1:45 AM
Is there a reason why the replies are not... Corné Aussems January 22, 2010 1:36 AM
I miss the fearure that makes all Wikis... Lorinc Nyitrai August 6, 2009 7:11 AM
Thank you, Brian. Helpful Wiki article. Jonas Yuan August 28, 2009 5:07 PM
Is there a way to link from one wiki page to... Robin Mitra February 17, 2010 8:09 AM
Found it by mistake! When adding a link, select... Robin Mitra February 17, 2010 8:12 AM
<a href="http://www.google.com/"... Alexia Biggs February 28, 2010 5:26 PM
Dear Team, it's is possible to keep the Revert... Senthil Chockalingam June 29, 2010 2:18 AM
how can i subscribe wiki for email notification... pooja shah August 4, 2010 11:37 PM
Is there anyway to change some settings to make... Puj Z August 31, 2010 5:52 AM
How can i remove "Front Page" heading from the... Sravani M November 5, 2010 9:06 PM
how can i give users the option to create new... Mohammed Azam November 25, 2010 11:40 PM
Is there a way to filter out, and view only... Ryan Paul Schultz January 20, 2011 11:39 AM
Liferay 6.0.6 CE - can't find Classic formats.... Vladimir Vladimirovich Druzenko August 7, 2011 5:38 AM
How does one implement Captcha in the Wiki? Bob Lyman September 1, 2011 12:31 PM
test Krishna Gadde September 22, 2011 6:00 AM
We have now invested 6 months in building an... Christine Sætre November 10, 2011 2:54 AM
How to zero-rise the "Views" for each page? sherry quik December 21, 2011 7:50 AM
good article Manikandan S January 10, 2012 3:23 AM
any body know how to make a backup and restore... enzo acosta January 31, 2014 3:51 AM

How can I remove FRONT PAGE from each wiki page?
thanks
Posted on 4/10/09 11:37 AM.
Same question...
Posted on 5/29/09 1:47 AM.
It seems that it is not possible to switch back and forth between Creole and HTML editing mode in the Wiki Portlet. Is this a bug or a feature?
Posted on 6/11/09 10:43 AM.
I miss the fearure that makes all Wikis structured: the Category page. I suppose that the Child page feature is intended to be its replacement.
Posted on 8/6/09 7:11 AM.
I used redirection for that purpose.
Posted on 8/6/09 7:14 AM in reply to Dmitry Babain.
Thank you, Brian.

Helpful Wiki article.
Posted on 8/28/09 5:07 PM.
see http://issues.liferay.com/browse/LPS-5221
Posted on 10/3/09 1:45 AM in reply to Per Spilling.
Is there a reason why the replies are not hierarchical like MessageBoard?
Posted on 1/22/10 1:36 AM in reply to Claas Ruschmeyer.
Is there a way to link from one wiki page to another by using the html FCKeditor? I couldn't find a way to do it.
Posted on 2/17/10 8:09 AM.
Found it by mistake! When adding a link, select "other" as the protocol and enter the page name in the url field. Simple enough!
Posted on 2/17/10 8:12 AM in reply to Robin Mitra.
<a href="http://www.google.com/" rel="dofollow">nice</a>
Posted on 2/28/10 5:26 PM in reply to Robin Mitra.
Dear Team,

it's is possible to keep the Revert option for Only for Admin(Owner)?
this.emoticonemoticon
Posted on 6/29/10 2:18 AM in reply to Alexia Biggs.
how can i subscribe wiki for email notification (for updates or changes in wiki)
Posted on 8/4/10 11:37 PM in reply to Senthil Chockalingam.
Is there anyway to change some settings to make the wiki content right-to-left for languages like Arabic?
Posted on 8/31/10 5:52 AM.
How can i remove "Front Page" heading from the wiki portlet.
Posted on 11/5/10 9:06 PM.
how can i give users the option to create new page add edit etc
Posted on 11/25/10 11:40 PM.
Is there a way to filter out, and view only those Wikis that you have either started, or edited in the past? Similar to viewing 'My Documents'.
Posted on 1/20/11 11:39 AM in reply to mohammed azam.
Liferay 6.0.6 CE - can't find Classic formats. Only Creole and HTML.
Where is it?
Posted on 8/7/11 5:38 AM.
How does one implement Captcha in the Wiki?
Posted on 9/1/11 12:31 PM.
Posted on 9/22/11 6:00 AM.
We have now invested 6 months in building an enterprise wiki, using Creol wiki (with WYSIWYG). Problem is we have now discovered a number of number of bugs that make launch impossible.
(1) Wish we had known that you can't link to email addresses! This has to be an option even in the simplest web page, and works in Creol, but not in Liferay. If it does I haven't found any information on what we might have done wrong locally.
(2) Line breaks don't work as specified above;
(3) Permalinks anchors after headings link to the incorrect page if an internal link precedes them.
(4) ... and it is increasingly hard to find clear information on fix it yourself options or potential relief from these issues. http://bit.ly/sWIhbz
One JIRA post from Vincent Lu (http://bit.ly/tyP9v0) says "... removing the Creole Filter JAR from the Liferay Portal distribution in favor for the creole implementation from JSPWiki might solve the problems ..." but there is no further information from the community or on Liferay.com about this operation or other things one can try.
We like the Liferay product, but these latest issues are pretty frustrating.
Posted on 11/10/11 2:54 AM.
How to zero-rise the "Views" for each page?
Posted on 12/21/11 7:50 AM.
good article
Posted on 1/10/12 3:23 AM in reply to sherry quik.
any body know how to make a backup and restore of a wiki in liferay.
Posted on 1/31/14 3:51 AM.