Шпаргалка по синтаксису

  • Здесь — лишь самое важное для этого сайта.
  • Полное описание синтаксиса читайте на странице Formatting Syntax.

Основы

Параграфы

  • Следует различать исходный текст(код) страницы, и результат в виде html-страницы на экране.
  • Текст разбивается на параграфы.
  • Параграфы разделяются пустыми строками. Текст, не разделенный пустыми строками — в одном параграфе.
  • Принудительный перевод строки внутри параграфа — символы «\\».
  • Пример:

Текст первого параграфа. Первое предложение. Второе предложение с принудительным переводом строки
Третье предложение. Всё еще 1-й параграф.

Это предложение — из 2-го параграфа.

Текст первого параграфа. Первое предложение.
Второе предложение с принудительным переводом строки \\
Третье предложение. Всё еще 1-й параграф.

Это предложение --- из 2-го параграфа.

Выделение текста

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

Dokuwiki позволяет писать **жирным**, //наклонным//, или __подчеркнутым__ стилем, 
а также произвольной их **__//комбинацией//__**.

Примечания

  • Примечания — текст в двойных круглых скобках (( и )).
  • Пример:

Это текст1).

Это текст((это примечание)).

Секции текста

Текст разбивается логически по уровням «вложенности». Для этого используется следующий синтаксис:

====== 6 уровень - самый верхний ======
тут содержимое
===== 5 уровень =====
текст, текст
==== 4 уровень ====
=== 3 ===
== 2 - самый "внутренний" ==

Можете попробовать поэкспериментировать с этим на специальной странице для экспериментов

Ссылки

DokuWiki поддерживает много способов создания ссылок.

Внешние

Внешние ссылки распознаются автоматически: http://www.google.com или просто www.google.com - Есть возможность установить и имена ссылок: Эта ссылка указывает на Google. Адреса электронной почты как этот: andi@splitbrain.org тоже распознаются.

Внешние ссылки распознаются автоматически: http://www.google.com или просто www.google.com
- Есть возможность установить и имена ссылок: [[http://www.google.com|Эта ссылка указывает на Google]].
Адреса электронной почты как этот: <andi@splitbrain.org> тоже распознаются.

Внутренние

Внутренние ссылки создаются при помощи квадратных скобок. Можно как просто задать wiki:имя_страницы, так и использовать дополнительно текст заголовка ссылки. Имена wiki-страниц переводятся в нижний регистр автоматически, нельзя использовать спецсимволы.

Внутренние ссылки создаются при помощи квадратных скобок. 
Можно как просто задать [[doku>wiki:имя_страницы]], так и использовать дополнительно текст [[doku<wiki:pagename|заголовка ссылки]].
Имена wiki-страниц переводятся в нижний регистр автоматически, нельзя использовать спецсимволы.

Можно использовать пространства имен при помощи двоеточия в адресе.

Можно использовать [[wiki:namespaces|пространства имен]] при помощи двоеточия в адресе.

Подробнее о пространствах имен см. wiki:namespaces.

Возможно задание ссылки на отдельный раздел на странице. Просто надо добавить имя раздела после символа #, как в HTML. Это ссылка на этот раздел.

Это ссылка на [[local:syntax#Внутренние|этот раздел]].

Замечания:

  • Ссылки на существующие страницы отображаются подругому, нежели на несуществующие.
  • DokuWiki не использует CamelCase, для автоматического задания ссылок по умолчанию, но такое поведение можно включить в конфиге. Подсказка: Если DokuWiki - это ссылка, тогда она отображается соответственно2).
  • Когда заголовок раздела изменяется, то также изменяется и имя закладки. Поэтому не увлекайтесь ссылками на разделы страницы.

Interwiki

DokuWiki поддерживает простое создание ссылок на страницы других wiki(Interwiki). Например вот ссылка на страницу Википедии о wiki: Wiki.

DokuWiki поддерживает простое создание ссылок на страницы других wiki([[doku>wiki:interwiki|Interwiki]]). 
Например вот ссылка на страницу Википедии о wiki: [[wp>Wiki]].

Ресурсы общего доступа Windows

Ссылки на ресуры общего доступа Windows3) типа этой распознаются автоматически. Заметьте, что такие ссылки имеют значение только для уского круга пользователей, вроде корпоративной сети Intranet.(или сети ПУНКа).

Ссылки на ресуры общего доступа Windows типа [[\\server\share|этой]] распознаются автоматически.

Замечания:

  • По соображениям безопасности переход на прямую по таким ссылкам работает по умаолчанию только в Microsoft Internet Explorer(и только для «local zone»).
  • Для браузеров Mozilla и Firefox можно включить просмотр через параметр security.checkloaduri, но так делать не рекомендуется.
  • Подробности см здесь: 151

Картинки как ссылки

Можно также использовать картинки, как ссылки на внутренние и внешние страницы комбинируя синтаксис для ссылок и картинок (см далее), например:

[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]

Заметьте: Картики форматируются в соответствии с синтаксисом дозволеным в именах ссылок.

Поддерживается весь синтаксис картинок и ссылок (включая изменение размеров картинки, внутренние и внешние картинки и ссылки interwiki).

Картинки и др. файлы

Существует возможность добавлять внешние и внутренние картинки при помощи фигурных скобок. При желании можно указать их размер.

Настоящий размер:

С заданной шириной:

С заданной шириной и высотой:

Внешняя картинка с измененным размером:

Настоящий размер:                        {{wiki:dokuwiki-128.png}}
С заданной шириной:                      {{wiki:dokuwiki-128.png?50}}
С заданной шириной и высотой:            {{wiki:dokuwiki-128.png?200x50}}
Внешняя картинка с измененным размером:  {{http://de3.php.net/images/php.gif?200x50}}

Добавляя пробел справа или слева можно выбрать выравнивание:

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Конечно можно выбрать и заголовок картинки (отображается как всплывающая подсказка большинством браузеров).

 Это заголовок

{{ wiki:dokuwiki-128.png |Это заголовок}}

Если задать ссылку на файл (внутренний или внешний), который не является картинкой (gif,jpeg,png), то будет отображена ссылка.

Для задания картинок как ссылки на другие страницы см. Картинки как ссылки.

Элементы форматирования

Списки

Dokuwiki поддерживает нумерованные и ненумерованные списки. Для создания элемента списка, отступите на 2 пробела и используйте символ * для ненумерованного и - для нумерованного списка.

  • Это список
  • Второй элемент
    • Поддерживаются многоуровневые списки
  • Другой элемент
  1. Тот же список, только нумерованный
  2. Еще элемент
    1. Просто отступите еще 2 пробела для следующего уровня
  3. Вот.
  * Это список
  * Второй элемент
    * Поддерживаются многоуровневые списки
  * Другой элемент

  - Тот же список, только нумерованный
  - Еще элемент
    - Просто отступите еще 2 пробела для следующего уровня
  - Вот.

Таблицы

DokuWiki поддерживает простой синтаксис для создания таблиц.

Загловок 1 Загловок 2 Загловок 3
Ряд 1 Колонка 1 Ряд 1 Колонка 2 Ряд 1 Колонка 3
Ряд 2 Колонка 1 объединение ячеек (двойная вертикальная черта)
Ряд 3 Колонка 1 Ряд 2 Колонка 2 Ряд 2 Колонка 3

Обычная ячейка начинается с символа |, а заголовочная с символа ^.

^ Загловок 1         ^ Загловок 2          ^ Загловок 3               ^
| Ряд 1 Колонка 1    | Ряд 1 Колонка 2     | Ряд 1 Колонка 3          |
| Ряд 2 Колонка 1    | объединение ячеек (двойная вертикальная черта) ||
| Ряд 3 Колонка 1    | Ряд 2 Колонка 2     | Ряд 2 Колонка 3          |

Чтобы объединить соседние ячейки по горизонтали, просто оставьте следующую ячейку пустой, как показанно выше. Удостоверьтесь что количество разделителей одинаково для всех рядов!

Поддерживается также и вертикальное расположение заголовков:

Заголовок 1 Заголовок 2
Заголовок 3 Ряд 1 Колонка 2 Ряд 1 Колонка 3
Заголовок 4 теперь без объединения
Заголовок 5 Ряд 2 Колонка 2 Ряд 2 Колонка 3

Как видно, разделительный символ в начале ячейки определяет ее форматирование:

|                ^ Заголовок 1            ^ Заголовок 2        ^
^ Заголовок 3    | Ряд 1 Колонка 2        | Ряд 1 Колонка 3    |
^ Заголовок 4    | теперь без объединения |                    |
^ Заголовок 5    | Ряд 2 Колонка 2        | Ряд 2 Колонка 3    |

Замечание: Объединение ячеек по вертикали не поддерживается.

Вы также можете выравнивать содержимое таблицы. Просто добавте хотябы 2 пробела на противоположном конце текста: Добавте 2 пробела слева чтобы выравнять по правому краю, 2 пробела справа чтобы выравнять по левому или по хотябы по 2 пробела справа и слева для выравнивания по центру.

Таблица с выравниванием
по правому краю по центру по левому краю
по левому краю по правому краю по центру
xxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxx

Вот так выглядит исходный код этой таблицы:

^                  Таблица с выравниванием                 ^^^
|     по правому краю|      по центру      |по левому краю       |
|по левому краю      |      по правому краю|      по центру      |
| xxxxxxxxxxxxxxxxxx | xxxxxxxxxxxxxxxxxxx | xxxxxxxxxxxxxxxxxxx |

см. tables

Цитаты

Иногда надо выделить какой-нибудь текст, чтобы показать что это ответ или комментарий. Можно использовать следующий синтаксис:

Я думаю мы должны сделать это.

> Нет, мы не должны.

>> А я сказал должны.

> Серьйозно ?

>> ДА!

>>> А, ну тогда давай !

Я думаю мы должны сделать это.

Нет, мы не должны.
А я сказал должны.
Серьйозно ?
ДА!
А, ну тогда давай !

Непреобразуемые блоки

Существует возможность вставки непреобразуемых блоков в текст, делая отсуп на хотя бы 2 пробела в начале строки или используя тэги code или file.

Это заранее отформатированный текст, все пробелы сохранены: типа              <-вот
Это почти тоже самое, но можно использовать такое форматирование, чтобы показать что это процитирован файл.

Чтобы парсер игнорировал блок полностью(т.е. чтобы он не вообще форматировался), используйте тэг nowiki, или попросту поставьте в начале строки два процента: %%.

Это текст, содержит ссылки типа http://www.splitbrain.org и **форматирование**, но отображение идёт "как есть".

См исходный код этой страницы, чтобы лучше понять как использовать такие блоки.

Расширения

box plug-in

BOX — это способ поместить текст в рамку, красиво его таким образом выделить и отделить от остального текста

Примеры: (чтобы посмотреть код, смотрите код ;) )

test

Содержимое рамки

Заголовок

Содержимое
Содержимое

Заголовок

Полный синтаксис:

<box width classes | title text> contents text </box>

  • width — any legal CSS width value — например, 35% (проценты ширины) или 220px (пиксели)
  • classes — any number of classes which use the styles in your template or the plugin's own stylesheet to determine the look of the box. The box plugins comes with the following classes already defined:
    • round — округленные края
    • [цвет] blue — синий (голубой)
    • [цвет] red — красный
    • [цвет] green — зеленый
    • [цвет] orange — оранжевый
    • left — float the box left within the wiki page — «плавающий» бокс слева
    • right — float the box right within the wiki page — так же справа

Если цвет не указать, используется цвет по умолчанию, зависящий от настроек сайта.

  • title text — текст заголовка (в рамках синтаксиса dokuwiki), отображается сверху бокса, в своем стиле.
  • caption text — текст «подписи» (просто текст), отображается под боксом, в своем стиле.

Открывающий тэг <box … > должен быть полностью на одной строке.

Интеграция информации с html-сайтов

Можно попробовать http://diberri.dyndns.org/html2wiki.html — вроде даже таблицы преобразует. нашел c2h5oh. — BAleks [2006-04-10 17:03]

1) это примечание
2) о чем тут ваще ?
3) В простонародье «шАры»
wiki/syntax-ru.txt · Последние изменения: Y-m-d H:i — 194.186.207.143
Наверх
CC Attribution-Noncommercial-Share Alike 3.0 Unported
Driven by DokuWiki Recent changes RSS feed Valid CSS Valid XHTML 1.0