====== Синтаксис форматирования ======
DokuWiki поддерживает язык разметки, который по возможности сохраняет файлы данных как можно более читабельными. Здесь перечислены все возможные синтаксические конструкции, которые можно использовать при редактировании страниц. Если хотите поупражняться, используйте [[playground:playground|песочницу]]. Простую разметку также можно легко сделать с помощью панели инструментов (открывается в режиме редактирования страницы)
===== Основные конструкции форматирования =====
DokuWiki поддерживает выделение текста **жирным шрифтом**, //курсивом//, __подчеркнутый текст__ и вывод текста ''моноширинным шрифтом''. Все эти конструкции можно **__//''объединить''//__**.
DokuWiki поддерживает выделение текста
**жирным шрифтом**,
//курсивом//,
__подчеркниванием текста__
и вывод текста ''моноширинным шрифтом''.
Все эти конструкции можно **__//''объединить''//__**.
Можно делать текст разного размера:
Обычный текст
текст размером 0.8 от обычного
текст в 1.5 раза больше обычного
Можно делать текст разного размера:
Обычный текст
текст размером 0.8 от обычного
текст в 1.5 раза больше обычного
Также можно использовать подстрочный и надстрочный индексы.
Также можно использовать подстрочный и надстрочный индексы.
Ещё можно зачеркнуть текст.
Ещё можно зачеркнуть текст.
===== Страницы, идентификаторы, ссылки, создание страниц =====
Каждая страница имеет свой уникальный идентификатор. Идентификатор страницы может содержать маленькие русские или английские буквы, цифры, знаки "-", "_". Еще в идентификаторе может быть двоеточие, см. ниже. Идентификатор страницы отображается вверху страницы в квадратных скобках (у этой страницы идентификатор "страница_документации").
Чтобы создать ссылку на другую страницу вики, нужно указать идентификатор страницы в двойных квадратных скобках: [[тестовая_страница_для_документации]]. Можно также сделать ссылку с [[тестовая_страница_для_документации|другим текстом]].
Чтобы создать ссылку на другую страницу вики, нужно указать
идентификатор страницы в двойных квадратных
скобках: [[тестовая_страница_для_документации]]. Можно также сделать
ссылку с [[тестовая_страница_для_документации|другим текстом]].
Чтобы создать новую страницу, нужно сначала создать ссылку на нее, указав идентификатор новой страницы: [[Несуществующая страница для документации]]. После чего можно перейти по этой ссылке и создать страницу. Можно, впрочем, ее и не создавать. При создании страницы ее идентификатор автоматически преобразуется в нижний регистр, пробелы заменяются на "_".
Чтобы создать новую страницу, нужно сначала создать ссылку на нее,
указав идентификатор новой страницы: [[Несуществующая страница для документации]].
После чего можно перейти по этой ссылке и создать страницу. Можно, впрочем,
ее и не создавать. При создании страницы ее идентификатор автоматически
преобразуется в нижний регистр, пробелы заменяются на "_".
Обратите внимание, что ссылки на существующие и несуществующие страницы отображаются по-разному.
===== Разделы (namespace) =====
Разделы (в официальной документации DokuWiki они называются namespace - пространства имен) - это способ группировать разные страницы. Чтобы сделать страницу в разделе, нужно указать идентификатор раздела в идентификаторе страницы, через двоеточие [[тестовый_раздел:тестовая_страница_в_разделе]]. Зайдите [[тестовый_раздел:тестовая_страница_в_разделе|сюда]] и обратите внимание, как изменился блок "Вы находитесь здесь" (вверху). А еще пройдите по ссылке "Все страницы" вверху и посмотрите, как аккуратно страницы группируются
по разделам (не все, конечно, но хотя бы некоторые %%=)%%.
Разделы (в официальной документации DokuWiki они называются namespace -
пространства имен) - это способ группировать разные страницы. Чтобы сделать
страницу в разделе, нужно указать идентификатор раздела в идентификаторе
страницы, через двоеточие [[тестовый_раздел:тестовая_страница_в_разделе]].
Зайдите [[тестовый_раздел:тестовая_страница_в_разделе|сюда]] и обратите внимание,
как изменился блок "Вы находитесь здесь" (вверху). А еще пройдите по ссылке
"Все страницы" вверху и посмотрите, как аккуратно страницы группируются
по разделам (не все, конечно, но хотя бы некоторые %%=)%%.
При создании страницы с разделом раздел создается автоматически.
===== Вложенные разделы =====
Разделы могут быть вложены друг в друга сколько угодно раз. Именно так у нас принято создавать странички с фотоальбомами по пробегам: [[фотоальбомы:2016:20160512_90-й_традиционный_пробег_пушкин-петербург]]
Разделы могут быть вложены друг в друга сколько угодно раз. Именно
так у нас принято создавать странички с фотоальбомами по пробегам:
[[фотоальбомы:2016:20160512_90-й_традиционный_пробег_пушкин-петербург]]
===== Заголовки =====
Для структурирования текста можно использовать до пяти уровней заголовков. Если в тексте больше трёх заголовков 3-го уровня и выше, автоматически создаётся список содержимого. Его можно отключить, вставив в документ строку %%~~NOTOC~~%%.
====== Заголовок 1-го уровня ======
===== Заголовок 2-го уровня =====
==== Заголовок 3-го уровня ====
=== Заголовок 4-го уровня ===
== Заголовок 5-го уровня ==
====== Заголовок 1-го уровня ======
===== Заголовок 2-го уровня =====
==== Заголовок 3-го уровня ====
=== Заголовок 4-го уровня ===
== Заголовок 5-го уровня ==
Четыре и более тире преобразуются в горизонтальную черту:
текст
----
еще текст
текст
----
еще текст
===== Заголовки и названия страниц =====
Если у страницы нет заголовка, то по умолчанию ее идентификатор используется в качестве названия в ссылках и блоке "Вы находитесь здесь": [[тестовая_страница_без_заголовка]]. Если же у страницы есть хотя бы один заголовок, то в качестве названия используется заголовок: [[тестовый_раздел_с_заголовком:тестовая_страница_с_заголовком]]. Заголовок страницы может содержать любые символы и вообще обычно более красивый, чем идентификатор.
===== Ссылки на другие сайты =====
Внешние ссылки распознаются автоматически: http://www.google.com или
просто www.google.com --- также можно указывать текст ссылки:
[[http://www.google.com|Это ссылка на Google]]. Адреса электронной почты
тоже распознаются: .
Внешние ссылки распознаются автоматически: http://www.google.com или
просто www.google.com --- также можно указывать текст ссылки:
[[http://www.google.com|Это ссылка на Google]]. Адреса электронной почты
тоже распознаются: .
Ссылки на внешние сайты, в отличие от ссылок на страницы вики, автоматически выделяются курсивом.
===== Картинки и другие файлы =====
С помощью фигурных скобок можно вставлять в текст картинки, лежащие на других сайтах.
Разумеется, нужна ссылка на оригинал картинки.
Картинка с Яндекс-Фоток: {{https://img-fotki.yandex.ru/get/105765/31216099.e4c/0_fb40c_5c5cb692_L.jpg}}
Картинка с Яндекс-Фоток: {{https://img-fotki.yandex.ru/get/105765/31216099.e4c/0_fb40c_5c5cb692_L.jpg}}
Поставив слева или справа пробел можно задать выравнивание картинки:
{{https://img-fotki.yandex.ru/get/105765/31216099.e4c/0_fb40c_5c5cb692_M.jpg }}
{{ https://img-fotki.yandex.ru/get/105765/31216099.e4e/0_fb476_c78061a1_M.jpg}}
{{ https://img-fotki.yandex.ru/get/151498/31216099.e54/0_fb59e_d8dc9ec7_M.jpg }}
{{https://img-fotki.yandex.ru/get/105765/31216099.e4c/0_fb40c_5c5cb692_M.jpg }}
{{ https://img-fotki.yandex.ru/get/105765/31216099.e4e/0_fb476_c78061a1_M.jpg}}
{{ https://img-fotki.yandex.ru/get/151498/31216099.e54/0_fb59e_d8dc9ec7_M.jpg }}
И, конечно, картинке можно задать название (в большинстве браузеров оно отображается в виде всплывающей подсказки).
{{https://img-fotki.yandex.ru/get/135076/31216099.e4e/0_fb470_972e1790_M.jpg|Белые Ночи 2016}}
{{https://img-fotki.yandex.ru/get/135076/31216099.e4e/0_fb470_972e1790_M.jpg|Белые Ночи 2016}}
Если задать имя файла, который не является картинкой (''gif, jpeg, png''), оно будет отображаться в виде ссылки. "Является или не является" определяется по тексту ссылки, так что для ссылок Яндекса надо явно дописывать ".jpg"
Это правильная ссылка, которая не работает, т.к. не оканчивается на .jpg {{https://img-fotki.yandex.ru/get/105765/31216099.e4d/0_fb46d_55ee430b_M}}
Это правильная ссылка, которая не работает, т.к. не оканчивается на .jpg {{https://img-fotki.yandex.ru/get/105765/31216099.e4d/0_fb46d_55ee430b_M}}
В теории, DokuWiki также поддерживает загрузку картинок непосредственно на наш сайт, но НаБегу эта возможность пока что отключена, т.к. место на хостинге ограничено.
===== Картинки-ссылки =====
Совместив синтаксис ссылки и картинки, можно вставить в текст картинку, которая будет внутренней или внешней ссылкой:
[[https://fotki.yandex.ru/users/pvolan/album/227839/|{{https://img-fotki.yandex.ru/get/25232/31216099.e9d/0_fd699_e3840787_M.jpg}}]]
[[https://fotki.yandex.ru/users/pvolan/album/227839/|{{https://img-fotki.yandex.ru/get/25232/31216099.e9d/0_fd699_e3840787_M.jpg}}]]
Учтите: форматирование картинок это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки.
===== Сноски =====
С помощью двойных скобок можно добавить сноску((Это сноска)).
С помощью двойных скобок можно добавить сноску ((Это сноска)).
===== Списки =====
Dokuwiki поддерживает нумерованные и ненумерованные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и потом * в случае ненумерованного списка, или - в случае нумерованного.
* Это список
* Второй элемент списка
* Можно сделать вложенный список
* Ещё один элемент
- Тот же список, только нумерованный
- Ещё элемент
- Чем больше пробелов в начале, тем глубже вложенность
- Всё просто
* Это список
* Второй элемент списка
* Можно сделать вложенный список
* Ещё один элемент
- Тот же список, только нумерованный
- Ещё элемент
- Чем больше пробелов в начале, тем глубже вложенность
- Всё просто
===== Типографские символы =====
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 |
Можно сделать вертикально объединённые ячейки добавлением трёх двоеточий '':::'' в объединяемые нижележащие ячейки.
^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^
| Ряд 1 Колонка 1 | эта ячейка объединена вертикально | Ряд 1 Колонка 3 |
| Ряд 2 Колонка 1 | ::: | Ряд 2 Колонка 3 |
| Ряд 3 Колонка 1 | ::: | Ряд 2 Колонка 3 |
В этих ячейках не должно быть ничего, кроме синтаксиса объединения ('':::'').
^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^
| Ряд 1 Колонка 1 | эта ячейка объединена вертикально | Ряд 1 Колонка 3 |
| Ряд 2 Колонка 1 | ::: | Ряд 2 Колонка 3 |
| Ряд 3 Колонка 1 | ::: | Ряд 2 Колонка 3 |
Текст клетки таблицы можно выравнивать. Просто добавьте минимум два пробела с противоположной стороны: слева — если надо выравнять вправо, справа – если надо выравнять влево, и по два с каждой стороны — если по центру.
^ Таблица с выравниванием ^^^
| вправо| по центру |влево |
|влево | вправо| по центру |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
^ Таблица с выравниванием ^^^
| вправо| по центру |влево |
|влево | вправо| по центру |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
===== Неформатируемые блоки =====
Неформатируемые блоки можно вставлять в документ, либо начиная каждую строчку блока с двух или более пробелов (как это делалось в некоторых предыдущих примерах), либо используя тэги ''%%%%'' или ''%%%%''. При этом пробелы в начале строки являются эквивалентом применения тега ''%%%%'' к одной строке, но без подсветки кода. Если несколько подряд идущих строк начинаются более чем с одного пробела, они объединяются в один блок ''%%%%''.
Пример использования ''%%%%''..''%%
%%''.
Это неформатированный текст, в котором сохранены все пробелы: вот <- так.
Пример использования ''%%%%''..''%%%%''.
В принципе то же самое, но этим выделением можно показать,
что цитируется содержимое файла.
Чтобы парсер полностью проигнорировал некий текст (т.е. не форматировал его), либо заключите его в тэги ''%%%%'', либо ещё проще — в двойные знаки процента ''%%''.
Это просто текст, в котором есть адрес %%http://www.splitbrain.org%%
и %%**форматирование**%% --- но ничего не происходит.
Это просто текст, в котором есть адрес %%http://www.splitbrain.org%%
и %%**форматирование**%% --- но ничего не происходит.
Чтобы увидеть, как используются эти блоки, смотрите код страницы.