User Tools

Site Tools


en:syntax

Formatting Syntax

In order to allow content editing by ordinary users (meaning you :-)), Legatum Homeopathicum runs on DokuWiki engine. DokuWiki supports some simple markup language, which tries to make the datafiles as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by clicking “Edit” button in the right upper part of the browser window. If you want to try something, just use the playground page.

The simpler markup is easily accessible via toolbar buttons too, so you are encouraged to use these as much as you can. Just select the text using your mouse or keyboard and click the toolbar button or hit the corresponding access key (hotkey) combination on the keyboard to achieve the same (Alt + Key).

Toolbar Buttons

Most buttons have access keys assigned to them – just press Alt button and a corresponding access key (see the table below).

:!: If these do not work with ALT, please refer to the access keys page or to your browser manual to see how to use access keys.

Button Key Function
b Bold formatting
i Italic formatting
u Underlined formatting
c Code formatting
d Strike-through formatting
8 Same level headline
9 Lower headline
0 Higher headline
Select headline
1 Level 1 headline (via 'Select headline' button)
2 Level 2 headline (via 'Select headline' button)
3 Level 3 headline (via 'Select headline' button)
4 Level 4 headline (via 'Select headline' button)
5 Level 5 headline (via 'Select headline' button)
l Internal link formatting (launches the Link Wizard)
External link formatting
- Ordered list item
. Unordered list item
Horizontal rule
Media Selection, includes file/attachment uploader
Smiley picker
Character picker
y Signature (only when logged in)

Basic Text Formatting

DokuWiki supports bold, italic, underlined and monospaced texts. Of course you can combine all these.

DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
Of course you can **__//''combine''//__** all these.

You can use subscript and superscript, too. For example, Lyc.30 would be a good use.

You can use <sub>subscript</sub> and <sup>superscript</sup>, too. For example, Lyc.<sup>30</sup> would be a good use.

You can mark something as deleted as well.

You can mark something as <del>deleted</del> as well.

Paragraphs are created from blank lines. If you want to force a newline without a paragraph, you can use two backslashes followed by a whitespace or the end of line.

This is some text with some linebreaks
Note that the two backslashes are only recognized at the end of a line
or followed by
a whitespace \\this happens without it.

This is some text with some linebreaks\\ Note that the
two backslashes are only recognized at the end of a line\\
or followed by\\ a whitespace \\this happens without it.

You should use forced newlines only if really needed.

Instead of a hyphen (-), please use a dash – either en dash (–) or em dash (—) – where appropriate (spaced or unspaced).

Instead of a **hyphen** (-), please use a **dash** -- either [[wp>Dash#En_dash_versus_em_dash|en dash]] (--) or em dash (---) -- where appropriate (spaced or unspaced).

DokuWiki supports multiple ways of creating links.

Internal

Internal links are created by using square brackets. You can either just give a page name – such as lippe-ad-importance-of-a-single-symptom-158-10559 – or use an additional link text – such as Lippe: Importance of a Single Symptom.

You can either just give a page name -- such as [[en:ahr:lippe-ad-importance-of-a-single-symptom-158-10559]] -- 
or use an additional link text -- such as [[en:ahr:lippe-ad-importance-of-a-single-symptom-158-10559|Lippe: Importance of a Single Symptom]].

Wiki pagenames are converted to lowercase automatically, special characters are not allowed.

You can use namespaces by using a colon in the pagename.

You can use [[some:namespaces]] by using a colon in the pagename.

In order to faciliate translations, the first namespace part is reserved for language variation (en for English, de for German, sk for Slovak)
For example http://www.legatum.sk/en:ahr:lippe-ad-clinical-observations-08-158-10555 and http://www.legatum.sk/sk:ahr:lippe-ad-clinical-observations-08-158-10555 are English and Slovak versions of the same article.

For details about namespaces see namespaces.

Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to this Section.

This links to [[syntax#internal|this Section]].

Linking to a specific sentence

Most articles in resources are sentence disambiguated (by an algorithm). In practice, this means each sentence has a unique anchor you can directly link to. This is a useful feature for linking directly to specific proving symptoms or any sentence or part of an article you would like to direct our attention to.

The syntax is the same as in section linking, you just need to find the anchor number in the source of the article (click the Edit button) – in order to know where to link to.

For example, if you wish to link to a sentence where Dr. Lippe explains to us how to properly relate a successful cure, you will do this as follows

[[en:ahr:lippe-ad-the-homoeopathician-158-10568#s24|Dr. Lippe explains to us how to properly relate a successful cure]]

Notes:

  • Links to existing pages are shown in a different style from nonexisting ones.
  • When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much – use anchor linking, if possible.

External

External links are recognized automagically: http://www.google.com or simply www.google.com - You can set the link text as well: This Link points to google. Email addresses like this one: contact@email.com are recognized, too.

DokuWiki supports multiple ways of creating links. External links are recognized
automagically: http://www.google.com or simply www.google.com - You can set
link text as well: [[http://www.google.com|This Link points to google]]. Email
addresses like this one: <contact@email.com> are recognized, too.

DokuWiki supports Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: Wiki.

DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis.
For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].

You can also use an image to link to another internal or external page by combining the syntax for links and images (see below) like this:

[[http://www.homeopathy.net|{{wiki:dokuwiki-128.png}}]]

Please note: The image formatting is the only formatting syntax accepted in link names.

The whole image and link syntax is supported (including image resizing, internal and external images and URLs and interwiki links).

Footnotes

You can add footnotes 1) by using double parentheses.

You can add footnotes ((This is a footnote)) by using double parentheses.

Sectioning

You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically – this can be disabled by including the string ~~NOTOC~~ in the document.

Headline Level 3

Headline Level 4

Headline Level 5
==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

By using four or more dashes, you can make a horizontal line:


Images and Other Files

You can include external and internal images with curly brackets. Optionally you can specify the size of them.

Real size:

Resize to given width:

Resize to given width and height2):

Resized external image:

Real size:                        {{wiki:dokuwiki-128.png}}
Resize to given width:            {{wiki:dokuwiki-128.png?50}}
Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}
Resized external image:           {{http://de3.php.net/images/php.gif?200x50}}

By using left or right whitespaces you can choose the alignment.

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Of course, you can add a title (displayed as a tooltip by most browsers), too.

This is the caption

{{ wiki:dokuwiki-128.png |This is the caption}}

If you specify a filename (external or internal) that is not an image (gif, jpeg, png), then it will be displayed as a link instead.

For linking an image to another page see Image Links above.

Lists

Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a * for unordered lists or a - for ordered ones.

  • This is a list
  • The second item
    • You may have different levels
  • Another item
  1. The same list but ordered
  2. Another item
    1. Just use indentation for deeper levels
  3. That's it
  * This is a list
  * The second item
    * You may have different levels
  * Another item

  - The same list but ordered
  - Another item
    - Just use indentation for deeper levels
  - That's it

Also take a look at the FAQ on list items.

Text Conversions

DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.

The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, but can be configured to use other HTML as well.

Text to Image Conversions

DokuWiki converts commonly used emoticons to their graphical equivalents. Those Smileys and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:

  • 8-) 8-)
  • 8-O 8-O
  • :-( :-(
  • :-) :-)
  • =) =)
  • :-/ :-/
  • :-\ :-\
  • :-? :-?
  • :-D :-D
  • :-P :-P
  • :-O :-O
  • :-X :-X
  • :-| :-|
  • ;-) ;-)
  • ^_^ ^_^
  • :?: :?:
  • :!: :!:
  • LOL LOL
  • FIXME FIXME
  • DELETEME DELETEME

Text to HTML Conversions

Typography: DokuWiki can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought 'It's a man's world'…”

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

The same can be done to produce any kind of HTML, it just needs to be added to the pattern file.

There are three exceptions which do not come from that pattern file: multiplication entity (640×480), 'single' and “double quotes”. They can be turned off through a config option.

Quoting

Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:

I think we should do it.

> No, we shouldn't.

>> Well, I say we should.

> Really?

>> Yes!

>>> Then let's do it!

I think we should do it.

No, we shouldn't.
Well, I say we should.
Really?
Yes!
Then let's do it!

Tables

DokuWiki supports a simple syntax to create tables.

Heading 1 Heading 2 Heading 3
Row 1 Col 1 Row 1 Col 2 Row 1 Col 3
Row 2 Col 1 some colspan (note the double pipe)
Row 3 Col 1 Row 3 Col 2 Row 3 Col 3

Table rows have to start and end with a | for normal rows or a ^ for headers.

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | some colspan (note the double pipe) ||
| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |

To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!

Vertical tableheaders are possible, too.

Heading 1 Heading 2
Heading 3 Row 1 Col 2 Row 1 Col 3
Heading 4 no colspan this time
Heading 5 Row 2 Col 2 Row 2 Col 3

As you can see, it's the cell separator before a cell which decides about the formatting:

|              ^ Heading 1            ^ Heading 2          ^
^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
^ Heading 4    | no colspan this time |                    |
^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |

You can have rowspans (vertically connected cells) by adding ::: into the cells below the one to which they should connect.

Heading 1 Heading 2 Heading 3
Row 1 Col 1 this cell spans vertically Row 1 Col 3
Row 2 Col 1 Row 2 Col 3
Row 3 Col 1 Row 2 Col 3

Apart from the rowspan syntax those cells should not contain anything else.

^ Heading 1      ^ Heading 2                  ^ Heading 3          ^
| Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        |
| Row 2 Col 1    | :::                        | Row 2 Col 3        |
| Row 3 Col 1    | :::                        | Row 2 Col 3        |

You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.

Table with alignment
right center left
left right center
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

This is how it looks in the source:

^           Table with alignment           ^^^
|         right|    center    |left          |
|left          |         right|    center    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Note: Vertical alignment is not supported.

No Formatting

If you need to display text exactly like it is typed (without any formatting), enclose the area either with <nowiki> tags or even simpler, with double percent signs %%.

This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. The same is true for //__this__ text// with a smiley ;-).

<nowiki>
This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
</nowiki>
The same is true for %%//__this__ text// with a smiley ;-)%%.

Code Blocks

You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags <code> or <file>.

This is text is indented by two spaces.
This is preformatted code all spaces are preserved: like              <-this
This is pretty much the same, but you could use it to show that you quoted a file.

Those blocks were created by this source:

  This is text is indented by two spaces.
<code>
This is preformatted code all spaces are preserved: like              <-this
</code>
<file>
This is pretty much the same, but you could use it to show that you quoted a file.
</file>

Control Macros

Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:

Macro Description
~~NOTOC~~ If this macro is found on the page, no table of contents will be created
~~DISCUSSION:off~~ If this macro is found on the page, no discussion at the end of the page will be created
~~NOCACHE~~ DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the <php> syntax above is used), adding this macro will force DokuWiki to rerender a page on every call
1) This is a footnote
2) when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing
You could leave a comment if you were logged in.
en/syntax.txt · Last modified: 2012/11/21 09:38 by legatum