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


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

Ниже следует описание доступных параметров, большинство из которых можно комбинировать.

Форматирование текста

Название Внешний вид Способ использования
Форматирование
текста
Полужирный Пример
**Пример**
Курсив Пример
//Пример//
Подчёркнутый Пример
__Пример__
Моноширинный Пример
''Пример''
Зачёркнутый Пример
<del>Пример</del>
Индекс Подстрочный Пример
<sub>Пример</sub>
Надстрочный Пример
<sup>Пример</sup>
Сноска 2)
((Это - сноска;-)))

Абзацы и переносы

Абзац формируется пустой строкой. Перенос строки без создания абзаца - \\.

Ссылки

Внешний вид Способ использования
Ссылки Внутренние Простые инструкция
[[инструкция]]
С произвольным именем Инструкция по использованию
[[инструкция|Инструкция по использованию]]
С изображением вместо текста
[[http://www.dokuwiki.org|{{wiki:dokuwiki-128.png?20}}]]
Направленные С относительным путём Ссылка
[[.:главная|Ссылка]]
С указанием пространства имён Nano
[[wiki:nano|Nano]]
С указанием раздела документа ссылки или ссылки
[[#ссылки]] или [[wiki:nano#ссылки]]
Интер-ссылки Википедия Википедия или Wikipedia
[[wpru>Википедия]] или [[wp>Wikipedia]]
Launchpad Bug 645818 или Фича
[[lpbug>645818]] или [[lpbug>645818|Фича]]
Профиль Форума D или User
[[user>D]] или [[user>D|User]]
Внешние Распознаваемые С указанием протокола http://www.ubuntu.ru
http://www.ubuntu.ru
Без указания протокола www.ubuntu.ru
www.ubuntu.ru
Прямо указанные Это ссылка HTTP
[[http://www.ubuntu.ru|Это ссылка HTTP]]
Это ссылка на email
[[user@example.com|Это ссылка на email]]
К сожалению, указать прямую ссылку на пакет через apt://
временно невозможно. Тема на Форуме

Интер-ссылки

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

Обработка текста

Внешний вид Способ использования
Необраба-
тываемый
Параметр «%%» http://ubuntu.ru
%%http://ubuntu.ru%%
тэг <nowiki> http://ubuntu.ru
<nowiki>http://ubuntu.ru</nowiki>
В блоке Простой Код
Пример
<code>Пример</code>
Файл
Пример
<file>Пример</file>
С подсветкой синтаксиса Bash
sudo dpkg -i ./package.deb
<code bash>sudo dpkg -i ./package.deb</code>
HTML
<font color="red">HTML</font>
<code html><font color="red">HTML</font></code>
PHP
<?php echo 'Hello, world!'; ?>
<code php><?php echo 'Hello, world!'; ?></code>
Без блока,
в тексте
HTML <font color="red">HTML</font>
<html><font color="red">HTML</font></html>
PHP <?php echo 'Hello, world!'; ?>
<php><?php echo 'Hello, world!'; ?></php>

Кроме того, для подсветки синтаксиса доступно множество иных параметров, подробнее см.плагин GeSHi3).

Преобразуемые сочетания символов

Смайлики

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

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

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

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

  • ->
  • <-
  • <->
  • =>
  • <=
  • <=>
  • << «
  • >> »
  • --
  • ---
  • '640x480' '640×480'
  • (c) ©
  • (tm)
  • (r) ®
  • "кавычки" «кавычки»4)

Списки

Dokuwiki поддерживает нумерованные, ненумерованные, с определениями и многоуровневые нумерованные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и потом * в случае ненумерованного списка, - в случае нумерованного или ~ в случае многоуровневого нумерованного. Для списка с определениями после двух пробелов поставьте ? для определения или : для элемента с описанием.
Кроме того, элементы списков (кроме определений) можно разрывать на абзацы. Для этого у нужного элемента вместо одного специального символа необходимо поставить два, а новый абзац начать с .. после двух пробелов.

  - нумерованный список
  ~ нумерованный список с многоуровневой нумерацией
  * ненумерованный список
  ? определение для списка с определениями
  : описание для списка с определениями

  -- элемент нумерованного списка с несколькими параграфами
  ~~ элемент многоуровневого нумерованного списка с несколькими параграфами
  ** элемент ненумерованного списка с несколькими параграфами
  :: элемент описания списка с определениями с несколькими параграфами
  .. новый параграф для --, ~~, **, или ::
  * Это список
    * Второй элемент списка
      * Можно сделать вложенный список
    ** Ещё один элемент, теперь разбитый на два параграфа
    .. Очень удобно

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

  ~ А вот это список с многоуровневой нумерацией
  ~ Мало чем отличается от нумерованного
    ~ Кроме нумерации подсписков
  ~ Иногда полезно

  ? Ну и напоследок
  : Список с определениями
    * Бывает, нужны и такие
    * Кстати, разные типы списков можно друг в друга вкладывать
  ? Можно поэкспериментировать
  :: Различных вариантов очень много
  .. Можно очень красиво структурировать материал
  • Это список
    • Второй элемент списка
      • Можно сделать вложенный список
    • Ещё один элемент, теперь разбитый на два параграфа

      Очень удобно

  1. Тот же список, только нумерованный
  2. Ещё элемент
    1. Чем больше пробелов в начале, тем глубже вложенность
  3. Всё просто
~ А вот это список с многоуровневой нумерацией
~ Мало чем отличается от нумерованного
  ~ Кроме нумерации подсписков
~ Иногда полезно
Ну и напоследок
Список с определениями
  • Бывает, нужны и такие
  • Кстати, разные типы списков можно друг в друга вкладывать
Можно поэкспериментировать

Различных вариантов очень много

Можно очень красиво структурировать материал

Таблицы

DokuWiki поддерживает упрощённый синтаксис создания таблиц.
Объединение символов границ позволяет объединить ячейки. Используемые символы или их комбинации:

  • ^ и ^^ - выделение заголовка и горизонтальное объединение заголовков
  • | и || - граница ячейки и две спаренные границы - пропуск одной ячейки горизонтально
  • ::: - параметр вертикального объединения ячейки с верхней ячейкой
Положение текста в ячейке определяется парами (и более) пробелов.
В ячейках возможно применение многих конструкций форматирования текста.
Центр Лево Право
Заголовок
строки
Одна ячейка Вторая ячейка
⇐ вертикальное объединение ячеек
Горизонтально объединённая ячейка
Сверху пробел Куда? Туда→ Раз.
Сюда→ Два.
|         Центр       ^^Лево         ^         Право^
^Заголовок \\ строки ||Одна ячейка   | Вторая ячейка|
^ :::                ||::: | <= вертикальное объединение ячеек|
^                    ||Горизонтально объединённая ячейка||
^ Сверху пробел      |Куда?  |Туда-> |Раз.          |
^ :::                | :::   |Сюда-> |Два.       |

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

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

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

См.также

тэг: Служебная:Синтаксис

1)
необработанный системой код страницы - именно в нём содержится вся статья, исключая изображения, но включая все элементы оформления и пр.
2)
Это - сноска;-)
3)
На данный момент распознаются следующие языки: actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, bnf, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, 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, python, qbasic, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro, winbatch, xml
4)
система не всегда корректно преобразует кавычки в «ёлочки» при комбинировании стилей, поэтому рекомендуется использовать символы << и >>.