Здесь показаны различия между двумя версиями данной страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
wiki:syntax [28.10.2016 20:47] admin |
— (текущий) | ||
---|---|---|---|
Строка 1: | Строка 1: | ||
- | ====== Синтаксис форматирования ====== | ||
- | |||
- | DokuWiki поддерживает язык разметки, который по возможности сохраняет файлы данных как можно более читабельными. Здесь перечислены все возможные синтаксические конструкции, которые можно использовать при редактировании страниц. Если хотите поупражняться, используйте [[playground:playground|песочницу]]. Простую разметку также можно легко сделать с помощью панели инструментов (открывается в режиме редактирования страницы) | ||
- | |||
- | ===== Основные конструкции форматирования ===== | ||
- | |||
- | DokuWiki поддерживает выделение текста **жирным шрифтом**, //курсивом//, __подчеркнутый текст__ и вывод текста ''моноширинным шрифтом''. Все эти конструкции можно **__//''объединить''//__**. | ||
- | |||
- | <code> | ||
- | DokuWiki поддерживает выделение текста | ||
- | **жирным шрифтом**, | ||
- | //курсивом//, | ||
- | __подчеркниванием текста__ | ||
- | и вывод текста ''моноширинным шрифтом''. | ||
- | Все эти конструкции можно **__//''объединить''//__**. | ||
- | </code> | ||
- | |||
- | Также можно использовать <sub>подстрочный</sub> и <sup>надстрочный</sup> индексы. | ||
- | |||
- | <code> | ||
- | Также можно использовать <sub>подстрочный</sub> и <sup>надстрочный</sup> индексы. | ||
- | </code> | ||
- | |||
- | Ещё можно <del>зачеркнуть текст</del>. | ||
- | |||
- | <code> | ||
- | Ещё можно <del>зачеркнуть текст</del>. | ||
- | </code> | ||
- | |||
- | |||
- | ===== Страницы, идентификаторы, ссылки, создание страниц ===== | ||
- | |||
- | Каждая страница имеет свой уникальный идентификатор. Идентификатор страницы может содержать маленькие русские или английские буквы, цифры и знак "_". Еще в идентификаторе может быть двоеточие, см. ниже. Идентификатор страницы отображается вверху страницы в квадратных скобках (у этой страницы идентификатор wiki:syntax). | ||
- | |||
- | Чтобы создать ссылку на другую страницу вики, нужно указать идентификатор страницы в двойных квадратных скобках: [[тестовая_страница_для_документации]]. Можно также сделать ссылку с [[тестовая_страница_для_документации|с другим текстом]]. | ||
- | |||
- | <code>Чтобы создать ссылку на другую страницу вики, нужно указать идентификатор страницы в двойных квадратных скобках: [[тестовая_страница_для_документации]]. Можно также сделать ссылку с [[тестовая_страница_для_документации|с другим текстом]].</code> | ||
- | |||
- | Чтобы создать новую страницу, нужно сначала создать ссылку на нее, указав идентификатор новой страницы: [[несуществующая страница для документации]]. После чего можно перейти по этой ссылке и создать страницу. Можно, впрочем, ее и не создавать. При создании страницы ее идентификатор автоматически преобразуется в нижний регистр, пробелы заменяются на "_". | ||
- | |||
- | <code>Чтобы создать новую страницу, нужно сначала создать ссылку на нее, указав идентификатор новой страницы: [[несуществующая страница для документации]]. После чего можно перейти по этой ссылке и создать страницу. Можно, впрочем, ее и не создавать. При создании страницы ее идентификатор автоматически преобразуется в нижний регистр, пробелы заменяются на "_".</code> | ||
- | |||
- | Обратите внимание, что ссылки на существующие и несуществующие страницы отображаются по-разному. | ||
- | |||
- | ===== Ссылки ===== | ||
- | |||
- | Ссылки в DokuWiki бывают разные, и создавать их можно тоже по-разному. | ||
- | |||
- | ==== Внешние ==== | ||
- | |||
- | Внешние ссылки распознаются автоматически: http://www.google.com или | ||
- | просто www.google.com --- также можно указывать текст ссылки: | ||
- | [[http://www.google.com|Это ссылка на Google]]. Адреса электронной почты | ||
- | тоже распознаются: <andi@splitbrain.org>. | ||
- | |||
- | <code>Внешние ссылки распознаются автоматически: http://www.google.com или | ||
- | просто www.google.com --- также можно указывать текст ссылки: | ||
- | [[http://www.google.com|Это ссылка на Google]]. Адреса электронной почты | ||
- | тоже распознаются: <andi@splitbrain.org>.</code> | ||
- | |||
- | |||
- | ==== Внутренние ==== | ||
- | |||
- | Внутренние ссылки создаются посредством квадратных скобок. | ||
- | Можно либо просто указать [[Идентификатор страницы]], либо дополнительно прописать | ||
- | [[Идентификатор страницы|Текст ссылки]]. Имена Wiki-страниц автоматически | ||
- | переводятся в нижний регистр, спецсимволы использовать нельзя. | ||
- | |||
- | <code>Внутренние ссылки создаются посредством квадратных скобок. | ||
- | Можно либо просто указать [[Идентификатор страницы]], либо дополнительно прописать | ||
- | [[Идентификатор страницы|Текст ссылки]]. Имена Wiki-страниц автоматически | ||
- | переводятся в нижний регистр, спецсимволы использовать нельзя.</code> | ||
- | |||
- | Можно использовать в ссылке [[namespaces]] (пространство имён) через двоеточие. | ||
- | |||
- | <code>Можно использовать в ссылке [[namespaces]] (пространство имён) через двоеточие.</code> | ||
- | |||
- | Ставить ссылки на определённый раздел тоже можно. Просто добавьте через решётку имя раздела, также как это делается в HTML. Ссылка на [[syntax#внутренние|этот раздел]]. | ||
- | |||
- | <code>Ссылка на [[syntax#внутренние|этот раздел]].</code> | ||
- | |||
- | Примечания: | ||
- | |||
- | * Ссылки на [[syntax|существующие страницы]] отображаются иначе, чем ссылки на [[несуществующие страницы]] | ||
- | * Внутренние ссылки без указанного текста могут отображаться по разному в зависимости от настроек - в качестве текста может использоваться название страницы или заголовок первого уровня((именно такая настройка используется на этом сайте)). Так что лучше каждый раз указывать текст ссылки. | ||
- | * DokuWiki по умолчанию не использует [[wp>CamelCase]] для автоматического создания ссылок, но эту возможность можно включить в файле [[doku>wiki:config]]. Проверка: Если DokuWiki — ссылка, значит эта возможность включена. | ||
- | * Если меняется название раздела, ссылки на него не меняются автоматически. Так что не очень полагайтесь на ссылки на разделы. | ||
- | |||
- | |||
- | |||
- | ===== Картинки и другие файлы ===== | ||
- | |||
- | С помощью фигурных скобок можно вставлять в текст внешние и внутренние [[doku>wiki:images|картинки]]. По желанию можно указать их размер. | ||
- | |||
- | Нормальный размер: {{dokuwiki-128.png}} | ||
- | |||
- | Отмасштабированная до заданной ширины: {{dokuwiki-128.png?50}} | ||
- | |||
- | Отмасштабированная до заданных размеров:{{dokuwiki-128.png?200x50}} | ||
- | |||
- | Отмасштабированная внешняя картинка: {{http://de3.php.net/images/php.gif?200x50}} | ||
- | |||
- | <code> | ||
- | Нормальный размер: {{dokuwiki-128.png}} | ||
- | Отмасштабированная до заданной ширины: {{dokuwiki-128.png?50}} | ||
- | Отмасштабированная до заданных размеров: {{dokuwiki-128.png?200x50}} | ||
- | Отмасштабированная внешняя картинка: {{http://de3.php.net/images/php.gif?200x50}} | ||
- | </code> | ||
- | |||
- | Поставив слева или справа пробел можно задать выравнивание картинки: | ||
- | |||
- | {{dokuwiki-128.png }} | ||
- | {{ dokuwiki-128.png}} | ||
- | {{ dokuwiki-128.png }} | ||
- | |||
- | <code>{{dokuwiki-128.png }} | ||
- | {{ dokuwiki-128.png}} | ||
- | {{ dokuwiki-128.png }} | ||
- | </code> | ||
- | |||
- | И, конечно, картинке можно задать название (в большинстве браузеров оно отображается в виде всплывающей подсказки). | ||
- | |||
- | {{ dokuwiki-128.png |Название картинки}} | ||
- | |||
- | <code>{{ dokuwiki-128.png |Название картинки}}</code> | ||
- | |||
- | Если задать имя файла (внутреннее или внешнее), который не является картинкой (''gif, jpeg, png''), оно будет отображаться в виде ссылки. | ||
- | |||
- | |||
- | |||
- | ==== Картинки-ссылки ==== | ||
- | |||
- | Совместив синтаксис ссылки и [[syntax#картинки и другие файлы|картинки]], можно вставить в текст картинку, которая будет внутренней или внешней ссылкой: | ||
- | |||
- | <code>[[http://www.php.net|{{dokuwiki-128.png}}]]</code> | ||
- | |||
- | [[http://www.php.net|{{dokuwiki-128.png}}]] | ||
- | |||
- | Учтите: форматирование картинок это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки. | ||
- | |||
- | ===== Сноски ===== | ||
- | |||
- | С помощью двойных скобок можно добавить сноску((Это сноска)). | ||
- | |||
- | <code>С помощью двойных скобок можно добавить сноску ((Это сноска)).</code> | ||
- | |||
- | ===== Разбивка на разделы ===== | ||
- | |||
- | Для структурирования текста можно использовать до пяти уровней заголовков. Если в тексте больше трёх заголовков 3-го уровня и выше, автоматически создаётся список содержимого. Его можно отключить, вставив в документ строку %%~~NOTOC~~%%. | ||
- | |||
- | |||
- | |||
- | ==== Заголовок 3-го уровня ==== | ||
- | === Заголовок 4-го уровня === | ||
- | == Заголовок 5-го уровня == | ||
- | |||
- | <code>==== Заголовок 3-го уровня ==== | ||
- | === Заголовок 4-го уровня === | ||
- | == Заголовок 5-го уровня ==</code> | ||
- | |||
- | Четыре и более тире преобразуются в горизонтальную черту: | ||
- | |||
- | ---- | ||
- | \\ | ||
- | |||
- | <code> | ||
- | ---- | ||
- | </code> | ||
- | |||
- | |||
- | |||
- | |||
- | ===== Списки ===== | ||
- | |||
- | Dokuwiki поддерживает нумерованные и ненумерованные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и потом * в случае ненумерованного списка, или - в случае нумерованного. | ||
- | |||
- | * Это список | ||
- | * Второй элемент списка | ||
- | * Можно сделать вложенный список | ||
- | * Ещё один элемент | ||
- | |||
- | - Тот же список, только нумерованный | ||
- | - Ещё элемент | ||
- | - Чем больше пробелов в начале, тем глубже вложенность | ||
- | - Всё просто | ||
- | |||
- | <code> | ||
- | * Это список | ||
- | * Второй элемент списка | ||
- | * Можно сделать вложенный список | ||
- | * Ещё один элемент | ||
- | |||
- | - Тот же список, только нумерованный | ||
- | - Ещё элемент | ||
- | - Чем больше пробелов в начале, тем глубже вложенность | ||
- | - Всё просто | ||
- | </code> | ||
- | |||
- | |||
- | |||
- | |||
- | |||
- | ===== Типографские символы ===== | ||
- | |||
- | DokuWiki может переделывать символы, набранные простым текстом, в их типографски корректные эквиваленты. Распознаются следующие символы. | ||
- | |||
- | -> <- <-> => <= <=> >> << -- --- '640x480' (c) (tm) (r)\\ | ||
- | "Владимир Владимирович(tm) --- это наше всё (c) не я" | ||
- | |||
- | <code> | ||
- | -> <- <-> => <= <=> >> << -- --- '640x480' (c) (tm) (r) | ||
- | "Владимир Владимирович(tm) --- это наше всё (c) не я" | ||
- | </code> | ||
- | |||
- | Примечание: Если потребуется вставить двойные кавычки (%%"%% или ''%%"%%''), например как знак дюйма :-), можно их экранировать ''<nowiki>%%</nowiki>'': | ||
- | %%"%% или ''%%"%%'' | ||
- | |||
- | |||
- | ===== Цитирование ===== | ||
- | |||
- | Иногда нужно пометить некоторый текст в качестве ответа или комментария. Для этого можно использовать следующий синтаксис: | ||
- | |||
- | Я думаю, мы должны это сделать. | ||
- | > Нет, мы не должны. | ||
- | >> Ну, я говорю, что мы должны. | ||
- | > Действительно? | ||
- | >> Да! | ||
- | >>> Тогда сделаем это! | ||
- | |||
- | Я думаю, мы должны это сделать. | ||
- | > Нет, мы не должны. | ||
- | >> Ну, я говорю, что мы должны. | ||
- | > Действительно? | ||
- | >> Да! | ||
- | >>> Тогда сделаем это! | ||
- | |||
- | ===== Таблицы ===== | ||
- | |||
- | DokuWiki поддерживает упрощённый синтаксис создания таблиц. | ||
- | |||
- | ^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^ | ||
- | | Ряд 1 Колонка 1 | Ряд 1 Колонка 2 | Ряд 1 Колонка 3 | | ||
- | | Ряд 2 Колонка 1 | Объединение колонок (обратите внимание на двойную вертикальную черту) || | ||
- | | Ряд 3 Колонка 1 | Ряд 2 Колонка 2 | Ряд 2 Колонка 3 | | ||
- | |||
- | Нормальные ряды должны начинаться и заканчиваться символом |, а заголовки — ^. | ||
- | |||
- | <code> | ||
- | ^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^ | ||
- | | Ряд 1 Колонка 1 | Ряд 1 Колонка 2 | Ряд 1 Колонка 3 | | ||
- | | Ряд 2 Колонка 1 | Объединение колонок (обратите внимание на двойную вертикальную черту) || | ||
- | | Ряд 3 Колонка 1 | Ряд 2 Колонка 2 | Ряд 2 Колонка 3 | | ||
- | </code> | ||
- | |||
- | Чтобы объединить две соседние клетки в ряду, просто оставьте соседнюю клетку полностью пустой, как показано выше. Следите, чтобы количество разделителей клеток было одинаковым! | ||
- | |||
- | Вертикальные заголовки тоже можно сделать. | ||
- | |||
- | | ^ Заголовок 1 ^ Заголовок 2 ^ | ||
- | ^ Заголовок 3 | Ряд 1 Колонка 2 | Ряд 1 Колонка 3 | | ||
- | ^ Заголовок 4 | Объединения нет | | | ||
- | ^ Заголовок 5 | Ряд 2 Колонка 2 | Ряд 2 Колонка 3 | | ||
- | |||
- | Как легко увидеть, разделитель стоящий перед клеткой определяет форматирование: | ||
- | |||
- | <code> | ||
- | | ^ Заголовок 1 ^ Заголовок 2 ^ | ||
- | ^ Заголовок 3 | Ряд 1 Колонка 2 | Ряд 1 Колонка 3 | | ||
- | ^ Заголовок 4 | Объединения нет | | | ||
- | ^ Заголовок 5 | Ряд 2 Колонка 2 | Ряд 2 Колонка 3 | | ||
- | </code> | ||
- | |||
- | Можно сделать вертикально объединённые ячейки добавлением трёх двоеточий '':::'' в объединяемые нижележащие ячейки. | ||
- | |||
- | ^ Заголовок 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 | | ||
- | |||
- | ===== Неформатируемые блоки ===== | ||
- | |||
- | Неформатируемые блоки можно вставлять в документ, либо начиная каждую строчку блока с двух или более пробелов (как это делалось в некоторых предыдущих примерах), либо используя тэги ''%%<code>%%'' или ''%%<file>%%''. При этом пробелы в начале строки являются эквивалентом применения тега ''%%<code>%%'' к одной строке, но без подсветки кода. Если несколько подряд идущих строк начинаются более чем с одного пробела, они объединяются в один блок ''%%<code>%%''. | ||
- | |||
- | Пример использования ''%%<code>%%''..''%%</code>%%''. | ||
- | <code>Это неформатированный текст, в котором сохранены все пробелы: вот <- так.</code> | ||
- | |||
- | Пример использования ''%%<file>%%''..''%%</file>%%''. | ||
- | <file>В принципе то же самое, но этим выделением можно показать, | ||
- | что цитируется содержимое файла.</file> | ||
- | |||
- | Чтобы парсер полностью проигнорировал некий текст (т.е. не форматировал его), либо заключите его в тэги ''%%<nowiki>%%'', либо ещё проще — в двойные знаки процента ''<nowiki>%%</nowiki>''. | ||
- | |||
- | Это просто текст, в котором есть адрес %%http://www.splitbrain.org%% | ||
- | и %%**форматирование**%% --- но ничего не происходит. | ||
- | |||
- | <code>Это просто текст, в котором есть адрес %%http://www.splitbrain.org%% | ||
- | и %%**форматирование**%% --- но ничего не происходит.</code> | ||
- | |||
- | Чтобы увидеть, как используются эти блоки, смотрите код страницы. | ||
- | |||