Синтаксис форматирования Сравнение версий

Различия

Здесь показаны различия между двумя версиями данной страницы.

Ссылка на это сравнение

Предыдущая версия справа и слева Предыдущая версия
Следующая версия
Предыдущая версия
wiki:syntax [2012/05/15 01:20]
ссылка на обсуждение.
wiki:syntax [2017/02/15 15:25] (текущий)
[Типографские символы]
Строка 5: Строка 5:
 ===== Основные конструкции форматирования ===== ===== Основные конструкции форматирования =====
  
-DokuWiki поддерживает выделение текста **полужирным шрифтом**,​ //​курсивом//,​ __подчеркнутым__вывод текста ''​моноширинным шрифтом''​. Все эти конструкции можно **__//''​объединить''//​__**:+DokuWiki поддерживает выделение текста **полужирным шрифтом**,​ //​курсивом//,​ __подчеркнутый__ текст и вывод текста ''​моноширинным шрифтом''​. Все эти конструкции можно **__//''​объединить''//​__**.
  
 <​code>​ <​code>​
-DokuWiki поддерживает выделение текста **полужирным шрифтом**,​ //​курсивом//,​ __подчеркнутым__+DokuWiki поддерживает выделение текста **полужирным шрифтом**,​ //​курсивом//,​ __подчеркнутый__ текст и вывод текста 
-вывод текста ''​моноширинным шрифтом''​. Все эти конструкции можно **__//''​объединить''//​__**:+''​моноширинным шрифтом''​. Все эти конструкции можно **__//''​объединить''//​__**.
 </​code>​ </​code>​
  
Строка 15: Строка 15:
  
 <​code>​ <​code>​
-Также можно использовать <​sub>​подстрочный</​sub>​ и <​sup>​надстрочный</​sup>​ индексы +Также можно использовать <​sub>​подстрочный</​sub>​ и <​sup>​надстрочный</​sup>​ индексы и <​del>​зачёркнутый текст</​del>​
-и <​del>​зачёркнутый текст</​del>​+
 </​code>​ </​code>​
  
Строка 33: Строка 32:
 ==== Внешние ==== ==== Внешние ====
  
-Внешние ссылки распознаются автоматически:​ http://​www.ubuntu.ru или просто www.ubuntu.ru. Можно использовать и явный синтаксис,​ который позволяет указывать текст ссылки:​ [[http://​ubuntu.ru|Это ссылка на Ubuntu.ru]]. Также можно добавлять адреса электронной почты: andi@splitbrain.org:​+Внешние ссылки распознаются автоматически:​ http://​www.ubuntu.ru или просто www.ubuntu.ru. Можно использовать и явный синтаксис,​ который позволяет указывать текст ссылки:​ [[http://​ubuntu.ru|Это ссылка на Ubuntu.ru]]. Также можно добавлять адреса электронной почты: ​<andi@splitbrain.org>:
  
 <​code>​ <​code>​
 Внешние ссылки распознаются автоматически:​ http://​www.ubuntu.ru или просто www.ubuntu.ru. Внешние ссылки распознаются автоматически:​ http://​www.ubuntu.ru или просто www.ubuntu.ru.
 Можно использовать и явный синтаксис,​ который позволяет указывать текст ссылки:​ [[http://​ubuntu.ru|Это ссылка на Ubuntu.ru]]. Можно использовать и явный синтаксис,​ который позволяет указывать текст ссылки:​ [[http://​ubuntu.ru|Это ссылка на Ubuntu.ru]].
-Также можно добавлять адреса электронной почты: andi@splitbrain.org.+Также можно добавлять адреса электронной почты: ​<andi@splitbrain.org>.
 </​code>​ </​code>​
 ==== Внутренние ==== ==== Внутренние ====
Строка 51: Строка 50:
 </​code>​ </​code>​
  
-Имена Wiki-страниц автоматически переводятся в нижний регистр,​ и пробел заменяется на подчёркивание,​ спецсимволы использовать нельзя. Вот ещё пару интересных примеров:​ [[#​внутренние|ссылка на подраздел текущего документа]] и [[.:..:loco:​главная|ссылка с использованием относительных путей]]:​+Имена Wiki-страниц автоматически переводятся в нижний регистр,​ и пробел заменяется на подчёркивание,​ спецсимволы использовать нельзя. Вот ещё пару интересных примеров:​ [[#​внутренние|ссылка на подраздел текущего документа]] и [[.:​..:​главная|ссылка с использованием относительных путей]]:​
  
 <​code>​ <​code>​
 Вот ещё пару интересных примеров:​ [[#​внутренние|ссылка на подраздел текущего документа]] и Вот ещё пару интересных примеров:​ [[#​внутренние|ссылка на подраздел текущего документа]] и
-[[.:..:loco:​главная|ссылка с использованием относительных путей]].+[[.:​..:​главная|ссылка с использованием относительных путей]].
 </​code>​ </​code>​
  
Строка 82: Строка 81:
 Для ссылок на английские статьи [[wpru>​Заглавная_страница|Википедии]] нужно использовать префикс ''​%%wp>​%%'',​ для ссылки на русские --- ''​%%wpru>​%%''​. Для ссылок на английские статьи [[wpru>​Заглавная_страница|Википедии]] нужно использовать префикс ''​%%wp>​%%'',​ для ссылки на русские --- ''​%%wpru>​%%''​.
  
-==== Иные специализированные ссылки ​====+==== Ссылки на различные ресурсы по Ubuntu ​====
  
-Кроме ​того, в функционал DocuWiki была внедрена и опция ​стилизованного ​отображения ссылок на баги [[wiki:​LaunchPad]]. Выглядит такая ссылка следующим ​образом: [[lpbug>​625882]]. +На этом ресурсе предусмотрен ​упрощённый синтаксис добавления ссылок на некоторые важные ресурсы, посвящённые Ubuntu.
-<code bash>​Выглядит такая ссылка ​следующим ​образом: [[lpbug>​625882]].</​code>​ +
-Где lpbag - префикс системы, а цифры ​после указателя '>'​ - номер бага.+
  
 +Если вам нужно указать ссылку на загрузку приложения из Центра приложений,​ то пожалуйста,​ используйте одну из следующих конструкций:​
  
 +  [[app>​firefox]]
 +  [[app>​firefox|Веб-браузер Firefox]]
  
 +Выглядеть это будет так: [[app>​firefox]] и [[app>​firefox|Веб-браузер Firefox]]
  
 +Отличие второй версии заключается в том, что при наведении курсора на кнопку во всплывающей подсказке имя пакета заменено на более понятное имя приложения. Пожалуйста,​ не используйте ссылки **%%apt://​%%** на ресурсе. Вместо них нужно добавлять описанные выше кнопки.
  
 +Кроме этого поддерживается специальный синтаксис для всех ресурсов на [[wiki:​LaunchPad|LaunchPad]]. На некоторые объекты можно ссылаться по имени (в случае в багами - по номеру),​ причём,​ как и в случае с приложениями,​ с помощью двух возможных конструкций:​
  
 +<​code>​
 +  * Ссылки на проекты по имени: [[lpproj>​ubuntu-ru-portal]] или [[lpproj>​ubuntu-ru-portal|Project of ubuntu.ru portal]]
 +  * На команды:​ [[lpteam>​ubuntu-ru]] или [[lpteam>​ubuntu-ru|“Ubuntu Russian Local Community” team]]
 +  * На страницы пользователей:​ [[lpuser>​malamut]] или [[lpuser>​malamut|Malamut]]
 +  * Ссылки на конкретный баг по номеру:​ [[lpbug>​1]] или [[lpbug>​1|Самый важный баг]]
 +</​code>​
 +
 +Вот как это будет выглядеть:​
 +
 +  * Ссылки на проекты по имени: [[lpproj>​ubuntu-ru-portal]] или [[lpproj>​ubuntu-ru-portal|Project of ubuntu.ru portal]]
 +  * На команды:​ [[lpteam>​ubuntu-ru]] или [[lpteam>​ubuntu-ru|“Ubuntu Russian Local Community” team]]
 +  * На страницы пользователей:​ [[lpuser>​malamut]] или [[lpuser>​malamut|Координатор этого ресурса]]
 +  * Ссылки на конкретный баг по номеру:​ [[lpbug>​1]] или [[lpbug>​1|Самый важный баг]]
 +
 +Если приведённых выше конструкций не хватает,​ то можно добавлять ссылки на любые страницы Launchpad и всех его подсайтов. Для этого нужно указать соответствующий префикс,​ а за ним адрес страницы. При этом обязательно надо добавить текст ссылки после символа ''​|'':​
 +
 +<​code>​
 +  * Страницы на launchpad.net:​ [[lp>​|Ссылка на главную Launchpad]],​ а вообще [[lp>​+tour/​index|тур по Launchpad]]
 +  * Страницы на bugs.launchpad.net:​ [[lpbugs>​ubuntu-ru-portal|Баги этого сайта]]
 +  * Страницы на code.launchpad.net:​ [[lpcode>​~ubuntu-ru-web/​ubuntu-ru-portal/​dokuwiki|lp:​ubuntu-ru-portal]]
 +  * Страницы на blueprints.launchpad.net:​ [[lpblueprints>​ubuntu-ru-portal/​+spec/​dokuwiki-launchpad-links|Блюпринт по ссылкам на Launchpad]]
 +  * Страницы на translations.launchpad.net:​ [[lptranslations>​ubuntu/​precise/​+lang/​ru|Перевод 12.04 на русский]]
 +  * Страницы на answers.launchpad.net:​ [[lpanswers>​ubuntu|Вопросы про Ubuntu на LP]]
 +</​code>​
 +
 +Получим:​
 +
 +  * Страницы на Launchpad: [[lp>​|Ссылка на главную Launchpad]],​ а вообще [[lp>​+tour/​index|тур по Launchpad]]
 +  * Страницы на bugs.launchpad.net:​ [[lpbugs>​ubuntu-ru-portal|Баги этого сайта]]
 +  * Страницы на code.launchpad.net:​ [[lpcode>​~ubuntu-ru-web/​ubuntu-ru-portal/​dokuwiki|lp:​ubuntu-ru-portal]]
 +  * Страницы на blueprints.launchpad.net:​ [[lpblueprints>​ubuntu-ru-portal/​+spec/​dokuwiki-launchpad-links|Блюпринт по ссылкам на Launchpad]]
 +  * Страницы на translations.launchpad.net:​ [[lptranslations>​ubuntu/​precise/​+lang/​ru|Перевод 12.04 на русский]]
 +  * Страницы на answers.launchpad.net:​ [[lpanswers>​ubuntu|Вопросы про Ubuntu на LP]]
 ==== Картинки-ссылки ==== ==== Картинки-ссылки ====
  
Строка 103: Строка 139:
  
 Учтите:​ форматирование картинок --- это единственная синтаксическая конструкция,​ которую можно использовать в тексте ссылки. Учтите:​ форматирование картинок --- это единственная синтаксическая конструкция,​ которую можно использовать в тексте ссылки.
 +
 ==== Сноски ==== ==== Сноски ====
  
Строка 274: Строка 311:
  
 -> <- <-> => <= <=> >> << -- --- '​640x480'​ (c) (tm) (r)\\ -> <- <-> => <= <=> >> << -- --- '​640x480'​ (c) (tm) (r)\\
-"Владимир Владимирович(tm) --- это наше всё (c) не я"+"Ubuntu(tm) --- это наше всё (c)"
  
 <​code>​ <​code>​
 -> <- <-> => <= <=> >> << -- --- '​640x480'​ (c) (tm) (r) -> <- <-> => <= <=> >> << -- --- '​640x480'​ (c) (tm) (r)
-"Владимир Владимирович(tm) --- это наше всё (c) не я"+"Ubuntu(tm) --- это наше всё (c)"
 </​code>​ </​code>​
  
Строка 317: Строка 354:
 </​code>​ </​code>​
  
-Примечание:​ Вертикальное объединение ​(rowspan) ​не поддерживается.+DokuWiki поддерживает вертикальное объединение ячеек (rowspan). Для этого в присоединяемых ячейках (ниже доминирующей,​ которая выше) нужно поместить три двоеточия подряд - ':::'.  
 +^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^ 
 +^ Ещё один | Ячейка 1 | Ячейка 2| 
 +^ И ещё. | Ячейка большая || 
 +Вертикальное ​\\ объединение ​ячеек |  23  || 
 +^ ::: |1|2| 
 +Обратите внимание на ручной перенос - <​nowiki>​\\</​nowiki>​. 
 + 
 +<​code>​DokuWiki ​поддерживает ​вертикальное объединение ячеек (rowspan). Для этого в присоединяемых ячейках (ниже доминирующей,​ которая выше) нужно поместить три двоеточия подряд - ':::'​.  
 +^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^ 
 +^ Ещё один | Ячейка 1 | Ячейка 2| 
 +^ И ещё. | Ячейка большая || 
 +^ Вертикальное \\ объединение ячеек |  23  || 
 +^ ::: |1|2| 
 +Обратите внимание на ручной перенос - <​nowiki>​\\</​nowiki>​.</​code>​
  
 Текст клетки таблицы можно выравнивать. Просто добавьте минимум два пробела с противоположной стороны:​ слева — если надо выравнять вправо,​ справа – если надо выравнять влево, и по два с каждой стороны — если по центру. ​ Текст клетки таблицы можно выравнивать. Просто добавьте минимум два пробела с противоположной стороны:​ слева — если надо выравнять вправо,​ справа – если надо выравнять влево, и по два с каждой стороны — если по центру. ​
Строка 369: Строка 420:
 На данный момент распознаются следующие языки: //​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// На данный момент распознаются следующие языки: //​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//
  
 +=====Скачать код===== 
 +Тэг код поддерживает возможность скачивания содержимого с указанным именем файла. Синтаксис такой же, как и в блоке ''​code''​ в предыдущем разделе,​ но на этот раз внутри тэга добавляется так же и название файла. Например %%<code java java.js>​%%. Если подсветка синтаксиса не нужна, то вместо названия языка необходимо поставить дефис(-) 
 +<code java java.js>​ 
 +/**  
 + * 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. 
 +    } 
 +
 +</​code>​ 
 +тоже самое без подсветки 
 +<code - java.js>​ 
 +/**  
 + * 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. 
 +    } 
 +
 +</​code>​
 ===== Вставка HTML и PHP ===== ===== Вставка HTML и PHP =====
  
Строка 400: Строка 475:
 ===== Управляющие макросы ===== ===== Управляющие макросы =====
  
-Некоторый синтаксис влияет на то, как DokuWiki обрабатывает страницы без создания каких либо результатов для себя. Доступны следующие макросы:​+Некоторый синтаксис влияет на то, как DokuWiki обрабатывает страницы без создания каких-либо результатов для себя. Доступны следующие макросы:​
  
 ^ Макрос ​         ^ Описание ​     | ^ Макрос ​         ^ Описание ​     |
 | %%~~NOTOC~~%% ​  | Если этот макрос присутствует на странице,​ оглавление не будет создано | | %%~~NOTOC~~%% ​  | Если этот макрос присутствует на странице,​ оглавление не будет создано |
-| %%~~NOCACHE~~%% | DokuWiki помещает все выводимое в кэш по умолчанию. Иногда это нежелательно (например когда выше был использован синаксис %%<​php>​%%),​ добавление этого макроса заставит DokuWiki обрабатывать страницу при каждом вызове |+| %%~~NOCACHE~~%% | DokuWiki помещает все выводимое в кэш по умолчанию. Иногда это нежелательно (напримеркогда выше был использован синаксис %%<​php>​%%),​ добавление этого макроса заставит DokuWiki обрабатывать страницу при каждом вызове |
  
 ===== Синтаксические плагины ===== ===== Синтаксические плагины =====
Строка 411: Строка 486:
 Как устанавливать дополнения и использовать их описывается на их страницах описания. Следующие дополнения синтаксиса доступны в этой инсталляции DokuWiki: Как устанавливать дополнения и использовать их описывается на их страницах описания. Следующие дополнения синтаксиса доступны в этой инсталляции DokuWiki:
  
-==== Cинтактический плагин Styler ====+==== Cинтаксический плагин Styler ====
  
 Синтаксис использования,​ примеры:​ Синтаксис использования,​ примеры:​
Строка 418: Строка 493:
   * http://​iar.spb.ru/​en/​projects/​dokuwiki/​styler/​start?​redirect=1   * http://​iar.spb.ru/​en/​projects/​dokuwiki/​styler/​start?​redirect=1
  
 +==== Цитаты ====
 +Можно использовать визуальное оформление цитат:
 +<​quote>​- Зачем sudo? \\
 +- Чтобы наверняка</​quote>​
 +<​code>​ Можно использовать визуальное оформление цитат:
 +<​quote>​- Зачем sudo? \\
 +- Чтобы наверняка</​quote></​code>​
 ==== Синтаксический плагин Note ==== ==== Синтаксический плагин Note ====
  
Строка 441: Строка 523:
     * Текст внутри тега **''​key''​** делится на позициях **''​-''​** (дефиса).     * Текст внутри тега **''​key''​** делится на позициях **''​-''​** (дефиса).
     * Каждая часть //​обрезается//​ (удаляются окружающие пробелы),​ а известные сокращения клавиш //​заменяются//​ на полные варианты. Например,​ **''​C''​** становится **''​Ctrl''​**,​ **''​Left''​** становится **''​%%&​larr;​%%''​**,​ и т.п.     * Каждая часть //​обрезается//​ (удаляются окружающие пробелы),​ а известные сокращения клавиш //​заменяются//​ на полные варианты. Например,​ **''​C''​** становится **''​Ctrl''​**,​ **''​Left''​** становится **''​%%&​larr;​%%''​**,​ и т.п.
-    * Замена сокращений //​зависит от языка//​. Например,​ в немецком,​ **''​C''​** становится **''​Strg''​**,​ а **''​Del''​** становится **''​Entf''​**. На данный момент поддерживаются только английсткий и немецний. Вы можете помочь,​ написав дополнительные заголовочные файлы и отправив их для включения.+    * Замена сокращений //​зависит от языка//​. Например,​ в немецком,​ **''​C''​** становится **''​Strg''​**,​ а **''​Del''​** становится **''​Entf''​**. На данный момент поддерживаются только английский и немецкий. Вы можете помочь,​ написав дополнительные заголовочные файлы и отправив их для включения.
     * Если замены не найдено,​ первая буква становится //​заглавной//,​ а специальные HTML-символы заменяются сущностями.     * Если замены не найдено,​ первая буква становится //​заглавной//,​ а специальные HTML-символы заменяются сущностями.
     * Заменяются только клавиши,​ начинающиеся с заглавной буквы. Строчные буквы не заменяются. Например,​ **''​C-c''​** становится **''​Ctrl-C''​**     * Заменяются только клавиши,​ начинающиеся с заглавной буквы. Строчные буквы не заменяются. Например,​ **''​C-c''​** становится **''​Ctrl-C''​**
Строка 459: Строка 541:
   * Используйте <​key>​C-Minus</​key>​ для увеличения масштаба. (''​%%<​key>​C-Minus</​key>​%%''​)   * Используйте <​key>​C-Minus</​key>​ для увеличения масштаба. (''​%%<​key>​C-Minus</​key>​%%''​)
   * Используйте <​key>'​any key'</​key>​ для выхода. (''​%%<​key>'​any key'</​key>​%%''​)   * Используйте <​key>'​any key'</​key>​ для выхода. (''​%%<​key>'​any key'</​key>​%%''​)
-==== Синтаксический плагин Columns ​==== +==== Колонки ==== 
- +Синтаксический плагин ​**Columns**. Система Документации Ubuntu.ru поддерживает простую организацию колонок с распределённым содержимым((заполнение колонок автоматически равномерно не производится ​всё в ваших руках:​-D)). Для создания колонок нужно указать тэг ''​<nowiki><колонки [параметры]></​nowiki>'',​ например,​ ''<​nowiki><​колонки ​100% 25% 25% 50%></​nowiki>'',​ где первый показатель ​''​100%'' ​процент занимаемой всеми колонками ширины страницы,​ по ''​25%''​ и ''​50%''​ - процент ширины каждой колонки,​ то есть две по четверти и одна - половина ширины от данных нами ''​100%''​. Вместо указания процентов можно использовать прочерк,​ ширина колонки будет подобрана системой зависимо от степени наполнения. Также не обойтись без тэгов ''​<nowiki><новаяколонка></nowiki>''​ и закрывающего тэга ''<​nowiki></колонки></​nowiki>''​.\\ 
-The syntax is mostly identical to the original version, except that the new column keyword has to be specified within angle brackets((The syntax can be made fully compatible with the original version of plugin by un-checking "Wrap the new column tag" check box in the Configuration Settings.))+По умолчанию текст в колонках выравнивается по левому краюЧтобы изменить способ выравниванияследует ставить звёздочку с определённой стороны показателя\\  
- +**Пример:​** 
-<code> +<колонки ​100% 25% *-* *- > 
-<columns ​100% 50% - -+Это просто текст в выравниванием по левой стороне. В этом случае звёздочка не нужна. 
- +<​новаяколонка>​ 
-information in column 1 (50% width) +А здесь текст выровнен по центру! 
- +<новаяколонка
-<newcolumn> +Такой же бесполезный текст, как и два предыдущих,​ но с выравниванием по правой стороне. 
- +</​колонки>​ 
-information in column 2 +<code bash
- +**Пример:​** 
-<newcolumn> +<​колонки 100% 25% *-* *- > 
- +Это просто текст в выравниванием по левой стороне. В этом случае звёздочка не нужна. 
-information in column 3 +<новаяколонка
- +А здесь текст выровнен по центру! 
-</columns> +<​новаяколонка>​ 
-</code> +Такой же бесполезный текст, как и два предыдущих,​ но с выравниванием по правой стороне. 
- +</колонки>
-By default the text in columns is justifiedThis can be changed by adding asterisks on either side of the column width specificationThe asterisk indicates non-justified side of the text blockso to achieve left alignment add the asterisk on the right side+
- +
-<code> +
-<​columns ​100% 25% 25%*-* *-> +
- +
-Justified text +
- +
-<newcolumn+
- +
-Aligned on the left side +
- +
-<newcolumn+
- +
-Center-aligned +
- +
-<newcolumn+
- +
-Aligned on the right side +
- +
-</columns>+
 </​code>​ </​code>​
  
Строка 506: Строка 568:
  
 ==== См.также ==== ==== См.также ====
 +
   * [[http://​forum.ubuntu.ru/​index.php?​topic=191084.0|Обсуждение статьи на форуме]]   * [[http://​forum.ubuntu.ru/​index.php?​topic=191084.0|Обсуждение статьи на форуме]]