• Home
• com.jsftoolkit
• components-base
• 0.9
• source code
• instructions.wiki.txt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.jsftoolkit.doc.instructions.wiki.txt Maven / Gradle / Ivy

== Wiki Markup Guide ==

The wiki syntax used here is very similar to that used by 
[http://en.wikipedia.org/ Wikipedia]. 

You can make text '''strong''' by surrounding it with `'''` on both sides. e.g. `'''strong'''`

`''` (two single quotes/apostrophes) on each side will ''emphasize'' e.g. `''emphasis''`

For '''''strong and emphasis''''', try `'''''`. e.g. `'''''strong and emphasis'''''`

You can create a link with the syntax `[http://someurl.com link text]`.

A blank line will start a new paragraph.

Code or monospaced text can be created with a pair of `^`. e.g. `^foo=bar;^` becomes ^foo=bar;^

=== Lists ===

Numbered and bulleted lists are created by indenting and the '#' or '*' character respectively.
e.g.
{{{
 * This is a bulleted list
 * This is the same list
  * This is a nested list
  * You must only indent by 1 additional space for each nested list. 
  * If you indent by more, your list wont render properly.
   * Nesting may be arbitrarily deep..
    * ...as long as this rule is followed.

 # This is a new list. 
 # It is also numbered.
  * You can nest either type of list inside the other
}}}
Creates:
 * This is a bulleted list
 * This is the same list
  * This is a nested list
  * You must only indent by 1 additional space for each nested list. 
  * If you indent by more, your list wont render properly.
   * Nesting may be arbitrarily deep..
    * ...as long as this rule is followed.

 # This is a new list. 
 # It is also numbered.
  * You can nest either type of list inside the other

A definition list looks like:
{{{
; term : definition goes here
; apple : a round reddish fruit that grows on trees. See also Garden of Eden, Snakes.
}}}
Which becomes
; term : definition goes here
; apple : a round reddish fruit that grows on trees. See also Garden of Eden, Snakes.
  
Headings are created by placing 2 or more '=' at the beginning and end of a line. e.g. `=== Caveats ===` creates:

=== Caveats ===

It is very important that you close markup in the same order that you opened it. e.g.
If you want to make a link bold, you must write it as `'''[http://url link]'''` 
and not something like `[http://url '''link]'''` or your page will fail to 
compile until you fix it.

=== Tables ===

Tables begin with {| and end with |}, each on a line by itself.  Table cells are defined with pairs of '|' and '!', the later creating a header cell. Cell attributes may be specified after the cell, but must be well formed. '|-' on a line by itself separates rows. Cells may span multiple lines if necessary.
e.g.
{{{
{|
! First Name !style="text-decoration: underline" ! Last Name !! Occupation !
|-
| Joe || Blow || Furniture Salesman |
|-
| Mike || Mikerson || Baby Naming Specialist |
|-
| Jack || O'All Trades ||
 * Carpenter
 * Astronaut
 * Zookeeper
|
|}
}}}
Becomes

{|
! First Name !style="text-decoration: underline" ! Last Name !! Occupation !
|-
| Joe || Blow || Furniture Salesman |
|-
| Mike || Mikerson || Baby Naming Specialist |
|-
| Jack || O'All Trades ||
 * Carpenter
 * Astronaut
 * Zookeeper
|
|}

=== Escaping Text ===

Sometimes you have text you don't want to be interpreted as wiki text.
For preformatted text like source code, you can use '`{{`{' and '`}}`}'. 
You cannot have '`}}`}' inside the text as that will cause it to stop being
escaped.

If you just have a few characters to escape and don't want them to be
formatted like source code, you can use ``` (backtick, adjacent to '1' or the space bar on most keyboards). Anything nested inside a pair of 
``` will not be interpreted. e.g. ````[]```` will render as `[]`. To render a ```, 
write `````````.  To escape '`{{`{' write something like '```{{```{'.

To obtain a '<' or '&', you must write '&lt;' and '&amp;' respectively.

If you have a large block of text that contains many '<' or '&', consider using '<<' and '>>' around the text. It has the same effect as `{{`{ and }}`}`, but automatically escapes for XML.  That means you cannot embed markup like you can in a normal ^pre^ tag.

=== HTML ===

If your site permits it, you can also include HTML tags in your text. 
Creating malformed HTML may cause a browser error on some platforms, 
making it where users can't read the page.

=== Limitations ===

This syntax covers most common cases. Many cases cannot be easily handled however. For example, nesting a definition list inside a bulleted list, or vice versa, is not possible.  Nesting a table inside another table is not possible.  Creating a table with a column span is not possible. Allowing HTML markup can accommodate these special markup needs, but caries with it additional risks and is left to the discretion of the site operator.