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

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


wiki:syntax

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


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

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

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

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

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

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

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

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

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

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

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

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

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

Ссылки

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> тоже распознаются.

Внутренние

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

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

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

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

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

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

Можно ссылаться на конкретный раздел, добавив имя раздела после символа #, как в HTML. Например: этот раздел.

Эта ссылка ведёт на [[syntax#internal|этот раздел]].

Примечания:

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

Интервики

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

DokuWiki поддерживает ссылки [[doku>Interwiki]]. Это быстрые ссылки на другие вики.
Например: [[wp>Wiki]].

Windows‑ресурсы

Ресурсы Windows вроде этого тоже распознаются. Но они имеют смысл только в однородной группе пользователей, например корпоративном интранете.

Ресурсы Windows вроде [[\\server\share|этого]] тоже распознаются.

Примечания:

  • По соображениям безопасности прямой доступ к Windows‑ресурсам работает только в Internet Explorer (и только в «локальной зоне»).
  • В Mozilla/Firefox это можно включить через обходные пути, описанные в базе знаний Mozilla. Но предупреждение JavaScript всё равно будет. Чтобы убрать его для всех пользователей, добавьте в conf/lang/en/lang.php:
conf/lang/en/lang.php
    <?php
    /**
     * Настройка английского языкового файла
     * Копируйте только строки, которые нужно изменить
     */
    $lang['js']['nosmblinks'] = '';
    

Ссылки‑картинки

Можно использовать изображение как ссылку, комбинируя синтаксис ссылок и изображений:

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

Учтите: форматирование изображения — единственный вид форматирования, допустимый в тексте ссылки.

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

Сноски

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

Вы можете добавлять сноски ((Вот такая сноска)).

Разделение

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

Заголовок уровня 3

Заголовок уровня 4

Заголовок уровня 5
==== Заголовок уровня 3 ====
=== Заголовок уровня 4 ===
== Заголовок уровня 5 ==

Четыре или более дефисов создают горизонтальную линию:


Медиафайлы

Можно вставлять внешние и внутренние изображения, видео и аудио в фигурных скобках. Можно указывать размер.

Исходный размер:

Изменить ширину:

Изменить ширину и высоту2):

Внешнее изображение с изменением размера:

Исходный размер:                 {{wiki:dokuwiki-128.png}}
Изменить ширину:                 {{wiki:dokuwiki-128.png?50}}
Изменить ширину и высоту:        {{wiki:dokuwiki-128.png?200x50}}
Внешнее изображение:             {{https://www.php.net/images/php.gif?200x50}}

Пробелы слева/справа задают выравнивание.

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Можно добавить заголовок (подсказку):

Это подпись

{{ wiki:dokuwiki-128.png |Это подпись}}

См. Image Links для ссылок‑картинок.

Поддерживаемые форматы

DokuWiki может встраивать следующие форматы:

Изображения gif, jpg, png
Видео webm, ogv, mp4
Аудио ogg, mp3, wav
Flash swf

Если формат не поддерживается, будет показана ссылка.

?linkonly создаёт только ссылку:

{{wiki:dokuwiki-128.png?linkonly}}

dokuwiki-128.png Это просто ссылка.

Запасные форматы

Не все браузеры поддерживают все форматы. Чтобы повысить совместимость, загрузите файл в нескольких форматах.

Например:

{{video.mp4|Забавное видео}}

Если рядом лежат video.webm и video.ogv, они будут добавлены автоматически.

Можно добавить «постер» — изображение video.jpg или video.png.

Списки

DokuWiki поддерживает маркированные и нумерованные списки. Для элемента списка отступите две позиции и используйте * или -.

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

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

См. также FAQ по спискам.

Преобразования текста

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

Преобразование текста в изображения

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 © ™ ® «He thought 'It's a man's world'…»

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

Исключения: умножение (640×480), одинарные и двойные кавычки — отключаются в config:typography.

Цитирование

Иногда нужно показать ответ или комментарий:

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 поддерживает простой синтаксис таблиц.

Заголовок 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

Rowspan:

Заголовок 1 Заголовок 2 Заголовок 3
Строка 1,1 ячейка тянется вниз Строка 1,3
Строка 2,1 Строка 2,3
Строка 3,1 Строка 3,3

Выравнивание:

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

Без форматирования

Если нужно отобразить текст ровно так, как он набран (без какого‑либо форматирования), заключите область либо в теги <nowiki>, либо, что ещё проще, используйте двойные знаки процента %%.

This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.

The same is true for //__this__ text// with a smiley ;-).

<nowiki>
This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
</nowiki>
The same is true for %%//__this__ text// with a smiley ;-)%%.

Блоки кода

Блоки кода создаются отступом в две позиции или тегами <code> и <file>.

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

Исходный код:

  Этот текст имеет отступ.
<code>
Это предварительно форматированный код, все пробелы сохраняются: вот              <-так
</code>
<file>
То же самое, но используется для отображения содержимого файла.
</file>

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

DokuWiki может подсвечивать исходный код с помощью GeSHi. Используйте теги с указанием языка: <code java> или <file java>.

/**
 * Класс HelloWorldApp выводит "Hello World!".
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!");
    }
}

Список поддерживаемых языков: 4cs 6502acme … yaml z80 zxbasic

Дополнительные параметры см. syntax_highlighting.

Скачиваемые блоки кода

Можно сделать код доступным для скачивания:

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

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

RSS/ATOM агрегирование

DokuWiki может интегрировать данные из внешних XML‑лент через SimplePie.

Параметр Описание
число максимум элементов, по умолчанию 8
reverse последние элементы первыми
author показывать авторов
date показывать даты
description показывать описание (HTML удаляется)
nosort не сортировать
n[dhm] период обновления

Пример:

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

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

Некоторые конструкции влияют на рендеринг страницы:

Макрос Описание
~~NOTOC~~ отключает оглавление
~~NOCACHE~~ отключает кэширование

Плагины синтаксиса

Синтаксис DokuWiki можно расширять через плагины. Установленные пла

1)
Вот такая сноска
2)
если пропорции не совпадают, изображение будет обрезано
wiki/syntax.1773847113.txt.gz · Последнее изменение: — admin

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki