Login / Status
developer.Resource
Home . Documentation . Document Library . Extension Manuals
Sponsors
hosted by punkt.deTYPO3 and Open Source MagazineAOE Media

1.6. Mark-ups

General Formatting Mark-ups

In order to format the content entered into DR_Wiki, the following mark-ups can be used:

Mark-up

Description

Paragraphs <p>

A single newline generally has no effect on the layout. These can however be used to separate sentences within a paragraph. Some editors find that this aids editing and improves clarity when utilising the ‘diff-tool’ (used by the editors to compare different versions of a page, see Usage Scenario: Case 3).

An empty line starts a new paragraph.

* item 1
** a
** b
*** c
*** d
* item 2
* item 3

Creates a bulleted list such as:

  1. item 1

    1. a

    2. b

      1. c

      2. d

  2. item 2

  3. item 3

# item 1
## a
## b
### c
### d
# item 2
# item 3

Creates a numbered list such as:

  1. item 1

    1. a

    2. b

      1. c

      2. d

  2. item 2

  3. item 3

* item 1
## a
## b
*** c
* item 2
* item 3

Both types of lists can also be combined:

  1. item 1

  1. a

  2. b

      1. c

  1. item 2

  2. item 3

: text
:: more text
::: even more text

A colon indents a line or paragraph. Works similar to the bulleted and numbered lists:

text

     even more text

                  even more text

[[word]]

A word between double square brackets creates a new internal link to a Wiki page, in this case for the term “word”. Links appear as bold text when the article is viewed. See Usage Scenario: Case 1 for more information.

[[HomePage]]

Creates a link specifically to the starting page of the Wiki.

[[word|alternative text]]

Creates a new internal link to a Wiki page called ‘word’, but using the ‘alternative text’ as link title.

[[word]]trail

Creates a new internal link to a Wiki page, using the combination wordtrail as link title.

  1. [[machine]]s --> machines (link to page called: machine)

[[ns:word]]

Creates a new internal link to a Wiki page called ‘word’ in the namespace ‘ns’. Currently the following namespaces are available:

  1. Wikipedia --> creates an external link to the English version of the Wikipedia encyclopaedia.

  2. Discussion --> discussion pages of the individual Wiki pages.

  3. IMDB --> Link to the international movies database.

  4. FIDIS --> Link to the FIDIS Wiki on Identity related terms (e.g. “[[FIDIS:WP1]]”)

  5. User --> User pages.

  6. Categories are also used as namespaces:

  7. Category:IDM

  8. Category:Identity

=word=

Creates a heading (level 1 - H1-tag).

==word==

Creates a heading (level 2 - H2-tag).

===word===

Creates a heading (level 3 - H3-tag).

====word====

Creates a heading (level 4 - H4-tag).

=====word=====

Creates a heading (level 5 - H5-tag).

======word======

Creates a heading (level 6 - H6-tag).

imageURL

Inserts an image from ‘imageURL’ into the Wiki page. Currently only gif, jpeg, jpg, and png images are allowed.

Example:

  1. http://somedomain.org/myimage.jpg

URL

URLs and email addresses are automatically converted to real HTML links. Currently ftp, http(s), mailto, irc, gopher, and news URLs are recognised.

Examples:

  1. mailto:someone@somedomain.org

  2. http://www.somedomain.org

[URL link-text]

Creates a link using the name as link-text. Currently ftp, http(s), mailto, irc, gopher, and news URLs are recognised.

Examples:

  1. [mailto:someone@somedomain.org My Email]

  2. [http://www.somedomain.org My Domain]

[URL]

Creates an enumerated link. Currently ftp and http(s) URLs are recognised.

Examples:

  1. [mailto:someone@somedomain.org]

  2. [http://www.somedomain.org]

----

Creates a bar / horizontal line (<hr>).

''text'' 

Sets the text to italic.

'''text'''

Sets the text to bold.

'''''text'''''

Sets the text to bold & italic.

{ | params | }

Creates a new table (for more detail  see “Table Examples”)

HTML Tags

Some HTML tags are allowed inside a Wiki. By default, the the tags below are currently supported:

<br />, <b>, <i>, <p>, <u>, <center>, <hr />. <sub>, <s>, <small>, <blockquote>, <td>, <tr>, <th>, <table>.

#REDIRECT [[IDM]]

Redirect one article to another by placing a directive like the one shown on the left on the first line of the article (such as at a page titled "IDM"  “Identity Management”).

You can <s>strike out deleted material</s> and <u>underline new material.</u>

The example on the left would display:

You can strike out deleted material and underline new material.

~~~
[Discussion only]

Adds the user’s login name to the article as signature. Only works for the “Discussion” namespaces.

  1. ~~~~ will be replaced by “Frank Idis”

~~~~
[Discussion only]

Adds the user’s login name and date to the article as signature. Only works for the “Discussion” namespaces.

  1. ~~~~ will be replaced by “Frank Idis” + date

~~~~~
[Discussion only]

Adds the current date to the Wiki page.

{{templatename}}

Templates are an easy way of adding pre fabricated text elements to a Wiki page. This mechanism can be used to insert repeating text elements to a Wiki page, such as notes, pre-formated tables and so on. Generally talking, templates are Wiki pages that reside in the namespace “Template”, such as”Template:templatename”. By adding the name of the template into curled braces without the namespace marker, the content of a template page is added into the Wiki page and rendered into HTML.

Wiki Variables

These Mark-ups can be used to automatically display additional/dynamic (Meta-) information on a Wiki page.

Mark-up

Description

{{PAGENAME}}

Displays the name of the current Wiki page.

{{GETDISCUSSIONLINK}}

Returns an internal link to the connected discussion page or an empty string if no discussion is present.

{{REVISIONID}}

Returns the ID of the current Wiki page.

{{NAMESPACE}}

Returns the name of the current namespace.

{{DATE}}

Returns the current date string (Y-m-d H:i:s).

{{CURRENTMONTH}}

Returns the current month as numerical value (e.g. 11).

{{CURRENTMONTHNAME}}

Returns the current month as word (e.g. November).

{{CURRENTMONTHNAMEGEN}}

Returns the current month as 3 letter short version (e.g. Nov).

{{CURRENTDAY}}

Returns the current day as numerical value (e.g. 1).

{{CURRENTDAYNAME}}

Returns the current day as word (e.g. Wednesday).

{{CURRENTYEAR}}

Returns the current year (e.g. 2005).

{{CURRENTTIME}}

Returns the current time (hh:mm).

{{SWATCHBEATS}}

Returns the current time in Swatch Internet Beats.

{{PAGEAUTHOR}}

Displays the author of the current page.

{{NUMBEROFARTICLES}}

Displays the number of articles in a Wiki.

{{ALLCONTRIBUTINGAUTHORS}}

Displays all authors contributing to a Wiki

{CONTRIBUTINGAUTHORS}}

Displays all authors contributing to an article of a Wiki page.

__NOTOC__

Deactivates the generation of a TOC.

__NONUMBERHEADINGS__

Deactivates the generation of a header numbers.

{{VERSION}}

Displays the release number of the Wiki engine.

Special Characters

Other special characters such as: Diacritical marks, punctuation, commercial symbols, Greek characters, mathematical characters.

Mark-up

Description

&Agrave; &Aacute; &Acirc; &Atilde; &Auml; &Aring; &AElig; &Ccedil; &Egrave; &Eacute; &Ecirc; &Euml; &Igrave; &Iacute; &Icirc; &Iuml; &Ntilde; &Ograve;&Oacute; &Ocirc; &Otilde; &Ouml; &Oslash; &Ugrave; 
&Uacute; &Ucirc; &Uuml; &szlig; &agrave; &aacute; &acirc; &atilde; &auml; &aring; &aelig; &ccedil;&egrave; &eacute; &ecirc; &euml; &igrave; &iacute;&icirc; &iuml; &ntilde; &ograve; &oacute; &ocirc; 
&oelig; &otilde; &ouml; &oslash; &ugrave; &uacute; &ucirc; &uuml; &yuml;

À Á Â Ã Ä ÅÆ Ç È É Ê ËÌ Í Î Ï Ñ ÒÓ Ô Õ Ö Ø ÙÚ Û Ü ß à áâ ã ä å æ çè é ê ë ì íî ï ñ ò ó ôœ õ ö ø ù úû ü ÿ

&iquest; &iexcl; &sect; &para; &dagger; &Dagger; &bull; &ndash; &mdash; &lsaquo; &rsaquo; &laquo; &raquo; &lsquo; &rsquo; &ldquo; &rdquo;

¿ ¡ § ¶† ‡ • – —‹ › « »‘ ’ “ ”

&trade; &copy; &reg; &cent; &euro; &yen; &pound; &curren;

™ © ® ¢ € ¥£ ¤

&alpha; &beta; &gamma; &delta; &epsilon; &zeta; &eta; &theta; &iota; &kappa; &lambda; &mu; &nu; &xi; &omicron; &pi; &rho; &sigma; &sigmaf; &tau; &upsilon; &phi; &chi; &psi; &omega; &Gamma; &Delta; &Theta; &Lambda; &Xi; &Pi; &Sigma; &Phi; &Psi; &Omega;

α β γ δ ε ζη θ ι κ λ μ νξ ο π ρ σ ςτ υ φ χ ψ ωΓ Δ Θ Λ Ξ ΠΣ Φ Ψ Ω

&int; &sum; &prod; &radic; &minus; &plusmn; &infin; &asymp; &prop; &equiv; &ne; &le; &ge; &times; &middot; &divide; &part; &prime; &Prime; &nabla; &permil; &deg; &there4; &alefsym; &oslash; &isin; &notin; &cap; &cup; &sub; &sup; &sube; &supe; &not; &and; &or; &exist; &forall; &rArr; &hArr; &rarr; &harr;

∫ ∑ ∏ √ − ± ∞≈ ∝ ≡ ≠ ≤ ≥× · ÷ ∂ ′ ″∇ ‰ ° ∴ ℵ ø∈ ∉ ∩ ∪ ⊂ ⊃ ⊆ ⊇¬ ∧ ∨ ∃ ∀ ⇒ ⇔→ ↔

Rendering of tables

Tables can be rendered using the following syntax (pipe-syntax):

Mark-up

Description

{ | params | }

Creates a new table. A table is defined by {| ''params'' |} which is the same as the HTML:

<table ''params''>Insert non-formatted text here </table>

Please note: You must include the space between “{|” and params, else the first parameter is ignored.

{ | border = 1-n

Create borders. Furthermore, most of the standard HTML table parameters work for Wiki tables too (e.g. cellspacing, cellpadding, bgcolor, etc.)

|+ Caption

Creates a caption for the table: <caption>Caption</caption>

!params|cell1

Creates a header-cell (<th>). Functions the same way as <td>, except "!" is used instead of the opening "|". "!!" can be used instead of "||".

|-

Creates a new row (<tr>).

|

Creates a cell (<td>).

Table Examples

A simple example for a table, using the Wiki Mark-ups:

{| border=1

|-

| bgcolor=red|cell1 || width=300px bgcolor=blue|cell2 || bgcolor=green|cell3

|}

This will result in the following table:

cell1

cell2

cell3

A more complex example using a nested table:

{| border=1

| &alpha;

|

{| bgcolor=blue border=2

|nested

|-

|table

|}

|the original table again

|}

This will result in the following output:

α

nested

table

the original table again

Please note: Nested tables have to start on a new line.

Wiki Plug-Ins

Currently the following dynamic Wiki plug-ins are available. In order to use these, simply insert the following Mark-ups into the source of a Wiki page:

Plug-In

Description

{###SEARCH###}{###SEARCH###}

Inserts a Search-Form on the Wiki page and displays the result. This plug-in searches the body and the keywords of the database.

{###LASTCHANGED###}[days]{###LASTCHANGED###}

Inserts a list of the pages changed in the last [days] days.

{###INDEXLIST###}{###INDEXLIST###}

Lists the Wiki words in a Wiki.

{###AUTHOR###}{###AUTHOR###}

Displays the creator of the Wiki page. This is done by picking the author of the oldest Wiki page entry and creating a new Wiki page link for the author.

{###TEMPLATELIST###}{###TEMPLATELIST###}

Displays the list of available templates in the current Wiki.

System Images

This is the list of images, which come with dr_wiki

Figure 9: These images come with dr_wiki

  1. {{IMAGE_ERROR2}} or {{IMAGE_ERROR}} for the left-aligned version

  2. {{IMAGE_FOLDER2}} or {{IMAGE_FOLDER}} for the left-aligned version

  3. {{IMAGE_INFO2}} or {{IMAGE_INFO}} for the left-aligned version

  4. {{IMAGE_WARNING2}} or {{IMAGE_WARNING}} for the left-aligned version

  5. {{IMAGE_WEBPAGE2}} or {{IMAGE_WEBPAGE}} for the left-aligned version

  6. {{IMAGE_COMPUTER2}} or {{IMAGE_COMPUTER}} for the left-aligned version

  7. {{IMAGE_RETURN2}} or {{IMAGE_RETURN}} for the left-aligned version

  8. {{IMAGE_COPY2}} or {{IMAGE_COPY}} for the left-aligned version

  9. {{IMAGE_TRASH2}} or {{IMAGE_TRASH}} for the left-aligned version

Adding References

Reference Mark-ups

Starting from version 1.5.2, dr_wiki supports references (A reference can be a book, article, or link - whatever you like.) as a Mark-up to add footnotes (A footnote is a note placed at the bottom of a page to comment on a part of the main text, or to provide a reference (a source) for it. Footnotes are often used to add information that might be helpful to later fact-checkers, such as a quotation that supports your edit.)

Here is how to use this Mark-up:

  1. Place a <ref> ... </ref> where you want a footnote reference number to appear in an article—type the text of the note between the ref tags.

  2. Place <references/> in an otherwise empty "Notes" or "References" section near the end of the article—the list of notes will be automatically generated here. If you want to create columns of notes, write <references-2col/>.

Example

Example edit:

The Sun is pretty big,<span style="color:black;">```<ref>```Miller, E: "The Sun", page 23. Academic Press, 2005```</ref>``` but the Moon is not so big.<span style="color:black;">```<ref>```Brown, R: "Size of the Moon", <nowiki>``Scientific American``, 51(78):46== Notes ==<references/>