DokuWiki поддерживает простой язык разметки, которая вставляется в текст файла и делает этот текст удобночитаемым. Эта страница содержит синтаксис всех возможныех способов, которые можно использовать при редактировании страниц. Вы можете взглянуть на исходный код этой страницы нажатием кнопки Править страницу, расположенную в верхней или нижней части страницы. Если вы хотите потренироваться в синтаксисе, используйте страницу песочница. Простые примеры разметки доступны также на quickbuttons.
DokuWiki поддерживает жирный, наклонный, подчеркнутый и моноширинный текст. Вы можете комбинировать их в любых сочетаниях.
DokuWiki поддерживает **жирный**, //наклонный//, __подчеркнутый__ и ''моношириный'' текст. Вы можете **__//''комбинировать''//__** их в любых сочетаниях.
Вы можете использовать Нижнийй индекс и Верхний индекс.
Вы можете использовать <sub>Нижний индекс</sub> и <sup>Верхний индекс</sup>.
Если необходимо, можно зачеркнуть часть текста.
Если необходимо, можно <del>зачеркнуть</del> часть текста.
Абзац создается после встреченной в коде текста пустой строки. Если Вы хотите, чтобы текст отображался с новой строки без абзаца, можно использовать два обратных слэша(\\) с пробелом для обозначения конца строки.
Вот некоторый текст с переходом на новую строку.
Обратите
внимание, как выглядит текст, если обратные
слэши применяются без\\пробела, с \\пробелом
перед слешами и пробелом после
слешей.
Вот некоторый текст с переходом на новую строку.\\ Обратите внимание, как выглядит текст, если обратные слэши применяются без\\пробела, с \\пробелом перед слешами и пробелом после\\ слешей.
Желательно использовать принудительный перевод строки слэшами, а не пустой строкой. В этом случае не сбрасывается счетчик нумерованого списка.
DokuWiki поддерживает несколько способов создания ссылок.
Внешняя ссылка создается автоматически, если в тексте есть такой фрагмент: http://www.google.com или просто www.google.com
Вы можете создать ссылку с описательным текстом: Эта ссылка откроет поисковик Гугль.
Вот как выглядит ссылка на электронную почту andi@splitbrain.org в Вашем тексте.
Внешняя ссылка создается автоматически, если в тексте есть такой фрагмент: http://www.google.com или просто www.google.com \\ Вы можете создать ссылку с описательным текстом: [[http://www.google.com|Эта ссылка откроет поисковик Гугль]]. \\ Вот как выглядит ссылка на электронную почту <andi@splitbrain.org> в Вашем тексте.
Внутренние ссылки создаются с использованием квадратных скобок.
Вы можете указать либо название страницы коды_wiki, либо сопроводить ссылку любым текстом.
Внутренние ссылки создаются с использованием квадратных скобок. Вы можете указать либо название страницы [[коды_wiki]], либо сопроводить ссылку [[коды_wiki|любым текстом]].
Имена страниц Wiki преобразуются в нижний регистр автоматически, специальные символы не допускаются.
Если существующая страница syntax является подстраницей, она отобразится красным цветом, как несуществующая.
В этом случае следует использовать полный путь к подстранице syntax, разделяя имена страниц двоеточиями.
Если существующая страница [[syntax]] является подстраницей, она отобразится красным цветом, как несуществующая. В этом случае следует использовать полный путь к подстранице [[wiki:syntax]], разделяя имена страниц двоеточиями.
Как формируется пространство имен, смотрите пространство_имен.
Также возможна ссылка на конкретный раздел, если страница очень велика. Для этого укажите название страницы, поставьте диез(#) и укажите раздел, как это делается в HTML. Например, вот ссылка на этот раздел.
Это ссылка на [[коды_wiki#Внутренние_ссылки|этот раздел]].
Важно:
DokuWiki поддерживает ссылки вида Interwiki. Это быстрая ссылка на другие Wiki.
Например, эта ссылка ведет на страницу Википедии, посвященную движку wiki: Wiki.
DokuWiki поддерживает ссылки вида [[doku>Interwiki]]. Это быстрая ссылка на другие Wiki. Например, эта ссылка ведет на страницу Википедии, посвященную движку wiki: [[wp>Wiki]].
Windows shares like this are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate Intranet.
Windows Shares like [[\\server\share|this]] are recognized, too.
Notes:
Можно сделать изображение, картинку или иконку ссылкой на внешнюю или внутреннюю страницу. Это делается путем объединения синтаксисов ссылки и картинки(см. ниже) в одной конструкции:
[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
Обратите внимание: Форматирование применяется только к изображеню, указанному в ссылке, сама картинка не меняется.
Поддерживаются все картинки и ссылки (в том числе изменение размера картинки, внутренние и внешние картинки, URL-адреса и ссылки на interwiki).
Вы можете добавить сноску 1) с помощью двойных скобок
Вы можете добавить сноску ((Это сноска)) с помощью двойных скобок
Вы можете использовать до пяти различных уровней заголовков, чтобы упорядочить структуру Вашей страницы.
Заголовок уровня 1 обозначается пятью знаками «равно» (=====) поставленными впереди и сзади названия заголовка.
Заголовок уровня 5 обозначается двумя знаками «равно» (==) поставленными впереди и сзади названия заголовка.
Если у вас более трех уровней заголовков, оглавления генерируется автоматически.
Можно отключить функцию генерации оглавлений, вставив строку ~~NOTOC~~ в документ.
==== Заголовок уровня 3 ==== === Заголовок уровня 4 === == Заголовок уровня 5 ==
Используя четыре минуса и больше, можно сформировать горизонтальную линию:
Вы можете вставить в страницу внешние или внутренние изображения images, заключив их в двойные фигурные скобки. Если нужно, можно изменить размер рисунка.
Изменение размера с указанием заданной ширины и высоты 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 поддерживает упорядоченные и неупорядоченные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и символ * для неупорядоченного списка и символ - для нумерованного.
* Это первый элемент списка
* Это второй элемент
* Можно использовать несколько уровней, добавляя два пробела для каждого следующего
* Снова элемент первого уровня
- А вот первый элемент нумерованого списка
- Второй элемент
- Добавив два пробела, получаем следующий уровень
-Еще два пробела и еще один уровень
- А так снова первый уровень
- Комбинация упорядоченного и неупорядоченного списков
- Второй элемент
* Пошел неупорядоченый список
* Еще
-Снова упорядоченый список, нумерация продолжается.
Примечание. Если между элементами списка встречается пустая строка, нумерация списка начинается заново. Если Вам необходимо все-таки отделить блоки разделов друг от друга, используйте символ принудительного перевода строки – два обратных слэша и пробел.
DokuWiki конвертирует обычно использующиеся смайлики в их графические эквиваленты. Дополнительные смайлики можно поместить в каталог и подключить его в файле конфигурации conf/smileys.conf. Здесь представлен обзор смайликов, включенных в DokuWiki.
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'..."
Важно: Эти преобразования могут быть отключены через config option и pattern file.
Иногда Вам необходимо оформить некий текст как диалог или ответить на вопрос. В этом случае следует применять синтаксис:
Я уверена, что все блондинки -- дуры > Я тоже так думаю >> Да ты же и сама блондинка! > Правда? >> Точно! >>> Ой....Блин!
Я уверена, что все блондинки – дуры
Я тоже так думаю
Да ты же и сама блондинка!
Правда?
Точно!
Ой….Блин!
DokuWiki поддерживает простой синтаксис при создании таблиц.
| Heading 1 | Heading 2 | Heading 3 |
|---|---|---|
| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 |
| Row 2 Col 1 | some colspan (note the double pipe) | |
| Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 |
Строки таблицы должны начинаться и заканчиваться | для нормальных строк и ^ для заголовков.
^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | Row 2 Col 1 | some colspan (note the double pipe) || | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 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 |
Как видите, разделитель находится перед клеткой, которую нужно оформить как заголовок:
| ^ 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 |
Можно управлять выравниванием текста в таблицах, добавляя по два (или больше) пробелов. Два пробела перед текстом сдвинут его вправо. Два пробела после текста сдвинут его влево. Для центрирования добавте два пробела впереди и сзади.
| Table with alignment | ||
|---|---|---|
| right | center | left |
| left | right | center |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Вот как выглядит код этой таблицы:
^ Table with alignment ^^^ | right| center |left | |left | right| center | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
В документ можно включить неанализируемые блоки текста. Это можно сделать, либо поставив перед текстом не меньше двух пробелов, либо используя теги-контейнеры code или file.
В этом фрагменте показывается, что все пробелы сохраняются.
Это практически то же самое, но вы можете использовать этот тег, чтобы показать, что вы процитировали фрагмент файла.
Чтобы проигнорировать анализ и форматирование текста, заключите его в контейнер nowiki, либо, в простом случае между двойными знаками процента %%.
Этот фрагмент текста содердит электронный адрес: http://www.splitbrain.org , а этот **жирный текст**, но движок их не анализирует.
Посмотрите исходный код этой страницы, чтобы уяснить, как включить в текст страницы неанализируемый текст.
DokuWiki может подсвечивать исходный код, делаяя его легче для чтения и понимания. Он использует GeSHi Generic Syntax Highlighter – так, что любой язык, поддерживающий GeSHi красиво отображается. Синтаксис такой же, как и в предыдущем разделе, но в качестве тэга-контейнера используется имя языка.
Например, <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. } }
В настоящее время распознаются и подсвечиваются следующие языки: abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoit, bash, basic4gl, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, cil, cobol, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, dot, d, eiffel, fortran, freebasic, genero, glsl, gml, gnuplot, groovy, gettext, haskell, html, idl, ini, inno, io, java5, java, javascript, kixtart, klonec, klonecpp, latex, lisp, lotusformulas, lotusscript, lua, m68k, matlab, mirc, mpasm, mxml, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, per, php-brief, php, pic16, plsql, povray, powershell, progress, python, qbasic, rails, reg, robots, ruby, sas, scala, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, typoscript, vbnet, vb, verilog, vhdl, visualfoxpro, winbatch, xml, xorg_conf, xpp, z80
DokuWiki может интегрировать внешние XML каналы. Для отображения XML-каналов, используется SimplePie. Все форматы, понимаемые SimplePie также понимаются и DokuWiki. Вы можете повлиять на отображение каналов, используя несколько параметров, разделив их пробелами:
| Параметр | Описание |
|---|---|
| любая цифра | устанавливается для показа максимального числа пунктов, по умолчанию 8 |
| reverse | последние каналы отображаются первыми |
| author | показывает имя автора |
| date | отображает число |
| description | отображает описание, если HTML отключен, все теги будут вырезаны |
| n[dhm] | период обновления, где d=дни, h=часы, m=минуты. (например, 12h = 12 часов) |
По умолчанию период обновления 4 часа. Любое значение меньше 10 минут будет рассматриваться как 10 минут. DokuWiki оставляет в кэше версию страницы, oоднако это недопустимо, если страница имеет внешний динамический контент. Параметр указывает DokuWiki перезагрузить страницу, если период обновления больше, чем время, прошедшее с полседнего обновления.
Например:
Новостной канал предоставлен русской службой BBC:
{{rss>http://www.bbc.co.uk/russian/index.xml 10 author date 1h}}
Все новости в одной ленте:
{{rss>http://kp.ru/rss/allsections.xml 4 author date 1h}}}
Новостной канал предоставлен русской службой BBC:
Все новости в одной ленте:
Вы можете вставлять в страницу HTML или PHP код, используя теги html или php таким образом:
<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 <span style="color:red;font-size:150%;">inline HTML</span>
<p style="border:2px dashed red;">And this is some block HTML</p>
<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>';
Обратите внимание: HTML и PHP по умолчанию отключены в конфигурационном файле. В этом случае на странице отображается код вместо результата выполнения кода.
Макросы непосредственно на странице не отображаются, но влияют на отображение страницы в целом. Например:
| Макрос | Описание |
|---|---|
| ~~NOTOC~~ | Если этот макрос вставлен в код страницы, оглавление не создается |
| ~~NOCACHE~~ | DokuWiki по умолчанию сохраняет содержимое страницы в кэше. Иногда это нежелательно (напр. когда используется синтаксис <php>, см. выше), при добавлении этого макроса DokuWiki будет перезагружать страницу при каждом вызове |
Синтаксис DokuWiki может быть расширен с помощью плагинов. Как использовать установленные плагины, изложено на соответствующих страницах описания. В данном случае доступны слелующие плагины синтаксиса DokuWiki:
На русский язык перевела feba7