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

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


wiki:syntax

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


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

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

Основные элементы форматирования текста

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

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

Можно набирать текст в нижнем и верхнем индексе.

Можно набирать текст в <sub>нижнем</sub> и <sup>верхнем</sup> индексе.

Можно помечать текст как удаленный.

Можно помечать текст как <del>удаленный</del>.

Параграфы создаются пустыми строками. Если нужно вставить разрыв строки без создания нового параграфа, достаточно ввести две обратные косые черты и, следом, пробел или конец строки (то есть нажать Enter).

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

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

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

Ссылки

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

Внешние ссылки

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

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

Внутренние ссылки

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

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

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

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

Подробную информацию о пространствах имен (namespaces) можно найти на официальном сайте wiki:namespaces.

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

Вот эта ссылка указывает на [[syntax#internal|текущий раздел]] этой страницы.

Примечания:

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

Interwiki

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

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

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

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

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

Notes:

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

Изображения-ссылки

Любое изображение может выступать в качестве ссылки на внутреннюю или внешнюю страницу с помощью совмещения синтаксиса изображения и ссылки, как это сделано ниже:

[[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 }}

Of course, you can add a title (displayed as a tooltip by most browsers), too.

This is the caption

{{ wiki:dokuwiki-128.png |This is the caption}}

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

Списки

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

  • Первый элемент списка
  • Второй элемент списка
    • Можно делать вложенные списки
  • Еще один элемент списка
  1. Тот же список, только нумерованный
  2. Еще один элемент
    1. Отступим и сделаем вложенный
  3. Вот и все
  * Первый элемент списка
  * Второй элемент списка
    * Можно делать вложенные списки
  * Еще один элемент списка

  - Тот же список, только нумерованный
  - Еще один элемент
    - Отступим и сделаем вложенный
  - Вот и все

Смайлики

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

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

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

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

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® «He thought 'It's a man's world'…»

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

Примечание: Такое преобразование может быть отключено в конфигурационном файле.

Цитаты

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

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

I think we should do it

No we shouldn't
Well, I say we should
Really?
Yes!
Then lets do it!

Таблицы

В DokuWiki довольно просто создавать таблицы.

Heading 1 Heading 2 Heading 3
Row 1 Col 1 Row 1 Col 2 Row 1 Col 3
Row 2 Col 1 some colspan (note the double pipe)
Row 3 Col 1 Row 2 Col 2 Row 2 Col 3

Обычные строки должны начинаться и заканчиваться символом | (им же отделяются столбцы). Для заголовков используется символ ^.

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | some colspan (note the double pipe) ||
| Row 3 Col 1    | Row 2 Col 2     | Row 2 Col 3        |

Возможно объединять ячейки горизонтально, для этого нужно сдвинуть разделитель к концу объединенной ячейки, как показано выше. При этом количество разделителей во всех строках таблицы должно быть одинаковым!

Возможно создавать заголовки в строках таблицы.

Heading 1 Heading 2
Heading 3 Row 1 Col 2 Row 1 Col 3
Heading 4 no colspan this time
Heading 5 Row 2 Col 2 Row 2 Col 3

Как вы видите, стоящий перед ячейкой разделитель определяет ее внешний вид:

|              ^ Heading 1            ^ Heading 2          ^
^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
^ Heading 4    | no colspan this time |                    |
^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |

Примечание: Объединять ячейки вертикально нельзя.

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

Таблица с выравниванием
right center left
left right center
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Обратите внимание на то, как это достигается

^           Таблица с выравниванием            ^^^
|         right|    center    |left          |
|left          |         right|    center    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Необрабатываемый парсером текст

Необрабатываемый текст можно добавить в документ либо отделив его по крайней мере двумя пробелами от начала строки (как в случае со всеми примерами на этой странице), либо с использованием тэгов code или file.

В этой строке сохранены все пробелы: все              <-this
Применение тэга %%<file>%% указывает на то, что вы приводите содержание файла.

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

В этой строке содержится URL: http://www.splitbrain.org и элементы **форматирования**, но ничего не происходит.

Вы можете просмотреть код этой страницы, чтобы лучше понять, как работают эти тэги.

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

DokuWiki может подсвечивать исходный код для разных языков программирования, тем самым облегчая его чтение и понимание. Для этого используется библиотека GeSHi Generic Syntax Highlighter – то есть все языки, поддерживаемые ею, подсвечиваются в DokuWiki. Для подсветки используется тэг <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, actionscript-french, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, caddcl, cadlisp, c, c_mac, cfm, cpp, csharp, css, delphi, diff, d, div, dos, eiffel, freebasic, gml, html4strict, ini, inno, java, java5, javascript, lisp, lua, matlab, mpasm, mysql, nsis, objc, ocaml, ocaml-brief, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, scheme, sdlbasic, smarty, sql, tsql, robots, ruby, vb, vbnet, vhdl, visualfoxpro, xml

Встраивание HTML и PHP

Код HTML и PHP можно встроить в код страницы с помощью тэгов html и php:

<html>
Здесь <font color="red" size="+1">HTML-код</font>
</html>

Здесь <font color="red" size="+1">HTML-код</font>

<php>
echo 'Логотип, сгенерированный PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
</php>

echo 'Логотип, сгенерированный PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';

Примечание:: Вставка HTML и PHP кода по умолчанию выключена и может быть включена в конфигурационном файле. В том случае, когда она запрещена, код не обрабатывается, а просто отображается на странице.

Плагины

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

  • Indexmenu Plugin 2015-08-26Samuele Tognini
    Show a customizable and sortable index for a namespace
  • Info Plugin 2014-10-01Andreas Gohr
    Displays information about various DokuWiki internals
  • keyboard 2018-08-09Gina Häußge
    The keyboard plugin provides a combined syntax and action plugin in order to markup text as keyboard keys, similar to (and making use of) the existing (X)HTML tag <kbd>…</kbd>. A quick button for the markup is automatically inserted into the toolbar of the edit form.
  • Wrap Plugin 2018-04-22Anika 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)
это - сноска
wiki/syntax.1147417423.txt.gz · Последние изменения: 2006/06/11 08:56 (внешнее изменение)