Содержание

Дополнения к основному синтаксису

Дополнения к основному синтаксису

Дополнения реализуются подключаемыми модулями-плагинами.

blockquote (цитата)

Красиво оформляет цитату в тексте. Добавляет кнопку в виде двойной кавычки на панель инструментов.

В отличии от стандартной разметки dokuwiki для цитат (при помощи символов »>»), содержимое цитаты может содержать любую вики-разметку, которая воспринимается так же хорошо, как и вне цитаты. Также допустимы вложенные цитаты.

Синтаксис

Плагин предоставляет в ваше распоряжение две дополнительные пары тэгов – blockquote и cite. Цитата позволяет дополнительно указать источник цитирования, который можно расположить в открывающем тэге <blockquote>. Тэг cite был создан, чтобы позволить добавлять более сложную разметку (включая ссылки, форматированный текст и т.п.) в качестве источника цитирования.

Примеры

Загрузка разметки

Следующий код

<blockquote>
Проверим работу разметки...

Ещё один абзац с маленькой [[http://никуда|ссылкой]] в никуда. Кстати, пока мы здесь, как насчёт немного
**жирного**, //курсивного// и __подчёркнутого__ текста? И, наконец, списки:

  * пункт 1
    * пункт 1.1
    * пункт 1.2
  * пункт 2
    - нумерованный пункт 2.1
    - нумерованный пункт 2.2
      - нумерованный пункт 2.2.1
  * пункт 3

Работает :-)
</blockquote>

возвращает

Проверим работу разметки…

Ещё один абзац с маленькой ссылкой в никуда. Кстати, пока мы здесь, как насчёт немного жирного, курсивного и подчёркнутого текста? И, наконец, списки:

пункт 1

пункт 1.1

пункт 1.2

пункт 2

нумерованный пункт 2.1

нумерованный пункт 2.2

нумерованный пункт 2.2.1

пункт 3

Работает

Источник цитирования

Следующий код

<blockquote J. Random Hacker>Проверка свойств цитаты...</blockquote>

возвращает

Проверка свойств цитаты…

Команда cite

Следующий код

<blockquote>Проверка команды cite...<cite>J. Random Hacker, [[http://localhost/~jrhacker]]</cite></blockquote>

возвращает

Проверка команды cite…
J. Random Hacker, http://localhost/~jrhacker

box (прямоугольник)

Плагин помещает красиво оформленные прямоугольники в текст, позволяя выделить важные части текста. Плагин позволяет создавать простые прямоугольники, прямоугольники со скругленными углами, прямоугольники с заголовками и прямоугольники разной ширины. Разметка DokuWiki распознаётся внутри прямоугольника, где она неплохо выглядит; внутри заголовка допускается только текстовая разметка, ссылки и смайлики.

Синтаксис

Простой прямоугольник:

<box>содержимое прямоугольника</box>

содержимое прямоугольника

Более сложные прямоугольники:

<box 80% round orange|заголовок>содержимое прямоугольника</box>

заголовок

содержимое прямоугольника

<box 50% left blue>содержимое прямоугольника</box|подпись>

содержимое прямоугольника

подпись

Текст, текст, просто текст. Текст, текст, просто текст. Текст, текст, просто текст. Текст, текст, просто текст. Текст, текст, просто текст. Текст, текст, просто текст. Текст, текст, просто текст. Текст, текст, просто текст. Текст, текст, просто текст. Текст, текст, просто текст. Текст, текст, просто текст. Текст, текст, просто текст.

<box 60% round #f99 #fc9 #fcc #f60|заголовок>содержимое прямоугольника</box|подпись>

заголовок

содержимое прямоугольника

подпись

Полный синтаксис:

<box ширина классы цвета | текст заголовка> текст содержимого </box | текст подписи>

ширина — любое значение, допустимое в CSS (числа с размерностями в %¹⁾, mm²⁾, cm³⁾, in⁴⁾, pt⁵⁾, pc⁶⁾, px⁷⁾, em⁸⁾, ex⁹⁾ );
классы — любое количество классов, используемых в стилях вашего шаблона для того, чтобы определить, как будет выглядеть прямоугольник. Плагин идёт со следующими, уже определёнными классами:
- round — прямоугольник с закруглёнными углами;
- blue — синяя цветовая схема;
- red — красная цветовая схема;
- green — зелёная цветовая схема;
- orange — оранжевая цветовая схема;
- left — «плавающий» прямоугольник в виде врезки с левой стороны страницы;
- right — «плавающий» прямоугольник в виде врезки с правой стороны страницы.
  Если классы не определены, будет использоваться стиль по умолчанию, это — прямые углы и цветовая схема, основанная на цветовой схеме DokuWiki по умолчанию.
цвета — 1–4 цвета в CSS нотации (hex или RGB), например #F00 #fcab94 rgb(255,255,0). Цвета применяются в таком порядке:
1. фон содержимого
2. фон заголовка
3. фон внешнего прямоугольника
4. границы
  Если определено менее четырёх цветов, то для неопределенных цветов будет использоваться первый цвет.
  Вы можете выбрать цвет из таблицы цветов.
текст заголовка — текст (включая разметку DokuWiki), показываемый над содержимым прямоугольника, с определённым стилем.
текст подписи — текст (разметка не поддерживается), показываемый под содержимым прямоугольника, с определённым стилем.

Открывающий тэг <box … >, включая заголовок, должен располагаться на одной строке. Содержимое прямоугольника может располагаться на любом необходимом количестве строк.

Плагин в действии можно посмотреть здесь. На этой странице отображаются все возможные стили.

color (цветной текст)

Плагин позволяет раскрасить текст и фон в произвольный цвет. Не добавляет кнопку на панель инструментов.

Синтаксис

<color цвет текста/цвет фона>произвольный текст</color>

Цвет можно задавать одним из трёх способов:

именованные цвета. Кроме стандартных шестнадцати цветов (aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, purple, red, silver, teal, white, yellow), многими браузерами распознаётся также обширный список цветов.
html-цвет. Указывается в форме #RGB или #RRGGBB, где R, G, B — шестнадцатеричные цифры (0-F). R определяет красную компоненту цвета, G — зелёную, B — синюю. Цвет получается смешиванием этих трёх компонент. Например, #F8F даёт ярко-фиолетовый цвет.
компонентная форма. Указывается в формеrgb(красный, зелёный, синий) (значения каждой компоненты должно быть в диапазоне от 0 до 255) или rgb(красный%, зелёный%, синий%) (значения каждой компоненты должно быть в диапазоне от 0% до 100%). Предыдущий пример в этом виде можно записать как rgb(255,128,128) или rgb(100%,50%,100%).

Вы можете выбрать цвет из таблицы цветов.

Примеры

Можно указывать одновременно оба цвета (как текста, так и фона), но можно и один, по необходимости.

<color blue/lightgrey>синий текст на светло-сером фоне</color>

синий текст на светло-сером фоне

<color blue>синий текст на обычном фоне</color>

синий текст на обычном фоне

<color /lightgrey>обычный текст на светло-сером фоне</color>

обычный текст на светло-сером фоне

comment (скрытый комментарий)

Этот маленький плагин позволяет вам оставлять заметки себе (и другим авторам вашей вики) в исходном вики-коде страниц. Эти заметки не видны на вики-странице. Синтаксис сходен с C и PHP:

Примеры

Текст /* между слэш-астериск и астериск-слэш */ скрыт.

Даёт:

Текст скрыт.

Также вы можете использовать многострочные комментарии:

/**
 * @todo: переписать этот раздел, чтобы отразить изменения, сделанные ранее
 *
 * это длинная заметка
 */

Но этот однострочный пример также работает:

/********** добавлено Esther **********/

definition list (список определений)

Позволяет вставлять в вики-разметку списки определений. Это один из нескольких плагинов подобного рода, но он отличается простым синтаксисом.

Синтаксис

Список определений создаётся из одной и более строк в формате, показанном ниже:

  ; термин : определение
  ; второй термин
  : второе определение

термин: определение
второй термин: второе определение

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

Строки могут использоваться в любом порядке. Единственным требованием является то, что список должен начинаться с одной из двух строк (показанных выше), начинающихся с точки с запятой »;». Список заканчивается полностью пустой строкой.

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

Здесь вы можете увидеть плагин в действии.

folded (сворачивание)

Данный плагин позволяет на странице сворачивать и разворачивать содержимое, которое может быть как фрагментом абзаца, так и блоком текста.

Встроенное в абзац:

Это пример ++текста | с частью, которую вы можете увидеть только развернув её++. И после этого
текст просто продолжает абзац.

Это пример текста с частью, которую вы можете увидеть только развернув её. И после этого текст просто продолжает абзац.

Блочное:

Это пример текста.

++++ Заголовок |

| Эта таблица | видна только тогда, | когда вы развернёте блок |

{{page>Другая вики-страница}}

++++

Это пример текста.

Заголовок

keyboard (клавиатура)

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

Синтаксис

Заключите имя клавиши или комбинации клавиш (разделённых дефисом (-)) в тэг <key>...</key>, например так:

<key>клавиша</key> или <key>C-x</key>

Текст внутри тэга key разделяется сиволом - (дефис).
Каждая часть обрезается (удаляются окружающие пробелы) и подставляются известные сокращения или имена клавиш. Так, C становится Ctrl, Left становится ← и т.п.
Подстановки зависят от языка. Так, например, в немецком, C становится Strg и Del становится Entf. На данный момент поддерживаются только английский и немецкий языки. Вы можете свободно написать дополнительные языковые файлы и послать их для включения в будущие версии плагина.
Если подстановки не найдены, первая буква делается прописной и специальные HTML-символы заменяются на сущности.
Таблица подстановки содержит только клавиши, начинающиеся с прописной буквы. Так, строчные буквы не будут заменены при подстановке, они только станут прописными, к примеру, C-c станет Ctrl-C.
Если вы хотите выразить клавишу 'дефис' (-), используйте Minus.
Если вам не нужна никакая обрезка, подстановка, перевод букв в прописные, заключите имя клавиши в одинарные кавычки.

Примеры

Нажмите Ctrl+Alt+Del для перезагрузки. (<key>C-A-del</key>)
Нажмите Ctrl+C, чтобы скопировать текст в буфер обмена. (<key>C - c</key>)
Нажмите Ctrl+X, чтобы вырезать текст и поместить его в буфер обмена. (<key>C-x</key>)
Нажмите Ctrl+V, чтобы вставить текст из буфера обмена. (<key>C-v</key>)
Нажмите Ctrl+Enter, чтобы вставить разрыв страницы. (<key>C-enter</key>)
Нажмите Ctrl+Shift+→, чтобы выделить от текущей позиции курсора до конца слова. (<key>C-S-Right</key>)
Нажмите Ctrl+Shift+←, чтобы выделить от текущей позиции курсора до начала слова. (<key>C-S-Left</key>)
Нажмите Ctrl+Page↑, чтобы переместиться на один экран выше. (<key>C-PageUp</key>)
Нажмите Ctrl+− (<key>C-Minus</key>)
Нажмите любую клавишу для выхода. (<key>'любую клавишу'</key>)

note (заметка)

Позволяет вставлять в текст красиво оформленные заметки. Добавляет на панель инструментов 4 кнопки (заметка, лампочка, восклицательный знак, знак 'стоп!').

Примеры

<note>
Это моя заметка! Запомните её!
</note>

Это моя заметка! Запомните её!

<note important>
Внимание! Похоже, Вы лишились ума ;-)
</note>

Внимание! Похоже, Вы лишились ума

<note tip>
Ключ к пониманию --- в картинках.
</note>

Ключ к пониманию — в картинках.

<note warning>
Остерегайтесь злую собаку, когда открываете дверь!
</note>

Остерегайтесь злую собаку, когда открываете дверь!

Wiki

¹⁾ проценты

²⁾ миллиметры

³⁾ сантиметры

⁴⁾ дюймы, 1 дюйм = 2,54 см

⁵⁾ пункты, 1 пункт = 1/72 дюйма

⁶⁾ пайки, 1 пайка = 12 пунктов

⁷⁾ пиксели

⁸⁾ высота шрифта

⁹⁾ высота буквы x