Это старая версия документа!


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

DokuWiki поддерживает простой язык разметки, который позволяет делать статьи настолько удобочитаемыми насколько это возможно. Эта статья содержит описание всего синтаксиса, который вы можете использовать при редактировании страниц. Чтобы начать редактирование, нажмите кнопку Править страницу сверху или снизу статьи. Если вы хотите попробовать какой-либо элемент синтаксиса, которым ещё ни разу не применяли, воспользуйтесь песочницей для своих экспериментов. Также для разметки страницы вы можете использовать quickbuttons.

Базовое форматирование текста

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

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

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

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

Что-то вы можете пометить как зачёркнутое.

Что-то вы можете пометить как <del>зачёркнутое</del>.

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

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

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

Вы должны использовать новые строки только там, где это действительно необходимо.

Ссылки

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

Внутренние

Внутренние ссылки создаются с помощью квадратных скобок. Вы можете использовать просто имя страницы или установить название ссылки.

Внутренние ссылки создаются с помощью квадратных скобок. Вы можете использовать просто
[[имя страницы]] или установить [[pagename|название ссылки]].

Названия страниц Wiki автоматически конвертируются в нижний регистр. Специальные символы не разрешены.

Вы можете применять namespaces, используя двоеточие в имени ссылки.

Вы можете применять [[some:namespaces]], используя двоеточие в имени ссылки.

Детальную информацию читайте в документации по namespaces.

Ссылки на конкретный раздел статьи также возможен. Просто добавьте имя раздела после символа #. Это ссылка на этот раздел.

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

Примечание:

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

Interwiki

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

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

Windows Shares

Ссылки Windows shares подобные этой также распознаются. Помните, что это имеет смысл только в однородной группе, например, в корпоративной Intranet.

Ссылки Windows shares подобные [[\\server\share|этой]] также распознаются.

Примечание:

  • По соображениям безопасности прямой просмотр windows shares работает по умолчанию только в Microsoft Internet Explorer (и только в локальной зоне);
  • Для Mozilla и Firefox это может быть включено с помощью параметра security.checkloaduri, но это не рекомендуется;
  • Смотрите баг 151, чтобы узнать больше информации.

Ссылки на изображениях

Вы можете использовать изображение как ссылку на какую-либо внутреннюю или внешнюю страницу, используя вместе синтаксис ссылки и изображения. Например:

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

Примечание: форматирование изображений является единственным синтаксисом, разрешённым в ссылках.

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

Сноски

Вы можете добавлять сноски 1), используя двойные круглые скобки.

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

Заголовки

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

Заголовок. Уровень 3

Заголовок. Уровень 4

Заголовок. Уровень 5
==== Заголовок. Уровень 3 ====
=== Заголовок. Уровень 4 ===
== Заголовок. Уровень 5 ==

Использовав 4 или более дефиса, вы можете создавать горизонтальную линию:


Изображения и другие файлы

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

Настоящий размер:

Изменение размера до указанной ширины:

Изменение размера до указанной ширины и высоты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 поддерживает упорядоченные и неупорядоченные списки. Для создания списка сделайте отступ в 2 пробела и используйте * для неупорядоченного списка или - для упорядоченного.

  • Это список. Пункт 1;
  • Пункт 2;
    • Вы можете делать ветвления;
  • Следующий пункт.
  1. Ещё один список, но с нумерованными пунктами;
  2. Следующий пункт;
    1. Здесь также доступны ветвления;
  3. Последний пункт.
  * Это список. Пункт 1;
  * Пункт 2;
    * Вы можете делать ветвления;
  * Следующий пункт.

  - Ещё один список, но с нумерованными пунктами;
  - Следующий пункт;
    - Здесь также доступны ветвления;
  - Последний пункт.

Смайлы

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

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

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

DokuWiki может преобразовывать простые текстовые символы в типографически корректные. Далее представлен список распознаваемых символов.

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

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

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

Цитирование

Иногда возникает необходимость обозначить в тексте чью-то цитату. Для этого используется следующий синтаксис:

Я думаю, мы должны сделать это

> Нет, не должны

>> Да ну, я сказал, что должны

> Действительно?

>> Да!

>>> Ну тогда давай сделаем!

Я думаю, мы должны сделать это

Нет, не должны
Да ну, я сказал, что должны
Действительно?
Да!
Ну, тогда давай сделаем!

Таблицы

DokuWiki поддерживает синтаксис для создания таблиц.

Заголовок 1 Заголовок 2 Заголовок
Строка 1 Стоблец 1 Строка 1 Стоблец 2 Строка 1 Стоблец 3
Строка 2 Стоблец 1 Объединённые ячейки
Строка 3 Стоблец 1 Строка 2 Стоблец 2 Строка 2 Стоблец 3

Строки таблицы должны начинаться и заканчиваться на |, заголовки — ^.

^ Заголовок 1           ^ Заголовок 2            ^ Заголовок                 ^
| Строка 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  |

Примечание: объединение соседних ячеек в одном столбце невозможно.

Вы можете выравнивать содержимое в таблице. Просто добавьте как минимум 2 пробела на противоположном конце текста. Добавьте 2 или более пробела слева, чтобы выровнять по правому краю, справа — чтобы выровнять по левому краю. Чтобы отцентровать текст, добавьте по 2 или более пробела с каждой из сторон.

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

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

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

Неформатируемые блоки

Вы можете добавлять блоки неформатируемого текста в свою статью, сделав отступ перед ним как минимум в 2 пробела (подобно предыдущим примерам) или использовав теги code или file.

Это преформатированный текст, в котором все пробелы сохранены. Подобно              <-этому
Здесь практически тоже самое, но вы можете показать, что цитируете документ.  

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

Этот текст содержит адрес: http://www.splitbrain.org и **форматирование текста**, но никаких преобразований не выполняется.

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

Подсветка синтаксиса

DokuWiki может подсвечивать исходный код, что позволяет делать его более удобным для восприятия. Для этого используется GeSHi (Generic Syntax Highlighter). Синтаксис аналогичен тому, что разбирается в предыдущем разделе, но на этот раз в тег необходимо добавить имя используемого языка. Например: <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

Ленты новостей в формате RSS/ATOM

В DokuWiki могут быть интегрированы данные из внешних XML-лент. Для их анализа используется SimplePie. Все форматы, поддерживаемые SimplePie, могут быть использованы и в DokuWiki. Вы можете влиять на отображение с помощью добавления перечисленных далее параметров, разделённых с помощью пробелов:

Параметр Описание
any number Используется для отображения максимального числа записей; по умолчанию 8.
reverse Показывать первой в ленте новостей последнюю написанную запись.
author Показывать имя автора записи.
date Показывать дату написания записи.
description Показывать описание записи. Если HTML отключён, то все теги будут игнорироваться.
n[dhm] Период обновления, где d=дни, h=часы, m=минуты (например 12h = 12 часов).

По умолчанию период обновления составляет 4 часа. Любое значение обновления, установленное менее чем на 10 минут, будет округлено до него. DokuWiki, как правило, кэширует статьи. Очевидно, что это неподходяще, когда статья содержит динамически обновляемый материал из внешнего источника. Данный параметр заставляет DokuWiki заново отображать страницу, если она хранится более, чем период обновления.

Пример:

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

Добавление кода HTML и PHP

Вы можете встраивать строки кода 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 по умолчанию в конфигурации отключено. В таком случае код просто отображается вместо того, чтобы выполняться.

Управляющие макросы

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

Макрос Описание
~~NOTOC~~ Если этот макрос найден на странице, то оглавление таблицы не будет показано.
~~NOCACHE~~ DokuWiki по умолчанию кэширует все выходные данные. Иногда это нежелательно (например, когда используется синтаксис <php>). Добавление этого макроса заставит DokuWiki каждый раз заново создавать страницу.

Заметки

Позволяет создавать акцентирующие внимание блоки текста: заметки, предупреждения и т.п. Внутри заметок можно использовать некоторые инструменты wiki-синтаксиса.
Примеры использования:

Это простая заметка

<note>Это простая заметка</note>

Это заметка типа «Внимание!»

<note important>Это заметка типа "Внимание!"</note>

Замечание, совет, подсказка

<note tip>Замечание, совет, подсказка</note>

Предупреждение

  • Список
  • форматирование текста

<note warning>Предупреждение
* Список
* **__форматирование текста__**
</note>

Плагины для расширения синтаксиса

Синтаксис DokuWiki может быть расширен с помощью плагинов. Как использовать установленные плагины, вы можете узнать на страницах их описания. В данной установке DokuWiki доступны следующие плагины для расширения синтаксиса:

1) это сноска
2) когда соотношение заданных высоты и ширины не совпадает с соотношением сторон рисунка, он обрезается до указанного соотношения перед масштабированием
wiki/syntax.1248942132.txt.gz · Последние изменения: 2009/07/30 12:22 — Quicksilver tears
CC Attribution-Share Alike 3.0 Unported
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0