Wiki-синтаксис

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

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

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

Можно набирать текст в _нижнем и ^{верхнем} индексе.

Можно набирать текст в <sub>нижнем</sub> и <sup>верхнем</sup> индексе.

Можно помечать текст как удаленный.

Можно помечать текст как <del>удаленный</del>.

Параграфы отбиваются пустыми строками. Если нужно вставить разрыв строки без создания нового параграфа, достаточно ввести две обратные косые черты и, следом, пробел или конец строки (то есть нажать Enter).

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

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

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

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

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

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

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

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

Можно использовать в ссылке указание на пространство имен, например playground, отделяя имя страницы (в данном случае playground) от названия пространства имен (в данном случае wiki) двоеточием.

Можно использовать в ссылке указание на пространство имен, например [[wiki:playground]], отделяя имя страницы
(в данном случае ''playground'') от названия пространства имен (в данном случае ''wiki'') двоеточием.

Подробную информацию о пространствах имен (namespaces) можно найти на официальном сайте wiki:namespaces.

Возможно указать в ссылке привязку к конкретному разделу страницы. Для этого нужно просто добавить к ссылке символ # и название раздела, как это принято в HTML. Например, вот эта ссылка указывает на текущий раздел этой страницы.

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

Примечания:

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

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

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

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

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

Примечания:

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

Любое изображение может выступать в качестве ссылки на внутреннюю или внешнюю страницу с помощью совмещения синтаксиса изображения и ссылки, как это сделано ниже:

[[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?20x50}}

Оставляя пробел после открывающей и/или перед закрывающей парой фигурных скобок, можно осуществлять выравнивание изображений:

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

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

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

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® «He thought 'It's a man's world'…»

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

Примечание: Такое преобразование может быть отключено в конфигурационном файле.

В некоторых случаях требуется оформить текст таким образом, чтобы показать, что это ответ на вопрос или комментарий. В таких случаях используется следующий метод:

Да будет так

> Нет, не так

>> Я сказал так, значит так

> Именно так?

>> Да!

>>> Ну раз так, пусть будет так!

Да будет так

> Нет, не так

Я сказал так, значит так

Именно так?

Да!

Ну раз так, пусть будет так!

В DokuWiki довольно просто создавать таблицы.

Обычные строки должны начинаться и заканчиваться символом | (им же отделяются столбцы). Для заголовков используется символ ^.

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

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

Возможно создавать заголовки в строках таблицы.

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

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

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

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

Обратите внимание на то, как это достигается:

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

Необрабатываемый текст можно добавить в документ либо отделив его по крайней мере двумя пробелами от начала строки (как в случае со всеми примерами на этой странице), либо с использованием тэгов code или file.

В этой строке сохранены все пробелы: все                 <- 17 пробелов

Применение тэга %%<file>%% указывает на то, что вы приводите содержание файла.  

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

В этой строке содержится URL: http://www.splitbrain.org и элементы **форматирования**, но ничего не происходит.

Вы можете просмотреть код этой страницы, чтобы лучше понять, как работают эти тэги.

DokuWiki может подсвечивать исходный код для разных языков программирования, тем самым облегчая его чтение и понимание. Для этого используется библиотека GeSHi – то есть все языки, поддерживаемые ею, подсвечиваются в DokuWiki. Для подсветки используется тэг <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, ada, apache, asm, asp, bash, caddcl, cadlisp, c, c_mac, cpp, csharp, css, delphi, diff, d, html4strict, java, javascript, lisp, lua, matlab, mpasm, nsis, objc, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, smarty, sql, vb, vbnet, vhdl, visualfoxpro, xml

Код HTML и PHP можно встроить в код страницы с помощью тэгов html и php:

<html>
Здесь <font color="red" size="+1">HTML-код</font>
</html>

Здесь HTML-код

<php>
echo 'Логотип, сгенерированный PHP:';

echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
</php>

echo 'Логотип, сгенерированный PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';

Примечание: Вставка HTML и PHP кода по умолчанию выключена и может быть включена в конфигурационном файле. В том случае, когда она запрещена, код не обрабатывается, а просто отображается на странице.

• Info Plugin 2013-02-16 — Andreas Gohr
  Displays information about various DokuWiki internals
• Math Plugin 2005-12-17 — Christopher Smith
  Add mathematical formulae to dokuwiki
  Syntax: <m size>math formulae</m>
  For formulae syntax visit http://www.xm1math.net/phpmathpublisher/doc/help.html
• More Plugin for q-news 2006-11-12 — Alexey Sergeev
  Include <!-- more --> in wiki pages
• NBSP Plugin 2005-09-26 — Matthias Watermann
  Include non-breaking spaces in wiki pages