Введение

Эта статья ни в коем случае не претендует на звание мануала, перевода оригинального описания синтаксиса (syntax) или ещё чего-то подобного. Тем не менее, оригинальное описание активно использовалось - в надежде что плохо знакомые с английским пользователи смогут что-то отсюда почерпнуть.

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

DokuWiki поддерживает простой язык разметки, который позволяет сделать файлы данных максимально читабельными. Русская версия сего мануала пока не содержит всех возможностей, но с ними можно ознакомиться на странице syntax. Посмотреть исходный код этой страницы можно, нажав на ссылку «править страницу» сверху или снизу статьи. Поиграться и посмотреть, как это работает, можно на странице playground. Также, для оформления можно использовать кнопки, расположенные над полем редактировая (подробнее здесь, англ.)

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

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

Текст можно сделать **жирным**, //курсивным//, __подчеркнутым__ и ''моноширинным''.
Разумеется, всю эту кухню можно применять **//__''сразу''__//**.

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

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

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

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

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

Какой-то текст с переводами строки без начала нового абзаца
Заметьте, что после двух обратных слешей есть перевод строки
или пробел
а если его не будет \\получится вот так.

Какой-то текст с переводами строки без начала нового абзаца\\ Заметьте, 
что после двух обратных слешей есть перевод строки\\
или пробел\\ а если его не будет \\получится вот так.

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

Ссылки

Внешние

Внешние ссылки распознаются автоматически - http://aumi.ru или даже так www.aumi.ru - кроме того, можно задавать имена ссылок: ссылка на аюми. Адреса электронной почты - admin@example.com - тоже распознаются.

Внешние ссылки распознаются автоматически - http://aumi.ru или даже так www.aumi.ru -
кроме того, можно задавать имена ссылок: [[http://aumi.ru|ссылка на аюми]].
Адреса электронной почты - <admin@example.com> - тоже распознаются.

Внутренние

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

Внутренние ссылки создаются использованием двойных квадратных скобок. Можно задать
или только название страницы - [[doku>wiki:pagename]] - или использовать
другое [[doku>wiki:pagename|имя ссылки]]. Все названия страниц приводятся к 
нижнему регистру, спецсимволы запрещены.

Можно использовать пространства имен (англ. namespaces), используя двоеточия в названии страницы. Рассматривайте пространства имен имен как способ сортировать статьи, например, статья про аюми будет выглядеть так: aumi:aumi, а про орехи - aumi:faq:nuts

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

Подробности можно прочитать здесь (англ.).

Также можно создавать ссылки на конкретный раздел статьи - для этого имя раздела указывается после знака решетки, как в HTML. Ссылка сюда. Обратите внимание, что пробелы в именах разделов заменяются точками.

Ссылка [[wiki:rusyntax#Внутренние|сюда]]

Примечания:

  • Ссылки на существующие страницы отображаются иначе, чем на несуществующие.
  • DokuWiki не использует ВерблюжийРегистр для автоматического создания ссылок. Теоретически, эту возможность можно включить, но на момент написания статьи она не работала.
  • Когда изменяется название раздела какой-либо страницы, изменяется и ссылка на него. Так что не полагайтесь особо на такие ссылки.

Интервики

DokuWiki поддерживает Интервики. Интервики - это быстрые ссылки на другие Вики. Например, вот ссылка на английскую и русскую википедию.

DokuWiki поддерживает [[doku>wiki:Interwiki|Интервики]]. Интервики - это быстрые ссылки
на другие Вики. Например, вот ссылка на [[wp>Wiki|английскую]] и [[wpru>Вики|русскую википедию]].

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

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

[[http://aumi.ru|{{wiki:aumi_banner.gif}}]]

Примечание: картинки - единственное, чем можно оформить ссылку (вы не можете использовать жирный, курсивный и т.п. текст прямо в двойных квадратных скобках, означающих ссылку). Тем не менее, все возможности ссылок и картинок поддерживаются в полном объеме.

Сноски

Сноски создаются 1) двойными круглыми скобками. Большинство браузеров при наведении курсора на сноску покажут её содержимое во всплывающей подсказке.

Сноски создаются ((это сноска)) двойными круглыми скобками.

Секционирование

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

Заголовок 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 |Заголовок этой картинки}}

Если в качестве картинки вы укажете файл, который не является картинкой (jpg, png, gif), он будет отображен как ссылка.

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

Списки

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

  • Это список
  • Ещё один пункт
    • Можно использовать разные уровни
  • И ещё один пункт
  1. Тот же список, но нумерованный
  2. Ещё один пункт
    1. Просто используйте больше пробелов для вложенных списков
  3. Как-то так
  * Это список
  * Ещё один пункт
    * Можно использовать разные уровни
  * И ещё один пункт

  - Тот же список, но нумерованный
  - Ещё один пункт
    - Просто используйте больше пробелов для вложенных списков
  - Как-то так

Смайлы

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

  • Акронимы, вроде HTML, PHP, LOL
  • FIXME FIXME
  • DELETEME DELETEME

Типографические знаки

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

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® «Он подумал: 'Что-то тут не так'…»

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"Он подумал: 'Что-то тут не так'..."

Цитирование

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

Я думаю, нам надо сделать это.
> Нет, не надо!
>> А я говорю что надо.
> Да ну?
>> Ога
>>> Тогда фперед!

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

Нет, не надо!
А я говорю что надо.

Да ну?

Ога
Тогда фперед!

Таблицы

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

Заголовок 1 Заголовок 2 Заголовок 3
Строка 1 столбец 1 Строка 1 столбец 2 Строка 1 столбец 3
Строка 2 столбец 1 объединение ячеек (обратите внимание на двойной разделитель)
Строка 3 столбец 1 Строка 3 столбец 2 Строка 3 столбец 3

Строки должны начинаться с ^ для заголовков и | для нормальных ячеек

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

Чтобы объединить строки горизонтально, убедитесь, что вторая и следующие объединяемые ячейки абсолютно пусты, как в примере выше.

Заголовки строк также возможны.

Заголовок 1 Заголовок 2
Заголовок 3 Строка 1 столбец 2 Строка 1 столбец 3
Заголовок 4 в этот раз объединения нет
Заголовок 5 Строка 3 столбец 2 Строка 3 столбец 3

Как видите, разделитель перед ячейкой (^ или |) определяет, как отображается ячейка:

|                ^ Заголовок 1                 ^ Заголовок 2               ^
^ Заголовок 3    | Строка 1 столбец 2          | Строка 1 столбец 3        |
^ Заголовок 4    | в этот раз объединения нет  |                           |
^ Заголовок 5    | Строка 3 столбец 2          | Строка 3 столбец 3        |

Объединения ячеек по вертикали невозможны.

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

Расположение текста
справа центр слева
слева справа центр
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Вот как это выглядит:

^           Расположение текста            ^^^
|        справа|     центр    |слева         |
|слева         |        справа|    центр     |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Заключение

В оригинальном описании синтаксиса было ещё несколько разделов, посвященных оформлению кода (как HTML/PHP и других языков, так и произвольного), использованию RSS и управляющим макросам. Об этом всегда можно прочитать в оригинальном описании, а эта статья заканчивается здесь.

silverdragon 2009/01/05 10:15

1) это сноска
 
Наверх
wiki/rusyntax.txt · Последние изменения: 2009/01/05 10:33 От sd
 
 
Valid XHTML 1.0 Valid CSS Creative Commons License Driven by DokuWiki Recent changes RSS feed

aUmi