Здесь показаны различия между двумя версиями данной страницы.
Предыдущая версия справа и слева Предыдущая версия Следующая версия | Предыдущая версия | ||
wiki:syntax [2006/05/12 11:03] Spike |
wiki:syntax [2018/05/20 19:03] (текущий) |
||
---|---|---|---|
Строка 1: | Строка 1: | ||
- | ====== Синтакс форматирования текста в системе DokuWiki ====== | + | ====== Formatting Syntax ====== |
- | [[wiki:DokuWiki]] предлагает довольно простой язык разметки, который позволяет файлам данных оставаться читаемыми. Здесь вы узнаете обо всех возможных элементах форматирования текста, которые пригодятся при редактировании страниц. Вы можете просмотреть код этой страницы, нажав кнопку // Править страницу//. Попрактиковаться в использовании кода можно на странице [[playground:playground|playground]]. Некоторые функции разметки также могут быть использованы с помощью [[doku>wiki:quickbuttons|quickbuttons]] (панель инструментов). | + | [[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 supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these. |
- | DokuWiki поддерживает **жирный**, //курсивный//, __подчеркнутый__ и ''моноширинный'' текст. Конечно, эти элементы можно **__//''объединять''//__**. | + | DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. |
+ | Of course you can **__//''combine''//__** all these. | ||
- | DokuWiki поддерживает **жирный**, //курсивный//, __подчеркнутый__ и ''моноширинный'' текст. | + | You can use <sub>subscript</sub> and <sup>superscript</sup>, too. |
- | Конечно, эти элементы можно **__//''объединять''//__**. | + | |
- | Можно набирать текст в <sub>нижнем</sub> и <sup>верхнем</sup> индексе. | + | You can use <sub>subscript</sub> and <sup>superscript</sup>, too. |
- | Можно набирать текст в <sub>нижнем</sub> и <sup>верхнем</sup> индексе. | + | You can mark something as <del>deleted</del> as well. |
- | Можно помечать текст как <del>удаленный</del>. | + | You can mark something as <del>deleted</del> as well. |
- | Можно помечать текст как <del>удаленный</del>. | + | **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. |
- | **Параграфы** создаются пустыми строками. Если нужно вставить **разрыв строки** без создания нового параграфа, достаточно ввести две обратные косые черты и, следом, пробел или конец строки (то есть нажать Enter). | + | 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. |
- | Вот текст, который заканчивается разрывом строки\\ Обратите внимание | + | You should use forced newlines only if really needed. |
- | на то, что две обратные косые черты должны быть в конце строки\\ | + | |
- | или отделяться от последующего текста\\ пробелом. Иначе \\ничего не получится. | + | |
- | Разрыв строки следует использовать только в случае крайней необходимости. | + | ===== Links ===== |
- | ===== Ссылки ===== | + | DokuWiki supports multiple ways of creating links. |
- | DokuWiki позволяет использовать несколько способов создания ссылок. | + | ==== External ==== |
- | ==== Внешние ссылки ==== | + | 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. |
- | Внешние ссылки создаются автоматически: http://www.google.com или просто www.google.com - Вы можете дать ссылкам название: [[http://www.google.com|Ссылка ведет на Google]]. Адреса электронной почты оформляются вот так: <andi@splitbrain.org>. | + | DokuWiki supports multiple ways of creating links. External links are recognized |
+ | automagically: http://www.google.com or simply www.google.com - You can set | ||
+ | link text as well: [[http://www.google.com|This Link points to google]]. Email | ||
+ | addresses like this one: <andi@splitbrain.org> are recognized, too. | ||
- | DokuWiki позволяет использовать несколько способов создания ссылок. Внешние ссылки | + | ==== Internal ==== |
- | создаются автоматически: http://www.google.com или просто www.google.com - Вы можете | + | |
- | дать ссылкам название: [[http://www.google.com|Ссылка ведет на Google]]. Адреса | + | |
- | электронной почты оформляются вот так: <andi@splitbrain.org>. | + | |
- | ==== Внутренние ссылки ==== | + | Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]]. |
- | Внутренние ссылки создаются с помощью двойных квадратных скобок. Можно не указывать название для [[doku>wiki:pagename]], можно снабдить ссылку [[doku>wiki:pagename|Названием]]. Имена страниц автоматически переводятся в нижний регистр, специальные символы не разрешаются. | + | Internal links are created by using square brackets. You can either just give |
+ | a [[pagename]] or use an additional [[pagename|link text]]. | ||
- | Внутренние ссылки создаются с помощью двойных квадратных скобок. Можно не указывать | + | [[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed. |
- | название для [[pagename]] , можно снабдить ссылку [[pagename|Названием]]. Имена страниц | + | |
- | автоматически переводятся в нижний регистр, специальные символы не разрешаются. | + | |
- | Можно использовать в ссылке указание на пространство имен, например [[wiki:namespaces]], отделяя имя страницы от названия пространства имен двоеточием. | + | You can use [[some:namespaces]] by using a colon in the pagename. |
- | Можно использовать в ссылке указание на пространство имен, например [[wiki:namespaces]], | + | You can use [[some:namespaces]] by using a colon in the pagename. |
- | отделяя имя страницы от названия пространства имен двоеточием. | + | |
- | Подробную информацию о пространствах имен (namespaces) можно найти на официальном сайте [[doku>wiki:namespaces]]. | + | For details about namespaces see [[doku>namespaces]]. |
- | Возможно указать в ссылке привязку к конкретному разделу страницы. Для этого нужно просто добавить к ссылке символ # и название раздела, как это принято в HTML. Например, вот эта ссылка указывает на [[syntax#internal|текущий раздел]] этой страницы. | + | 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]]. |
- | Вот эта ссылка указывает на [[syntax#internal|текущий раздел]] этой страницы. | + | This links to [[syntax#internal|this Section]]. |
- | Примечания: | + | Notes: |
- | * Как вы уже могли заметить, ссылки на [[wiki:syntax|существующие страницы]] отличаются от ссылок на [[wiki:несуществующие]]. | + | * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. |
- | * По умолчанию в DokuWiki не используется [[wp>CamelCase]] для автоматического создания ссылок, но эту функцию можно включить в файле [[doku>config]]. Подсказка: Если DokuWiki – это ссылка, тогда данная функция включена. | + | * 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 ==== | ==== Interwiki ==== | ||
- | DokuWiki поддерживает [[doku>wiki:interwiki|Ссылки-Interwiki]]. Это короткие ссылки на другие Wiki. Например, вот ссылка на страницу Википедии о Wiki [[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]]. |
- | DokuWiki поддерживает [[doku>wiki:interwiki|Ссылки-Interwiki]]. Это короткие ссылки на другие Wiki. | + | DokuWiki supports [[doku>Interwiki]] links. These are quick links to other Wikis. |
- | Например, вот ссылка на страницу Википедии о Wiki [[wp>Wiki]]. | + | For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]]. |
- | ==== Виндовые шАры ==== | + | ==== Windows Shares ==== |
- | Ссылки на виндовые шары типа [[\\server\share|this]]тоже распознаются. Однако учтите, что такие ссылки имеют смысл только в гомогенных группах пользователей, например в корпоративном [[wp>Intranet]]. | + | 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]]. |
- | Ссылки на виндовые шары типа [[\\server\share|this]]тоже распознаются. | + | Windows Shares like [[\\server\share|this]] are recognized, too. |
Notes: | Notes: | ||
- | * Из соображений безопасности непосредственный просмотр виндовых шар работает по умолчанию только в Internet Explorer (и только в “локальной зоне”). | + | * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone"). |
- | * В Mozilla и Firefox эту возможность можно включить с помощью опции [[http://www.mozilla.org/quality/networking/docs/netprefs.html#file|security.checkloaduri]], но делать это не рекомендуется. | + | * 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> |
- | * Подробней читайте [[bug>151|здесь]]. | + | <?php |
+ | /** | ||
+ | * Customization of the english language file | ||
+ | * Copy only the strings that needs to be modified | ||
+ | */ | ||
+ | $lang['js']['nosmblinks'] = ''; | ||
+ | </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: |
- | [[http://www.php.net|{{wiki:dokuwiki-128.png}}]] | + | [[http://php.net|{{wiki:dokuwiki-128.png}}]] |
- | [[http://www.php.net|{{wiki:dokuwiki-128.png}}]] | + | [[http://php.net|{{wiki:dokuwiki-128.png}}]] |
- | Помните: Форматирование картинок – это единственная синтаксическая конструкция, которую можно использовать в наименовании ссылки. | + | Please note: The image formatting is the only formatting syntax accepted in link names. |
+ | 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). | ||
- | ===== Сноски ===== | + | ===== 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. |
- | ===== Структурирование текста ===== | + | ===== Sectioning ===== |
- | Для структурирования текста на странице можно использовать заголовки пяти уровней вложенности. Если использовать более трех заголовков, автоматически создается список содержимого страницы. Чтобы отключить эту функцию (например, когда текст страницы умещается в один экран), нужно включить в текст страницы неотображаемую строку ''<nowiki>~~NOTOC~~</nowiki>''. | + | 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. |
- | ==== Заголовок 3-го уровня ==== | + | ==== Headline Level 3 ==== |
- | === Заголовок 4-го уровня === | + | === Headline Level 4 === |
- | == Заголовок 5-го уровня == | + | == Headline Level 5 == |
- | ==== Заголовок 3-го уровня ==== | + | ==== Headline Level 3 ==== |
- | === Заголовок 4-го уровня === | + | === Headline Level 4 === |
- | == Заголовок 5-го уровня == | + | == Headline Level 5 == |
- | С помощью четырех и более минусов (дефисов) можно сделать горизонтальную разделительную линию: | + | By using four or more dashes, you can make a horizontal line: |
---- | ---- | ||
- | ===== Изображения и другие файлы ===== | + | ===== Media Files ===== |
- | Вы можете вставлять в текст внешние и внутренние [[doku>изображения]] с помощью фигурных скобок. Также можно масштабировать изображения. | + | You can include external and internal [[doku>images|images, videos and audio files]] with curly brackets. Optionally you can specify the size of them. |
- | Нормальный размер: {{wiki:dokuwiki-128.png}} | + | Real size: {{wiki:dokuwiki-128.png}} |
- | Масштабирование по ширине: {{wiki:dokuwiki-128.png?50}} | + | Resize to given width: {{wiki:dokuwiki-128.png?50}} |
- | Масштабирование по ширине и высоте: {{wiki:dokuwiki-128.png?200x50}} | + | 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}} |
- | Масштабирование внешнего изображения: {{http://de3.php.net/images/php.gif?200x50}} | + | Resized external image: {{http://php.net/images/php.gif?200x50}} |
- | Нормальный размер: {{wiki:dokuwiki-128.png}} | + | Real size: {{wiki:dokuwiki-128.png}} |
- | Масштабирование по ширине: {{wiki:dokuwiki-128.png?50}} | + | Resize to given width: {{wiki:dokuwiki-128.png?50}} |
- | Масштабирование по ширине и высоте: {{wiki:dokuwiki-128.png?200x50}} | + | Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} |
- | Масштабирование внешнего изображения: {{http://de3.php.net/images/php.gif?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}} | ||
Строка 157: | Строка 163: | ||
{{ wiki:dokuwiki-128.png |This is the caption}} | {{ wiki:dokuwiki-128.png |This is the caption}} | ||
- | Также можно снабдить изображение пояснительным текстом, который отображается большинством браузеров как всплывающая подсказка. (''gif,jpeg,png''). Если имя файла (внутреннего или внешнего) говорит о том, что это не изображение (то есть имеет расширение, отличное от gif, jpeg или png), будет отображена ссылка. | + | For linking an image to another page see [[#Image Links]] above. |
+ | ==== Supported Media Formats ==== | ||
- | ===== Списки ===== | + | DokuWiki can embed the following media formats directly. |
- | Dokuwiki поддерживает нумерованные и ненумерованные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и следом ''*'' для ненумерованного списка или ''-'' для нумерованного. | + | | Image | ''gif'', ''jpg'', ''png'' | |
+ | | Video | ''webm'', ''ogv'', ''mp4'' | | ||
+ | | Audio | ''ogg'', ''mp3'', ''wav'' | | ||
+ | | Flash | ''swf'' | | ||
- | * Первый элемент списка | + | If you specify a filename that is not a supported media format, then it will be displayed as a link instead. |
- | * Второй элемент списка | + | |
- | * Можно делать вложенные списки | + | |
- | * Еще один элемент списка | + | |
- | - Тот же список, только нумерованный | + | By adding ''?linkonly'' you provide a link to the media without displaying it inline |
- | - Еще один элемент | + | |
- | - Отступим и сделаем вложенный | + | {{wiki:dokuwiki-128.png?linkonly}} |
- | - Вот и все | + | |
+ | {{wiki:dokuwiki-128.png?linkonly}} This is just a link to the image. | ||
+ | |||
+ | ==== 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. | ||
+ | |||
+ | For example consider this embedded mp4 video: | ||
+ | |||
+ | {{video.mp4|A funny video}} | ||
+ | |||
+ | 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. | ||
+ | |||
+ | 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> | ||
- | * Первый элемент списка | + | * 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> | ||
- | ===== Смайлики ===== | + | 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: | ||
- | DokuWiki конвертирует текстовые [[wp>смайлики]] в их графические изображения. Дополнительные смайлики можно поместить в каталог ''smiley'' и прописать в файле ''conf/smileys.conf''. Вот смайлики, которые есть в DokuWiki изначально. | ||
* 8-) %% 8-) %% | * 8-) %% 8-) %% | ||
* 8-O %% 8-O %% | * 8-O %% 8-O %% | ||
Строка 210: | Строка 253: | ||
* DELETEME %% DELETEME %% | * DELETEME %% DELETEME %% | ||
- | ===== Типографские символы ===== | + | ==== Text to HTML Conversions ==== |
- | [[DokuWiki]] может преобразовывать некоторые символы, набранные текстом, в их типографски корректные эквиваленты. По умолчанию распознаются такие элементы. | + | Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters. |
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
Строка 222: | Строка 265: | ||
</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]]. |
- | В некоторых случаях требуется оформить текст таким образом, чтобы показать, что это ответ на вопрос или комментарий. В таких случаях используется следующий метод: | + | ===== Quoting ===== |
- | I think we should do it | + | Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: |
- | + | ||
- | > No we shouldn't | + | <code> |
- | + | I think we should do it | |
- | >> Well, I say we should | + | |
- | + | > No we shouldn't | |
- | > Really? | + | |
- | + | >> Well, I say we should | |
- | >> Yes! | + | |
- | + | > Really? | |
- | >>> Then lets do it! | + | |
+ | >> Yes! | ||
+ | |||
+ | >>> Then lets do it! | ||
+ | </code> | ||
I think we should do it | I think we should do it | ||
Строка 252: | Строка 299: | ||
>>> Then lets do it! | >>> Then lets do it! | ||
- | ===== Таблицы ===== | + | ===== Tables ===== |
- | В DokuWiki довольно просто создавать таблицы. | + | DokuWiki supports a simple syntax to create tables. |
^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
| Row 2 Col 1 | some colspan (note the double pipe) || | | Row 2 Col 1 | some colspan (note the double pipe) || | ||
- | | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | | + | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | |
- | Обычные строки должны начинаться и заканчиваться символом ''|'' (им же отделяются столбцы). Для заголовков используется символ ''^''. | + | Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers. |
^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
| Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | ||
| Row 2 Col 1 | some colspan (note the double pipe) || | | Row 2 Col 1 | some colspan (note the double pipe) || | ||
- | | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | | + | | Row 3 Col 1 | Row 3 Col 2 | Row 3 Col 3 | |
- | Возможно объединять ячейки горизонтально, для этого нужно сдвинуть разделитель к концу объединенной ячейки, как показано выше. При этом количество разделителей во всех строках таблицы должно быть одинаковым! | + | 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. |
| ^ Heading 1 ^ Heading 2 ^ | | ^ Heading 1 ^ Heading 2 ^ | ||
Строка 277: | Строка 324: | ||
^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ||
- | Как вы видите, стоящий перед ячейкой разделитель определяет ее внешний вид: | + | As you can see, it's the cell separator before a cell which decides about the formatting: |
| ^ Heading 1 ^ Heading 2 ^ | | ^ Heading 1 ^ Heading 2 ^ | ||
Строка 284: | Строка 331: | ||
^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ||
- | Примечание: Объединять ячейки вертикально нельзя. | + | You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect. |
- | Вы можете определить выравнивание текста внутри ячеек. Для этого нужно добавить не менее двух пробелов с противоположной стороны ячейки: при пробелах слева, текст выравнивается по правому краю и наоборот. Если два и более пробелов отделяют текст от обоих разделителей, текст центрируется. | + | ^ 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 | | ||
- | ^ Таблица с выравниванием ^^^ | + | Apart from the rowspan syntax those cells should not contain anything else. |
+ | |||
+ | ^ 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. | ||
+ | |||
+ | ^ Table with alignment ^^^ | ||
| right| center |left | | | right| center |left | | ||
|left | right| center | | |left | right| center | | ||
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | Обратите внимание на то, как это достигается | + | This is how it looks in the source: |
- | ^ Таблица с выравниванием ^^^ | + | ^ Table with alignment ^^^ |
| right| center |left | | | right| center |left | | ||
|left | right| center | | |left | right| center | | ||
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | ===== Необрабатываемый парсером текст ===== | + | Note: Vertical alignment is not supported. |
- | Необрабатываемый текст можно добавить в документ либо отделив его по крайней мере двумя пробелами от начала строки (как в случае со всеми примерами на этой странице), либо с использованием тэгов ''code'' или ''file''. | + | ===== 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>''. | ||
+ | |||
+ | <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 ;-)%%. | ||
+ | |||
+ | <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 ;-)%%. | ||
+ | |||
+ | ===== Code Blocks ===== | ||
+ | |||
+ | 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>%%''. | ||
+ | |||
+ | This is text is indented by two spaces. | ||
<code> | <code> | ||
- | В этой строке сохранены все пробелы: все <-this | + | This is preformatted code all spaces are preserved: like <-this |
</code> | </code> | ||
<file> | <file> | ||
- | Применение тэга %%<file>%% указывает на то, что вы приводите содержание файла. | + | This is pretty much the same, but you could use it to show that you quoted a file. |
</file> | </file> | ||
- | Чтобы заставить парсер игнорировать участки текста (то есть не форматировать их), обозначьте текст с двух сторон тэгом ''nowiki'' (разумеется, открывающим и закрывающим) или просто ''<nowiki>%%</nowiki>''. | + | Those blocks were created by this source: |
- | <nowiki> | + | This is text is indented by two spaces. |
- | В этой строке содержится URL: http://www.splitbrain.org и элементы **форматирования**, но ничего не происходит. | + | |
- | </nowiki> | + | <code> |
+ | This is preformatted code all spaces are preserved: like <-this | ||
+ | </code> | ||
- | Вы можете просмотреть код этой страницы, чтобы лучше понять, как работают эти тэги. | + | <file> |
+ | This is pretty much the same, but you could use it to show that you quoted a file. | ||
+ | </file> | ||
- | ===== Подсветка синтаксиса ===== | + | ==== Syntax Highlighting ==== |
- | [[DokuWiki]] может подсвечивать исходный код для разных языков программирования, тем самым облегчая его чтение и понимание. Для этого используется библиотека [[http://qbnz.com/highlighter/|GeSHi]] Generic Syntax Highlighter -- то есть все языки, поддерживаемые ею, подсвечиваются в DokuWiki. Для подсветки используется тэг ''<nowiki><code></nowiki>'' с указанием языка. Например, ''<nowiki><code java></nowiki>''. | + | [[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>''. |
<code java> | <code java> | ||
- | /** | + | /** |
* The HelloWorldApp class implements an application that | * The HelloWorldApp class implements an application that | ||
* simply displays "Hello World!" to the standard output. | * simply displays "Hello World!" to the standard output. | ||
Строка 336: | Строка 417: | ||
</code> | </code> | ||
- | В настоящее время поддерживаются следующие языки: //actionscript, actionscript-french, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, caddcl, cadlisp, c, c_mac, cfm, cpp, csharp, css, delphi, diff, d, div, dos, eiffel, freebasic, gml, html4strict, ini, inno, java, java5, javascript, lisp, lua, matlab, mpasm, mysql, nsis, objc, ocaml, ocaml-brief, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, scheme, sdlbasic, smarty, sql, tsql, robots, ruby, vb, vbnet, vhdl, visualfoxpro, xml// | + | The following language strings are currently recognized: //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// |
- | ===== Встраивание HTML и PHP ===== | + | There are additional [[doku>syntax_highlighting|advanced options]] available for syntax highlighting, such as highlighting lines or adding line numbers. |
+ | |||
+ | ==== 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> | ||
+ | <file php myexample.php> | ||
+ | <?php echo "hello world!"; ?> | ||
+ | </file> | ||
+ | </code> | ||
+ | |||
+ | <file php myexample.php> | ||
+ | <?php echo "hello world!"; ?> | ||
+ | </file> | ||
+ | |||
+ | If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''. | ||
+ | |||
+ | |||
+ | ===== Embedding HTML and PHP ===== | ||
+ | |||
+ | 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.) | ||
+ | |||
+ | HTML example: | ||
- | Код HTML и PHP можно встроить в код страницы с помощью тэгов ''html'' и ''php'': | ||
<code> | <code> | ||
<html> | <html> | ||
- | Здесь <font color="red" size="+1">HTML-код</font> | + | This is some <span style="color:red;font-size:150%;">inline HTML</span> |
</html> | </html> | ||
+ | <HTML> | ||
+ | <p style="border:2px dashed red;">And this is some block HTML</p> | ||
+ | </HTML> | ||
</code> | </code> | ||
<html> | <html> | ||
- | Здесь <font color="red" size="+1">HTML-код</font> | + | This is some <span style="color:red;font-size:150%;">inline HTML</span> |
</html> | </html> | ||
+ | <HTML> | ||
+ | <p style="border:2px dashed red;">And this is some block HTML</p> | ||
+ | </HTML> | ||
+ | |||
+ | PHP example: | ||
<code> | <code> | ||
<php> | <php> | ||
- | echo 'Логотип, сгенерированный PHP:'; | + | echo 'The PHP version: '; |
- | echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; | + | echo phpversion(); |
+ | echo ' (generated inline HTML)'; | ||
</php> | </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> | </code> | ||
<php> | <php> | ||
- | echo 'Логотип, сгенерированный PHP:'; | + | echo 'The PHP version: '; |
- | echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; | + | echo phpversion(); |
+ | echo ' (inline HTML)'; | ||
</php> | </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> | ||
- | **Примечание:**: Вставка HTML и PHP кода по умолчанию выключена и может быть включена в конфигурационном файле. В том случае, когда она запрещена, код не обрабатывается, а просто отображается на странице. | + | **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. |
- | ===== Плагины ===== | + | ===== 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: | ||
- | Синтаксис DokuWiki может быть расширен с помощью [[doku>wiki:plugins|плагинов]]. На официальном сайте имеется описание назначения и установки для каждого плагина. DokuWiki на этом сайте включает в себя следующие плагины: | + | ^ 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). | | ||
+ | |||
+ | 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. | ||
+ | |||
+ | 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''. | ||
+ | |||
+ | **Example:** | ||
+ | |||
+ | {{rss>http://slashdot.org/index.rss 5 author date 1h }} | ||
+ | |||
+ | {{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~~ | ||
+ |