Это старая версия документа.
Для того, чтобы создать страницу, нужно в конкретном разделе после адресной строки ввести её название латинскими буквами.
[[wiki/syntax/new]]
Выдастся сообщение о том, что страница не найдена и будет предложено её создать.
Кроме того, название страницы вписать а адресную строку, так и добавить ссылку на несуществующую страницу.
Пример:
Для того, чтобы удалить страницу нужно:
**Жирный**
Жирный
__Подчёркнутый__
Подчёркнутый
//Курсив//
Курсив
При формировании списков нужно сначала ставить 2 пробела, затем спец символ (звёздочка для ненумерованного списка, минус для нумерованного). Если нужен элемент списка более нижнего уровня, то ставим перед символом на 2 пробела больше.
* Ненумерованный список * Ненумерованный список
- Нумерованный список - Нумерованный список
Здесь описаны правила организации ссылок при создании страниц с помощью системы DokuWiki.
После слова результат следует снимок экрана с тем, как это будет выглядеть в системе.
Внешние ссылки распознаются автоматически: http://www.google.com.
Или просто www.google.com.
Также можно указывать текст ссылки:
[[http://www.google.com|Это ссылка на Google]]
Результат:
Адреса электронной почты тоже распознаются: andi@splitbrain.org.
Внутренние ссылки создаются посредством квадратных скобок.
Можно либо просто указать
[[wiki/syntax]]
Результат:
Либо дополнительно прописать
[[wiki/syntax|Справка по синтаксису]]
Результат:
Имена Wiki-страниц автоматически переводятся в нижний регистр, спецсимволы использовать нельзя.
Ставить ссылки на определённый раздел тоже можно. Просто добавьте через решётку имя раздела, также как это делается в HTML.
Ссылка на
[[wiki/syntax?&#внутренние_ссылки|Внутренние ссылки]]
Результат:
Примечания:
Отсылки на другие разделы документации могут быть двух типов:
Ссылки полагается начинать с пространства имён. Перед самой ссылкой полагается писать название раздела, в котором находится глава.
Внутренние ссылки первого типа полагается писать следующим образом:
([[ссылка_на_документ]], глава [[ссылка_на_главу]]).
Никаких названий дописывать не нужно, они подставятся автоматически.
Пример:
(см. [[ru/bsc/bsc]], глава [[ru/bsc/develop/data_struct]])
результат:
(см. Разработка сбалансированной системы показателей, глава Объекты ССП)
Ссылки второго типа полагается писать следующим образом:
[[ссылка_на_методику]], статья [[ссылка_на_главу#ссылка_на_статью|этот раздел]]
В этом случае нужно в ссылке статьи обязательно дописывать название статьи. Замечание про [методика] сохраняется.
Пример:
см. [[ru/bsc/bsc]], статья [[ru/bsc/develop/indicator_target#свойства_показателя|Свойства показателя]]
Результат:
(см. Разработка сбалансированной системы показателей, статья Свойства показателя)
Поскольку в данном случае мы пишем название статьи вручную, то при смене названия статьи внутри документа придётся также менять название ссылки вручную. (Делается это поиском ссылки на изменённую статью с помощью комынды ?do=backlink, подробнее см. удаление)
Кроме того, к ссылкам обращение может быть двух типов
В первом случае перед указанием методики (кроме случаев, когда методика - это какое-либо руководство) стоит "описано в", а слово "методика", "глава", "статья" употребляются в предложном падеже.
Пример:
…описано в методике Проектирование системы управления в статье Команды панели инструментов для диаграммы epc.
…описано в Руководство пользователя в главе Системные требования.
Во втором случаем слово "методика" не употребляется вообще, слова не склоняются, отсылка заключается в скобки.
Пример:
(см. Разработка сбалансированной системы показателей, глава Объекты ССП)
Совместив синтаксис ссылки и картинки, можно вставить в текст картинку, которая будет внутренней или внешней ссылкой:
[[http://www.php.net|{{dokuwiki-128.png}}]]
Учтите: форматирование картинок это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки.
Здесь приводятся способы вставки картинок при создании страниц в системе DokuWiki.
Но чаще всего приходится вставлять картинки с помощью стороннего плагина ImageBox. Подробности о нём ниже.
С помощью фигурных скобок можно вставлять в текст внешние и внутренние картинки.
{{wiki/syntax/dokuwiki-128.png?nolink}}
nolink - команда необходимая для того, чтобы изображение было не кликабельно.
Поставив слева или справа пробел можно задать выравнивание картинки:
{{wiki/syntax/dokuwiki-128.png?nolink }} {{ wiki/syntax/dokuwiki-128.png?nolink }} {{ wiki/syntax/dokuwiki-128.png?nolink}}
Картинке можно задать название (в большинстве браузеров оно отображается в виде всплывающей подсказки).
{{wiki/syntax/dokuwiki-128.png?nolink|DokuWiki}}
Если нужно прикрепить картинку как файл или просто прикрепить какой-либо файл, то для этого пишем относительную ссылку на него.
Для файлов
{{wiki/syntax/1.xml}}
результат
1.xml
Для изображений после ссылки на изображение дописываем linkonly
{{wiki\syntax\dokuwiki-128.png?linkonly}}
результат
dokuwiki-128.png
Ссылку на изображение нужно указывать с учётом пространства имён:
{{ ru/head1/img1.png }}
При этом необходимо, чтобы картинка находилась в каталоге Media в соответствущем месте:
/media/ru/head1/img1.png.
Все иконки должны браться из единой папки: common/icons.
Иконки пронумерованы с 0 до 257. Если в системе меняется какая-либо иконка, то менять её именно в этой папке, чтобы потом изменения отобразились везде, где она есть.
Если есть иконки со словами, то вставлять их в подобный каталог в соответствующий региональный раздел. (н-р ru/common/icons).
Все большие изображение, шириной более 800 пикселей, нужно сжимать.
Для сжатия использовать FastStown Wiever. Использовать фильтр Lanczos3.
Прочие особенности синтаксиса не нужны.
Для конвертации страниц используется Html2DokuWiki.ЕХЕ (лежит в этой же папке). Принимает этот HTML код небольшими порциями.
Но ссылки и изображение приходится редактировать вручную.
Для названия статьи всегда используем заголовок первого уровня ( ====== Заголовок1 ====== ). Остальные по понижающейся ( ===== Заголовок2 ===== ).
Для того, чтобы вставить блок «Внимание» («Примечания»), нужно использовать заголовок 5-го уровня ( == Внимание! == ), затем продолжать писать, как обычные раздел, а завершать блок пустым заголовком второго уровня ( ===== ===== ).
Вставка рисунка внутри рамки с помощью плагина imagebox осуществляется с помощью тага
[{{ путь?nolink |Рисунок 1. Описание}}]
Здесь:
Пример: [{{ wiki/syntax/dokuwiki-128.png |Логотип ДокуВики}}]
Вставка таблиц внутри рамки осуществляется с помощью следующих тагов:
<startTableBox>
^ Заголовок1 ^ Заголовок2 ^
| Ячейка1 | Ячейка2 |
| Ячейка3 | Ячейка4 |
<endTableBox| Таблица>
Заголовок1 | Заголовок2 |
---|---|
Ячейка1 | Ячейка2 |
Ячейка3 | Ячейка4 |
Здесь:
Для вставки тэгов необходимо пользоваться следующим кодом:
{{tag>Таг}}
Если к странице нужно прикрепить несколько тагов, то разделяются они пробелами.
Таги стоит вводить аккуратно, т.к. лишний символ = новый таг.