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

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

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

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

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

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

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

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

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

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

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

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

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

Внешние ссылки распознаются автоматически: 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>.

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

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

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

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

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

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

Примечания:

• Ссылки на существующие страницы отображаются иначе, чем ссылки на несуществующие
• Внутренние ссылки без указанного текста могут отображаться по разному в зависимости от настроек - в качестве текста может использоваться название страницы или заголовок первого уровня¹⁾. Так что лучше каждый раз указывать текст ссылки.
• DokuWiki по умолчанию не использует CamelCase для автоматического создания ссылок, но эту возможность можно включить в файле wiki:config. Проверка: Если DokuWiki — ссылка, значит эта возможность включена.
• Если меняется название раздела, ссылки на него не меняются автоматически. Так что не очень полагайтесь на ссылки на разделы.

DokuWiki поддерживает InterWiki-ссылки. Это короткие ссылки на другие Wiki. Например, вот ссылка на страницу Википедии о Wiki: Wiki.

Например, вот ссылка на страницу Википедии о Wiki: [[wp>Wiki]].

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

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

Примечания:

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

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

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

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

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

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

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

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

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

----

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

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

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

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

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

Нормальный размер:                        {{dokuwiki-128.png}}
Отмасштабированная до заданной ширины:    {{dokuwiki-128.png?50}}
Отмасштабированная до заданных размеров:  {{dokuwiki-128.png?200x50}}
Отмасштабированная внешняя картинка:      {{http://de3.php.net/images/php.gif?200x50}}

Поставив слева или справа пробел можно задать выравнивание картинки:

{{dokuwiki-128.png }}
{{ dokuwiki-128.png}}
{{ dokuwiki-128.png }}

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

{{ dokuwiki-128.png |Название картинки}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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 поддерживает упрощённый синтаксис создания таблиц.

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

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

Примечание: Вертикальное объединение (rowspan) не поддерживается.

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

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

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

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

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

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

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

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

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

Текст можно выделять цветом. <hi>Цвет по умолчанию</hi> может быть заменён на какой-либо другой, например <hi red>красный</hi> или <hi lightblue>голубой</hi>.

Текст можно выделять цветом.
<hi>Цвет по умолчанию</hi> может быть заменён на какой-либо другой, 
например <hi red>красный</hi> или <hi lightblue>голубой</hi>.

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

• 'Women Who Code' Shuts Down Unexpectedly — BeauHD (2024/04/20 01:02)
• A Chess Formula Is Taking Over the World — BeauHD (2024/04/20 00:25)
• EPA Will Make Polluters Pay To Clean Up Two 'Forever Chemicals' — msmash (2024/04/19 23:45)
• Linus Torvalds on 'Hilarious' AI Hype — msmash (2024/04/19 23:05)
• Microsoft's VASA-1 Can Deepfake a Person With One Photo and One Audio Track — msmash (2024/04/19 22:30)

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 inline HTML

And this is some block HTML

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

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

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:

• Box Plugin 2008-11-11 — Christopher Smith
  Boxes with titles, colour and rounded corners.
  Syntax: <box width class colours|title> ... </box|caption>
  width, class, colours title & caption are optional.
  The title can include some wiki markup, the box
  contents can include almost any wiki markup.
• ckgedit 2013-3-20 — Myron Turner
  WYSIWYG plugin for Dokuwiki
• Cloud Plugin 2009-05-11 — Gina Häußge, Michael Klier, Esther Brunner
  displays the most used words in a word cloud
• Color Plugin 2008-02-06 — Christopher Smith
  Changes text colour and background
• Discussion Plugin (threads component) 2009-05-11 — Gina Häußge, Michael Klier, Esther Brunner
  Displays a list of recently active discussions
• GOTO 2006-07-19 — Allen Ormond
  Easily redirect to other pages in your wiki.
• Info Plugin 2013-02-16 — Andreas Gohr
  Displays information about various DokuWiki internals
• Note Plugin 2009-06-15 — Olivier Cortès / Eric Hameleers / Christopher Smith / Aurélien Bompard
  Add Note/Important/Tip/Warning Capability (DIV+CSS box)