Здесь показаны различия между выбранной ревизией и текущей версией данной страницы.
wiki:syntax [2013/01/28 15:25] admin [Отсылки на другие разделы документации] |
wiki:syntax [2017/07/18 14:15] (текущий) |
||
---|---|---|---|
Строка 5: | Строка 5: | ||
==== Создание ==== | ==== Создание ==== | ||
- | Для того, чтобы создать страницу, нужно в конкретном разделе после адресной строки ввести её название латинскими буквами. | + | Для того, чтобы создать страницу, нужно в конкретном разделе после адресной строки ввести её название латинскими буквами. |
<code> | <code> | ||
[[wiki/syntax/new]] | [[wiki/syntax/new]] | ||
Строка 11: | Строка 11: | ||
Выдастся сообщение о том, что страница не найдена и будет предложено её создать. | Выдастся сообщение о том, что страница не найдена и будет предложено её создать. | ||
- | Кроме того, название страницы вписать а адресную строку, так и добавить ссылку на несуществующую страницу. | + | Кроме того, название страницы можно вписать в адресную строку, добавив /имя к текущему адресу, а также можно добавить в текст статьи ссылку на несуществующую страницу, при нажатии на которую будет также предложено создать новую страницу. |
Пример: | Пример: | ||
Строка 17: | Строка 17: | ||
* [[wiki/syntax]] | * [[wiki/syntax]] | ||
* [[wiki/new]] | * [[wiki/new]] | ||
+ | |||
==== Удаление ==== | ==== Удаление ==== | ||
Для того, чтобы удалить страницу нужно: | Для того, чтобы удалить страницу нужно: | ||
- | - Удалить все ссылки на неё. Для этого в адресной строке добавляем к тому, что написано ?do=backlink. DоkuWiki выдаст все страницы, которые ссылаются на текущую. | + | * Удалить все ссылки на неё. Для этого в адресной строке добавляем к тому, что написано ?do=backlink. DоkuWiki выдаст все страницы, которые ссылаются на текущую. \\ В случае, если ссылки на страницу или её части могли использоваться для внедрения в другие статьи с помощью плагина Include, требуется поискать такие ссылки поиском в текстовых файлах DocuWiki (см. [[wiki/syntax#вставка_части_одной_статьи_в_другую_плагин_include|Вставка части одной статьи в другую (плагин Include)]]). |
- | - На удаляемой странице нажать "Править", удалить весь текст и сохранить. | + | * На удаляемой странице нажать "Править", удалить весь текст и сохранить. |
===== Форматирование текста ===== | ===== Форматирование текста ===== | ||
Строка 38: | Строка 39: | ||
</code> | </code> | ||
//Курсив// | //Курсив// | ||
- | |||
При формировании списков нужно сначала ставить 2 пробела, затем спец символ (звёздочка для ненумерованного списка, минус для нумерованного). Если нужен элемент списка более нижнего уровня, то ставим перед символом на 2 пробела больше. | При формировании списков нужно сначала ставить 2 пробела, затем спец символ (звёздочка для ненумерованного списка, минус для нумерованного). Если нужен элемент списка более нижнего уровня, то ставим перед символом на 2 пробела больше. | ||
Строка 53: | Строка 53: | ||
- Нумерованный список | - Нумерованный список | ||
- Нумерованный список | - Нумерованный список | ||
+ | |||
===== Ссылки ===== | ===== Ссылки ===== | ||
Строка 74: | Строка 75: | ||
Адреса электронной почты тоже распознаются: <andi@splitbrain.org>. | Адреса электронной почты тоже распознаются: <andi@splitbrain.org>. | ||
- | ==== Внутренние ссылки. ==== | + | |
+ | ==== Внутренние ссылки ==== | ||
Внутренние ссылки создаются посредством квадратных скобок. | Внутренние ссылки создаются посредством квадратных скобок. | ||
Строка 87: | Строка 89: | ||
[[wiki/syntax]] | [[wiki/syntax]] | ||
- | + | Либо дополнительно прописать: | |
- | Либо дополнительно прописать | + | |
<code> | <code> | ||
Строка 97: | Строка 98: | ||
[[wiki/syntax|Справка по синтаксису]] | [[wiki/syntax|Справка по синтаксису]] | ||
- | |||
Имена Wiki-страниц автоматически переводятся в нижний регистр, спецсимволы использовать нельзя. | Имена Wiki-страниц автоматически переводятся в нижний регистр, спецсимволы использовать нельзя. | ||
Строка 111: | Строка 111: | ||
[[wiki/syntax?&#внутренние_ссылки|Внутренние ссылки]] | [[wiki/syntax?&#внутренние_ссылки|Внутренние ссылки]] | ||
- | |||
Примечания: | Примечания: | ||
Строка 119: | Строка 118: | ||
* Если меняется название раздела, ссылки на него не меняются автоматически. Так что не очень полагайтесь на ссылки на разделы. | * Если меняется название раздела, ссылки на него не меняются автоматически. Так что не очень полагайтесь на ссылки на разделы. | ||
- | ==== Отсылки на другие разделы документации ==== | + | ==== Ссылки на другие разделы документации ==== |
- | ** Типы отсылок ** | + | **Типы ссылок** |
- | Отсылки на другие разделы документации могут быть двух типов: | + | Ссылки на другие разделы документации могут быть двух типов: |
- | * На конкретный раздел; | + | |
- | * На подпункт конкретного раздела (статью). | + | |
- | Ссылки полагается начинать с пространства имён. Перед самой ссылкой полагается писать название раздела, в котором находится глава.\\ | + | |
- | Внутренние ссылки первого типа полагается писать следующим образом:\\ | + | |
- | ([[ссылка_на_документ]], глава [[ссылка_на_главу]]). | + | |
- | Никаких названий дописывать не нужно, они подставятся автоматически.\\ | + | * На конкретный раздел (документ или главу); |
+ | * На подпункт конкретного раздела (статью). | ||
- | Пример: | + | Ссылки полагается начинать с пространства имён. |
- | (см. [[ru/bsc/bsc]], глава [[ru/bsc/develop/data_struct]]) | + | |
- | результат:\\ | + | Внутренние ссылки первого типа полагается писать следующим образом: |
- | (см. [[ru/bsc/bsc]], глава [[ru/bsc/develop/data_struct]]) | + | |
+ | [[ссылка_на_раздел]] | ||
+ | |||
+ | Никаких названий дописывать не нужно, они подставятся автоматически. | ||
+ | |||
+ | Пример: | ||
+ | |||
+ | (см. [[ru/bsc/develop/data_struct]]) | ||
+ | |||
+ | результат: | ||
+ | |||
+ | (см. [[ru/bsc/develop/data_struct]]) | ||
Ссылки второго типа полагается писать следующим образом: | Ссылки второго типа полагается писать следующим образом: | ||
- | [[ссылка_на_методику]], статья [[ссылка_на_главу#ссылка_на_статью|этот раздел]] | + | |
- | В этом случае нужно в ссылке статьи обязательно дописывать название статьи.\\ | + | [[ссылка_на_раздел#ссылка_на_статью|эта статья]] |
+ | |||
+ | В этом случае нужно в ссылке статьи обязательно дописывать название статьи. | ||
Пример: | Пример: | ||
- | см. [[ru/bsc/bsc]], статья [[ru/bsc/develop/indicator_target#свойства_показателя|Свойства показателя]] | ||
- | Результат:\\ | ||
- | (см. [[ru/bsc/bsc]], статья [[ru/bsc/develop/indicator_target#свойства_показателя|Свойства показателя]])\\ | ||
- | Поскольку в данном случае мы пишем название статьи вручную, то при смене названия статьи внутри документа придётся также менять название ссылки вручную. (Делается это поиском ссылки на изменённую статью с помощью комынды ?do=backlink, подробнее см. [[wiki/syntax?&#удаление|удаление]]) \\ | + | см. [[ru/bsc/technology#этапы_разработки_и_внедрения_ссп|Этапы разработки и внедрения ССП]] |
- | ** Типы обращений к ссылкам ** | + | Результат: |
- | К ссылкам обращение может быть двух типов | + | см. [[ru/bsc/technology#этапы_разработки_и_внедрения_ссп|Этапы разработки и внедрения ССП]] |
- | * описано в | + | |
- | * см. | + | |
- | В первом случае перед указанием методики (кроме случаев, когда методика - это какое-либо руководство) стоит "описано в", а слово "методика", "глава", "статья" употребляются в предложном падеже. | + | Поскольку в данном случае мы пишем название статьи вручную, то при смене названия статьи внутри раздела придётся также менять название ссылки вручную. |
+ | |||
+ | Просмотреть полный перечень страниц, которые ссылаются на данную статью(#якорь), можно написав в поисковике в кавычках “имя_страницы#имя_статьи” (так, как они написаны в ссылке) либо “внутренний_путь(начиная с пространства имён)#имя_статьи” - в этом случае без кавычек. | ||
+ | |||
+ | **Способы использования ссылок** | ||
+ | |||
+ | Ссылки могут использоваться двумя способами: | ||
+ | |||
+ | - По ходу изложения в тексте | ||
+ | - Использование оборота (см. ….) | ||
+ | |||
+ | **По ходу изложения в тексте** | ||
+ | |||
+ | Синтаксис: | ||
+ | |||
+ | <тип раздела> [[ссылка_на_раздел]] | ||
+ | |||
+ | Тип раздела -- это: "глава" или "статья". | ||
Пример: | Пример: | ||
- | ...описано в методике [[ru/csdesign/csdesign]] в статье [[ru/csdesign/bpmodeling/epc_notation#команды_панели_инструментов_для_диаграммы_epc|Команды панели инструментов для диаграммы epc]].\\ | + | …описаны в статье [[ru/csdesign/bpmodeling/epc_notation#команды_панели_инструментов_для_диаграммы_epc|Команды панели инструментов для диаграммы EPC]]. |
- | ...описано в [[ru/manual/manual]] в главе [[ru/manual/install/requirements]]. | + | |
+ | Если в разделе одного документа дается ссылка на раздел другого документа, то перед ссылкой на раздел дается ссылка на документ. Если рядом дается 2 и более ссылок на разделы из разных документов, то перед ссылкой на раздел также дается ссылка на документ. | ||
+ | |||
+ | Пример: | ||
+ | |||
+ | …описаны в главе [[ru/csdesign/csdesign|Проектирование системы управления]] -> [[ru/csdesign/bpmodeling/epc_notation|Нотация EPC]]. | ||
+ | |||
+ | …описаны в главах [[ru/manual/manual|Руководство пользователя]] --> [[ru/manual/creating_model/epc_notation|Нотация EPC]], [[ru/csdesign/csdesign|Проектирование системы управления]] --> [[ru/csdesign/bpmodeling/epc_notation|Нотация EPC]]. | ||
+ | |||
+ | **Использование оборота (см. ….)** | ||
+ | |||
+ | Синтаксис: | ||
+ | |||
+ | (см. [[ссылка_на_раздел]]) | ||
+ | |||
+ | Пример: | ||
+ | |||
+ | (см. [[ru/csdesign/bpmodeling/epc_notation#команды_панели_инструментов_для_диаграммы_epc|Команды панели инструментов для диаграммы EPC]]) | ||
+ | |||
+ | Если в разделе одного документа дается ссылка на раздел другого документа, то перед ссылкой на раздел дается ссылка на документ. Если рядом дается 2 и более ссылок на разделы из разных документов, то перед ссылкой на раздел также дается ссылка на документ. | ||
+ | |||
+ | Пример: | ||
+ | |||
+ | (см. [[ru/csdesign/csdesign]] --> [[ru/csdesign/bpmodeling/epc_notation]]). | ||
+ | |||
+ | (см. [[ru/manual/manual]] --> [[ru/manual/creating_model/epc_notation]], [[ru/csdesign/csdesign]] --> [[ru/csdesign/bpmodeling/epc_notation]]) | ||
+ | |||
+ | **Просто текст** | ||
- | Во втором случаем слово "методика" не употребляется вообще, слова не склоняются, отсылка заключается в скобки. | + | Если требуется вставить текс, содержащий служебные символы (тэги), то чтобы вставить их как обычный текст, нужно открывающиеся скобки тэга обрамить в символы процентов, т.е. %%{{%%. |
Пример: | Пример: | ||
- | (см. [[ru/bsc/bsc]], глава [[ru/bsc/develop/data_struct]]) | + | Текст %%[[%%ru/csdesign/csdesign]] внутри текста страницы выглядит как {{wiki/syntax/text.png?nolink}} |
- | ==== Картинки ссылки. ==== | + | ==== Картинки ссылки ==== |
Совместив синтаксис ссылки и картинки, можно вставить в текст картинку, которая будет внутренней или внешней ссылкой: | Совместив синтаксис ссылки и картинки, можно вставить в текст картинку, которая будет внутренней или внешней ссылкой: | ||
Строка 178: | Строка 225: | ||
Учтите: форматирование картинок это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки. | Учтите: форматирование картинок это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки. | ||
- | + | ===== Картинки в DokuWiki ===== | |
- | ===== Картинки и другие файлы в DokuWiki. ===== | + | |
Здесь приводятся способы вставки картинок при создании страниц в системе DokuWiki. | Здесь приводятся способы вставки картинок при создании страниц в системе DokuWiki. | ||
Строка 212: | Строка 258: | ||
Если нужно прикрепить картинку как файл или просто прикрепить какой-либо файл, то для этого пишем относительную ссылку на него.\\ | Если нужно прикрепить картинку как файл или просто прикрепить какой-либо файл, то для этого пишем относительную ссылку на него.\\ | ||
- | Для файлов | ||
- | <code> | ||
- | {{wiki/syntax/1.xml}} | ||
- | </code> | ||
- | результат\\ | ||
- | {{wiki/syntax/1.xml}} | ||
Для изображений после ссылки на изображение дописываем linkonly | Для изображений после ссылки на изображение дописываем linkonly | ||
Строка 234: | Строка 274: | ||
/media/ru/head1/img1.png. | /media/ru/head1/img1.png. | ||
- | |||
Строка 244: | Строка 283: | ||
- | |||
Все большие изображение, шириной более 800 пикселей, нужно сжимать. | Все большие изображение, шириной более 800 пикселей, нужно сжимать. | ||
Для сжатия использовать FastStown Wiever. Использовать фильтр Lanczos3.\\ \\ | Для сжатия использовать FastStown Wiever. Использовать фильтр Lanczos3.\\ \\ | ||
- | ===== Прочий синтаксис. ===== | ||
- | Прочие особенности синтаксиса не нужны. | ||
- | Для конвертации страниц используется Html2DokuWiki.ЕХЕ (лежит в этой же папке). Принимает этот HTML код небольшими порциями. | + | ==== Вставка картинок с рамкой и заголовком (плагин Imagebox) ==== |
- | + | ||
- | Но ссылки и изображение приходится редактировать вручную. | + | |
- | + | ||
- | Для названия статьи всегда используем заголовок первого уровня ( ====== Заголовок1 ====== ). Остальные по понижающейся ( ===== Заголовок2 ===== ). | + | |
- | + | ||
- | Для того, чтобы вставить блок «Внимание» («Примечания»), нужно использовать заголовок 5-го уровня ( == Внимание! == ), затем продолжать писать, как обычные раздел, а завершать блок пустым заголовком второго уровня ( ===== ===== ). | + | |
- | + | ||
- | + | ||
- | ===== Правила вставки картинок с использованием плагина imagebox. ===== | + | |
- | Вставка рисунка внутри рамки с помощью плагина imagebox осуществляется с помощью тага | + | Вставка рисунка внутри рамки с помощью плагина Imagebox осуществляется с помощью тага |
%%[{{ путь?nolink |Рисунок 1. Описание}}]%% | %%[{{ путь?nolink |Рисунок 1. Описание}}]%% | ||
Строка 274: | Строка 301: | ||
- %%|%% - разделитель. | - %%|%% - разделитель. | ||
- Рисунок 1. Описание -- подпись к рисунку. Структура подписи следующая: | - Рисунок 1. Описание -- подпись к рисунку. Структура подписи следующая: | ||
- | * Сначала пишется «Рисунок 1.» обычным шрифтом (без подчёркивания и курсива) с точкой на конце. | + | * Сначала пишется "Рисунок 1." обычным шрифтом (без подчёркивания и курсива) с точкой на конце. |
* Описание, если такое присутствует. Шрифт обычный (без подчёркивания и курсива). | * Описание, если такое присутствует. Шрифт обычный (без подчёркивания и курсива). | ||
- | **Пример**: %%[{{ wiki/syntax/dokuwiki-128.png |Логотип ДокуВики}}]%% | + | **Пример**: %%[{{ wiki/syntax/dokuwiki-128.png |Логотип DokuWiki}}]%% |
- | [{{ wiki/syntax/dokuwiki-128.png |Логотип ДокуВики}}] | + | [{{ wiki/syntax/dokuwiki-128.png |Логотип DokuWiki}}] |
- | ===== Правила вставки таблиц с помощью плагина tablebox (таблицы с обрамлением рамкой) ===== | + | |
+ | Ограничения по размеру вставляемых изображений сохраняются и при работе с данным плагином. | ||
+ | ===== Прикрепление файлов к статьям ===== | ||
+ | |||
+ | Файлы прикрепляются к статьям по аналогии с картинками, т.е. тот же синтаксис.\\ | ||
+ | Но при этом файл предварительно запаковываем в *.zip. Использование файлов в виде архива zip обязательно для облегчения поиска файлов при обновлении и для совместимости с браузерами. | ||
+ | |||
+ | Файлы выкладываем в каталог /common в зависимости от языкового пространства. | ||
+ | |||
+ | Пример: | ||
+ | {{common/ru/bs.zip|Файл конфигурации}} | ||
+ | Результат: | ||
+ | |||
+ | {{common/bs.zip|Файл конфигурации}} | ||
+ | |||
+ | Поиск файлов осуществлять через ".zip" (включая кавычки).\\ | ||
+ | Таким образом нужно прикреплять все файлы кроме картинок.\\ | ||
+ | \\ | ||
+ | **Внимание!** В ссылках, а также в названиях файлов не должно быть заглавных букв. Иначе ссылки на файлы не будут работать. | ||
+ | ===== Прочий синтаксис. ===== | ||
+ | |||
+ | Прочие особенности синтаксиса не нужны. | ||
+ | |||
+ | Для конвертации страниц используется Html2DokuWiki.ЕХЕ (лежит в этой же папке). Принимает этот HTML код небольшими порциями. | ||
+ | |||
+ | Но ссылки и изображение приходится редактировать вручную. | ||
+ | |||
+ | Для названия статьи всегда используем заголовок первого уровня ( ====== Заголовок1 ====== ). Остальные по понижающейся ( ===== Заголовок2 ===== ). | ||
+ | |||
+ | Для того, чтобы вставить блок "Внимание" ("Примечания"), нужно использовать заголовок 5-го уровня ( == Внимание! == ), затем продолжать писать, как обычные раздел, а завершать блок пустым заголовком второго уровня ( ===== ===== ). | ||
+ | |||
+ | |||
+ | |||
+ | ===== Вставка таблиц с рамкой и заголовком (плагин Tablebox) ===== | ||
Вставка таблиц внутри рамки осуществляется с помощью следующих тагов: | Вставка таблиц внутри рамки осуществляется с помощью следующих тагов: | ||
Строка 303: | Строка 363: | ||
* | - разделитель. | * | - разделитель. | ||
* Таблица 1. Описание -- подпись к таблице: | * Таблица 1. Описание -- подпись к таблице: | ||
- | * Сначала пишется «Таблица 1.» обычным шрифтом (без подчёркивания и курсива) с точкой на конце. | + | * Сначала пишется "Таблица 1." обычным шрифтом (без подчёркивания и курсива) с точкой на конце. |
* Описание, если такое присутствует. Шрифт обычный (без подчёркивания и курсива). | * Описание, если такое присутствует. Шрифт обычный (без подчёркивания и курсива). | ||
+ | ===== Вставка текста кода в статьи ===== | ||
+ | |||
+ | Для вставки кода в статьи нужно воспользоватьмя тегами | ||
+ | |||
+ | <cоde _наименование_языка>\\ | ||
+ | Текст кода\\ | ||
+ | </cоde>\\ | ||
+ | |||
+ | **Пример**\\ | ||
+ | Вставка "Hello world!" на C# будет выглядеть так: | ||
+ | <code Csharp> | ||
+ | // A Hello World! program in C#. | ||
+ | using System; | ||
+ | namespace HelloWorld | ||
+ | { | ||
+ | class Hello | ||
+ | { | ||
+ | static void Main() | ||
+ | { | ||
+ | Console.WriteLine("Hello World!"); | ||
+ | |||
+ | // Keep the console window open in debug mode. | ||
+ | Console.WriteLine("Press any key to exit."); | ||
+ | Console.ReadKey(); | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | </code> | ||
+ | |||
+ | Перечень всех поддерживаемых языков (код которых надо вставлять в открывающий тэг вместо "_наименование_языка") для подсветки синтаксиса внутри блока можно посмотреть [[http://www.dokuwiki.ru/syntax#podsvetka_sintaksisa|здесь]]. | ||
+ | |||
+ | ===== Вставка части одной статьи в другую (плагин Include) ===== | ||
+ | |||
+ | Для вставки части текста из другой статьи в текущую нужно воспользоваться тэгами | ||
+ | |||
+ | %%{{%%page>страница#якорь&noheader&noeditbutton&nouser&nodate}} | ||
+ | |||
+ | Здесь: | ||
+ | - page> - стартовый тег. Обозначает, что в результате работы тэга будет выведена часть другой страницы. | ||
+ | - страница#якорь - путь до страницы и конкретного куска текста на ней. | ||
+ | - noheader - запрещает вывод заголовка раздела, который вставляется данной командой. | ||
+ | - noeditbutton - убирает кнопку редактирования со вставляемого текста. | ||
+ | - nouser&nodate - убирают информацию в нижней части экрана о авторе и дате написания вставляемого текста. | ||
+ | |||
+ | **Пример**\\ | ||
+ | Вставим часть статьи по ссылке [[ru/terms/terms_modeling_notations#нотация]], как встраиваемый текст. | ||
+ | Результат команды %%{{%%page>ru/terms/terms_modeling_notations#нотация&noheader&noeditbutton&nouser&nodate}}, будет выглядеть как (результат работы только следующая строка): | ||
+ | |||
+ | {{page>ru/terms/terms_modeling_notations#нотация&noheader&noeditbutton&nouser&nodate}} | ||
+ | |||
+ | **Примечание.** Ссылки внутри данного плагина невозможно найти с помощью стандартных средств поиска DokuWiki, поэтому в случае необходимости (например, при удалении или переименовании статьи или её раздела, ссылки на которые могли использоваться внутри такого плагина) требуется использовать поиск в текстовых файлах DokuWiki. | ||
===== Плагин Tag ===== | ===== Плагин Tag ===== | ||
Строка 314: | Строка 425: | ||
Если к странице нужно прикрепить несколько тагов, то разделяются они пробелами.\\ | Если к странице нужно прикрепить несколько тагов, то разделяются они пробелами.\\ | ||
Таги стоит вводить аккуратно, т.к. лишний символ = новый таг. | Таги стоит вводить аккуратно, т.к. лишний символ = новый таг. | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | [<contextnavigator>] | ||
+ | |||
+ |