Инструменты пользователя

Инструменты сайта


wiki:syntax

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


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

DokuWiki поддерживает простой язык разметки, который делает файлы с данными максимально удобочитаемыми. На этой странице приведены все возможные синтаксические конструкции, которые можно использовать при редактировании страниц. Чтобы увидеть исходный код этой страницы, нажмите «Редактировать страницу». Если хотите поэкспериментировать, используйте страницу песочницы. Простейшая разметка легко доступна через панель инструментов.

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

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

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

Можно использовать нижний индекс и верхний индекс.

Можно использовать нижний индекс и верхний индекс.

Также можно помечать что-либо как удалённое.

Также можно помечать что-либо как удалённое.

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

Вот пример текста с переносами строк\ Обратите внимание, что две обратные косые черты распознаются только в конце строки\ или после них идёт пробел\ а без пробела это не сработает.

Вот пример текста с переносами строк\ Обратите внимание, что две обратные косые черты распознаются только в конце строки\ или после них идёт пробел\ а без пробела это не сработает.

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

Ссылки

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

Внешние

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

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

Внутренние

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

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

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

Можно использовать пространства имён, указав двоеточие в имени страницы.

Можно использовать пространства имён, указав двоеточие в имени страницы.

Подробнее о пространствах имён смотрите namespaces.

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

Вот ссылка на этот раздел.

Примечания:

Ссылки на существующие страницы отображаются иначе, чем на несуществующие.

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

При изменении заголовка раздела меняется и его закладка. Поэтому не стоит слишком полагаться на ссылки на разделы.

Интервики

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

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

Сетевые папки Windows

Сетевые адреса Windows, например вот такой, тоже распознаются. Обратите внимание, что они имеют смысл только в однородной пользовательской среде, например в корпоративной Интранет.

Сетевые адреса Windows, например вот такой, тоже распознаются.

Примечания:

Из соображений безопасности прямой просмотр сетевых папок Windows по умолчанию работает только в Microsoft Internet Explorer (и только в «локальной зоне»).

В Mozilla и Firefox это можно включить с помощью обходных путей, описанных в базе знаний Mozilla. Однако всё равно будет появляться предупреждение JavaScript о попытке открыть сетевую папку Windows. Чтобы убрать это предупреждение (для всех пользователей), добавьте следующую строку в файл conf/lang/en/lang.php (подробнее о локализации):

conf/lang/en/lang.php
<?php /** * Customization of the english language file * Copy only the strings that needs to be modified */ $lang['js']['nosmblinks'] = ''; 

==== Ссылки-изображения ==== Можно также использовать изображение для ссылки на другую внутреннюю или внешнюю страницу, комбинируя синтаксис ссылок и изображений (см. ниже) следующим образом: Обратите внимание: в именах ссылок допускается только синтаксис форматирования изображений. Поддерживается весь синтаксис изображений и ссылок (включая изменение размера, внутренние и внешние изображения, URL и интервики-ссылки). ===== Сноски ===== Можно добавлять сноски 1) с помощью двойных круглых скобок. Можно добавлять сноски 2) с помощью двойных круглых скобок. ===== Заголовки разделов ===== Можно использовать до пяти различных уровней заголовков для структурирования содержимого. Если заголовков больше трёх, автоматически создаётся оглавление — это можно отключить, добавив в документ строку ~~NOTOC~~. ==== Заголовок уровня 3 ==== === Заголовок уровня 4 === == Заголовок уровня 5 == ==== Заголовок уровня 3 ==== === Заголовок уровня 4 === == Заголовок уровня 5 == С помощью четырёх или более дефисов можно создать горизонтальную линию: —- ===== Медиафайлы ===== Можно вставлять внешние и внутренние изображения, видео и аудиофайлы с помощью фигурных скобок. При желании можно указать их размер. Исходный размер: Уменьшить до заданной ширины: Уменьшить до заданных ширины и высоты3): Внешнее изображение с изменённым размером: Исходный размер: Уменьшить до заданной ширины: Уменьшить до заданных ширины и высоты: Внешнее изображение с изменённым размером: С помощью пробелов слева или справа можно выбрать выравнивание. Разумеется, можно добавить и заголовок (большинство браузеров отображают его в виде всплывающей подсказки). Это подпись Это подпись О том, как сделать изображение ссылкой, смотрите выше в разделе Ссылки-изображения. ==== Поддерживаемые медиаформаты ==== DokuWiki может непосредственно встраивать следующие медиаформаты. | Изображение | gif, jpg, png | | Видео | webm, ogv, mp4 | | Аудио | ogg, mp3, wav | | Flash | swf | Если указано имя файла, формат которого не поддерживается, оно будет отображено как ссылка. Добавив ?linkonly, можно создать ссылку на медиафайл без его встраивания. dokuwiki-128.png dokuwiki-128.png Это просто ссылка на изображение. ==== Резервные форматы ==== К сожалению, не все браузеры понимают все видео- и аудиоформаты. Чтобы смягчить проблему, можно загрузить файл в разных форматах для максимальной совместимости с браузерами. Например, рассмотрим встроенное видео mp4: Если рядом с указанным файлом video.mp4 вы загрузите video.webm и video.ogv, DokuWiki автоматически добавит их как альтернативные, так что браузер сможет воспроизвести один из трёх файлов. Кроме того, DokuWiki поддерживает изображение-«постер», которое будет показано до начала воспроизведения видео. Это изображение должно иметь то же имя файла, что и видео, и быть в формате jpg или png. В приведённом выше примере подойдёт файл video.jpg. ===== Списки ===== DokuWiki поддерживает неупорядоченные и упорядоченные списки. Чтобы создать элемент списка, сделайте отступ в два пробела и используйте * для неупорядоченных или - для упорядоченных. * Это список * Второй элемент * Можно создавать разные уровни * Ещё один элемент - Тот же список, но упорядоченный - Другой элемент - Просто используйте отступы для глубоких уровней - Вот и всё

 * Это список * Второй элемент * Можно создавать разные уровни * Ещё один элемент - Тот же список, но упорядоченный - Другой элемент - Просто используйте отступы для глубоких уровней - Вот и всё 

Также ознакомьтесь с FAQ по элементам списков. ===== Текстовые преобразования ===== DokuWiki может преобразовывать определённые предопределённые символы или строки в изображения, другой текст или HTML. Преобразование текста в изображения в основном используется для смайликов. Преобразование текста в HTML применяется для типографских замен, но может быть настроено и для другого HTML. ==== Преобразование текста в изображения ==== DokuWiki преобразует часто используемые эмотиконы в их графические аналоги. Эти Smileys и другие изображения можно настраивать и расширять. Вот обзор смайликов, включённых в DokuWiki: * 8-) 8-) * 8-O 8-O * :-( :-( * :-) :-) * =) =) * :-/ :-/ * :-\ :-\ * :-? :-? * :-D :-D * :-P :-P * :-O :-O * :-X :-X * :-| :-| * ;-) ;-) * ^_^ ^_^ * m( m( * :?: :?: * :!: :!: * LOL LOL * FIXME FIXME * DELETEME DELETEME ==== Преобразование текста в HTML ==== Типографика: DokuWiki может преобразовывать простые текстовые символы в их типографски правильные эквиваленты. Вот пример распознаваемых символов. → ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® «Он подумал: 'Это мужской мир'…»

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

То же самое можно делать для генерации любого HTML, достаточно добавить его в файл шаблонов. Есть три исключения, которые не берутся из файла шаблонов: знак умножения (640×480), 'одинарные' и «двойные кавычки». Их можно отключить через параметр конфигурации. ===== Цитирование ===== Иногда нужно выделить текст, чтобы показать, что это ответ или комментарий. Можно использовать следующий синтаксис:

 Я думаю, нам стоит это сделать > Нет, не стоит >> Ну, я считаю, стоит > Правда? >> Да! >>> Тогда давайте сделаем! 

Я думаю, нам стоит это сделать > Нет, не стоит » Ну, я считаю, стоит > Правда? » Да! »> Тогда давайте сделаем! ===== Таблицы ===== 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 | Строка 2 Кол 2 | Строка 2 Кол 3 | Как видите, форматирование ячейки определяется разделителем перед ней: | ^ Заголовок 1 ^ Заголовок 2 ^ ^ Заголовок 3 | Строка 1 Кол 2 | Строка 1 Кол 3 | ^ Заголовок 4 | без объединения на этот раз | | ^ Заголовок 5 | Строка 2 Кол 2 | Строка 2 Кол 3 | Можно создавать объединение ячеек по вертикали (rowspan), добавив ::: в ячейки ниже той, с которой они должны быть объединены. ^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^ | Строка 1 Кол 1 | эта ячейка объединяется по вертикали | Строка 1 Кол 3 | | Строка 2 Кол 1 | ::: | Строка 2 Кол 3 | | Строка 3 Кол 1 | ::: | Строка 3 Кол 3 | Кроме синтаксиса rowspan, такие ячейки не должны содержать ничего другого. ^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^ | Строка 1 Кол 1 | эта ячейка объединяется по вертикали | Строка 1 Кол 3 | | Строка 2 Кол 1 | ::: | Строка 2 Кол 3 | | Строка 3 Кол 1 | ::: | Строка 3 Кол 3 | Также можно выравнивать содержимое таблицы. Просто добавьте не менее двух пробелов на противоположном конце текста: два пробела слева — выравнивание вправо, два пробела справа — влево, и не менее двух пробелов с обеих сторон — по центру. ^ Таблица с выравниванием ^^^ | вправо| по центру |влево | |влево | вправо| по центру | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | Вот как это выглядит в исходном коде: ^ Таблица с выравниванием ^^^ | вправо| по центру |влево | |влево | вправо| по центру | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | Примечание: вертикальное выравнивание не поддерживается. ===== Без форматирования ===== Если нужно отобразить текст в точности так, как он набран (без какого-либо форматирования), заключите его в теги <nowiki> или, ещё проще, в двойные знаки процента %%. Вот текст, содержащий адреса типа http://www.splitbrain.org и **форматирование**, но ничего из этого не обрабатывается. То же самое справедливо для //__этого текста__// со смайликом ;-). Вот текст, содержащий адреса типа http://www.splitbrain.org и **форматирование**, но ничего из этого не обрабатывается. То же самое справедливо для //__этого текста__// со смайликом ;-). ===== Блоки кода ===== Вы можете включать блоки кода в документы, либо делая отступ не менее двух пробелов (как в предыдущих примерах), либо используя теги <code> или <file>. Этот текст имеет отступ в два пробела.

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

Эти блоки были созданы из следующего исходного кода: Этот текст имеет отступ в два пробела.

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

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

В настоящее время распознаются следующие строки языков: 4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram xbasic xml xojo xorg_conf xpp yaml z80 zxbasic Существуют дополнительные расширенные возможности подсветки синтаксиса, такие как выделение строк или добавление номеров строк. ==== Загружаемые блоки кода ==== При использовании синтаксиса <code> или <file>, как показано выше, вы можете также сделать код доступным для скачивания. Для этого укажите имя файла после кода языка:

 <file php myexample.php> <?php echo "hello world!"; ?></file> 
myexample.php
 <?php echo "hello world!"; ?> 

Если вы не хотите подсветки, но нужен скачиваемый файл, укажите дефис (-) в качестве кода языка: <code - myfile.foo>.

Агрегация RSS/ATOM-лент

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

Параметр Описание
любое число используется как максимальное количество отображаемых элементов, по умолчанию 8
reverse отображать последние элементы ленты первыми
author показывать имена авторов элементов
date показывать даты элементов
description показывать описание элемента. Все HTML-теги будут удалены
nosort не сортировать элементы в ленте
n[dhm] период обновления, где d=дни, h=часы, m=минуты (например, 12h = 12 часов)

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

По умолчанию лента сортируется по дате, сначала новые элементы. Вы можете отсортировать сначала старые с помощью параметра reverse или отображать ленту как есть с помощью nosort.

Пример:

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

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

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

Синтаксические плагины

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

  • Info Plugin 2020-06-04Andreas Gohr
    Displays information about various DokuWiki internals
  • Wrap Plugin 2026-06-02Anika Henke
    Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.
1) , 2)
Это сноска
3)
Если соотношение сторон заданных ширины и высоты не совпадает с соотношением сторон изображения, оно будет обрезано до нового соотношения перед масштабированием
wiki/syntax.1783980065.txt.gz · Последнее изменение: root