Синтаксис форматирования

DokuWiki поддерживает специальный простой язык форматирования, делающий файлы с данными максимально читабельными. Эта страница содержит все возможные синтаксические конструкции, которые вы можете использовать при создании своих страниц. Просто посмотрите в код страницы, нажав кнопку Править страницу наверху. Если вы что-то хотите просто попробовать, делайте это на странице playground. Простейшие средстав разметки доступны также через панель инструментов.

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

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

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

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

Что-то можно помечать как удалённое.

Что-то можно помечать как <del>удалённое</del>.

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

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

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

Но используйте эту возможность, пожалуйста, только при крайней необходимости.

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

Внешние ссылки распознаются автоматически: http://www.google.com и даже просто www.google.com - но вы можете дать им названия: Эта ссылка указывает на google. Адреса email в таком виде: andi [at] splitbrain [dot] org также распознаются.

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

Внутренние ссылки создаются при помощи квадратных скобок. Вы можно просто ввести wiki:pagename, или дополнительно указать текст ссылки. Названия страниц Wiki автоматически конвертируются в нижний регистр, и специальные символы не допускаются.

Внутренние ссылки создаются при помощи квадратных скобок. Вы можно просто ввести [[doku>wiki:pagename]],
или дополнительно указать [[doku>wiki:pagename|текст ссылки]]. Названия страниц Wiki автоматически
конвертируются в нижний регистр, и специальные символы не допускаются.

Вы можете использовать группы страниц, используя двоеточие в названии страницы.

Вы можете использовать [[doku>wiki:namespaces|группы страниц]], используя двоеточие в названии страницы.

Можно даже ссылаться на определённый раздел страницы. Просто добавьте знак диез # и название раздела после названия страницы, как в HTML. Вот эта ссылка ведёт этот раздел.

 Вот эта ссылка ведёт прямо на [[syntax#Внутренние|этот раздел]].

Примечания:

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

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

DokuWiki умеет делать [[doku>wiki:interwiki|Interwiki]]-ссылки. Это такие
простые ссылки для связи с другими Wiki. Например, чтобы поставить ссылку
на страницу в Википедии про то, что такое Wiki: [[wp>Wiki]].

Также распознаются ресурсы Windows вида this. Это, правда, может быть полезно только для гомогенной группы пользователей, в зоне интрасети.

Также распознаются ресурсы Windows вида [[\\server\share|this]].

Замечания:

• Из соображений безопасности, прямой просмотр ресурсов Windows по умолчанию работает только в Microsoft Internet Explorer (и то, только в «локальной зоне»).
• Эту возможность в Mozilla Firefox можно включить в настройке security.checkloaduri, но это не рекомендуется делать.
• Подробнее об этом можно почитать здесь.

Можно также сделать изображение, которое было бы ссылкой на другую внутреннюю или внешнюю страницу, объединяя синтаксис ссылок и изображений (см. ниже) вот таким образом:

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

Заметьте, что форматирование изображений - это единственный синтаксис фоматирования, который DokuWiki распознаёт внутри имён ссылок.

Поддерживаются все возможности синтаксиса для изображений и для ссылок, включая изменение размеров изображения, внешние и внутренние изображения, URL и ссылки Interwiki.

Вы можете создавать сноски 1), используя двойные скобки.

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

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

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

Используя четыре или более тире 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. И оно заработает
   • Можно даже перемешивать списки нумерованные и ненумерованные
   • Вот таким образом

  * Это список
  * Это второй пункт
    * Можно делать вложенные списки
  * Ещё пункт

  - Так же, только нумерованный
  - Другой пункт
    - Просто добавьте пробелов
  - И оно заработает
    * Можно даже перемешивать списки нумерованные и ненумерованные
    * Вот таким образом

DokuWiki преобразовывает часто употребляемые смайлики в их графические представления. Можно добавить смайликов в директорию smiley, и настроить их соответствие в файле conf/smileys.confe. Список смайлов, которые распознаются DokuWiki:

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

DokuWiki может преобразовывать простые текстовые символы в их типографские эквиваленты. Пример символов, которые распознаются:

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® «Он подумал: 'Это мир людей'…»

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"Он подумал: 'Это мир людей'..."

Заметьте, что это распознавание может быть выключено в настройках и в файле шаблонов.

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

Я думаю, мы должны это сделать
> Не, мы не должны
>> А я говорю, должны
> Чо, правда?
>> Ага!
>>> Ну так давай сделаем!

Я думаю, мы должны это сделать

Не, мы не должны

А я говорю, должны

Чо, правда?

Ага!

Ну так давай сделаем!

DokuWiki поддерживает простой синтаксис для создания таблиц.

Строки таблицы начинаются и оканчиваются | для нормальных строк или ^ для заголовочных.

^ Заголовок 1      ^ Заголовок 2       ^ Заголовок 3          ^
| Строка 1 столбец 1    | Строка 1 столбец 2     | Строка 1 столбец 3        |
| Строка 2 столбец 1    | Объединение ячеек (обратите внимание на две вертикальных черты) ||
| Строка 3 столбец 1    | Строка 2 столбец 2     | Строка 2 столбец 3        |

Чтобы объединить ячейки по горизонтали, просто сделайте вторую ячейку совершенно пустой, как в примере. Только следите, чтобы в каждой строке было одинаковое количество разделителей ячеек!

Вертикальные заголовки тоже возможны (это заголовки для каждой строки, а не для каждого столбца).

Как вы видите, за форматирование ячейки отвечает разделитель, который находится непосредственно перед ней:

|              ^ Заголовок 1            ^ Заголовок 2          ^
^ Заголовок 3    | Строка 1 столбец 2          | Строка 1 столбец 3        |
^ Заголовок 4    | а здесь ячейки не объединятся |                    |
^ Заголовок 5    | Строка 2 столбец 2          | Строка 2 столбец 3        |

Замечание: по вертикали ячейки объединить невозможно.

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

Вот, как это сделано:

^          Таблица с выравниванием         ^^^
|        вправо|   по центру  |влево         |
|влево         |        вправо|   по центру  |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Вы можете так включить части текста, чтобы они не обрабатывались парсером. Для этого, доавьте в начало каждой строки не меньше двух пробелов, или используйте спец-теги code либо file:

Это - предварительно
 форматированный
  текст,
   Все
    пробелы
     остались                    на                месте

<code>
Это - предварительно
 форматированный
  текст,
   Все
    пробелы
     остались                    на                месте
</code>

Это то же самое, но чтобы специально показать, что вы вставили сюда содержимое файла

<file>
Это то же самое, но чтобы специально показать, что вы вставили сюда содержимое файла
</file>

Чтобы парсер просто проигнорировал область, либо заключите её в теги nowiki, либо в двойные проценты %%.

Этот текст содержит адреса http://www.splitbrain.org и **форматирование**, но они остались без именений.

<nowiki>
Этот текст содержит адреса http://www.splitbrain.org и **форматирование**, но они остались без именений.
</nowiki>

DokuWiki умеет подсвечивать синтаксис в исходных текстах программ, что облегчает их чтение. Для этого используется GeSHi Generic Syntax Highlighter – так что будет подсвечен любой язык, который поддерживается GeSHi. Синтаксис такой же как для блока code в предыдущем разделе, но на этот раз туда ещё добавляется название языка для подсветки Например, блок ниже получен с использованием <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.
    }
}

На данный момент, распознаются такие названия языков: 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, rails, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro, winbatch, xml, xpp, z80.

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:

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

• Ten Drones Attack Saudi Arabia's Oil and Gas Facilities EditorDavid (15.09.2019 07:34)
• 2019's 'Ig Nobel' Prizes Honor Strange, Unusual, and Hilarious Research EditorDavid (15.09.2019 05:34)
• Was Advertising in Open Source Software a Useful Experiment? EditorDavid (15.09.2019 03:44)
• Tonight's Asteroid Will Pass So Close To Earth, Home Telescopes Can See It EditorDavid (15.09.2019 02:34)
• Java EE 'Goes All In' on Open Source with Jakarta EE 8 EditorDavid (15.09.2019 01:34)

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 может быть расширен плагинами. Как именно эти плагины использовать, написано в соответствующих местах на страницах описания плагинов. На данный момент, в DokuWiki установлены следующие плагины синтаксиса:

• Feed Plugin 2006-12-20 Mikhail Girshfeld
  Generates feeds for other plugins
• Box Plugin 2006-04-25 Christopher Smith
  Boxes with titles, colour and rounded corners.
  Syntax: <box width class|title> ... </box|caption>
  width, class, title & caption are optional.
  The title can include some wiki markup, the box
  contents can include almost any wiki markup.
• Feed Plugin 2006-12-20 Mikhail Girshfeld
  Generates feeds for other plugins
• Blog Plugin (blog component) 2007-08-22 Esther Brunner
  Displays a number of recent entries from a given namesspace
• Blog Plugin (headers component) 2007-08-22 Esther Brunner
  Displays a number of headers of recent entries from a given namesspace
• Blog Plugin (draft component) 2007-04-27 Esther Brunner
  Marks the current page as draft
• Blog Plugin (archive component) 2007-08-02 Esther Brunner
  Displays a list of wiki pages from a given month
• Info Plugin 2006-12-09 Andreas Gohr
  Displays information about various DokuWiki internals
• Citrus-CalcGame Plugin 2007-12-14 Никита Киприянов
  Рассчитывает результаты игры и отображает их на странице
• addnewpage 20/12/2006 iDo
  This add a "new page form" in your page. \ Syntax : {{NEWPAGE[>namespace]}} where [>namespace] is optional.
• Dir Plugin 2007-09-28 Jacobus Geluk
  Shows pages in one or namespaces in a table or list
• Form Plugin 2008-01-09 Ole Rienow
  Creates HTML Forms
• Pagelist Plugin 2007-01-12 Esther Brunner
  lists pages
• CSV Plugin 2005-11-08 Steven Danz
  Displays a CSV file, or inline CSV data, as a table
• Citrus Encounter 2007-12-18 Никита Киприянов
  Отображает кнопку для проверки статуса заявки
• Feed Plugin 2006-12-20 Esther Brunner
  Generates feeds for other plugins
• Discussion Plugin (threads component) 2007-01-16 Esther Brunner
  Displays a list of recently active discussions
• Discussion Plugin (comments component) 2007-08-21 Esther Brunner
  Enables discussion features
• Structured Data Plugin 2008-02-08 Andreas Gohr
  Add and query structured data in your wiki
• Structured Data Plugin 2008-02-08 Andreas Gohr
  Add and query structured data in your wiki
• Structured Data Plugin 2008-02-08 Andreas Gohr
  Add and query structured data in your wiki
• Structured Data Plugin 2008-02-08 Andreas Gohr
  Add and query structured data in your wiki
• Structured Data Plugin 2008-02-08 Andreas Gohr
  Add and query structured data in your wiki
• Include Plugin 2007-08-10 Esther Brunner
  Displays a wiki page (or a section thereof) within another