Различия
Здесь показаны различия между двумя версиями данной страницы.
Следующая версия | Предыдущая версия | ||
справка:разметка [2012/06/02 23:16] создано |
справка:разметка [2013/03/19 22:40] (текущий) заметки |
||
---|---|---|---|
Строка 1: | Строка 1: | ||
- | ======== Wiki: Разметка, синтаксис, форматирование ======== | + | ====== Разметка, синтаксис, форматирование ====== |
+ | [[http://www.dokuwiki.ru|DokuWiki]] поддерживает простой язык разметки, который по возможности сохраняет исходный текст((необработанный системой код страницы - именно в нём содержится вся статья, исключая изображения, но включая все элементы оформления и пр.)) как можно более читабельным. | ||
- | [[http://www.docuwiki.ru|DokuWiki]] поддерживает простой язык разметки, который по возможности сохраняет исходный текст((необработанный системой код страницы - именно в нём содержится вся статья, исключая изображения, но включая все элементы оформления и пр.)) как можно более читабельным. Ниже следует описание доступных параметров, большинство из которых можно комбинировать. | + | Ниже следует описание доступных параметров, большинство из которых можно комбинировать. |
- | ====== Форматирование текста ====== | + | ===== Форматирование текста ===== |
| ^Название ^^Внешний вид ^Способ использования ^ | | ^Название ^^Внешний вид ^Способ использования ^ | ||
- | ^ Форматирование \\ текста |Полужирный || **Пример** | <code>**Пример**</code> | | + | ^ Форматирование \\ текста |Полужирный || **Пример** | <code>**Пример**</code> | |
- | ^ ::: |Курсив || //Пример// | <code>//Пример//</code> | | + | ^ ::: |Курсив || //Пример// | <code>//Пример//</code> | |
- | ^ ::: |Подчёркнутый || __Пример__ | <code>__Пример__</code> | | + | ^ ::: |Подчёркнутый || __Пример__ | <code>__Пример__</code> | |
- | ^ ::: |Моноширинный || ''Пример'' | <code>''Пример''</code> | | + | ^ ::: |Моноширинный || ''Пример'' | <code>''Пример''</code> | |
- | ^ ::: |Зачёркнутый || <del>Пример</del> | <code><del>Пример</del></code> | | + | ^ ::: |Зачёркнутый || <del>Пример</del> | <code><del>Пример</del></code> | |
- | ^ ::: |Индекс |Подстрочный | <sub>Пример</sub> | <code><sub>Пример</sub></code> | | + | ^ ::: |Индекс |Подстрочный | <sub>Пример</sub> | <code><sub>Пример</sub></code> | |
- | ^ ::: | ::: |Надстрочный | <sup>Пример</sup> | <code><sup>Пример</sup></code> | | + | ^ ::: | ::: |Надстрочный | <sup>Пример</sup> | <code><sup>Пример</sup></code> | |
+ | ^ ::: |Сноска || ((Это - сноска;-)))| <code>((Это - сноска;-)))</code> | | ||
+ | ^ ::: |Комбинация клавиш || <key>C-A-Del</key>| <code><key>C+A+D</key></code> | | ||
- | ====== Абзацы и переносы ====== | + | ===== Абзацы и переносы ===== |
**Абзац** формируется пустой строкой. Перенос строки без создания абзаца - ''\\''. | **Абзац** формируется пустой строкой. Перенос строки без создания абзаца - ''\\''. | ||
- | ====== Ссылки ====== | + | ===== Ссылки ===== |
| ^^^^Внешний вид ^Способ использования ^ | | ^^^^Внешний вид ^Способ использования ^ | ||
^Ссылки |Внутренние |Простые ||[[инструкция]] |<code>[[инструкция]]</code> | | ^Ссылки |Внутренние |Простые ||[[инструкция]] |<code>[[инструкция]]</code> | | ||
^::: |::: |С произвольным именем ||[[инструкция|Инструкция по использованию]] |<code>[[инструкция|Инструкция по использованию]]</code> | | ^::: |::: |С произвольным именем ||[[инструкция|Инструкция по использованию]] |<code>[[инструкция|Инструкция по использованию]]</code> | | ||
- | ^::: |::: |Направленные |С относительным путём |[[.:главная|Ссылка]] |<code>[[.:главная|Ссылка]]</code> | | + | ^::: |::: |С [[#изображения|изображением]] вместо текста ||[[http://www.dokuwiki.org|{{wiki:dokuwiki-128.png?20}}]] |<code>[[http://www.dokuwiki.org|{{wiki:dokuwiki-128.png?20}}]]</code> | |
- | ^::: |::: |::: |С указанием пространства имён |[[wiki:nano|Nano]] |<code>[[wiki:nano|Nano]]</code> | | + | ^::: |::: |Направленные |С относительным путём |[[.:главная|Ссылка]] |<code>[[.:главная|Ссылка]]</code> | |
- | ^::: |::: |::: |С указанием раздела документа |[[#ссылки]] или [[wiki:nano#ссылки]] |<code>[[#ссылки]] или [[wiki:nano#ссылки]]</code> | | + | ^::: |::: |::: |С указанием [[инструкция#именования статей|пространства имён]] |[[wiki:nano|Nano]] |<code>[[wiki:nano|Nano]]</code> | |
- | ^::: |[[#Интер-ссылки]] ||Википедия |[[wpru>Википедия]] или [[wp>Wikipedia]] |<code>[[wpru>Википедия]] или [[wp>Wikipedia]]</code> | | + | ^::: |::: |::: |С указанием раздела документа |[[#ссылки]] или [[wiki:nano#ссылки]] |<code>[[#ссылки]] или [[wiki:nano#ссылки]]</code> | |
- | ^::: |::: ||[[wiki:Launchpad|]] Bug |[[lpbug>645818]] |<code>[[lpbug>645818]]</code> | | + | ^::: |[[#Интер-ссылки]] ||Википедия |[[wpru>Википедия]] или [[wp>Wikipedia]] |<code>[[wpru>Википедия]] или [[wp>Wikipedia]]</code> | |
- | ^::: |Внешние |Распознаваемые |С указанием протокола |http://www.ubuntu.ru |<code>http://www.ubuntu.ru</code> | | + | ^::: |::: ||[[wiki:Launchpad]] Bug |[[lpbug>1]] или [[lpbug>1|Bug]] |<code>[[lpbug>645818]] или [[lpbug>645818|Bug]]</code> | |
- | ^::: |::: |::: |Без указания протокола |www.ubuntu.ru |<code>www.ubuntu.ru</code> | | + | ^::: |::: ||Проект на Launchpad |[[lpproj>ubuntu-ru-portal]] или [[lpproj>ubuntu-ru-portal|ubuntu.ru]] |<code>[[lpproj>ubuntu-ru-portal]] или [[lpproj>ubuntu-ru-portal|ubuntu.ru]]</code> | |
- | ^::: |::: |Указанные || [[http://www.ubuntu.ru|Это ссылка HTTP]] | <code>[[http://www.ubuntu.ru|Это ссылка]]</code> | | + | ^::: |::: ||Команда на Launchpad |[[lpteam>ubuntu-ru]] или [[lpteam>ubuntu-ru|Ubuntu Russian LoCo]] |<code>[[lpteam>ubuntu-ru]] или [[lpteam>ubuntu-ru|Ubuntu Russian LoCo]]</code> | |
- | ^::: |::: |::: || [[user@example.com|Это ссылка на email]] | <code>[[user@example.com|Это ссылка на email]]</code> | | + | ^::: |::: ||Профиль на Launchpad |[[lpuser>malamut]] или [[lpuser>malamut|Malamut]] |<code>[[lpuser>malamut]] или [[lpuser>malamut|Malamut]]</code> | |
- | ^::: |::: |::: || К сожалению, указать прямую ссылку на пакет через <nowiki>apt://</nowiki> \\ временно невозможно. [[http://forum.ubuntu.ru/index.php?topic=190808.0|Тема на Форуме]] || | + | ^::: |::: ||Профиль [[wiki:forum|Форума]] |[[user>forekko]] или [[user>forekko|User]] |<code>[[user>forekko]] или [[user>forekko|User]]</code> | |
+ | ^::: |::: ||Ссылка на приложение из [[wiki:центр_приложений_ubuntu|Центра приложений]] |[[app>firefox]] или [[app>firefox|Веб-браузер Firefox]] |<code>[[app>firefox]] или [[app>firefox|Веб-браузер Firefox]]</code> | | ||
+ | ^::: |Внешние |Распознаваемые |С указанием протокола |http://www.ubuntu.ru |<code>http://www.ubuntu.ru</code> | | ||
+ | ^::: |::: |::: |Без указания протокола |www.ubuntu.ru |<code>www.ubuntu.ru</code> | | ||
+ | ^::: |::: |Прямо указанные || [[http://www.ubuntu.ru|Это ссылка HTTP]] | <code>[[http://www.ubuntu.ru|Это ссылка HTTP]]</code> | | ||
+ | ^::: |::: |::: || [[user@example.com|Это ссылка на email]] | <code>[[user@example.com|Это ссылка на email]]</code> | | ||
+ | ==== Интер-ссылки ==== | ||
+ | Префиксальные ссылки, параметры отображения и функционирования которых заведомо заданы [[http://forum.ubuntu.ru/index.php?action=groups;sa=members;group=1|администратором]]. | ||
+ | ===== Обработка текста ===== | ||
+ | | ^^^ Внешний вид ^Способ использования | | ||
+ | ^Необраба- \\ тываемый |Параметр <<<nowiki>%%</nowiki>>> ||%%http://ubuntu.ru%% |<code>%%http://ubuntu.ru%%</code> | | ||
+ | ^::: |тэг %%<nowiki>%% ||<nowiki>http://ubuntu.ru</nowiki> |<code><nowiki>http://ubuntu.ru</nowiki></code> | | ||
+ | ^В блоке |Простой |Код |<code>Пример</code> |<file><code>Пример</code></file> | | ||
+ | ^::: |::: |Файл |<file>Пример</file> |<code><file>Пример</file></code> | | ||
+ | ^::: |С подсветкой синтаксиса |Bash |<code bash>sudo dpkg -i ./package.deb</code> |<file><code bash>sudo dpkg -i ./package.deb</code></file> | | ||
+ | ^::: |::: |HTML |<code html><font color="red">HTML</font></code> |<file><code html><font color="red">HTML</font></code></file> | | ||
+ | ^::: |::: |PHP |<code php><?php echo 'Hello, world!'; ?></code> |<file><code php><?php echo 'Hello, world!'; ?></code></file> | | ||
+ | ^Без блока, \\ в тексте |::: |HTML |<html><font color="red">HTML</font></html> |<code><html><font color="red">HTML</font></html></code> | | ||
+ | ^::: |::: |PHP |<php><?php echo 'Hello, world!'; ?></php> |<code><php><?php echo 'Hello, world!'; ?></php></code> | | ||
- | ==== Интер-ссылки ==== | + | Кроме того, для подсветки синтаксиса доступно множество иных параметров, подробнее см.плагин [[http://qbnz.com/highlighter/|GeSHi]]((На данный момент распознаются следующие языки: ''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'')). |
- | Префиксальные ссылки, параметры отображения и функционирования которых заведомо заданы администратором. | + | |
+ | ==== Заметки ==== | ||
+ | Вики поддерживает создание блоков с заметками. | ||
+ | |||
+ | <колонки> | ||
+ | <note> Обратите внимание. Это нужно запомнить! </note> | ||
+ | <note important> Внимание! Вы можете потерять рассудок. </note> | ||
+ | <note tip> Подсказки находятся на изображениях. </note> | ||
+ | <note warning> Остерегайтесь собаки, когда открываете дверь! </note> | ||
+ | |||
+ | <новаяколонка> | ||
+ | |||
+ | <note> Обратите внимание. Это нужно запомнить! </note> | ||
+ | |||
+ | <note important> Внимание! Вы можете потерять рассудок. </note> | ||
+ | |||
+ | <note tip> Подсказки находятся на изображениях. </note> | ||
+ | |||
+ | <note warning> Остерегайтесь собаки, когда открываете дверь! </note> | ||
+ | |||
+ | </колонки> | ||
+ | ==== Цитирование ==== | ||
+ | Цитирование текста происходит при помощи тега ''%%<quote></quote>%%'' | ||
+ | <колонки 100%> | ||
+ | <quote>В цитатах действует оформление текста.\\ | ||
+ | //Эта строка написана курсивом.//</quote> | ||
+ | <новаяколонка> | ||
+ | <code><quote>В цитатах действует оформление текста.\\ | ||
+ | //Эта строка написана курсивом.//</quote></code> | ||
+ | </колонки> | ||
+ | |||
+ | ==== Колонки ==== | ||
+ | В вики поддерживается простая организация колонок. Для этого используется тег ''<nowiki><колонки [параметры]></nowiki>''. Например, ''<nowiki><колонки 100% 25% 25% 50%></nowiki>'', где первый показатель - ''100%'' - процент занимаемой всеми колонками ширины страницы, по ''25%'' и ''50%'' - процент ширины каждой колонки, то есть две по четверти и одна - половина ширины от данных нами ''100%''. Вместо указания процентов можно использовать прочерк, ширина колонки будет подобрана системой зависимо от степени наполнения. Каждая новая колонка должна начинатся тегом ''%%<новаяколонка>%%''. Пример использования колонок представлен ниже: | ||
+ | |||
+ | <колонки 100% 25% *-* *- > | ||
+ | Это просто текст в выравниванием по левой стороне. В этом случае звёздочка не нужна. | ||
+ | <новаяколонка> | ||
+ | А здесь текст выровнен по центру! | ||
+ | <новаяколонка> | ||
+ | Такой же бесполезный текст, как и два предыдущих, но с выравниванием по правой стороне. | ||
+ | </колонки> | ||
+ | <code> | ||
+ | <колонки 100% 25% *-* *- > | ||
+ | Это просто текст в выравниванием по левой стороне. В этом случае звёздочка не нужна. | ||
+ | <новаяколонка> | ||
+ | А здесь текст выровнен по центру! | ||
+ | <новаяколонка> | ||
+ | Такой же бесполезный текст, как и два предыдущих, но с выравниванием по правой стороне. | ||
+ | </колонки> | ||
+ | </code> | ||
+ | ===== Преобразуемые сочетания символов ===== | ||
+ | ==== Смайлики ==== | ||
+ | <note tip>Все перечисленные здесь символы доступны для простой вставки с [[инструкция:панель инструментов|панели инструментов окна редактирования]].</note> | ||
+ | [[wiki:DokuWiki]] преобразовывает наиболее употребляемые сочетания символов в их графические эквиваленты. | ||
+ | <колонки> | ||
+ | * ''[[справка:тэги#FIXME|FIXME]]'' FIXME | ||
+ | * ''[[справка:тэги#DELETEME|DELETEME]]'' DELETEME | ||
+ | <новаяколонка> | ||
+ | * ''%%:!:%%'' :!: | ||
+ | * ''%%:?:%%'' :?: | ||
+ | <новаяколонка> | ||
+ | * ''%%:-(%%'' :-( | ||
+ | * ''%%:-)%%'' :-) | ||
+ | <новаяколонка> | ||
+ | * ''%%=)%%'' =) | ||
+ | * ''%%:-/%%'' :-/ | ||
+ | <новаяколонка> | ||
+ | * ''%%:-\%%'' :-\ | ||
+ | * ''%%:-?%%'' :-? | ||
+ | <новаяколонка> | ||
+ | * ''%%:-D%%'' :-D | ||
+ | * ''%%:-P%%'' :-P | ||
+ | <новаяколонка> | ||
+ | * ''%%8-)%%'' 8-) | ||
+ | * ''%%8-O%%'' 8-O | ||
+ | <новаяколонка> | ||
+ | * ''%%:-O%%'' :-O | ||
+ | * ''%%:-X%%'' :-X | ||
+ | <новаяколонка> | ||
+ | * ''%%:-|%%'' :-| | ||
+ | * ''%%;-)%%'' ;-) | ||
+ | <новаяколонка> | ||
+ | * ''%%^_^%%'' ^_^ | ||
+ | * ''%%LOL%%'' LOL | ||
+ | </колонки> | ||
+ | |||
+ | ==== Типографские символы ==== | ||
+ | <колонки> | ||
+ | * ''%%->%%'' -> | ||
+ | * ''%%<-%%'' <- | ||
+ | <новаяколонка> | ||
+ | * ''%%<->%%'' <-> | ||
+ | * ''%%=>%%'' => | ||
+ | <новаяколонка> | ||
+ | * ''%%<=%%'' <= | ||
+ | * ''%%<=>%%'' <=> | ||
+ | <новаяколонка> | ||
+ | * ''%%<<%%'' << | ||
+ | * ''%%>>%%'' >> | ||
+ | <новаяколонка> | ||
+ | * ''%%--%%'' -- | ||
+ | * ''%%---%%'' --- | ||
+ | <новаяколонка> | ||
+ | * ''%%'640x480'%%'' '640x480' | ||
+ | * ''%%(c)%%'' (c) | ||
+ | <новаяколонка> | ||
+ | * ''%%(tm)%%'' (tm) | ||
+ | * ''%%(r)%%'' (r) | ||
+ | <новаяколонка> | ||
+ | * ''%%"кавычки"%%'' "кавычки"((система не всегда корректно преобразует кавычки в "//ёлочки//" при комбинировании стилей, поэтому рекомендуется использовать символы %%<<%% и %%>>%%.)) | ||
+ | </колонки> | ||
+ | |||
+ | ===== Списки ===== | ||
+ | |||
+ | [[wiki:Dokuwiki]] поддерживает нумерованные, ненумерованные, с определениями и многоуровневые нумерованные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и потом * в случае ненумерованного списка, - в случае нумерованного или ~ в случае многоуровневого нумерованного. Для списка с определениями после двух пробелов поставьте ? для определения или : для элемента с описанием.\\ | ||
+ | Кроме того, элементы списков (кроме определений) можно разрывать на [[#абзацы]]. Для этого у нужного элемента вместо одного специального символа необходимо поставить два, а новый абзац начать с .. после двух пробелов. | ||
+ | |||
+ | <колонки> | ||
+ | <code> | ||
+ | - нумерованный список | ||
+ | ~ нумерованный список с многоуровневой нумерацией | ||
+ | * ненумерованный список | ||
+ | ? определение для списка с определениями | ||
+ | : описание для списка с определениями | ||
+ | |||
+ | -- элемент нумерованного списка с несколькими параграфами | ||
+ | ~~ элемент многоуровневого нумерованного списка с несколькими параграфами | ||
+ | ** элемент ненумерованного списка с несколькими параграфами | ||
+ | :: элемент описания списка с определениями с несколькими параграфами | ||
+ | .. новый параграф для --, ~~, **, или :: | ||
+ | </code> | ||
+ | |||
+ | <code> | ||
+ | * Это список | ||
+ | * Второй элемент списка | ||
+ | * Можно сделать вложенный список | ||
+ | ** Ещё один элемент, теперь разбитый на два параграфа | ||
+ | .. Очень удобно | ||
+ | |||
+ | - Тот же список, только нумерованный | ||
+ | - Ещё элемент | ||
+ | - Чем больше пробелов в начале, тем глубже вложенность | ||
+ | - Всё просто | ||
+ | |||
+ | ~ А вот это список с многоуровневой нумерацией | ||
+ | ~ Мало чем отличается от нумерованного | ||
+ | ~ Кроме нумерации подсписков | ||
+ | ~ Иногда полезно | ||
+ | |||
+ | ? Ну и напоследок | ||
+ | : Список с определениями | ||
+ | * Бывает, нужны и такие | ||
+ | * Кстати, разные типы списков можно друг в друга вкладывать | ||
+ | ? Можно поэкспериментировать | ||
+ | :: Различных вариантов очень много | ||
+ | .. Можно очень красиво структурировать материал | ||
+ | </code> | ||
+ | <новаяколонка> | ||
+ | * Это список | ||
+ | * Второй элемент списка | ||
+ | * Можно сделать вложенный список | ||
+ | ** Ещё один элемент, теперь разбитый на два параграфа | ||
+ | .. Очень удобно | ||
+ | |||
+ | - Тот же список, только нумерованный | ||
+ | - Ещё элемент | ||
+ | - Чем больше пробелов в начале, тем глубже вложенность | ||
+ | - Всё просто | ||
+ | |||
+ | ~ А вот это список с многоуровневой нумерацией | ||
+ | ~ Мало чем отличается от нумерованного | ||
+ | ~ Кроме нумерации подсписков | ||
+ | ~ Иногда полезно | ||
+ | |||
+ | ? Ну и напоследок | ||
+ | : Список с определениями | ||
+ | * Бывает, нужны и такие | ||
+ | * Кстати, разные типы списков можно друг в друга вкладывать | ||
+ | ? Можно поэкспериментировать | ||
+ | :: Различных вариантов очень много | ||
+ | .. Можно очень красиво структурировать материал | ||
+ | |||
+ | </колонки> | ||
+ | |||
+ | ===== Таблицы ===== | ||
+ | |||
+ | [[wiki:DokuWiki]] поддерживает упрощённый синтаксис создания **таблиц**.\\ | ||
+ | Объединение символов границ позволяет объединить ячейки. | ||
+ | Используемые символы или их комбинации:\\ | ||
+ | * %%^%% и %%^^%% - выделение заголовка и горизонтальное объединение заголовков\\ | ||
+ | * %%|%% и %%||%% - граница ячейки и две спаренные границы - пропуск одной ячейки горизонтально\\ | ||
+ | * %%:::%% - параметр вертикального объединения ячейки с верхней ячейкой\\ | ||
+ | <note tip>Положение текста в ячейке определяется парами (и более) пробелов. \\ | ||
+ | В ячейках возможно применение многих конструкций форматирования текста.</note> | ||
+ | <колонки> | ||
+ | | Центр ^^Лево ^ Право^ | ||
+ | ^Заголовок \\ строки ||Одна ячейка | Вторая ячейка| | ||
+ | ^ ::: ||::: | <= вертикальное объединение ячеек| | ||
+ | ^ ||Горизонтально объединённая ячейка|| | ||
+ | ^ Сверху пробел |Куда? |Туда-> |Раз. | | ||
+ | ^ ::: | ::: |Сюда-> |Два. | | ||
+ | <новаяколонка> | ||
+ | <code> | ||
+ | | Центр ^^Лево ^ Право^ | ||
+ | ^Заголовок \\ строки ||Одна ячейка | Вторая ячейка| | ||
+ | ^ ::: ||::: | <= вертикальное объединение ячеек| | ||
+ | ^ ||Горизонтально объединённая ячейка|| | ||
+ | ^ Сверху пробел |Куда? |Туда-> |Раз. | | ||
+ | ^ ::: | ::: |Сюда-> |Два. | | ||
+ | </code> | ||
+ | </колонки> | ||
+ | ===== Управляющие макросы ===== | ||
+ | |||
+ | Некоторый синтаксис влияет на то, как DokuWiki обрабатывает страницы без создания каких-либо результатов для себя. Доступны следующие макросы: | ||
+ | ^ Макрос ^ Описание | | ||
+ | | %%~~NOTOC~~%% | Если этот макрос присутствует на странице, оглавление не будет создано | | ||
+ | | %%~~NOCACHE~~%% | DokuWiki помещает все выводимое в кэш по умолчанию. Иногда это нежелательно (например, когда выше был использован синаксис %%<php>%%), добавление этого макроса заставит DokuWiki обрабатывать страницу при каждом вызове | | ||
+ | | %%~~REDIRECT>перенаправление~~%% | Этот макрос позволяет автоматически перенаправить пользователя со страницы, на которой он размещен, на страницу, указанную в параметре макроса. | | ||
+ | ===== См.также ===== | ||
+ | {{topic> Справка:Синтаксис }} | ||
+ | <style float-right> тэг: Служебная:Синтаксис </style> | ||
+ | {{tag> Справка Служебная_статья Справка:инструкция Справка:FIXME}} |