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

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


doc:dokuwiki

Работа с dokuwiki

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

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

Основы форматирования

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

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

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

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

Вы можете перечеркнуть какой-нибудь текст.

Вы можете <del>перечеркнуть</del> какой-нибудь текст.

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

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

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

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

Ссылки

В DokuWiki ссылки можно создавать различными способами.

Внешние

Внешние ссылки распознаются автоматически: http://www.google.com или просто www.google.com Также можно давать ссылкам названия - Эта ссылка на Google. Электронные адреса работают так же: azamat@airrb.ru

Внешние ссылки распознаются автоматически: http://www.google.com или просто www.google.com 
Также можно давать ссылкам названия - [[http://www.google.com|Эта ссылка на Google]].
Электронные адреса работают так же: <azamat@airrb.ru>

Внутренние

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

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

Вы можете использовать пространство_имен с помощью двоеточия.

Вы можете использовать [[namespaces|пространство_имен]] с помощью двоеточия.

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

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

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

Примечание:

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

Интервики

DokuWiki поддерживает и интервики - быстрые ссылки на другие Вики-сайты. Например, эта ссылка ведет на страницу в Википедии о Вики: Wiki.

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

Общие ресурсы Windows

Ресурсы Windows (например такой) тоже распознаются. Помните, что это применимо только для локальных сетей интранета.

Ресурсы Windows ([[\\otpfserv\Music|например такой]]) тоже распознаются.

Примечания:

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

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

На изображения можно ссылаться, как с внутренних, так и с внешних источников, путем сочетания ссылок и изображений (см. ниже), как показано ниже:

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

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

Весь синтаксис для изображений и ссылок (включая изменение размера изображения, внешние и внутренние изображения, URL и интервики-ссылки) может быть использован.

Сноски

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

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

Разделы

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

Заголовок третьего уровня

Заголовок четвертого уровня

Заголовок пятого уровня
==== Заголовок третьего уровня ====
=== Заголовок четвертого уровня ===
== Заголовок пятого уровня ==

Указав четыре или более дефиса, вы получите горизонтальную линию:


Изображения и другие файлы

Вы можете использовать внешние и внутренние wiki:изображения с помощью фигурных скобок. Также вы можете указать размер для них.

Настоящий размер:

Размер с указанной шириной:

Размер с указанными шириной и высотой:

Изменение размера внешнего изображения:

Настоящий размер:                        {{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 }}

Конено же вы можете указать название изображения (отображаемое в подсказке браузера.

Это название изображения

{{ wiki:dokuwiki-128.png |Это название изображения}}

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

Для создания ссылки изображения в странице см. ниже Ссылки на изображение.

Списки

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

  • Это список
  • Второй элемент
    • Можно изменить уровень вложенности
  • Другой элемент
  1. Тот же список, но упорядоченный
  2. Другой элемент
    1. Погружаемся на уровень ниже
  3. Вот и все
  * Это список
  * Второй элемент
    * Можно изменить уровень вложенности
  * Другой элемент

  - Тот же список, но упорядоченный
  - Другой элемент
    - Погружаемся на уровень ниже
  - Вот и все

Смайлики

DokuWiki конвертирует распространенные смайлики в их графический эквивалент. Большинство смайликов размещено в каталоге smiley и настраивается в файле conf/smileys.conf. Вот некоторые из них.

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

Типографика

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

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® «Он считал, что это 'Мир для людей'…»

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"Он считал, что это 'Мир для людей'..."

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

Цитирование

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

Я думаю, лучше сделать это

> Нет, не надо

>> А я сказал, надо

> Правда?

>> Да!

>>> Тогда сделаем!

Я думаю, лучше сделать это

> Нет, не надо

А я сказал, надо

Правда?

Да!
Тогда сделаем!

Таблицы

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 |

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

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

Таблица с выравниванием
справа в центре слева
слева справа в центре
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Как это выглядит:

^           Таблица с выравниванием        ^^^
|        справа|   в центре   |слева         |
|слева         |        справа|    в центре  |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Нераспознаваемые парсером блоки

Вы можете указать блоки, которые не будут распознаваться парсером, либо добавив впереди два пробела (как в предыдущих примерах), либо с помощью тега code или file.

Это преформатированный код с сохранением всех           <-вот этих пробелов
А вот это тоже самое, но вы можете использовать это как в файле.  

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

Это текст, содержащий адрес this: http://www.splitbrain.org и **форматирование**, но с ними ничего не произошло

См. исходный текст этой страницы, чтобы понять как это сделать.

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

DokuWiki может подсвечивать синтаксис исходного текста, делая его проще для восприятия. При это используется GeSHi (Generic Syntax Highlighter) - поэтому любой поддерживаемый GeSHi синтаксис также поддерживается. Синтаксис выглядит так же, как в блоках кода из предыдущего раздела, но на этот раз необходимо указать используемый язык внутри тега. Например, <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-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

Включение блоков HTML и PHP

Вы можете вставлять сырой HTML или PHP код внутри документов, используя теги html или php как приведено ниже:

<html>
Это <font color="red" size="+1">HTML</font>
</html>

<html> Это <font color=«red» size=«+1»>HTML</font> </html>

<php>
echo 'Лого, созданное PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
</php>

<php> echo 'Лого, созданное PHP:'; echo '<img src=«' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '» alt=«PHP Logo !» />'; </php>

Примечание: HTML- и PHP-включения отключены по умолчанию в настройках. Если они выключены, то код будет отображаться, а не выполняться.

Плагины

Синтаксис DokuWiki может быть расширен плагинами. Установка описана в подходящем для этого месте. См. Плагины для описания работы с ними.

1)
Вот это сноска
/var/www/wiki.itcall.ru/data/pages/doc/dokuwiki.txt · Последнее изменение: d.m.Y H:i — 127.0.0.1