Различия
Здесь показаны различия между двумя версиями данной страницы.
| Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
|
wiki:syntax [2012/04/26 19:24] [Внутренние] исправление отсутствующей ссылки |
wiki:syntax [2017/08/23 21:21] (текущий) |
||
|---|---|---|---|
| Строка 1: | Строка 1: | ||
| - | ====== Синтаксис форматирования ====== | + | ====== Formatting Syntax ====== |
| - | DokuWiki поддерживает простой язык разметки, который по возможности сохраняет исходный текст как можно более читабельным. Здесь перечислены все доступные синтаксические конструкции, которые можно использовать при редактировании страниц на данном ресурсе. Если хотите поупражняться в использовании разметки, используйте специально предназначенную для этого [[playground:playground|«песочницу»]]. Большинство элементов разметки также можно добавить с помощью панели инструментов, которая появляется при редактировании над областью изменения текста. | + | [[doku>DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". If you want to try something, just use the [[playground:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too. |
| - | ===== Основные конструкции форматирования ===== | + | ===== Basic Text Formatting ===== |
| - | DokuWiki поддерживает выделение текста **полужирным шрифтом**, //курсивом//, __подчеркнутым__, вывод текста ''моноширинным шрифтом''. Все эти конструкции можно **__//''объединить''//__**: | + | DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these. |
| - | <code> | + | DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. |
| - | DokuWiki поддерживает выделение текста **полужирным шрифтом**, //курсивом//, __подчеркнутым__, | + | Of course you can **__//''combine''//__** all these. |
| - | вывод текста ''моноширинным шрифтом''. Все эти конструкции можно **__//''объединить''//__**: | + | |
| - | </code> | + | |
| - | Также можно использовать <sub>подстрочный</sub> и <sup>надстрочный</sup> индексы и <del>зачёркнутый текст</del>: | + | You can use <sub>subscript</sub> and <sup>superscript</sup>, too. |
| - | <code> | + | You can use <sub>subscript</sub> and <sup>superscript</sup>, too. |
| - | Также можно использовать <sub>подстрочный</sub> и <sup>надстрочный</sup> индексы | + | |
| - | и <del>зачёркнутый текст</del> | + | |
| - | </code> | + | |
| - | **Абзацы** отбиваются пустой строкой. Если нужно //принудительно// вставить перенос строки, не создавая абзац, вставьте два обратных слэша и за ним пробел или переход к новой строке((Принудительные переносы следует использовать только в случае крайней необходимости!)): | + | You can mark something as <del>deleted</del> as well. |
| - | Вот так можно принудительно\\ | + | You can mark something as <del>deleted</del> as well. |
| - | перенести текст на новую строку. | + | |
| - | <code> | + | **Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line. |
| - | Вот так можно принудительно\\ | + | |
| - | перенести текст на новую строку. | + | |
| - | </code> | + | |
| - | ===== Ссылки ===== | + | |
| + | This is some text with some linebreaks\\ Note that the | ||
| + | two backslashes are only recognized at the end of a line\\ | ||
| + | or followed by\\ a whitespace \\this happens without it. | ||
| - | ==== Внешние ==== | + | This is some text with some linebreaks\\ Note that the |
| + | two backslashes are only recognized at the end of a line\\ | ||
| + | or followed by\\ a whitespace \\this happens without it. | ||
| - | Внешние ссылки распознаются автоматически: http://www.ubuntu.ru или просто www.ubuntu.ru. Можно использовать и явный синтаксис, который позволяет указывать текст ссылки: [[http://ubuntu.ru|Это ссылка на Ubuntu.ru]]. Также можно добавлять адреса электронной почты: andi@splitbrain.org: | + | You should use forced newlines only if really needed. |
| - | <code> | + | ===== Links ===== |
| - | Внешние ссылки распознаются автоматически: http://www.ubuntu.ru или просто www.ubuntu.ru. | + | |
| - | Можно использовать и явный синтаксис, который позволяет указывать текст ссылки: [[http://ubuntu.ru|Это ссылка на Ubuntu.ru]]. | + | |
| - | Также можно добавлять адреса электронной почты: andi@splitbrain.org. | + | |
| - | </code> | + | |
| - | ==== Внутренние ==== | + | |
| - | Внутренние ссылки, как и явные внешние, создаются посредством квадратных скобок. Можно либо просто указать имя страницы [[syntax]], либо добавить [[syntax|текст ссылки]]. Кроме того, можно ссылаться на отдельные [[syntax#внутренние|разделы документа]] и использовать [[wiki:syntax|пути до страницы]], содержащие пространства имён, разделённые двоеточиями: | + | DokuWiki supports multiple ways of creating links. |
| - | <code> | + | ==== External ==== |
| - | Внутренние ссылки, как и явные внешние, создаются посредством квадратных скобок. | + | |
| - | Можно либо просто указать имя страницы [[syntax]], либо добавить [[syntax|текст ссылки]]. | + | |
| - | Кроме того, можно ссылаться на отдельные [[syntax#внутренние|разделы документа]] и | + | |
| - | использовать [[wiki:syntax|пути до страницы]], содержащие пространства имён, разделённые двоеточиями. | + | |
| - | </code> | + | |
| - | Имена Wiki-страниц автоматически переводятся в нижний регистр, и пробел заменяется на подчёркивание, спецсимволы использовать нельзя. Вот ещё пару интересных примеров: [[#внутренние|ссылка на подраздел текущего документа]] и [[.:..:loco:главная|ссылка с использованием относительных путей]]: | + | External links are recognized automagically: http://www.google.com or simply www.google.com - You can set the link text as well: [[http://www.google.com|This Link points to google]]. Email addresses like this one: <andi@splitbrain.org> are recognized, too. |
| - | <code> | + | DokuWiki supports multiple ways of creating links. External links are recognized |
| - | Вот ещё пару интересных примеров: [[#внутренние|ссылка на подраздел текущего документа]] и | + | automagically: http://www.google.com or simply www.google.com - You can set |
| - | [[.:..:loco:главная|ссылка с использованием относительных путей]]. | + | link text as well: [[http://www.google.com|This Link points to google]]. Email |
| - | </code> | + | addresses like this one: <andi@splitbrain.org> are recognized, too. |
| - | Кстати, ссылки на [[syntax|существующие страницы]] отображаются иначе, чем ссылки на [[nonexisting|несуществующие]]. | + | ==== Internal ==== |
| - | ==== Ссылки на профили пользователей форума ==== | + | |
| - | Можно добавлять ссылки на профили пользователей [[http://forum.ubuntu.ru|форума]], как [[user>Malamut|с текстом]], так и без [[user>Malamut]]: | + | Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]]. |
| - | <code> | + | Internal links are created by using square brackets. You can either just give |
| - | Можно добавлять ссылки на профили пользователей [[http://forum.ubuntu.ru|форума]], | + | a [[pagename]] or use an additional [[pagename|link text]]. |
| - | как [[user>Malamut|с текстом]], так и без [[user>Malamut]]. | + | |
| - | </code> | + | |
| - | Имя пользователя можно скопировать с его странички на форуме. Кстати, эти ссылки используются в подписи, которую можно добавить к статье с помощью одной из кнопок на панели редактирования. | + | [[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed. |
| - | ==== InterWiki ==== | + | You can use [[some:namespaces]] by using a colon in the pagename. |
| - | DokuWiki поддерживает [[wpru>interwiki]]-ссылки. Это короткие ссылки на другие Wiki. | + | You can use [[some:namespaces]] by using a colon in the pagename. |
| - | Например, можно добавить ссылку на [[wpru>Wiki|страницу Википедии о Wiki]]: | + | |
| - | <code> | + | For details about namespaces see [[doku>namespaces]]. |
| - | DokuWiki поддерживает [[wpru>interwiki]]-ссылки. Это короткие ссылки на другие Wiki. | + | |
| - | Например, можно добавить ссылку на [[wpru>Wiki|страницу Википедии о Wiki]]: | + | |
| - | </code> | + | |
| - | Для ссылок на английские статьи [[wpru>Заглавная_страница|Википедии]] нужно использовать префикс ''%%wp>%%'', для ссылки на русские --- ''%%wpru>%%''. | + | Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[syntax#internal|this Section]]. |
| + | This links to [[syntax#internal|this Section]]. | ||
| + | Notes: | ||
| + | * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. | ||
| + | * DokuWiki does not use [[wp>CamelCase]] to automatically create links by default, but this behavior can be enabled in the [[doku>config]] file. Hint: If DokuWiki is a link, then it's enabled. | ||
| + | * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much. | ||
| + | ==== Interwiki ==== | ||
| + | DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]]. | ||
| + | DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. | ||
| + | For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]]. | ||
| + | ==== Windows Shares ==== | ||
| - | ==== Картинки-ссылки ==== | + | Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate [[wp>Intranet]]. |
| - | Совместив синтаксис ссылки и [[#картинки и другие файлы|картинки]], можно вставить в текст картинку [[http://www.dokuwiki.org/ru:dokuwiki|{{wiki:dokuwiki-128.png?20}}]], которая будет внутренней или внешней ссылкой: | + | Windows Shares like [[\\server\share|this]] are recognized, too. |
| - | <code> | + | Notes: |
| - | Совместив синтаксис ссылки и [[#картинки и другие файлы|картинки]], можно вставить в текст картинку | + | |
| - | [[http://www.dokuwiki.org/ru:dokuwiki|{{wiki:dokuwiki-128.png?20}}]], которая будет внутренней или внешней ссылкой. | + | * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone"). |
| + | * For Mozilla and Firefox it can be enabled through different workaround mentioned in the [[http://kb.mozillazine.org/Links_to_local_pages_do_not_work|Mozilla Knowledge Base]]. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in ''conf/lang/en/lang.php'' (more details at [[doku>localization#changing_some_localized_texts_and_strings_in_your_installation|localization]]): <code - conf/lang/en/lang.php> | ||
| + | <?php | ||
| + | /** | ||
| + | * Customization of the english language file | ||
| + | * Copy only the strings that needs to be modified | ||
| + | */ | ||
| + | $lang['js']['nosmblinks'] = ''; | ||
| </code> | </code> | ||
| - | Учтите: форматирование картинок --- это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки. | + | ==== Image Links ==== |
| - | ==== Сноски ==== | + | |
| - | С помощью двойных скобок можно добавить сноску((Вот так)): | + | You can also use an image to link to another internal or external page by combining the syntax for links and [[#images_and_other_files|images]] (see below) like this: |
| - | <code>С помощью двойных скобок можно добавить сноску ((Вот так)).</code> | + | [[http://php.net|{{wiki:dokuwiki-128.png}}]] |
| - | ===== Разбивка на разделы ===== | + | [[http://php.net|{{wiki:dokuwiki-128.png}}]] |
| - | Для структурирования текста можно использовать до пяти уровней заголовков. Если в тексте больше трёх заголовков, автоматически создаётся список содержимого. Его можно отключить, вставив в начало документа специальную строку %%~~NOTOC~~%%. Кроме того, четыре и более тире преобразуются в горизонтальную черту: | + | Please note: The image formatting is the only formatting syntax accepted in link names. |
| - | <code> | + | The whole [[#images_and_other_files|image]] and [[#links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links). |
| - | ====== Заголовок 1-го уровня ====== | + | |
| - | ===== Заголовок 2-го уровня ===== | + | |
| - | ==== Заголовок 3-го уровня ==== | + | |
| - | === Заголовок 4-го уровня === | + | |
| - | == Заголовок 5-го уровня == | + | |
| - | ------ | + | |
| - | </code> | + | |
| + | ===== Footnotes ===== | ||
| + | You can add footnotes ((This is a footnote)) by using double parentheses. | ||
| - | ===== Списки ===== | + | You can add footnotes ((This is a footnote)) by using double parentheses. |
| - | Dokuwiki поддерживает нумерованные, ненумерованные, с определениями и многоуровневые нумерованные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и потом * в случае ненумерованного списка, - в случае нумерованного или ~ в случае многоуровневого нумерованного. Для списка с определениями после двух пробелов поставьте ? для определения или : для элемента с описанием. | + | ===== Sectioning ===== |
| - | Кроме того, элементы списков (кроме определений) можно разрывать на абзацы. Для этого у нужного элемента вместо одного специального символа необходимо поставить два, а новый абзац начать с .. после двух пробелов. | + | You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically -- this can be disabled by including the string ''<nowiki>~~NOTOC~~</nowiki>'' in the document. |
| - | <code> | + | ==== Headline Level 3 ==== |
| - | - нумерованный список | + | === Headline Level 4 === |
| - | ~ нумерованный список с многоуровневой нумерацией | + | == Headline Level 5 == |
| - | * ненумерованный список | + | |
| - | ? определение для списка с определениями | + | |
| - | : описание для списка с определениями | + | |
| - | -- элемент нумерованного списка с несколькими параграфами | + | ==== Headline Level 3 ==== |
| - | ~~ элемент многоуровневого нумерованного списка с несколькими параграфами | + | === Headline Level 4 === |
| - | ** элемент ненумерованного списка с несколькими параграфами | + | == Headline Level 5 == |
| - | :: элемент описания списка с определениями с несколькими параграфами | + | |
| - | .. новый параграф для --, ~~, **, или :: | + | |
| - | </code> | + | |
| - | * Это список | + | By using four or more dashes, you can make a horizontal line: |
| - | * Второй элемент списка | + | |
| - | * Можно сделать вложенный список | + | |
| - | ** Ещё один элемент, теперь разбитый на два параграфа | + | |
| - | .. Очень удобно | + | |
| - | - Тот же список, только нумерованный | + | ---- |
| - | - Ещё элемент | + | |
| - | - Чем больше пробелов в начале, тем глубже вложенность | + | |
| - | - Всё просто | + | |
| - | ~ А вот это список с многоуровневой нумерацией | + | ===== Media Files ===== |
| - | ~ Мало чем отличается от нумерованного | + | |
| - | ~ Кроме нумерации подсписков | + | |
| - | ~ Иногда полезно | + | |
| - | ? Ну и напоследок | + | You can include external and internal [[doku>images|images, videos and audio files]] with curly brackets. Optionally you can specify the size of them. |
| - | : Список с определениями | + | |
| - | * Бывает, нужны и такие | + | |
| - | * Кстати, разные типы списков можно друг в друга вкладывать | + | |
| - | ? Можно поэкспериментировать | + | |
| - | :: Различных вариантов очень много | + | |
| - | .. Можно очень красиво структурировать материал | + | |
| - | <code> | + | Real size: {{wiki:dokuwiki-128.png}} |
| - | * Это список | + | |
| - | * Второй элемент списка | + | |
| - | * Можно сделать вложенный список | + | |
| - | ** Ещё один элемент, теперь разбитый на два параграфа | + | |
| - | .. Очень удобно | + | |
| - | - Тот же список, только нумерованный | + | Resize to given width: {{wiki:dokuwiki-128.png?50}} |
| - | - Ещё элемент | + | |
| - | - Чем больше пробелов в начале, тем глубже вложенность | + | |
| - | - Всё просто | + | |
| - | ~ А вот это список с многоуровневой нумерацией | + | Resize to given width and height((when the aspect ratio of the given width and height doesn't match that of the image, it will be cropped to the new ratio before resizing)): {{wiki:dokuwiki-128.png?200x50}} |
| - | ~ Мало чем отличается от нумерованного | + | |
| - | ~ Кроме нумерации подсписков | + | |
| - | ~ Иногда полезно | + | |
| - | ? Ну и напоследок | + | Resized external image: {{http://php.net/images/php.gif?200x50}} |
| - | : Список с определениями | + | |
| - | * Бывает, нужны и такие | + | |
| - | * Кстати, разные типы списков можно друг в друга вкладывать | + | |
| - | ? Можно поэкспериментировать | + | |
| - | :: Различных вариантов очень много | + | |
| - | .. Можно очень красиво структурировать материал | + | |
| - | </code> | + | |
| + | Real size: {{wiki:dokuwiki-128.png}} | ||
| + | Resize to given width: {{wiki:dokuwiki-128.png?50}} | ||
| + | Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} | ||
| + | Resized external image: {{http://php.net/images/php.gif?200x50}} | ||
| - | ===== Картинки и другие файлы ===== | ||
| - | С помощью фигурных скобок можно вставлять в текст внешние и внутренние картинки. | + | By using left or right whitespaces you can choose the alignment. |
| - | Для загрузки файла на вики в режиме редактирования статьи одна из кнопок над формой редактирования вызывает менеджер закачки файлов. | + | {{ wiki:dokuwiki-128.png}} |
| - | По желанию можно указать их размер. | + | {{wiki:dokuwiki-128.png }} |
| - | Полный размер: {{wiki:dokuwiki-128.png}} | + | {{ wiki:dokuwiki-128.png }} |
| - | Отмасштабированная до заданной ширины: {{wiki:dokuwiki-128.png?50}} | + | {{ wiki:dokuwiki-128.png}} |
| + | {{wiki:dokuwiki-128.png }} | ||
| + | {{ wiki:dokuwiki-128.png }} | ||
| - | Отмасштабированная до заданных размеров: {{wiki:dokuwiki-128.png?200x50}} | + | Of course, you can add a title (displayed as a tooltip by most browsers), too. |
| - | Отмасштабированная внешняя картинка: {{http://de3.php.net/images/php.gif?200x50}} | + | {{ wiki:dokuwiki-128.png |This is the caption}} |
| - | <code> | + | {{ wiki:dokuwiki-128.png |This is the caption}} |
| - | Полный размер: {{wiki:dokuwiki-128.png}} | + | |
| - | Отмасштабированная до заданной ширины: {{wiki:dokuwiki-128.png?50}} | + | |
| - | Отмасштабированная до заданных размеров: {{wiki:dokuwiki-128.png?200x50}} | + | |
| - | Отмасштабированная внешняя картинка: {{http://de3.php.net/images/php.gif?200x50}} | + | |
| - | </code> | + | |
| - | Поставив слева или справа пробел, можно задать выравнивание картинки: | + | For linking an image to another page see [[#Image Links]] above. |
| - | {{wiki:dokuwiki-128.png |Первая строка кода (см. ниже)}} | + | ==== Supported Media Formats ==== |
| - | {{ wiki:dokuwiki-128.png|Вторая строка кода (см. ниже)}} | + | |
| - | {{ wiki:dokuwiki-128.png |Третья строка кода (см. ниже)}} | + | |
| - | <code> | + | DokuWiki can embed the following media formats directly. |
| - | {{wiki:dokuwiki-128.png |Первая строка кода (см. ниже)}} | + | |
| - | {{ wiki:dokuwiki-128.png|Вторая строка кода (см.ниже)}} | + | |
| - | {{ wiki:dokuwiki-128.png |Третья строка кода (см.ниже)}} | + | |
| - | </code> | + | |
| - | И, конечно, картинке можно задать название (в большинстве браузеров оно отображается в виде всплывающей подсказки). | + | | Image | ''gif'', ''jpg'', ''png'' | |
| + | | Video | ''webm'', ''ogv'', ''mp4'' | | ||
| + | | Audio | ''ogg'', ''mp3'', ''wav'' | | ||
| + | | Flash | ''swf'' | | ||
| - | {{ wiki:dokuwiki-128.png |Название картинки}} | + | If you specify a filename that is not a supported media format, then it will be displayed as a link instead. |
| - | <code>{{ wiki:dokuwiki-128.png |Название картинки}}</code> | + | By adding ''?linkonly'' you provide a link to the media without displaying it inline |
| - | Если задать имя файла (внутреннее или внешнее), которое не является картинкой (''gif'', ''jpeg'', ''png''), оно будет отображаться в виде ссылки. | + | {{wiki:dokuwiki-128.png?linkonly}} |
| - | Узнать, как вставить картинку со ссылкой, можно в [[#картинки-ссылки|разделе выше]]. | + | {{wiki:dokuwiki-128.png?linkonly}} This is just a link to the image. |
| - | ===== Смайлики ===== | + | |
| - | DokuWiki переделывает наиболее употребляемые смайлики в их графические эквиваленты. Вот список доступных смайлов: | + | ==== Fallback Formats ==== |
| - | <колонки> | + | Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility. |
| - | * FIXME %%FIXME%% | + | |
| - | * DELETEME %%DELETEME%% | + | |
| - | * 8-) %%8-)%% | + | |
| - | * 8-O %%8-O%% | + | |
| - | * :-( %%:-(%% | + | |
| - | <новаяколонка> | + | |
| - | * :-) %%:-)%% | + | |
| - | * =) %%=)%% | + | |
| - | * :-/ %%:-/%% | + | |
| - | * :-\ %%:-\%% | + | |
| - | * :-? %%:-?%% | + | |
| - | <новаяколонка> | + | |
| - | * :-D %%:-D%% | + | |
| - | * :-P %%:-P%% | + | |
| - | * :-O %%:-O%% | + | |
| - | * :-X %%:-X%% | + | |
| - | * :-| %%:-|%% | + | |
| - | <новаяколонка> | + | |
| - | * ;-) %%;-)%% | + | |
| - | * ^_^ %%^_^%% | + | |
| - | * :?: %%:?:%% | + | |
| - | * :!: %%:!:%% | + | |
| - | * LOL %%LOL%% | + | |
| - | </колонки> | + | |
| - | ===== Типографские символы ===== | + | For example consider this embedded mp4 video: |
| - | DokuWiki может переделывать символы, набранные простым текстом, в их типографски корректные эквиваленты. Распознаются следующие символы: | + | {{video.mp4|A funny video}} |
| - | -> <- <-> => <= <=> >> << -- --- '640x480' (c) (tm) (r)\\ | + | When you upload a ''video.webm'' and ''video.ogv'' next to the referenced ''video.mp4'', DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser. |
| - | "Владимир Владимирович(tm) --- это наше всё (c) не я" | + | |
| + | Additionally DokuWiki supports a "poster" image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a ''video.jpg'' file would work. | ||
| + | |||
| + | ===== Lists ===== | ||
| + | |||
| + | Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a ''*'' for unordered lists or a ''-'' for ordered ones. | ||
| + | |||
| + | * This is a list | ||
| + | * The second item | ||
| + | * You may have different levels | ||
| + | * Another item | ||
| + | |||
| + | - The same list but ordered | ||
| + | - Another item | ||
| + | - Just use indention for deeper levels | ||
| + | - That's it | ||
| <code> | <code> | ||
| - | -> <- <-> => <= <=> >> << -- --- '640x480' (c) (tm) (r) | + | * This is a list |
| - | "Владимир Владимирович(tm) --- это наше всё (c) не я" | + | * The second item |
| + | * You may have different levels | ||
| + | * Another item | ||
| + | |||
| + | - The same list but ordered | ||
| + | - Another item | ||
| + | - Just use indention for deeper levels | ||
| + | - That's it | ||
| </code> | </code> | ||
| - | ===== Таблицы ===== | + | Also take a look at the [[doku>faq:lists|FAQ on list items]]. |
| + | |||
| + | ===== Text Conversions ===== | ||
| + | |||
| + | DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML. | ||
| + | |||
| + | The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, but can be configured to use other HTML as well. | ||
| + | |||
| + | ==== Text to Image Conversions ==== | ||
| + | |||
| + | DokuWiki converts commonly used [[wp>emoticon]]s to their graphical equivalents. Those [[doku>Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki: | ||
| + | |||
| + | * 8-) %% 8-) %% | ||
| + | * 8-O %% 8-O %% | ||
| + | * :-( %% :-( %% | ||
| + | * :-) %% :-) %% | ||
| + | * =) %% =) %% | ||
| + | * :-/ %% :-/ %% | ||
| + | * :-\ %% :-\ %% | ||
| + | * :-? %% :-? %% | ||
| + | * :-D %% :-D %% | ||
| + | * :-P %% :-P %% | ||
| + | * :-O %% :-O %% | ||
| + | * :-X %% :-X %% | ||
| + | * :-| %% :-| %% | ||
| + | * ;-) %% ;-) %% | ||
| + | * ^_^ %% ^_^ %% | ||
| + | * :?: %% :?: %% | ||
| + | * :!: %% :!: %% | ||
| + | * LOL %% LOL %% | ||
| + | * FIXME %% FIXME %% | ||
| + | * DELETEME %% DELETEME %% | ||
| - | DokuWiki поддерживает упрощённый синтаксис создания таблиц. | + | ==== Text to HTML Conversions ==== |
| - | ^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^ | + | Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. |
| - | | Ряд 1 Колонка 1 | Ряд 1 Колонка 2 | Ряд 1 Колонка 3 | | + | |
| - | | Ряд 2 Колонка 1 | Объединение колонок (обратите внимание на двойную вертикальную черту) || | + | |
| - | | Ряд 3 Колонка 1 | Ряд 2 Колонка 2 | Ряд 2 Колонка 3 | | + | |
| - | Нормальные ряды должны начинаться и заканчиваться символом |, а заголовки — ^. | + | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) |
| + | "He thought 'It's a man's world'..." | ||
| <code> | <code> | ||
| - | ^ Заголовок 1 ^ Заголовок 2 ^ Заголовок 3 ^ | + | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) |
| - | | Ряд 1 Колонка 1 | Ряд 1 Колонка 2 | Ряд 1 Колонка 3 | | + | "He thought 'It's a man's world'..." |
| - | | Ряд 2 Колонка 1 | Объединение колонок (обратите внимание на двойную вертикальную черту) || | + | |
| - | | Ряд 3 Колонка 1 | Ряд 2 Колонка 2 | Ряд 2 Колонка 3 | | + | |
| </code> | </code> | ||
| - | Чтобы объединить две соседние клетки в ряду, просто оставьте соседнюю клетку полностью пустой, как показано выше. Следите, чтобы количество разделителей клеток было одинаковым! | + | The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]]. |
| - | Вертикальные заголовки тоже можно сделать. | + | There are three exceptions which do not come from that pattern file: multiplication entity (640x480), 'single' and "double quotes". They can be turned off through a [[doku>config:typography|config option]]. |
| - | | ^ Заголовок 1 ^ Заголовок 2 ^ | + | ===== Quoting ===== |
| - | ^ Заголовок 3 | Ряд 1 Колонка 2 | Ряд 1 Колонка 3 | | + | |
| - | ^ Заголовок 4 | Объединения нет | | | + | |
| - | ^ Заголовок 5 | Ряд 2 Колонка 2 | Ряд 2 Колонка 3 | | + | |
| - | Как легко увидеть, разделитель стоящий перед клеткой определяет форматирование: | + | Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: |
| <code> | <code> | ||
| - | | ^ Заголовок 1 ^ Заголовок 2 ^ | + | I think we should do it |
| - | ^ Заголовок 3 | Ряд 1 Колонка 2 | Ряд 1 Колонка 3 | | + | |
| - | ^ Заголовок 4 | Объединения нет | | | + | |
| - | ^ Заголовок 5 | Ряд 2 Колонка 2 | Ряд 2 Колонка 3 | | + | |
| - | </code> | + | |
| - | Примечание: Вертикальное объединение (rowspan) не поддерживается. | + | > No we shouldn't |
| - | Текст клетки таблицы можно выравнивать. Просто добавьте минимум два пробела с противоположной стороны: слева — если надо выравнять вправо, справа – если надо выравнять влево, и по два с каждой стороны — если по центру. | + | >> Well, I say we should |
| - | ^ Таблица с выравниванием ^^^ | + | > Really? |
| - | | вправо| по центру |влево | | + | |
| - | |влево | вправо| по центру | | + | |
| - | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | + | |
| - | ^ Таблица с выравниванием ^^^ | + | >> Yes! |
| - | | вправо| по центру |влево | | + | |
| - | |влево | вправо| по центру | | + | |
| - | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | + | |
| + | >>> Then lets do it! | ||
| + | </code> | ||
| - | ===== Неформатируемые блоки ===== | + | I think we should do it |
| - | Неформатируемые блоки можно вставлять в документ, либо начиная каждую строчку блока с двух или более пробелов (как это делалось в некоторых предыдущих примерах), либо используя тэги ''%%<code>%%'' или ''%%<file>%%''. | + | > No we shouldn't |
| - | <code>Это неформатированный текст, в котором сохранены все пробелы: вот <- так.</code> | + | >> Well, I say we should |
| - | <file>В принципе то же самое, но этим выделением можно показать, | + | > Really? |
| - | что цитируется содержимое файла.</file> | + | |
| - | Чтобы парсер полностью проигнорировал некий текст (т.е. не форматировал его), либо заключите его в тэги ''nowiki'', либо ещё проще — в двойные знаки процента ''<nowiki>%%</nowiki>''. | + | >> Yes! |
| - | Это просто текст, в котором есть адрес %%http://www.splitbrain.org%% | + | >>> Then lets do it! |
| - | и %%**форматирование**%% --- но ничего не происходит. | + | |
| - | <code>Это просто текст, в котором есть адрес %%http://www.splitbrain.org%% | + | ===== Tables ===== |
| - | и %%**форматирование**%% --- но ничего не происходит.</code> | + | |
| - | Чтобы увидеть, как используются эти блоки, смотрите код страницы. | + | DokuWiki supports a simple syntax to create tables. |
| - | ===== Подсветка синтаксиса ===== | + | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ |
| + | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
| + | | Row 2 Col 1 | some colspan (note the double pipe) || | ||
| + | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | | ||
| - | DokuWiki может подсвечивать программный код, чтобы его было проще читать. Для этого используется библиотека [[http://qbnz.com/highlighter/|GeSHi]] — соответственно подсвечиваются все языки, поддерживаемые GeSHi. Синтаксис такой же, как и в блоке ''code'' в предыдущем разделе, но на этот раз внутри тэга добавляется название языка. Например %%<code java>%%. | + | Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers. |
| - | <code java> | + | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ |
| - | /** | + | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | |
| - | * The HelloWorldApp class implements an application that | + | | Row 2 Col 1 | some colspan (note the double pipe) || |
| - | * simply displays "Hello World!" to the standard output. | + | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | |
| - | */ | + | |
| - | class HelloWorldApp { | + | |
| - | public static void main(String[] args) { | + | |
| - | System.out.println("Hello World!"); //Display the string. | + | |
| - | } | + | |
| - | } | + | |
| - | </code> | + | |
| - | На данный момент распознаются следующие языки: //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// | + | To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators! |
| + | Vertical tableheaders are possible, too. | ||
| - | ===== Вставка HTML и PHP ===== | + | | ^ Heading 1 ^ Heading 2 ^ |
| + | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | | ||
| + | ^ Heading 4 | no colspan this time | | | ||
| + | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ||
| - | Чистый HTML- или PHP-код можно вставлять в документ с помощью тэгов html и php: | + | As you can see, it's the cell separator before a cell which decides about the formatting: |
| - | <code html> | + | | ^ Heading 1 ^ Heading 2 ^ |
| - | <html> | + | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | |
| - | Тут вставлен <font color="red" size="+1">HTML-код</font> | + | ^ Heading 4 | no colspan this time | | |
| - | </html> | + | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | |
| - | </code> | + | |
| - | <html> | + | You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect. |
| - | Тут вставлен <font color="red" size="+1">HTML-код</font> | + | |
| - | </html> | + | |
| - | <code php> | + | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ |
| - | <php> | + | | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | |
| - | echo 'Логотип, сгенерированный PHP:'; | + | | Row 2 Col 1 | ::: | Row 2 Col 3 | |
| - | echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="Логотип PHP!" />'; | + | | Row 3 Col 1 | ::: | Row 2 Col 3 | |
| - | </php> | + | |
| - | </code> | + | |
| - | <php> | + | Apart from the rowspan syntax those cells should not contain anything else. |
| - | echo 'Логотип, сгенерированный PHP:'; | + | |
| - | echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="Логотип PHP!" />'; | + | |
| - | </php> | + | |
| - | **Примечание**: по умолчанию вставка HTML и PHP запрещена. Когда она запрещена, код не исполняется, а выводится в исходном виде. | + | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ |
| + | | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | | ||
| + | | Row 2 Col 1 | ::: | Row 2 Col 3 | | ||
| + | | Row 3 Col 1 | ::: | Row 2 Col 3 | | ||
| - | ===== Управляющие макросы ===== | + | You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. |
| - | Некоторый синтаксис влияет на то, как DokuWiki обрабатывает страницы без создания каких либо результатов для себя. Доступны следующие макросы: | + | ^ Table with alignment ^^^ |
| + | | right| center |left | | ||
| + | |left | right| center | | ||
| + | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
| - | ^ Макрос ^ Описание | | + | This is how it looks in the source: |
| - | | %%~~NOTOC~~%% | Если этот макрос присутствует на странице, оглавление не будет создано | | + | |
| - | | %%~~NOCACHE~~%% | DokuWiki помещает все выводимое в кэш по умолчанию. Иногда это нежелательно (например когда выше был использован синаксис %%<php>%%), добавление этого макроса заставит DokuWiki обрабатывать страницу при каждом вызове | | + | |
| - | ===== Синтаксические плагины ===== | + | ^ Table with alignment ^^^ |
| + | | right| center |left | | ||
| + | |left | right| center | | ||
| + | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
| - | Синтаксис DokuWiki может быть расширен за счет [[doku>plugins|плагинов]]. | + | Note: Vertical alignment is not supported. |
| - | Как устанавливать дополнения и использовать их описывается на их страницах описания. Следующие дополнения синтаксиса доступны в этой инсталляции DokuWiki: | + | |
| - | ==== Cинтактический плагин Styler ==== | + | ===== No Formatting ===== |
| - | Синтаксис использования, примеры: | + | If you need to display text exactly like it is typed (without any formatting), enclose the area either with ''%%<nowiki>%%'' tags or even simpler, with double percent signs ''<nowiki>%%</nowiki>''. |
| - | * http://www.dokuwiki.org/plugin:styler | + | <nowiki> |
| - | * http://iar.spb.ru/en/projects/dokuwiki/styler/start?redirect=1 | + | This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. |
| + | </nowiki> | ||
| + | The same is true for %%//__this__ text// with a smiley ;-)%%. | ||
| - | ==== Синтаксический плагин Note ==== | + | <nowiki> |
| + | This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. | ||
| + | </nowiki> | ||
| + | The same is true for %%//__this__ text// with a smiley ;-)%%. | ||
| - | <note> Обратите внимание. Это нужно запомнить! </note> | + | ===== Code Blocks ===== |
| - | <note important> Внимание! Вы можете потерять рассудок. </note> | + | |
| - | <note tip> Подсказки находятся на изображениях. </note> | + | |
| - | <note warning> Остерегайтесь собаки, когда открываете дверь! </note> | + | |
| - | <note> Обратите внимание. Это нужно запомнить! </note> | + | You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags ''%%<code>%%'' or ''%%<file>%%''. |
| - | <note important> Внимание! Вы можете потерять рассудок. </note> | + | |
| - | <note tip> Подсказки находятся на изображениях. </note> | + | |
| - | <note warning> Остерегайтесь собаки, когда открываете дверь! </note> | + | |
| - | Вы можете использовать важные примечания, предупреждения и подсказки. Довольно легко добавить новые типы примечаний, если Вы знаете немного PHP и CSS. | + | This is text is indented by two spaces. |
| + | <code> | ||
| + | This is preformatted code all spaces are preserved: like <-this | ||
| + | </code> | ||
| - | ==== Cинтаксический плагин Keyboard ==== | + | <file> |
| + | This is pretty much the same, but you could use it to show that you quoted a file. | ||
| + | </file> | ||
| - | Enclose the name of a key, or a combination of keys, separated by a dash (**''-''**), in a //key// tag, like this: | + | Those blocks were created by this source: |
| - | <key>Key</key> or <key>C-x</key> | + | This is text is indented by two spaces. |
| - | * The text inside the **''key''** tag is split at the occurrences of **''-''** (dash). | + | <code> |
| - | * Each part is //trimmed// (surrounding whitespace removed) and known shortcuts or key names are //substituted//. E.g. **''C''** becomes **''Ctrl''**, **''Left''** becomes **''%%←%%''** etc. | + | This is preformatted code all spaces are preserved: like <-this |
| - | * The substitutions are //language specific//. So, e.g. in German, **''C''** becomes **''Strg''** and **''Del''** becomes **''Entf''**. Only English and German are supported at the moment. Feel free to write additional language files and send them in for inclusion. | + | </code> |
| - | * If no substitution was found, the first letter is //capitalized// and special HTML chars are replaced with entities. | + | |
| - | * The substitution table only has key aliases that begin with a capital letter. So lower letters will not be substituted, only capitalized and, for example, **''C-c''** becomes **''Ctrl-C''** | + | |
| - | * If you want to express the dash (**''-''**) key, use **''Minus''**. | + | |
| - | * If you don't want any trimming, alias or language substitution, or capitalization, enclose your key name in //single// quotes. | + | |
| - | **Examples:** | + | <file> |
| + | This is pretty much the same, but you could use it to show that you quoted a file. | ||
| + | </file> | ||
| - | * <key>C-A-del</key> to reboot. (''%%<key>C-A-del</key>%%'') | + | ==== Syntax Highlighting ==== |
| - | * <key>C-c</key> to copy text to the clipboard. (''%%<key>C-c</key>%%'') | + | |
| - | * <key>C-x</key> to cut text and put it into the clipboard. (''%%<key>C-x</key>%%'') | + | |
| - | * <key>C-v</key> to paste text from the clipboard. (''%%<key>C-v</key>%%'') | + | |
| - | * <key>C-enter</key> to insert a page break. (''%%<key>C-enter</key>%%'') | + | |
| - | * <key>C-S-Right</key> to select from current cursor position to end of a word. (''%%<key>C-S-Right</key>%%'') | + | |
| - | * <key>C-S-Left</key> to select from current cursor position to the beginning of a word. (''%%<key>C-S-Left</key>%%'') | + | |
| - | * <key>C-PageUp</key> to go one screen page up. (''%%<key>C-PageUp</key>%%'') | + | |
| - | * <key>C-Minus</key> (''%%<key>C-Minus</key>%%'') | + | |
| - | * <key>'any key'</key> to exit. (''%%<key>'any key'</key>%%'') | + | |
| + | [[wiki:DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://qbnz.com/highlighter/|GeSHi]] Generic Syntax Highlighter -- so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. ''<nowiki><code java></nowiki>'' or ''<nowiki><file java></nowiki>''. | ||
| - | ==== Синтаксический плагин Columns ==== | + | <code java> |
| + | /** | ||
| + | * 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> | ||
| - | 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.)): | + | The following language strings are currently recognized: //4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript-french, actionscript, actionscript3, ada, algol68, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, e, epc, ecmascript, eiffel, email, erlang, euphoria, f1, falcon, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, go, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, html5, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, objeck, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, pli, plsql, postgresql, povray, powerbuilder, powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, uscript, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic// |
| + | |||
| + | ==== Downloadable Code Blocks ==== | ||
| + | |||
| + | When you use the ''%%<code>%%'' or ''%%<file>%%'' syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this: | ||
| <code> | <code> | ||
| - | <columns 100% 50% - -> | + | <file php myexample.php> |
| + | <?php echo "hello world!"; ?> | ||
| + | </file> | ||
| + | </code> | ||
| - | information in column 1 (50% width) | + | <file php myexample.php> |
| + | <?php echo "hello world!"; ?> | ||
| + | </file> | ||
| - | <newcolumn> | + | If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''. |
| - | information in column 2 | ||
| - | <newcolumn> | + | ===== Embedding HTML and PHP ===== |
| - | information in column 3 | + | You can embed raw HTML or PHP code into your documents by using the ''%%<html>%%'' or ''%%<php>%%'' tags. (Use uppercase tags if you need to enclose block level elements.) |
| - | </columns> | + | HTML example: |
| + | |||
| + | <code> | ||
| + | <html> | ||
| + | This is some <span style="color:red;font-size:150%;">inline HTML</span> | ||
| + | </html> | ||
| + | <HTML> | ||
| + | <p style="border:2px dashed red;">And this is some block HTML</p> | ||
| + | </HTML> | ||
| </code> | </code> | ||
| - | By default the text in columns is justified. This can be changed by adding asterisks on either side of the column width specification. The asterisk indicates non-justified side of the text block, so to achieve left alignment add the asterisk on the right side. | + | <html> |
| + | This is some <span style="color:red;font-size:150%;">inline HTML</span> | ||
| + | </html> | ||
| + | <HTML> | ||
| + | <p style="border:2px dashed red;">And this is some block HTML</p> | ||
| + | </HTML> | ||
| + | |||
| + | PHP example: | ||
| <code> | <code> | ||
| - | <columns 100% 25% 25%* *-* *-> | + | <php> |
| + | echo 'The PHP version: '; | ||
| + | echo phpversion(); | ||
| + | echo ' (generated inline HTML)'; | ||
| + | </php> | ||
| + | <PHP> | ||
| + | echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; | ||
| + | echo '<td>'.phpversion().'</td>'; | ||
| + | echo '</tr></table>'; | ||
| + | </PHP> | ||
| + | </code> | ||
| - | Justified text | + | <php> |
| + | echo 'The PHP version: '; | ||
| + | echo phpversion(); | ||
| + | echo ' (inline HTML)'; | ||
| + | </php> | ||
| + | <PHP> | ||
| + | echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; | ||
| + | echo '<td>'.phpversion().'</td>'; | ||
| + | echo '</tr></table>'; | ||
| + | </PHP> | ||
| - | <newcolumn> | + | **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. |
| - | Aligned on the left side | + | ===== RSS/ATOM Feed Aggregation ===== |
| + | [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http://simplepie.org/|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters: | ||
| - | <newcolumn> | + | ^ Parameter ^ Description ^ |
| + | | any number | will be used as maximum number items to show, defaults to 8 | | ||
| + | | reverse | display the last items in the feed first | | ||
| + | | author | show item authors names | | ||
| + | | date | show item dates | | ||
| + | | description| show the item description. If [[doku>config:htmlok|HTML]] is disabled all tags will be stripped | | ||
| + | | nosort | do not sort the items in the feed | | ||
| + | | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | | ||
| - | Center-aligned | + | The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki:DokuWiki]] will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[wiki:DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered. |
| - | <newcolumn> | + | By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''reverse'' parameter, or display the feed as is with ''nosort''. |
| - | Aligned on the right side | + | **Example:** |
| - | </columns> | + | {{rss>http://slashdot.org/index.rss 5 author date 1h }} |
| - | </code> | + | |
| + | {{rss>http://slashdot.org/index.rss 5 author date 1h }} | ||
| + | |||
| + | |||
| + | ===== Control Macros ===== | ||
| + | |||
| + | Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: | ||
| + | |||
| + | ^ Macro ^ Description | | ||
| + | | %%~~NOTOC~~%% | If this macro is found on the page, no table of contents will be created | | ||
| + | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<php>%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call | | ||
| + | |||
| + | ===== Syntax Plugins ===== | ||
| - | ==== Все синтаксические плагины ==== | + | DokuWiki's syntax can be extended by [[doku>plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation: |
| ~~INFO:syntaxplugins~~ | ~~INFO:syntaxplugins~~ | ||
