Это старая версия документа.


Форматирование синтаксиса

Ссылки

Здесь описаны правила организации ссылок при создании страниц с помощью системы DokuWiki.

После слова результат следует снимок экрана с тем, как это будет выглядеть в системе.

Внешние ссылки

Внешние ссылки распознаются автоматически: http://www.google.com.

Или просто www.google.com.

Также можно указывать текст ссылки:

[[http://www.google.com|Это ссылка на Google]].

Результат:

Это ссылка на Google 

Адреса электронной почты тоже распознаются: andi@splitbrain.org.

Внутренние ссылки.

Внутренние ссылки создаются посредством квадратных скобок.

Можно либо просто указать  [[wiki/syntax]]

Результат:

Форматирование синтаксиса

Либо дополнительно прописать [[wiki/syntax|Справка по синтаксису]].

Результат:

Справка по синтаксису 

Имена Wiki-страниц автоматически переводятся в нижний регистр, спецсимволы использовать нельзя.

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

Ссылка на [[http://byte_srv:8080/doku.php/wiki/syntax?&#внутренние_ссылки|Внутренние ссылки]].

Результат:

Внутренние ссылки

Примечания:

  • Ссылки на существующие страницы отображаются иным цветом, чем ссылки на несуществующие.
  • Внутренние ссылки без указанного текста могут отображаться по разному в зависимости от настроек - в качестве текста может использоваться название страницы или заголовок первого уровня. Так что лучше каждый раз указывать текст ссылки.
  • Если меняется название раздела, ссылки на него не меняются автоматически. Так что не очень полагайтесь на ссылки на разделы.

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

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

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

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

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

Здесь приводятся способы вставки картинок при создании страниц в системе 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}}

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 ===== ).

               

Правила вставки картинок с использованием плагина imagebox.

Вставка рисунка внутри рамки с помощью плагина imagebox осуществляется с помощью тага

[{{ путь?nolink |Рисунок 1. Описание}}]

Здесь:

  1. Путь – путь к файлу.
  2. ? – разделитель.
  3. nolink – команда с помощью которой изображение перестаёт быть ссылкой на само себя (по умолчанию в ДокуВики при нажатии на любое изображение осуществляется переход на него)
  4. | - разделитель.
  5. Рисунок 1. Описание – подпись к рисунку. Структура подписи следующая:
    • Сначала пишется «Рисунок 1.» обычным шрифтом (без подчёркивания и курсива) с точкой на конце.
    • Описание, если такое присутствует. Шрифт обычный (без подчёркивания и курсива).

Пример: [{{ wiki/syntax/dokuwiki-128.png |Логотип ДокуВики}}]

Логотип ДокуВики

Правила вставки таблиц с помощью плагина tablebox (таблицы с обрамлением рамкой)

Вставка таблиц внутри рамки осуществляется с помощью следующих тагов:

Заголовок1 Заголовок2
Ячейка1 Ячейка2
Ячейка3 Ячейка4
Таблица 1

Здесь: 1.      

- начало контейнера. 2.       ^ Заголовок 1 ^ Заголовок 2 ^ | Ячейка 1 | Ячейка 2 | | Ячейка 3 | Ячейка 4 | - содержимое таблицы (стандартный синтаксис ДокуВики) 3.      

Таблица 1. Описание

a.       endTableBox – команда контейнера. b.      | - разделитель. c.        Таблица 1. Описание – подпись к таблице: i.      Сначала пишется «Таблица 1.» обычным шрифтом (без подчёркивания и курсива) с точкой на конце. ii.      Описание, если такое присутствует. Шрифт обычный (без подчёркивания и курсива).

Актуальные новости, публикации и практики для бизнес-архитекторов и аналитиков
Driven by DokuWiki