Это старая версия документа.
Содержание
Wiki: Разметка, синтаксис, форматирование
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 преобразовывает наиболее употребляемые сочетания символов в их графические эквиваленты.
|
|
|
|
|
|
|
|
|
|
Типографские символы
|
|
|
|
|
|
|
|
Списки
Dokuwiki поддерживает нумерованные, ненумерованные, с определениями и многоуровневые нумерованные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и потом * в случае ненумерованного списка, - в случае нумерованного или ~ в случае многоуровневого нумерованного. Для списка с определениями после двух пробелов поставьте ? для определения или : для элемента с описанием.
Кроме того, элементы списков (кроме определений) можно разрывать на абзацы. Для этого у нужного элемента вместо одного специального символа необходимо поставить два, а новый абзац начать с .. после двух пробелов.
- нумерованный список ~ нумерованный список с многоуровневой нумерацией * ненумерованный список ? определение для списка с определениями : описание для списка с определениями -- элемент нумерованного списка с несколькими параграфами ~~ элемент многоуровневого нумерованного списка с несколькими параграфами ** элемент ненумерованного списка с несколькими параграфами :: элемент описания списка с определениями с несколькими параграфами .. новый параграф для --, ~~, **, или :: * Это список * Второй элемент списка * Можно сделать вложенный список ** Ещё один элемент, теперь разбитый на два параграфа .. Очень удобно - Тот же список, только нумерованный - Ещё элемент - Чем больше пробелов в начале, тем глубже вложенность - Всё просто ~ А вот это список с многоуровневой нумерацией ~ Мало чем отличается от нумерованного ~ Кроме нумерации подсписков ~ Иногда полезно ? Ну и напоследок : Список с определениями * Бывает, нужны и такие * Кстати, разные типы списков можно друг в друга вкладывать ? Можно поэкспериментировать :: Различных вариантов очень много .. Можно очень красиво структурировать материал |
~ А вот это список с многоуровневой нумерацией ~ Мало чем отличается от нумерованного ~ Кроме нумерации подсписков ~ Иногда полезно
|
Таблицы
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 |
DocuWiki поддерживает вертикальное объединение ячеек (rowspan). Для этого в присоединяемых ячейках (ниже доминирующей, которая выше) нужно поместить три двоеточия подряд - ':::'.
Заголовок 1 | Заголовок 2 | Заголовок 3 |
---|---|---|
Ещё один | Ячейка 1 | Ячейка 2 |
И ещё. | Ячейка большая | |
Вертикальное объединение ячеек | 23 | |
1 | 2 |
Обратите внимание на ручной перенос - \\.
DocuWiki поддерживает вертикальное объединение ячеек (rowspan). Для этого в присоединяемых ячейках (ниже доминирующей, которая выше) нужно поместить три двоеточия подряд - ':::'. ^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^ ^ Ещё один | Ячейка 1 | Ячейка 2| ^ И ещё. | Ячейка большая || ^ Вертикальное \\ объединение ячеек | 23 || ^ ::: |1|2| Обратите внимание на ручной перенос - <nowiki>\\</nowiki>.
Текст клетки таблицы можно выравнивать. Просто добавьте минимум два пробела с противоположной стороны: слева — если надо выравнять вправо, справа – если надо выравнять влево, и по два с каждой стороны — если по центру.
Таблица с выравниванием | ||
---|---|---|
вправо | по центру | влево |
влево | вправо | по центру |
xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
^ Таблица с выравниванием ^^^ | вправо| по центру |влево | |влево | вправо| по центру | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Управляющие макросы
Некоторый синтаксис влияет на то, как DokuWiki обрабатывает страницы без создания каких-либо результатов для себя. Доступны следующие макросы:
Макрос | Описание |
---|---|
~~NOTOC~~ | Если этот макрос присутствует на странице, оглавление не будет создано |
~~NOCACHE~~ | DokuWiki помещает все выводимое в кэш по умолчанию. Иногда это нежелательно (например, когда выше был использован синаксис <php>), добавление этого макроса заставит DokuWiki обрабатывать страницу при каждом вызове |
См.также
2012/06/04 03:09 |
тэг: Служебная:Синтаксис
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