Содержание

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

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

Внутренние

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

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

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

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

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

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

Примечания:

InterWiki

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

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

Сетевые ресурсы Windows

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

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

Примечания:

Картинки-ссылки

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

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

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

Сноски

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

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

Разбивка на разделы

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

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

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

Заголовок 5-го уровня
==== Заголовок 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), оно будет отображаться в виде ссылки.

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

Списки

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

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

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

Смайлики

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

Типографские символы

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

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ®
«Он подумал: 'Это мужское общество'…» 

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"Он подумал: 'Это мужское общество'..."

Примечание: Это конвертирование можно отключить в файле конфигурации (см. config option и pattern file).

Цитирование

FIXME 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 Столбец 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 Столбец 2   | Строка 1 Столбец 3  |
^ Заголовок 4  | Объединения нет      |                     |
^ Заголовок 5  | Строка 2 Столбец 2   | Строка 2 Столбец 3  |

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

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

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

Так выглядит исходный текст: 

^           Таблица с выравниванием        ^^^
|        вправо|   по центру  |влево         |
|влево         |        вправо|   по центру  |
| 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: 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

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 <font color="red" size="+1">HTML</font>
</html>

This is some HTML 

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

Заметки (Note)

Оформляет текст как заметку (:!: Выглядит по-разному в Explorer'е и Firefox'е)

В таком виде можно оформлять всевозможные комментарии в справочных руководствах
заметка-подсказка
важная заметка
заметка-предупреждение

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) Это сноска