Синтаксис ДокуВики

DokuWiki предоставляет простой язык разметки, в попытке сделать файлы базы данных как можно более понятными. На данной странице представлены синтаксические конструкции ДокуВики, используемые для создания страниц. Поглядеть на исходный код страницы можно просто нажав кнопку Изменить страницу на верхней или нижней панели. Если Вы хотите протестировать возможности ДокуВики - используйте тестовую страницу playground. Простейшая разметка текста доступна также через меню редактирования ДокуВики quickbuttons.

Простейшее форматирование

DokuWiki поддерживает жирный, курсивный, подчёркнутый и моноширинный формат текста. Конечно, Вы можете их скомбинировать.

DokuWiki поддерживает **жирный**, //курсивный//, __подчёркнутый__ и ''моноширинный'' формат текста. 
Конечно, Вы можете их **__//''скомбинировать''//__**.

Можно использовать нижние и верхние индексы.

Можно использовать <sub>нижние</sub> и <sup>верхние</sup> индексы.

Можно пометить что-либо удалённым (зачёркнутым).

Можно пометить что-либо <del>удалённым</del> (зачёркнутым).

Параграфы разделяются пустыми строками. Если Вы хотите перейти на новую строку без создания параграфа, следует разместить два бэкслэша и пробел за ними, либо символ конца строки.

Это некий текст с разрывами строк
Помните, что два бэкслэша распознаются только в конце строки
или если за ними
стоит пробел, \\а вот что происходит в противном случае.

Это некий текст с разрывами строк\\ Помните, что
два бэкслэша распознаются только в конце строки \\
или если за ними\\ стоит пробел, \\а вот что происходит в противном случае.

Следует использовать такой перенос строки только в случае необходимости.

Ссылки

DokuWiki позволяет создавать ссылки различных типов.

Внешние ссылки

Внешние ссылки распознаются автоматически: http://www.google.com или просто www.google.com - Также можно написать текстовое описание ссылки: This Link points to google. Адреса Email: andi@splitbrain.org также выделяются автоматически.

Внешние ссылки распознаются автоматически: http://www.google.com или просто www.google.com - Также можно написать текстовое описание ссылки:
[[http://www.google.com|This Link points to google]]. Адреса Email: <andi@splitbrain.org> также выделяются автоматически.

Внутренние ссылки

Внутренние ссылки создаются с помощью двойных квадратных скобок. Можно просто задать имя страницы Имя страницы или использовать дополнительное описание Текст описания.

Внутренние ссылки создаются с помощью двойных квадратных скобок. Можно просто задать имя страницы [[Имя страницы]] 
или использовать дополнительное описание [[Имя страницы|Текст описания]].

Имена страниц Wiki автоматически конвертируются в строчные буквы, специальные символы не учитываются.

Также можно использовать пространства имён с помощью двоеточия в имени страницы.

Также можно использовать [[некоторые:пространства имён]] с помощью двоеточия в имени страницы.

Дополнительную информацию о пространствах имён можно найти здесь: Пространства имён.

Также возможно связывание ссылки с определённой секцией материала. Для этого просто добавьте символ »#» и имя секции к ссылке. Данная ссылка на эту секцию.

Данная ссылка на [[syntax#Внутренние ссылки|эту секцию]].

Замечания:

  • Ссылки на существующие страницы отличаются по стилю от ссылок на несуществующие страницы.
  • DokuWiki не использует CamelCase для автоматического создания ссылок по умолчанию, но данная опция может быть включена в файле config.
  • Когда изменяется название секции, ссылка на заголовок может стать недействительной. Поэтому особо не увлекайтесь ссылками на секции страниц.

Interwiki

DokuWiki также позволяет создавать Interwiki ссылки. Это ссылки для быстрого перехода на другие вики. Например, это ссылка на статью о вики в Википедии: Wiki.

DokuWiki также позволяет создавать [[doku>Interwiki]] ссылки. Это ссылки для быстрого перехода на другие вики. 
Например, это ссылка на статью о вики в Википедии: [[wp>Wiki]].

Windows Shares

Windows shares like this are recognized, too. Please note that these only make sense in a homogeneous 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.

Ссылки-изображения

Для ссылки на другие страницы можно также использовать изображения. Для этого нужно использовать комбинированный синтаксис - достаточно в описание ссылки вставить изображение (синтаксис см. ниже). Вот пример такой ссылки:

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

Замечание: Синтаксис форматирования изображения - допустимый синтаксис форматирования в ссылке.

Весь синтаксис изображений и ссылок поддерживается (включая изменение размера изображения, внешние и локальные изображения и URL, а также ссылки interwiki).

Сноски

Можно добавить сноски 1) с помощью двойных круглых скобок.

Можно добавить сноски ((Это текст сноски)) с помощью двойных круглых скобок.

Разделение на секции

Для структурирования текста можно использовать пять различных типов заголовков. Если страница содержит более трёх заголовков, таблица содержания генерируется автоматически – можно запретить генерацию содержания, включив строку ~~NOTOC~~ в текст страницы.

Заголовок уровня 3

Заголовок уровня 4

Заголовок уровня 5
==== Заголовок уровня 3 ====
=== Заголовок уровня 4 ===
== Заголовок уровня 5 ==

Используя четыре или более чёрточек подряд, можно разделять текст горизонтальными линиями:

Текст до линии


Текст после линии

Текст до линии
----
Текст после линии

Изображения и другие файлы

Можно включать в документы внешние и локальные изображения images с помощью двойных фигурных скобок. Также можно указывать размер изображений и их расположение.

Исходный размер:

Изменяем размер - указываем ширину:

Указываем ширину и высоту2):

Изменение размера внешнего изображения:

Исходный размер:                        {{wiki:dokuwiki-128.png}}
Задаём ширину:                          {{wiki:dokuwiki-128.png?50}}
Задаём ширину и высоту:                 {{wiki:dokuwiki-128.png?200x50}}
Изменение размера внешнего изображения: {{http://de3.php.net/images/php.gif?200x50}}

Используя пробелы слева и/или справа от имени изображения, можно задать его положение в тексте.

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

Также можно задать название или описание изображения (в большинстве браузеров выводится при наведении указателя на картинку).

Это описание

{{ wiki:dokuwiki-128.png |Это описание}}

Если задать имя файла (внешнего или локального), не являющегося изображением (gif, jpeg, png), в тексте будет отображаться ссылка на этот файл.

Пример использования изображений в качестве ссылок на другие странице можно помотреть выше Ссылки-изображения.

Списки

Dokuwiki поддерживает создание нумерованных и простых списков. Чтобы создать список, поставьте перед текстом два пробела и используйте символ * для обычных списков или - для нумерованных.

  • Это список
  • Второй элемент
    • Можно использовать подуровни списка
  • Другой элемент
  1. Тот же список, но нумерованный
  2. Другой элемент
    1. Обозначение подуровней
  3. Готово
  * Это список
  * Второй элемент
    * Можно использовать подуровни списка
  * Другой элемент

  - Тот же список, но нумерованный
  - Другой элемент
    - Обозначение подуровней
  - Готово

Smileys

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

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'..."

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

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

I think we should do it

No we shouldn't
Well, I say we should
Really?
Yes!
Then lets 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 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 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        |

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 |

Non-parsed Blocks

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.

Syntax Highlighting

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: abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoit, bash, basic4gl, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, cil, cobol, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, dot, d, eiffel, fortran, freebasic, genero, glsl, gml, gnuplot, groovy, gettext, haskell, html, idl, ini, inno, io, java5, java, javascript, kixtart, klonec, klonecpp, latex, lisp, lotusformulas, lotusscript, lua, m68k, matlab, mirc, mpasm, mxml, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, per, php-brief, php, pic16, plsql, povray, powershell, progress, python, qbasic, rails, reg, robots, ruby, sas, scala, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, typoscript, vbnet, vb, verilog, vhdl, visualfoxpro, winbatch, xml, xorg_conf, xpp, z80

RSS/ATOM Feed Aggregation

DokuWiki can integrate data from external XML feeds. For parsing the XML feeds, SimplePie is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:

Parameter Description
any number will be used as maximum number items to show, defaults to 8
reverse display the last items in the feed first
author show item authors names
date show item dates
description show the item description. If HTML is disabled all tags will be stripped
n[dhm] refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours).

The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. DokuWiki will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells DokuWiki to re-render the page if it is more than refresh period since the page was last rendered.

Example:

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

Embedding HTML and PHP

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

<html>
This is some <span style="color:red;font-size:150%;">inline HTML</span>
</html>
<HTML>
<p style="border:2px dashed red;">And this is some block HTML</p>
</HTML>

This is some <span style="color:red;font-size:150%;">inline HTML</span>

<p style="border:2px dashed red;">And this is some block HTML</p>
<php>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
echo '(generated inline HTML)';
</php>
<PHP>
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';
</PHP>

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

echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';

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

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
~~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

Syntax Plugins

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) Это текст сноски
2) если отношение высоты к ширине в исходном изображении не соответствует указанной, изображение будет обрезано перед изменением размера
 
wiki/syntax.txt · Последние изменения: 2009/04/23 07:32 От mungojerrie
 
За исключением случаев, когда указано иное, содержимое этой вики предоставляется на условиях следующей лицензии:GNU Free Documentation License 1.2
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki