«Докувики» поддерживает простой язык разметки, который по возможности сохраняет файлы данных как можно более читабельными. Здесь перечислены все возможные синтаксические конструкции, которые можно использовать при редактировании статей. Просто посмотрите на исходный код этой статьи, нажав кнопку «Править страницу» в правой верхней части страницы в меню управления пользователя. Если хотите поупражняться, просто используйте «песочницу». Простую разметку также можно легко сделать с помощью панели инструментов.

«Докувики» поддерживает выделение текста жирным шрифтом, курсивом, подчёркнутый текст и вывод текста моноширинным шрифтом. Все эти конструкции можно объединить.

«Докувики» поддерживает выделение текста **жирным шрифтом**, //курсивом//, 
__подчёркнутый текст__ и вывод текста ''моноширинным шрифтом''. 
Все эти конструкции можно **__//''объединить''//__**. 

Также можно использовать _{подстрочный} и ^{надстрочный} индексы.

Также можно использовать <sub>подстрочный</sub> и <sup>надстрочный</sup> индексы.

Ещё можно зачеркнуть текст.

Ещё можно <del>зачеркнуть текст</del>.

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

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

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

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

Ссылки в «Докувики» бывают разные и создавать их можно тоже по-разному.

Внешние ссылки распознаются автоматически: http://www.google.com или просто www.google.com — также можно указывать текст ссылки: Это ссылка на Google. Адреса электронной почты тоже распознаются: andi@splitbrain.org.

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

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

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

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

Можно использовать в ссылке [[doku>ru:namespaces|пространства имён]] через двоеточие.

Ставить ссылки на определённый раздел тоже можно. Просто добавьте через решётку (#) имя раздела, так же, как это делается в HTML. Ссылка на этот раздел.

Ссылка на [[#внутренние|этот раздел]].

Примечания:

• Ссылки на существующие статьи отображаются иначе, чем ссылки на несуществующие.
• «Докувики» по умолчанию не использует CamelCase (ВерблюжийРегистр) для автоматического создания ссылок, но эту возможность можно включить в конфигурации. Проверка: если DokuWiki — ссылка, значит эта возможность включена.
• Если меняется название раздела, ссылки на него не меняются автоматически. Так что не очень полагайтесь на ссылки на разделы.
• Ссылки на разделы делаются именно на разделы.

«Докувики» поддерживает интервики-ссылки. Это короткие ссылки на другие вики. Например, вот ссылка на статью Википедии о вики: Wiki.

«Докувики» поддерживает [[doku>ru:interwiki|интервики]]-ссылки. Это короткие ссылки
на другие вики. Например, вот ссылка на статью Википедии о вики: [[wp>Wiki]].

Ссылки на сетевые ресурсы вида \\server\share тоже распознаются. Однако учтите, что такие ссылки имеют смысл только в гомогенных группах пользователей, например в корпоративном интранете.

Ссылки на сетевые ресурсы вида \\server\share тоже распознаются.

Примечания:

• Из соображений безопасности непосредственный просмотр сетевых ресурсов работает по умолчанию только в Internet Explorer (и только в «локальной зоне»).
• В браузерах Mozilla эту возможность можно включить с помощью опции security.checkloaduri, но делать это не рекомендуется.
• Подробней читайте здесь: 151.

Совместив синтаксис ссылки и картинки, можно вставить в текст картинку, которая будет внутренней или внешней ссылкой:

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

Учтите: форматирование картинок — это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки.

С помощью двойных скобок можно добавить сноску¹⁾.

С помощью двойных скобок можно добавить сноску((Сноска —
помещаемые внизу страницы примечание, ссылка, перевод.)).

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

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

Четыре и более тире преобразуются в горизонтальную черту:

См. также: «Работа с изображениями и медиафайлами».

С помощью фигурных скобок можно вставлять в текст внешние и внутренние картинки. По желанию можно указать их размер.

Нормальный размер:

Отмасштабированная до заданной ширины:

Отмасштабированная до заданных размеров:

Отмасштабированная внешняя картинка:

Нормальный размер:                        {{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), оно будет отображаться в виде ссылки.

Узнать, как вставить картинку со ссылкой можно в разделе выше.

A basic gallery can be added by selecting a namespace like this:

{{gallery>:namespace}}

All image files in the selected namespace will be added to the image gallery. Don't forget the «:» in front of the namespace.

Instead of using a whole namespace of images, you can also specify a single image – this makes more sense when combined with the lightbox mode (see below).

{{gallery>:namespace:someimage.jpg}}

The created gallery can be aligned by using white space (defaults to centered):

{{gallery> namespace}} (right aligned)
{{gallery>namespace }} (left aligned)
{{gallery> namespace }} (centered)

Instead of a namespace, you can also give an HTTP(s) URL to any Media RSS or ATOM feed with enclosures (as produced by most photo sharing sites like Flickr). The images will then be pulled from that feed instead:

{{gallery>http://www.23hq.com/rss/schabloni}}

Note: since the question mark is used to separate the parameters (see next section) the URL can not contain any question mark. To use such a feed URL with the gallery plugin, just use one of the many short URL services like http://bit.ly.

E.g. instead of http://api.flickr.com/services/feeds/photos_public.gne?id=22019303@N00&lang=en-us&format=rss_200 use a shortened URL like http://bit.ly/HurZM.

Additionally, to have thumbnail creation correctly working you need to set fetchsize big enough to get the remote images downloaded.

«Докувики» поддерживает нумерованные и маркированные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и потом звёздочку (*) в случае маркированного списка, или дефис (-) — в случае нумерованного.

• Первый элемент маркированного списка
  • Второй элемент списка
    • Можно сделать вложенный список
  • Ещё один элемент

1. Тот же список, только нумерованный
2. Ещё элемент
   1. Чем больше пробелов в начале, тем глубже вложенность
3. Всё просто

  * Первый элемент маркированного списка
    * Второй элемент списка
      * Можно сделать вложенный список
    * Ещё один элемент

  - Тот же список, только нумерованный
  - Ещё элемент
    - Чем больше пробелов в начале, тем глубже вложенность
  - Всё просто

См. также FAQ по элементам списка.

«Докувики» переделывает наиболее употребляемые смайлики в их графические эквиваленты. Дополнительные смайлики можно положить в директорию smiley и добавить их в файл conf/smileys.local.conf. Вот смайлики, которые есть в «Докувики»:

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

«Докувики» может переделывать символы, набранные простым текстом, в их типографски корректные эквиваленты. Распознаются следующие символы.

→ ← ↔ ⇒ ⇐ ⇔ » « – — '640×480' © ™ ® …
«Владимир Владимирович™ — это наше всё © не я»

-> <- <-> => <= <=> >> << -- --- '640x480' (c) (tm) (r) ...
"Владимир Владимирович(tm) --- это наше всё (c) не я"

Примечание: это конвертирование можно отключить в файле конфигурации conf/entities.conf.

«Докувики» поддерживает упрощённый синтаксис создания таблиц.

Нормальные ряды должны начинаться и заканчиваться вертикальной чертой — |, а заголовки «крышечкой» — ^.

^ Заголовок 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  |

Можно сделать вертикально объединённые ячейки добавлением трёх двоеточий ::: в объединяемые нижележащие ячейки.

В этих ячейках не должно быть ничего, кроме синтаксиса объединения (:::).

^ Заголовок 1        ^ Заголовок 2                       ^ Заголовок 3            ^
| Ряд 1 Колонка 1    | эта ячейка объединена вертикально | Ряд 1 Колонка 3        |
| Ряд 2 Колонка 1    | :::                               | Ряд 2 Колонка 3        |
| Ряд 3 Колонка 1    | :::                               | Ряд 2 Колонка 3        |

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

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

Примечание: вертикальное выравнивание не поддерживается.

Неформатируемые блоки можно вставлять в документ, либо начиная каждую строчку блока с двух или более пробелов (как это делалось в некоторых предыдущих примерах), либо используя тэги <code> или <file>.

Это неформатированный текст, в котором сохранены все пробелы: вот             <- так.

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

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

Это просто текст, в котором есть адрес http://www.splitbrain.org/ и **форматирование** — но ничего не происходит.

Это просто текст, в котором есть адрес %%http://www.splitbrain.org/%%
и %%**форматирование**%% --- но ничего не происходит.

Чтобы увидеть, как используются эти блоки, смотрите код статьи.

«Докувики» может подсвечивать программный код, чтобы его было проще читать. Для этого используется библиотека GeSHi — соответственно подсвечиваются все языки, поддерживаемые 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.
    }
}

На данный момент распознаются следующие языки: 4cs;, abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, ecmascript, eiffel, email, erlang, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lisp, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, plsql, postgresql, povray, powerbuilder, powershell, progress, prolog, properties, providex, purebasic, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, z80.

Используя тэги <code> или <file>, как показано выше, вы можете сделать отображаемый код доступным для загрузки. Для этого определите имя файла после кода языка вот так:

<file php myexample.php>
<?php echo "hello world!"; ?>
</file>

myexample.php

<?php echo "hello world!"; ?>

Если вам не нужна подсветка, но нужен загружаемый файл, поставьте прочерк (-) на месте кода языка: <code - myfile.foo>.

Особенность: при написании имени файла на русском языке для формирования корректного имени файла обрамляйте название файла двойными кавычками например «Фоо Бар.php».

"Фоо Бар.php"

<?php echo "hello world!"; ?>

Некоторый синтаксис влияет на то, как «Докувики» обрабатывает статьи без создания каких-либо результатов для себя. Доступны следующие макросы:

Синтаксис «Докувики» может быть расширен за счёт плагинов. Как их устанавливать и использовать — описывается на страницах плагинов. Следующие плагины доступны в инсталляции «Докувики» на этом сайте:

• Add New Page 2015-11-02 — Benjamin Santalucia, Sam Wilson, Michael Braun, Gerrit Uitslag, Albert Chern
  Adds a "new page form" to any wiki page.
• Avatar 2017-08-25 — Michael Hamann, Michael Klier, Gina Haeussge
  Displays avatar images
• Backlinks Plugin 2019-01-26 — Mark C. Prins
  Displays backlinks to a given page.
• Blockquote Plugin 2017-08-25 — Anika Henke (previous author: Gina Haeussge)
  Write quotations in a semantically correct way
• Cloud Plugin 2020-09-27 — Michael Hamann, Michael Klier, Gina Haeussge
  Displays the most used words in a word cloud.
• discussion plugin 2020-09-24 — Michael Hamann, Gerrit Uitslag, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner, Matthias Schulte
  Provides discussion funtionality for wiki pages
• Gallery Plugin 2019-01-05 — Andreas Gohr
  Creates a gallery of images from a namespace or RSS/ATOM feed
• Plugin imagebox 2019-10-13 — Lukas Rademacher, CvH, Dr-Yukon, FFTiger & myst6re
  Syntax for display an image with a caption, like Wikipedia.org
• Indexmenu Plugin 2020-07-31 — Samuele Tognini
  Show a customizable and sortable index for a namespace
• Info Plugin 2020-06-04 — Andreas Gohr
  Displays information about various DokuWiki internals
• nspages plugin 2020-09-16 — Guillaume Turri
  Presents a toc of the selected namespace using <nspages>
• orphanswanted plugin 2017-06-25 — Doug Edmunds, Cyrille37, Federico Ariel Castagnini, Andy Webber, Matthias Schulte
  Display Orphans, Wanteds and Valid link tables
• Pagelist Plugin 2017-08-24 — Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
  Lists pages in a nice formatted way
• PanoView Plugin 2016-02-03 — Andreas Gohr
  View large images in a pannable view
• Publish Plugin 2019-06-19 — Jarrod Lowe, Andreas Gohr, Dominik Eckelmann
  Integrate a publishing process into DokuWiki
• Tag Plugin 2017-08-24 — Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
  tag wiki pages
• Video Sharing Site Plugin 2020-03-18 — Andreas Gohr
  Easily embed videos from various Video Sharing sites. Example: {{youtube>XXXXXX}}
• Wrap Plugin 2018-04-22 — Anika Henke
  Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.

NSPages – плагин для создания удобного сортированного списка страниц в пространстве имён. Основное использование с помощью соответствующей кнопки редактора, подробности синтаксиса либо здесь (англ), либо ниже по тексту, опять же на английском.

This plugin nicely displays a table of content of the pages -and optionally the subnamespaces- of a given (sub)namespace.

Using this plugin is easy: just write

<nspages>

and see the result. (You may also use the button from the toolbar.)

The general syntax is

<nspages path_to_a_namespace -option1 -option2 ...>

where:

• path_to_a_namespace represents the path to the wanted namespace. It can be an absolute (ex: namespace1:subnamespace) or a relative path (ex: .:subnamespace). If no path is specified, the current namespace is selected.
• -option may be one of the following (it is possible to specify several options):

-subns

-nopages

-exclude:nameOfPage

-exclude:subNs:

-exclude

-h1

-textPages="some text"

-textNS="some text"

-title

-simpleList

-numberedList

-simpleLine

-simpleLineBreak

-nbCol=3

-sortId

-reverse

-naturalOrder

-pagesInNs

-r

-exclude:[page1 subNs: page2]

-pregPagesOn
-pregPagesOff
-pregNSOn
-pregNSOff

-anchorName=myName

-actualTitle

-actualTitle=n

-idAndTitle

-nbItemsMax=n

ex: <nspages path_to_a_namespace -exclude>  or <nspages -subns -nopages> will work.