====== Синтаксис форматирования ====== [[документация:докувики]] поддерживает язык разметки, который по возможности сохраняет файлы данных как можно более читабельными! Здесь перечислены все возможные синтаксические конструкции, которые можно использовать при редактировании страниц. Просто посмотрите на исходный код этой страницы, нажав кнопку Отредактировать страницу вверху или внизу страницы. Если хотите поупражняться, используйте [[документация:тестирование|песочницу]]. ===== Основные конструкции форматирования ===== [[документация:докувики]] поддерживает выделение текста **жирным шрифтом**, //курсивом//, __подчеркнутый текст__ и вывод текста ''моноширинным шрифтом''. Все эти конструкции можно **__//''объединить''//__**. DokuWiki поддерживает выделение текста **жирным шрифтом**, //курсивом//, __подчеркниванием текста__ и вывод текста ''моноширинным шрифтом''. Все эти конструкции можно **__//''объединить''//__**. Также можно использовать подстрочный и надстрочный индексы. Также можно использовать подстрочный и надстрочный индексы. Ещё можно зачеркнуть текст. Ещё можно зачеркнуть текст. **Параграфы** отбиваются пустой строкой. Если нужно **принудительно вставить перенос строки**, не создавая параграф, вставьте два обратных слэша и за ним пробел или энтер. Просто текст с разрывом строк\\ Обратите внимание, что два обратных слэша действуют только в конце строки\\ или если за ними стоит\\ пробел. Если его не поставить, \\получится вот так. Просто текст с разрывом строк\\ Обратите внимание, что два обратных слэша действуют только в конце строки\\ или если за ними стоит\\ пробел. Если его не поставить, \\получится вот так. :!: Принудительные переносы следует использовать только в случае крайней необходимости. ===== Ссылки ===== Ссылки в [[документация:докувики]] бывают разные, и создавать их можно тоже по-разному. ==== Внешние ==== Внешние ссылки распознаются автоматически: 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#внутренние|этот раздел]]. Примечания: * Ссылки на [[синтаксис|существующие страницы]] отображаются иначе, чем ссылки на [[несуществующие страницы]] * Внутренние ссылки без указанного текста могут отображаться по разному в зависимости от настроек - в качестве текста может использоваться название страницы или заголовок первого уровня((именно такая настройка используется на этом сайте)). Так что лучше каждый раз указывать текст ссылки. * [[документация:докувики]] по умолчанию не использует [[wp>CamelCase]] для автоматического создания ссылок, но эту возможность можно включить в файле [[doku>wiki:config]]. Проверка: Если [[документация:докувики]] — ссылка, значит эта возможность включена. * Если меняется название раздела, ссылки на него не меняются автоматически. Так что не очень полагайтесь на ссылки на разделы. ==== InterWiki ==== [[документация:докувики]] поддерживает [[doku>wiki:interwiki|InterWiki]]-ссылки. Это короткие ссылки на другие Wiki. Например, вот ссылка на страницу Википедии о Wiki: [[wp>Wiki]]. Например, вот ссылка на страницу Википедии о Wiki: [[wp>Wiki]]. ==== Сетевые ресурсы Windows ==== Ссылки на сетевые ресурсы вида \\server\share тоже распознаются. Однако учтите, что такие ссылки имеют смысл только в гомогенных группах пользователей, например в корпоративном Интранете. Ссылки на виндовые шары вида \\server\share тоже распознаются. Примечания: * Из соображений безопасности непосредственный просмотр виндовых шар работает по умолчанию только в Internet Explorer (и только в “локальной зоне”). * Для Mozilla Firefox его можно включить с помощью другого обходного пути, упомянутого в [[http://kb.mozillazine.org/Links_to_local_pages_do_not_work|Mozilla Knowledge Base]]. Тем не менее, вы все еще будете видеть предупреждение [[документация:javascript]] о попытке открыть общий ресурс Windows. Чтобы удалить это предупреждение (для всех пользователей), вставьте следующую строку в ''conf/lang/en/lang.php'' (подробнее: [[doku>localization#changing_some_localized_texts_and_strings_in_your_installation|localization]]): ==== Картинки-ссылки ==== Совместив синтаксис ссылки и [[синтаксис#картинки и другие файлы|картинки]], можно вставить в текст картинку, которая будет внутренней или внешней ссылкой: [[http://www.php.net|{{dokuwiki-128.png}}]] [[http://www.php.net|{{медиа:dokuwiki-128.png}}]] Учтите: форматирование картинок это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки. Поддерживается весь синтаксис [[#images_and_other_files|картинок]] и [[#links|ссылок]] (включая изменение размера изображений, внутренних и внешних изображений, URL-адресов и ссылок на вики) ===== Сноски ===== С помощью двойных скобок можно добавить сноску((Это сноска)). С помощью двойных скобок можно добавить сноску ((Это сноска)). ===== Разбивка на разделы ===== Для структурирования текста можно использовать до пяти уровней заголовков. Если в тексте больше трёх заголовков 3-го уровня и выше, автоматически создаётся список содержимого. Его можно отключить, вставив в документ строку %%~~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''), оно будет отображаться в виде ссылки. ==== Поддерживаемые медиа-форматы ==== [[документация:докувики]] может встраивать следующие медиаформаты напрямую. | Картинки | ''gif'', ''jpg'', ''png'' | | Видео | ''webm'', ''ogv'', ''mp4'' | | Аудио | ''ogg'', ''mp3'', ''wav'' | | Flash | ''swf'' | Если вы укажете имя файла, которое не поддерживается форматом мультимедиа, оно будет отображаться в виде ссылки. Для добавления ''?linkonly'' вы предоставляете ссылку на медиа-файл, не отображая ее в строке {{wiki:dokuwiki-128.png?linkonly}} {{медиа:dokuwiki-128.png?linkonly}} Это просто ссылка на изображение. ==== Резервные форматы ==== сожалению, не все браузеры понимают все видео и аудио форматы. Чтобы смягчить проблему, вы можете загрузить свой файл в разных форматах для максимальной совместимости браузера. Например, рассмотрим это встроенное видео mp4: {{video.mp4|Очень смешное видео}} Когда вы загружаете '' video.webm '' и '' video.ogv '' рядом с ссылкой на '' video.mp4 '', [[документация:докувики]] автоматически добавляет их в качестве альтернативы, чтобы ваш браузер распознал один из трех файлов. , Кроме того, [[документация:докувики]] поддерживает «постер», которое будет показано перед началом видео. Это изображение должно иметь то же имя файла, что и видео, и иметь формат jpg или png. ===== Списки ===== Dokuwiki поддерживает нумерованные и ненумерованные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и потом * в случае ненумерованного списка, или - в случае нумерованного. * Это список * Второй элемент списка * Можно сделать вложенный список * Ещё один элемент - Тот же список, только нумерованный - Ещё элемент - Чем больше пробелов в начале, тем глубже вложенность - Всё просто * Это список * Второй элемент списка * Можно сделать вложенный список * Ещё один элемент - Тот же список, только нумерованный - Ещё элемент - Чем больше пробелов в начале, тем глубже вложенность - Всё просто Также взгляните на [[doku> faq: lists | FAQ по элементам списка]]. ===== Преобразование текста ===== [[документация:докувики]] может конвертировать определенные заранее символы или строки в изображения, другой текст или HTML. Преобразование текста в изображение в основном делается для смайликов. А преобразование текста в HTML используется для замены типографики, но может быть настроено и на использование другого HTML. ===== Смайлики ===== [[документация:докувики]] преобразует наиболее употребляемые смайлики в их графические эквиваленты. Дополнительные смайлики можно положить в директорию ''smiley'' и внести изменения в файл ''conf/smileys.conf''. Вот смайлики, которые есть в [[документация:докувики]]: * 8-) %%8-)%% * 8-O %%8-O%% * :-( %%:-(%% * :-) %%:-)%% * =) %%=)%% * :-/ %%:-/%% * :-\ %%:-\%% * :-? %%:-?%% * :-D %%:-D%% * :-P %%:-P%% * :-O %%:-O%% * :-X %%:-X%% * :-| %%:-|%% * ;-) %%;-)%% * ^_^ %%^_^%% * :?: %%:?:%% * :!: %%:!:%% * LOL %%LOL%% * FIXME %%FIXME%% * DELETEME %%DELETEME%% ===== Типографские символы ===== [[документация:докувики]] может переделывать символы, набранные простым текстом, в их типографски корректные эквиваленты. Распознаются следующие символы. -> <- <-> => <= <=> >> << -- --- '640x480' (c) (tm) (r)\\ "Владимир Владимирович(tm) --- это наше всё (c) не я" -> <- <-> => <= <=> >> << -- --- '640x480' (c) (tm) (r) "Владимир Владимирович(tm) --- это наше всё (c) не я" Примечание: Это конвертирование можно отключить в файле конфигурации.\\ Примечание 2: Если потребуется вставить двойные кавычки (%%"%% или ''%%"%%''), например как знак дюйма :-), можно их экранировать ''%%'': %%"%% или ''%%"%%'' То же самое можно сделать для создания любого вида HTML, его просто нужно добавить в [[doku> entity | pattern file]]. Есть три исключения, которые не приходят из этого файла шаблона: объект умножения (640x480), «одинарные» и «двойные кавычки». Их можно отключить с помощью [[doku> config: typography | config option]]. ===== Цитирование ===== Иногда нужно пометить некоторый текст в качестве ответа или комментария. Для этого можно использовать следующий синтаксис: Я думаю, мы должны это сделать. > Нет, мы не должны. >> Ну, я говорю, что мы должны. > Действительно? >> Да! >>> Тогда сделаем это! Я думаю, мы должны это сделать. > Нет, мы не должны. >> Ну, я говорю, что мы должны. > Действительно? >> Да! >>> Тогда сделаем это! ===== Таблицы ===== [[документация:докувики]] поддерживает упрощённый синтаксис создания таблиц. ^ Заголовок 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%% и %%**форматирование**%% --- но ничего не происходит. Чтобы увидеть, как используются эти блоки, смотрите код страницы. ===== Блоки кода ===== Вы можете включить блоки кода в свои документы, сделав отступ по крайней мере на два пробела (как в предыдущих примерах) или используя теги ''%%%%'' or ''%%%%''. Это текст с двумя пробелами. Это предварительно отформатированный код, все пробелы сохраняются: как <-это Это почти то же самое, но вы можете использовать его, чтобы показать, что вы цитировали файл. Эти блоки были созданы этим источником: Это текст с двумя пробелами. Это предварительно отформатированный код, все пробелы сохраняются: как <-это Это почти то же самое, но вы можете использовать его, чтобы показать, что вы цитировали файл. ===== Подсветка синтаксиса ===== [[документация:докувики]] может подсвечивать программный код, чтобы его было проще читать. Для этого используется библиотека [[http://qbnz.com/highlighter/|GeSHi]] — соответственно подсвечиваются все языки, поддерживаемые [[документация:geshi]]. Синтаксис такой же, как и в блоке ''code'' в предыдущем разделе, но на этот раз внутри тэга добавляется название языка. Например '''' or ''''. /** * 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. } } На данный момент распознаются следующие языки: //4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch xbasic xml xojo xorg_conf xpp yaml z80 zxbasic// Для подсветки синтаксиса доступны дополнительные [[doku> syntax_highlighting | дополнительные параметры]], такие как выделение строк или добавление номеров строк. ==== Скачиваемые блоки кода ==== Используя тэги ''%%%%'' или ''%%%%'', как показано выше, вы можете сделать отображаемый код доступным для загрузки. Для этого определите имя файла после кода языка вот так: Если вам не нужна подсветка, но нужен загружаемый файл, поставьте прочерк (''-'') на месте кода языка: ''%%%%''. ===== Вставка HTML и PHP ===== Чистый HTML- или PHP-код можно вставлять в документ с помощью тэгов ''html'' и ''php'': Тут вставлен HTML-код Тут вставлен HTML-код echo 'Логотип, сгенерированный PHP:'; echo 'Логотип PHP!'; echo 'Логотип, сгенерированный PHP:'; echo 'Логотип PHP!'; **Примечание**: по умолчанию вставка HTML и PHP запрещена. Когда она запрещена, код не исполняется, а выводится в исходном виде. ===== Интеграция с RSS/ATOM фидами ===== [[документация:докувики]] может отображать на своих страницах данные из внешних XML-фидов. Для парсинга XML-фидов используется библиотека [[http://simplepie.org/|SimplePie]], соответственно, все форматы, распознаваемые этой библиотекой поддерживаются в [[документация:докувики]]. Вывод информации можно настроить, используя следующие параметры (параметры надо разделять пробелами): ^ Параметр ^ Описание ^ | любое число | максимальное кол-во отображаемых элементов, по умолчанию - 8 | | reverse | вывести список новостей в обратном порядке - самые старые записи выводятся первыми | | author | показывать имена авторов (если указаны в фиде) | | date | показывать даты записей (если указаны в фиде) | | description| показывать описание записи. Если в настройках [[документация:докувики]] выключено отображение HTML кодов, то из описания будут удалены все HTML коды | | nosort | не сортировать элементы в ленте | | //n//[dhm] | период обновления фида, где d=дни, h=часы, m=минуты. (т.е. 12h = 12 часов, а 2d = 2 дня). | По умолчанию период обновления равен 4 часам. Если указать значение меньше 10 минут, то [[документация:докувики]] всё-равно будет обновлять не чаще, чем раз в 10 минут. По умолчанию [[документация:докувики]] выдаёт пользователю сохранённую версию страницы, однако указание периода обновления фида приводит к повторному рендерингу страницы. По умолчанию лента будет отсортирована по дате, сначала самые новые элементы. Вы можете сначала отсортировать их по возрасту, используя параметр 'reverse' ', или отобразить канал как есть с помощью' 'nosort' '. **Пример:** {{rss>http://slashdot.org/index.rss 5 author date 10h }} {{rss>http://slashdot.org/index.rss 5 author date 10h }} ===== Управляющие макросы ===== Некоторый синтаксис влияет на то, как «ДокуВики» обрабатывает статьи без создания каких-либо результатов для себя. Доступны следующие макросы: ^ Макрос ^ Описание | | %%~~NOTOC~~%% | Если этот макрос присутствует в статье, оглавление не будет создано. | | %%~~NOCACHE~~%% | «ДокуВики» помещает всё выводимое в кэш по умолчанию. Иногда это нежелательно (например, когда выше был использован синтаксис %%%%), добавление этого макроса заставит «ДокуВики» обрабатывать статью при каждом вызове. | ====== Дополнительное форматирование (синтаксические плагины) ====== Синтаксис «ДокуВики» может быть расширен за счёт [[doku>plugins|плагинов]]. Как их устанавливать и использовать --- описывается на страницах описания. На этом сайте установлены следующие модули, которые расширяют стандартное форматирование [[документация:докувики]]: ~~INFO:syntaxplugins~~