Formatiga sintakso

DokuWiki suptenas simplan formatlingvon, kiu igas datapaĝojn tiel legeblajn kiel eblas. Tiu ĉi paĝo enhavas tutan eblan sintakson, kiun vi povas uzi dum redaktado de paĝoj. Vi povas vidi fontotekston de tiu paĝo klakante sur redakti paĝon supre aŭ sube de la paĝo. Se vi deziras provi ion, uzu testejo. Ankaŭ simple estas uzi rapidbutonojn.

DokuWiki subtenas grasan, klinigitan, substrekan kaj fikslarĝan tekstojn. Certe vi povas kombini ilin ĉiujn.

DokuWiki subtenas **grasan**, //klinigitan//, __substrekan__ kaj ''fikslargxan'' tekstojn.
Certe vi povas **__//''kombini''//__** ilin cxiujn.

Vi povas uzi subskribon kaj ankaŭ superskribon.

Vi povas uzi <sub>subskribon</sub> kaj ankaux <sup>superskribon</sup>.

Vi povas noti ion kiel forigita.

Vi povas noti ion kiel <del>forigita</del>.

Alineoj estas kreataj je malplena linio(j). Se vi volas komenci novan linion sen komenco de alineo, vi povas uzi du deklivojn “\\” kun spacsigno aŭ linifino poste.

Jen estas teksto kun kelkaj linifinoj
Notu, ke du
deklivoj efikas nure fine de linio

aŭ kun
spacsigno poste \\male ili ne funkcias.

Jen estas teksto kun kelkaj linifinoj\\ Notu, ke du
deklivoj efikas nure fine de linio\\
aux kun\\ spacsigno poste \\male ili ne funkcias.

Estas bone uzi du deklivojn nur se tio vere necesas.

DokuWiki subtenas multajn variantojn por fari ligojn.

Eksteraj

Eksteraj ligoj estas agnoskataj aŭtomate: http://www.google.com aŭ pli simple www.google.com - Vi povas ankaŭ fari ligonomojn: Ligo al Guglo. Retadresoj kiel tiu: andi@splitbrain.org ankaŭ estas agnoskataj.

Eksteraj ligoj estas agnoskataj auxtomate: http://www.google.com aux pli simple
www.google.com - Vi povas ankaux fari ligonomojn: [[http://www.google.com|Ligo
al Guglo]]. Retadresoj kiel tiu: <andi@splitbrain.org> ankaux estas agnoskataj.

Internaj

Internaj ligoj estas kreataj uzante rektaj krampoj. Vi povas kaj skribi wiki:pagxonomo kaj uzi aldonan tekston. Paĝonomoj en la viki iĝas minusklaj aŭtomate, specialaj signoj estas ne permesitaj.

Internaj ligoj estas kreataj uzante rektaj krampoj. Vi povas kaj skribi
[[doku>wiki:pagxonomo]] kaj uzi aldonan [[doku>wiki:pagxonomo|tekston]].
Pagxonomoj en la viki igxas minusklaj auxtomate, specialaj signoj estas ne
permesitaj. 

Vi povas uzi nomospacojn uzante dupunkton en paĝonomo.

Vi povas uzi [[wiki:nomospacoj|nomospacojn]] uzante dupunkton en pagxonomo.

Detale pri nomospacoj legu en wiki:nomospacoj.

Ligi al definita sekcio estas ankaŭ ebla. Simple aldonu nomon de sekcio post dieso-signo kiel en HTML. Tio ligas al tiu cxi sekcio.

Tio ligas al [[sintakso#internaj|tiu cxi sekcio]].

Notoj:

  • Ligoj al ekzistaj pagxoj montriĝas alie ol al neekzistantaj.
  • DokuWiki ne uzas CamelCase por aŭtomate krei ligojn, sed tiun ĉi opcion eblas ŝalti en wiki:config-dosiero. Konsileto: Se DokuWiki estas ligo, la opcio estas ŝaltita.
  • Kiam nomo de sekcio ŝanĝiĝas, ĝia markilo ankaŭ ŝanĝiĝas. Do, ne tro uzu ligojn al sekcioj.

Intervikiaj

DokuWiki subtenas intervikiajn ligojn. Ili estas rapidaj ligoj al aliaj Vikioj. Ekzemple, tio estas ligo al paĝo pri Vikioj en Vikipedio: Viki.

DokuWiki subtenas [[doku>wiki:interwiki|intervikiajn]] ligojn. Ili estas rapidaj ligoj al aliaj Vikioj.
Ekzemple, tio estas ligo al pagxo pri Vikioj en Vikipedio: [[wpeo>Vikio]].

Windows Shares

Windows shares like this are recognized, too. Please note that these only make sense in a homogenous user group like a corporate Intranet.

Windows Shares like [[\\server\share|this]] are recognized, too.

Notes:

  • For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the “local zone”).
  • For Mozilla and Firefox it can be enabled through the config option security.checkloaduri but this is not recommended.
  • See 151 for more info.

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.php.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).

You can add footnotes 1) by using double parentheses.

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

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:


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

Real size:

Resize to given width:

Resize to given width and height:

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.

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

- The same list but ordered

  1. Another item
    1. Just use indention for deeper levels
  2. 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 indention for deeper levels
  - That's it

DokuWiki converts commonly used emoticons to their graphical equivalents. More smileys can be placed in the smiley directory and configured in the conf/smileys.conf file. 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

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

→ ← ↔

> <= <=> >> << -- --- 640x480 (c) (tm) (r)

“He thought 'It's a man's world'…”

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

Please note: These conversions can be turned off through a config option and a pattern file.

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 lets do it!

I think we should do it

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

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 2 Col 2 Row 2 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 2 Col 2     | Row 2 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 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        |

Note: Vertical spans (rowspan) are not possible.

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 |

You can include non-parsed 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 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.  

To let the parser ignore an area completely (ie. do no formatting on it), 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.

See the source of this page to see how to use these blocks.

DokuWiki can highlight sourcecode, which makes it easier to read. It uses the GeSHi Generic Syntax Highlighter -- so any language supported by GeSHi is supported. The syntax is the same like in the code block in the previous section, but this time the name of the used language is inserted inside the tag. Eg. <code java>.

/** 
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

The following language strings are currently recognized: actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, bnf, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, d, eiffel, fortran, freebasic, gml, groovy, html, idl, ini, inno, io, java5, java, javascript, latex, lisp, lua, matlab, mirc, mpasm, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, php-brief, php, plsql, python, qbasic, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro, winbatch, xml, z80

You can embed raw HTML or PHP code into your documents by using the html or php tags like this:

<html>
This is some <font color="red" size="+1">HTML</font>
</html>

This is some <font color="red" size="+1">HTML</font>

<php>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
</php>

echo 'A logo generated by PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';

Please Note: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.

DokuWiki's syntax can be extended by Plugins. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:


1)
This is a footnote
  • wiki/sintakso.txt
  • Lastaj ŝanĝoj: 04.11.2015 13:57
  • (ekstera redakto)