====== Синтаксис форматирования ======
DokuWiki поддерживает простой язык разметки, который по возможности сохраняет файлы данных как можно более читабельными! Здесь перечислены все возможные синтаксические конструкции, которые можно использовать при редактировании страниц. Просто посмотрите на исходный код этой странцы, нажав кнопку Отредактировать страницу вверху или внизу страницы. Если хотите поупражняться, используйте [[playground:playground|песочницу]]. Простую разметку также можно легко сделать с помощью [[quickbuttons|панели инструментов]]
===== Основные конструкции форматирования =====
DokuWiki поддерживает выделение текста **жирным шрифтом**, //курсивом//, __подчеркнутый текст__ и вывод текста ''моноширинным шрифтом''. Все эти конструкции можно **__//''объединить''//__**.
DokuWiki поддерживает выделение текста **жирным шрифтом**, //курсивом//,
__подчеркнутый текст__ и вывод текста ''моноширинным шрифтом''.
Все эти конструкции можно **__//''объединить''//__**.
Также можно использовать подстрочный и надстрочный индексы.
Также можно использовать подстрочный и надстрочный индексы.
Ещё можно зачеркнуть текст.
Ещё можно зачеркнуть текст.
**Параграфы** отбиваются пустой строкой. Если нужно **принудительно вставить перенос строки**, не создавая параграф, вставьте два обратных слэша и за ним пробел или энтер.
Просто текст с разрывом строк\\ Обратите внимание,
что два обратных слэша действуют только в конце строки\\
или если за ними стоит\\ пробел. Если его не поставить, \\получится вот так.
Просто текст с разрывом строк\\ Обратите внимание,
что два обратных слэша действуют только в конце строки\\
или если за ними стоит\\ пробел. Если его не поставить, \\получится вот так.
:!: Принудительные переносы следует использовать только в случае крайней необходимости.
===== Размер шрифта =====
Размер вашего текста, сейчас составляет 12px. Это стандартный размер.
Если вам нужно увеличить текст, повышайте числовое значение, или понижайте, если вам необходимо его уменьшить.
===== Ссылки =====
Ссылки в DokuWiki бывают разные, и создавать их можно тоже по-разному.
===== Ссылки на пространства имен =====
Можно задавать ссылку на файл по умолчанию для пространства имен, заканчивая ссылку двоеточием: %%[[foo:bar:]]%%. На какую страницу указывает ссылка, зависит от наличия файлов с определенными именами. Для %%[[foo:bar:]]%% проверяется существование следующих страниц:
foo:bar:$conf['start']
foo:bar:bar
foo:bar
Страницы проверяются в этом порядке и ссылка указывает на первую найденную.
==== Внешние ====
Внешние ссылки распознаются автоматически: http://www.google.com или
просто www.google.com --- также можно указывать текст ссылки:
[[http://www.google.com|Это ссылка на Google]]. Адреса электронной почты
тоже распознаются: .
Внешние ссылки распознаются автоматически: http://www.google.com или
просто www.google.com --- также можно указывать текст ссылки:
[[http://www.google.com|Это ссылка на Google]]. Адреса электронной почты
тоже распознаются: .
==== Внутренние ====
Внутренние ссылки создаются посредством квадратных скобок.
Можно либо просто указать [[Имя страницы]], либо дополнительно прописать
[[Имя страницы|Текст ссылки]]. Имена Wiki-страниц автоматически
переводятся в нижний регистр, спецсимволы использовать нельзя.
Внутренние ссылки создаются посредством квадратных скобок.
Можно либо просто указать [[Имя страницы]], либо дополнительно прописать
[[Имя страницы|Текст ссылки]]. Имена Wiki-страниц автоматически
переводятся в нижний регистр, спецсимволы использовать нельзя.
Можно использовать в ссылке [[namespaces]] (пространство имён) через двоеточие.
Можно использовать в ссылке [[namespaces]] (пространство имён) через двоеточие.
Ставить ссылки на определённый раздел тоже можно. Просто добавьте через решётку имя раздела, также как это делается в HTML. Ссылка на [[syntax#внутренние|этот раздел]].
Ссылка на [[syntax#внутренние|этот раздел]].
Примечания:
* Ссылки на [[syntax|существующие страницы]] отображаются иначе, чем ссылки на [[несуществующие]]
* Внутренние ссылки без указанного текста могут отображаться по разному в зависимости от настроек - в качестве текста может использоваться название страницы или заголовок первого уровня((именно такая настройка используется на этом сайте)). Так что лучше каждый раз указывать текст ссылки.
* DokuWiki по умолчанию не использует [[wp>CamelCase]] для автоматического создания ссылок, но эту возможность можно включить в файле [[doku>wiki:config]]. Проверка: Если DokuWiki — ссылка, значит эта возможность включена.
* Если меняется название раздела, ссылки на него не меняются автоматически. Так что не очень полагайтесь на ссылки на разделы.
==== InterWiki ====
DokuWiki поддерживает [[doku>wiki:interwiki|InterWiki]]-ссылки. Это короткие ссылки
на другие Wiki. Например, вот ссылка на страницу Википедии о Wiki: [[wp>Wiki]].
Например, вот ссылка на страницу Википедии о Wiki: [[wp>Wiki]].
==== Виндовые шары ====
Ссылки на виндовые шары вида \\server\share тоже распознаются. Однако учтите, что такие ссылки имеют смысл только в гомогенных группах пользователей, например в корпоративном Интранете.
Ссылки на виндовые шары вида \\server\share тоже распознаются.
Примечания:
* Из соображений безопасности непосредственный просмотр виндовых шар работает по умолчанию только в Internet Explorer (и только в “локальной зоне”).
* В Mozilla и Firefox эту возможность можно включить с помощью опции [[http://www.mozilla.org/quality/networking/docs/netprefs.html#file|security.checkloaduri]], но делать это не рекомендуется.
* Подробней читайте здесь: [[bug>151]].
==== Картинки-ссылки ====
Совместив синтаксис ссылки и [[syntax#картинки и другие файлы|картинки]], можно вставить в текст картинку, которая будет внутренней или внешней ссылкой:
[[http://www.php.net|{{dokuwiki-128.png}}]]
[[http://www.php.net|{{dokuwiki-128.png}}]]
Учтите: форматирование картинок это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки.
==== Сноски ====
С помощью двойных скобок можно добавить сноску((Это сноска)).
С помощью двойных скобок можно добавить сноску ((Это сноска)).
===== Разбивка на разделы =====
Для структурирования текста можно использовать до пяти уровней заголовков. Если в тексте больше трёх заголовков, автоматически создаётся список содержимого. Его можно отключить, вставив в документ строку %%~~NOTOC~~%%.
==== Заголовок 3-го уровня ====
=== Заголовок 4-го уровня ===
== Заголовок 5-го уровня ==
==== Заголовок 3-го уровня ====
=== Заголовок 4-го уровня ===
== Заголовок 5-го уровня ==
Четыре и более тире преобразуются в горизонтальную черту:
----
\\
----
===== Картинки и другие файлы =====
С помощью фигурных скобок можно вставлять в текст внешние и внутренние [[doku>wiki:images|картинки]]. По желанию можно указать их размер.
Нормальный размер: {{dokuwiki-128.png}}
Отмасштабированная до заданной ширины: {{dokuwiki-128.png?50}}
Отмасштабированная до заданных размеров: {{dokuwiki-128.png?200x50}}
Отмасштабированная внешняя картинка: {{http://de3.php.net/images/php.gif?200x50}}
Нормальный размер: {{dokuwiki-128.png}}
Отмасштабированная до заданной ширины: {{dokuwiki-128.png?50}}
Отмасштабированная до заданных размеров: {{dokuwiki-128.png?200x50}}
Отмасштабированная внешняя картинка: {{http://de3.php.net/images/php.gif?200x50}}
Поставив слева или справа пробел можно задать выравнивание картинки:
{{dokuwiki-128.png }}
{{ dokuwiki-128.png}}
{{ dokuwiki-128.png }}
{{dokuwiki-128.png }}
{{ dokuwiki-128.png}}
{{ dokuwiki-128.png }}
И, конечно, картинке можно задать название (в большинстве браузеров оно отображается в виде всплывающей подсказки).
{{ dokuwiki-128.png |Название картинки}}
{{ dokuwiki-128.png |Название картинки}}
Если задать имя файла (внутреннее или внешнее), который не является картинкой (''gif, jpeg, png''), оно будет отображаться в виде ссылки.
Узнать, как вставить картинку со ссылкой можно в [[syntax#картинки-ссылки|разделе выше]].
===== Работа с плагином ImagBox =====
[{{ :wiki:dokuwiki-128.png|Ваш текст Ваш Текст Ваш текст}}]
Хотите такую картинку, как справа с текстом внизу?
Используйте следующий код:
[{{:wiki:dokuwiki-128.png|Ваш текст Ваш текст Ваш Текст}}]
Основное отличие от описанного выше - сперва идет квадратная скобочка, потом две фигурных. Форматирование справа-слева осуществляется без особенностей.
===== Списки =====
Dokuwiki поддерживает нумерованные и ненумерованные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и потом * в случае ненумерованного списка, или - в случае нумерованного.
* Это список
* Второй элемент списка
* Можно сделать вложенный список
* Ещё один элемент
- Тот же список, только нумерованный
- Ещё элемент
- Чем больше пробелов в начале, тем глубже вложенность
- Всё просто
* Это список
* Второй элемент списка
* Можно сделать вложенный список
* Ещё один элемент
- Тот же список, только нумерованный
- Ещё элемент
- Чем больше пробелов в начале, тем глубже вложенность
- Всё просто
===== Смайлики =====
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 может переделывать символы, набранные простым текстом, в их типографски корректные эквиваленты. Распознаются следующие символы.
-> <- <-> => <= <=> >> << -- --- '640x480' (c) (tm) (r)\\
"Владимир Владимирович(tm) --- это наше всё (c) не я"
-> <- <-> => <= <=> >> << -- --- '640x480' (c) (tm) (r)
"Владимир Владимирович(tm) --- это наше всё (c) не я"
Примечание: Это конвертирование можно отключить в файле конфигурации.
===== Таблицы =====
DokuWiki поддерживает упрощённый синтаксис создания таблиц.
^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^
| Ряд 1 Колонка 1 | Ряд 1 Колонка 2 | Ряд 1 Колонка 3 |
| Ряд 2 Колонка 1 | Объединение колонок (обратите внимание на двойную вертикальную черту) ||
| Ряд 3 Колонка 1 | Ряд 2 Колонка 2 | Ряд 2 Колонка 3 |
Нормальные ряды должны начинаться и заканчиваться символом |, а заголовки — ^.
^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^
| Ряд 1 Колонка 1 | Ряд 1 Колонка 2 | Ряд 1 Колонка 3 |
| Ряд 2 Колонка 1 | Объединение колонок (обратите внимание на двойную вертикальную черту) ||
| Ряд 3 Колонка 1 | Ряд 2 Колонка 2 | Ряд 2 Колонка 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) не поддерживается.
Текст клетки таблицы можно выравнивать. Просто добавьте минимум два пробела с противоположной стороны: слева — если надо выравнять вправо, справа – если надо выравнять влево, и по два с каждой стороны — если по центру.
^ Таблица с выравниванием ^^^
| вправо| по центру |влево |
|влево | вправо| по центру |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
^ Таблица с выравниванием ^^^
| вправо| по центру |влево |
|влево | вправо| по центру |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
===== Неформатируемые блоки =====
Неформатируемые блоки можно вставлять в документ, либо начиная каждую строчку блока с двух или более пробелов (как это делалось в некоторых предыдущих примерах), либо используя тэги ''%%%%'' или ''%%%%''.
Это неформатированный текст, в котором сохранены все пробелы: вот <- так.
В принципе то же самое, но этим выделением можно показать,
что цитируется содержимое файла.
Чтобы парсер полностью проигнорировал некий текст (т.е. не форматировал его), либо заключите его в тэги ''nowiki'', либо ещё проще — в двойные знаки процента ''%%''.
Это просто текст, в котором есть адрес %%http://www.splitbrain.org%%
и %%**форматирование**%% --- но ничего не происходит.
Это просто текст, в котором есть адрес %%http://www.splitbrain.org%%
и %%**форматирование**%% --- но ничего не происходит.
Чтобы увидеть, как используются эти блоки, смотрите код страницы.
===== Подсветка синтаксиса =====
DokuWiki может подсвечивать программный код, чтобы его было проще читать. Для этого используется библиотека [[http://qbnz.com/highlighter/|GeSHi]] — соответственно подсвечиваются все языки, поддерживаемые GeSHi. Синтаксис такой же, как и в блоке ''code'' в предыдущем разделе, но на этот раз внутри тэга добавляется название языка. Например %%%%.
/**
* 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//
====== Дополнительное форматирование ======
На этом сайте установлены модули, которые расширяют стандартное форматирование DokuWiki.
===== Выделение цветом (маркер) =====
Текст можно выделять цветом.
Цвет по умолчанию может быть заменён на какой-либо другой,
например красный или голубой.
Текст можно выделять цветом.
Цвет по умолчанию может быть заменён на какой-либо другой,
например красный или голубой.
===== Форматирование химических формул =====.
С помощью плагина **chem** простые химические формулы форматируются автоматически, например: 10C2H5OH, 2H3PO4, Al(OH)3, Fe3+, 15[Cat]3|2+[Anion]2|3-
10C2H5OH, 2H3PO4, Al(OH)3, Fe3+, 15[Cat]3|2+[Anion]2|3-
==== Баги ====
* Символ '+' в выражениях: 2H2 + O2 -> 2H2O
* Некорректно отображается степень окисления - H+1, P+5, O-2
* Невозможно ввести обозначения изотопов (цифры всегда трактуются как формульный индекс): 238Pu (задачка неразрешима без введения специального символа, например '^': 238^Pu).
===== Заметки =====
Плагин **Note** позволяет легко оформлять всевозможные комментарии и заметки:
обычная заметка
заметка-подсказка
важная заметка
заметка-предупреждение
обычная заметка
заметка-подсказка
важная заметка
заметка-предупреждение
===== Дискуссии =====
Для управление дискуссией, необходимо вставить следующие коды внизу страницы:
~~DISCUSSION~~
~~DISCUSSION:off~~
~~DISCUSSION:closed~~
~~DISCUSSION|Custom Title String~~
~~DISCUSSION:closed|Custom Title String~~
===== YouTube =====
=====Summary=====
This DokuWiki plugin creates a link and embed a YouTube movie in an Wiki page. User can embed movies just input the movie ID with simple syntax as same as [[:syntax#images_and_other_files]].
Check also the Jason's YouTube plugin ver.2 -> [[youtubev2]] \\
=====How to use=====
You can display a YouTube movie by setting the '**command**' and the '**ID**' code. You can align the movie object by using whitespaces before/after brackets.
**%%{{youtube>(command):(ID code)|(title)}}%%**
\\ \\
----
**Commands**\\
^ link | Displays a link icon only. |
^ small | Displays a small YouTube movie.|
^ large | Displays a large YouTube movie.|
**ID code**\\ You can find the ID code in the YouTube site.\\
**Title**\\
You can define a title of movie by putting on a pipe '|' after ID. It's optional.
**Alignment**\\
Use white spaces for alignment of YouTube movie object. Syntax is same as [[http://www.dokuwiki.org/wiki:syntax?#images_and_other_files|images]].
^ default |%%{{youtube>small:XXXXXX}}%% |
^ right | %%{{ youtube>small:XXXXXX}}%%|
^ left |%%{{youtube>small:XXXXXX }}%% |
^ center | %%{{ youtube>small:XXXXXX }}%% |
=====Example=====
Wiki syntax
{{youtube>link:MJj5XWQHUFE}} -> Creates a link to YouTube
{{youtube>small:MJj5XWQHUFE}} -> Creates a small movie object.
{{youtube>large:MJj5XWQHUFE}} -> Creates a large movie object.
Alignments (same as image alignment)
{{youtube>small:MJj5XWQHUFE }} -> Align to left
^
{{ youtube>link:MJj5XWQHUFE}} -> Align to right
^
{{ youtube>link:MJj5XWQHUFE }} -> Centering
^ ^
=====Discussion=====
Good plugin, thanks!
Whether it is possible to add an opportunity to do signatures and to place window on page on the right, at the left or on the center?
Something like: %%{{youtube>small?right:xxxxxxxxx|Comment}}%%
--- //[[ka2pink@gmail.com|Aleksej KUZNECOV]] 2008/03/30 22:53//
Thanks, Aleksej. The plugin was upgraded. Right/left alignment can be written like this.
%%{{ youtube>small:xxxxxxxxx}}%%
%%{{youtube>small:xxxxxxxxx }}%%
===== Redirect =====
=== Синтаксис ===
Поместите строку GOTO в любом месте документа. Укажите страницу для пере направления.
1) ~~GOTO>wiki:syntax~~
~~GOTO>корень:страница~~
Чаще всего ссылка будет иметь такой вид:
2) ~~GOTO>:страница~~
На нашей вики используется только несколько корней пространства имён в_тылу_врага, в_тылу_врага_2. Остальные страницы, находятся в пространстве имён без корня, т.с. ссылка на них будет иметь такой вид: способ 2
=== Перенаправление с задержкой: ===
~~GOTO>wiki:syntax?15~~
==== Обратные ссылки ====
=== Syntax ===
Пожалуйста, при создании новой страницы, делайте обратную ссылку на предведущую и главную страницу.
The syntax is as follows:
{{backlinks>wiki:page}}
You can list the backlinks to the current page by using:
{{backlinks>.}}
==== Плагин PageList ====
http://www.dokuwiki.org/plugin:pagelist