Киби.ru

Живой сайт об актуальных проектах

User Tools

Site Tools


wiki:syntax

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

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

Основные конструкции форматирования

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

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

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

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

Ещё можно зачеркнуть текст.

Ещё можно <del>зачеркнуть текст</del>.

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

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

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

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

Ссылки

Ссылки в DokuWiki бывают разные, и создавать их можно тоже по-разному.

Внешние

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

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

Внутренние

Внутренние ссылки создаются посредством квадратных скобок. Можно либо просто указать ИмяСтраницы, либо дополнительно прописать Текст ссылки. Имена Wiki-страниц автоматически переводятся в нижний регистр, спецсимволы использовать нельзя.

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

Можно использовать в ссылке namespaces (пространство имён) через двоеточие.

Можно использовать в ссылке [[wiki:namespaces]] (пространство имён) через двоеточие.

Подробней о пространствах имён (in English).

Ставить ссылки на определённый раздел тоже можно. Просто добавьте через решётку имя раздела, также как это делается в HTML. Ссылка на этот раздел.

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

Примечания:

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

InterWiki

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

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

Виндовые шары

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

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

Примечания:

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

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

Совместив синтаксис ссылки и картинки, можно вставить в текст картинку, которая будет внутренней или внешней ссылкой:

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

Учтите: форматирование картинок это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки.

Сноски

С помощью двойных скобок можно добавить сноску1).

С помощью двойных скобок можно добавить сноску ((Это сноска)).

Разбивка на разделы

Для структурирования текста можно использовать до пяти уровней заголовков. Если в тексте больше трёх заголовков, автоматически создаётся список содержимого. Его можно отключить, вставив в документ строку ~~NOTOC~~.

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

Если задать имя файла (внутреннее или внешнее), который не является картинкой (gif, jpeg, png), оно будет отображаться в виде ссылки.

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

Списки

Dokuwiki поддерживает нумерованные и ненумерованные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и потом * в случае ненумерованного списка, или - в случае нумерованного.

  • Это список
    • Второй элемент списка
      • Можно сделать вложенный список
    • Ещё один элемент
  1. Тот же список, только нумерованный
  2. Ещё элемент
    1. Чем больше пробелов в начале, тем глубже вложенность
  3. Всё просто
  * Это список
    * Второй элемент списка
      * Можно сделать вложенный список
    * Ещё один элемент

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

Смайлики

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

  • 8-) 8-)5
  • 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)
"Владимир Владимирович(tm) --- это наше всё (c) не я"

Примечание: Это конвертирование можно отключить в файле конфигурации.

Таблицы

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

Заголовок 1 Заголовок 2 Заголовок 3
Ряд 1 Колонка 1 Ряд 1 Колонка 2 Ряд 1 Колонка 3
Ряд 2 Колонка 1 Объединение колонок (обратите внимание на двойную вертикальную черту)
Ряд 3 Колонка 1 Ряд 2 Колонка 2 Ряд 2 Колонка 3

Нормальные ряды должны начинаться и заканчиваться символом |, а заголовки — ^.

^ Заголовок 1      ^ Заголовок 2         ^ Заголовок 3            ^
| Ряд 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  |

Примечание: Вертикальное объединение (rowspan) не поддерживается.

Текст клетки таблицы можно выравнивать. Просто добавьте минимум два пробела с противоположной стороны: слева — если надо выравнять вправо, справа – если надо выравнять влево, и по два с каждой стороны — если по центру.

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

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

Неформатируемые блоки можно вставлять в документ, либо начиная каждую строчку блока с двух или более пробелов (как это делалось в некоторых предыдущих примерах), либо используя тэги <code> или <file>.

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

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

Это просто текст, в котором есть адрес http://www.splitbrain.org и **форматирование** — но ничего не происходит.

Это просто текст, в котором есть адрес %%http://www.splitbrain.org%% 
и %%**форматирование**%% --- но ничего не происходит.

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

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

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

Дополнительное форматирование

На этом сайте установлены модули, которые расширяют стандартное форматирование DokuWiki.

Выделение цветом (маркер)

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

Текст можно выделять цветом.
<hi>Цвет по умолчанию</hi> может быть заменён на какой-либо другой, 
например <hi red>красный</hi> или <hi lightblue>голубой</hi>.
1)
Это сноска
You could leave a comment if you were logged in.
wiki/syntax.txt · Last modified: 2008/12/11 13:01 (external edit)