Справочник

Как создавать и редактировать страницы

Вы можете редактировать любые страницы этого сайта, а также создавать новые. Внизу каждой страницы есть кнопка “Править страницу” (“Создать страницу”, “Посмотреть исходный код” и др.), которая позволит вам это делать.

Приступая к разработке сайта, вы должны учитывать следующие моменты:

  • Редактирование доступно тем, кто прошел регистрацию. Вы должны указывать свой логин и пароль (“Вход” в левой части каждой страницы) всякий раз, когда хотите что-то изменить на страницах сайта. (подробнее о регистрации)
  • При оформлении страниц используется специальный язык Wiki-разметки. Он достаточно прост и нагляден, основные операции вы сможете делать через панель инструментов окна редактирования. Подробное описание языка Wiki-разметки вы найдете на странице Wiki-синтаксис. Кроме этого, всегда можно посмотреть исходный код других страниц сайта, на которых есть нужное вам оформление.
  • В Вики всегда используется правило: “сначала ссылка, затем страница”. Ссылки, указывающие на несуществующие страницы, отображаются красным. Если выбрать такую ссылку, то вам предложат эту страницу создать. Используйте эту возможность для создания новых страниц, т.е. создайте сначала ссылку на нужную вам страницу, а затем создайте и саму страницу.
  • Страницы в Вики располагаются по пространствам имен. Каждый новый раздел следует располагать в своем пространстве, для чего нужно правильно оформить новую ссылку, указав полное имя страницы. Если новая страница относится к текущему разделу, то ссылайтесь на нее по обычному имени. (подробнее о пространствах имен и именах страниц)
  • Старайтесь не использовать длинные русские имена в названиях страниц и загружаемых документов. Используйте английские символы, или делайте название страниц лаконичным (до 15-и русских букв). Помните, что в гиперссылках выводится первый заголовок страниц, а не их название, поэтому имя страницы не так важно для пользователя.

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

DokuWiki поддерживает простой язык разметки, который по возможности сохраняет файлы данных как можно более читабельными. Здесь перечислены все возможные синтаксические конструкции, которые можно использовать при редактировании статей. Просто посмотрите на исходный код этой статьи, нажав кнопку Отредактировать статью вверху или внизу страницы. Если хотите поупражняться, просто используйте «песочницу». Простую разметку также можно легко сделать с помощью панели инструментов.

Основные конструкции форматирования

DokuWiki поддерживает выделение текста жирным шрифтом, курсивом, подчеркнутый текст и вывод текста моноширинным шрифтом. Все эти конструкции можно объединить.

DokuWiki поддерживает выделение текста **жирным шрифтом**, //курсивом//, 
__подчеркнутый текст__ и вывод текста ''моноширинным шрифтом''. 
Все эти конструкции можно **__//''объединить''//__**.

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

Также можно использовать <sub>подстрочный</sub> и <sup>надстрочный</sup> индексы.

Ещё можно зачеркнуть текст.

Ещё можно <del>зачеркнуть текст</del>.

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

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

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

Принудительные переносы следует использовать только в случае крайней необходимости.

Ссылки

Ссылки в 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>.

Внутренние

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

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

Можно использовать в ссылке пространства имён через двоеточие.

Можно использовать в ссылке [[ru:namespaces|пространство имён]] через двоеточие.

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

Ссылка на [[syntax#внутренние|этот раздел]].

Примечания:

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

InterWiki

DokuWiki поддерживает interwiki-ссылки. Это короткие ссылки на другие Wiki. Например, вот ссылка на статью Википедии о Wiki: Wiki.

DokuWiki поддерживает [[interwiki]]-ссылки. Это короткие ссылки
на другие Wiki. Например, вот ссылка на статью Википедии о Wiki: [[wp>Wiki]].

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

Совместив синтаксис ссылки и картинки, можно вставить в текст картинку, которая будет внутренней или внешней ссылкой:

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

Учтите: форматирование картинок это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки.

Сноски

С помощью двойных скобок можно добавить сноску1).

С помощью двойных скобок можно добавить сноску ((Это сноска)).

Заголовок 3-го уровня

Заголовок 4-го уровня

Заголовок 5-го уровня
==== Заголовок 3-го уровня ====
=== Заголовок 4-го уровня ===
== Заголовок 5-го уровня ==

Четыре и более тире преобразуются в горизонтальную черту:


Картинки и другие файлы

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

Нормальный размер:

Отмасштабированная до заданной ширины:

Отмасштабированная до заданных размеров:

Отмасштабированная внешняя картинка:

Нормальный размер:                        {{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 поддерживает нумерованные и ненумерованные списки. Чтобы создать элемент списка, поставьте в начале строки два пробела и потом * в случае ненумерованного списка, или - в случае нумерованного.

  • Это список
    • Второй элемент списка
      • Можно сделать вложенный список
    • Ещё один элемент
  1. Тот же список, только нумерованный
  2. Ещё элемент
    1. Чем больше пробелов в начале, тем глубже вложенность
  3. Всё просто
  * Это список
    * Второй элемент списка
      * Можно сделать вложенный список
    * Ещё один элемент

  - Тот же список, только нумерованный
  - Ещё элемент
    - Чем больше пробелов в начале, тем глубже вложенность
  - Всё просто

Типографские символы

DokuWiki может переделывать символы, набранные простым текстом, в их типографски корректные эквиваленты. Распознаются следующие символы.

→ ← ↔ ⇒ ⇐ ⇔ » « – — '640×480' © ™ ®
«Владимир Владимирович™ — это наше всё © не я»

-> <- <-> => <= <=> >> << -- --- '640x480' (c) (tm) (r)
"Владимир Владимирович(tm) --- это наше всё (c) не я"

Примечание: Это конвертирование можно отключить в файле конфигурации.

Таблицы

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  |

Можно сделать rowspans (вертикально объединённые ячейки) добавлением ::: в объединяемые нижележащие ячейки.

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

В этих ячейках не должно быть ничего, кроме синтаксиса rowspan (:::).

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

Текст клетки таблицы можно выравнивать. Просто добавьте минимум два пробела с противоположной стороны: слева — если надо выравнять вправо, справа – если надо выравнять влево, и по два с каждой стороны — если по центру.

Таблица с выравниванием
вправо по центру влево
влево вправо по центру
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx
^           Таблица с выравниванием        ^^^
|        вправо|   по центру  |влево         |
|влево         |        вправо|   по центру  |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Примечание: вертикальное выравнивание не поддерживается.

Неформатируемые блоки

Неформатируемые блоки можно вставлять в документ, либо начиная каждую строчку блока с двух или более пробелов (как это делалось в некоторых предыдущих примерах), либо используя тэги <code> или <file>.

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

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

Это просто текст, в котором есть адрес http://www.splitbrain.org и **форматирование** — но ничего не происходит.

Это просто текст, в котором есть адрес %%http://www.splitbrain.org%% 
и %%**форматирование**%% --- но ничего не происходит.

Чтобы увидеть, как используются эти блоки, смотрите код статьи.

Пространство имен

В DokuWiki вы можете использовать так называемые «Пространства имён» или «Именные пространства» для упорядочивания ваших статей.2)

Создание пространства имен

Для создания пространств имен не нужно предпринимать каких-то специальных действий: просто используйте двоеточие : в названиях статей. Часть названия после последнего двоеточия станет названием статьи (файла), а все, что находится до, станет именным пространством (последовательностью вложенных директорий). Если такого именного пространства еще нет, оно создастся автоматически.

Ссылка указывает на статью (файл) «example»
example
.example
.:example
в текущем именном пространстве.
:exampleв корневом именном пространстве.
..example
..:example
.:..:example
в родительском именном пространстве (директории на уровень выше)
wiki:example в именном пространстве «wiki». Именное пространство «wiki» вложено в корневое именное пространство.
ns1:ns2:example
:ns1:ns2:example
статья «example» находится в именном пространстве «ns2». Пространство «ns2» расположено в пространстве «ns1», которое, в свою очередь, лежит в корневом именном пространстве.
.ns1:ns2:example
.:ns1:ns2:example
страница «example» находится в именном пространстве «ns2». Пространство «ns2» расположено в пространстве «ns1», лежащем, в свою очередь, в текущем именном пространстве.
.ns1:ns2:ссылается на страницу «start» в именном пространстве «ns2». Именное пространство «ns2» расположено в именном пространстве «ns1», лежащем, в свою очередь, в текущем именном пространстве.3)

Удаление пространства имен

Если все статьи внутри пространства имен удалены, это пространство имен логически перестает существовать. DokuWiki обычно удаляет соответствующую ему пустую директорию.

1) Это сноска
2) На сервере, который обслуживает DokuWiki, пространство имён — это обычная директория, в которой находятся текстовые файлы — статьи DokuWiki.
3) Статья по умолчанию может называться не только «start», для этого надо указать нужное значение в настройках DokuWiki#start