Различия

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

--- wiki:syntax [2013/02/19 14:48]
admin [Примеры отчётов]
+++ wiki:syntax [2017/07/18 14:15] (текущий)
@@ Строка 5: / Строка 5: @@
 ==== Создание ====
 Для того, чтобы создать страницу, нужно в конкретном разделе после адресной строки ввести её название латинскими буквами.
 <code>
 [[wiki/syntax/new]]
@@ Строка 11: / Строка 11: @@
 Выдастся сообщение о том, что страница не найдена и будет предложено её создать.
-Кроме того, название страницы вписать а адресную строку, так и добавить ссылку на несуществующую страницу.
+Кроме того, название страницы можно вписать в адресную строку, добавив /имя к текущему адресу, а также можно добавить в текст статьи ссылку на несуществующую страницу, при нажатии на которую будет также предложено создать новую страницу.
 Пример:
@@ Строка 17: / Строка 17: @@
   * [[wiki/syntax]]
   * [[wiki/new]]
 ==== Удаление ====
 Для того, чтобы удалить страницу нужно:
-  - Удалить все ссылки на неё. Для этого в адресной строке добавляем к тому, что написано ?do=backlink. DоkuWiki выдаст все страницы, которые ссылаются на текущую.
+  * Удалить все ссылки на неё. Для этого в адресной строке добавляем к тому, что написано ?do=backlink. DоkuWiki выдаст все страницы, которые ссылаются на текущую. \\ В случае, если ссылки на страницу или её части могли использоваться для внедрения в другие статьи с помощью плагина Include, требуется поискать такие ссылки поиском в текстовых файлах DocuWiki (см. [[wiki/syntax#вставка_части_одной_статьи_в_другую_плагин_include|Вставка части одной статьи в другую (плагин Include)]]).
-  - На удаляемой странице нажать "Править", удалить весь текст и сохранить.
+  * На удаляемой странице нажать "Править", удалить весь текст и сохранить.
 ===== Форматирование текста =====
@@ Строка 38: / Строка 39: @@
 </code>
 //Курсив//
 При формировании списков нужно сначала ставить 2 пробела, затем спец символ (звёздочка для ненумерованного списка, минус для нумерованного). Если нужен элемент списка более нижнего уровня, то ставим перед символом на 2 пробела больше.
@@ Строка 53: / Строка 53: @@
   - Нумерованный список
   - Нумерованный список
 ===== Ссылки =====
@@ Строка 74: / Строка 75: @@
 Адреса электронной почты тоже распознаются: <andi@splitbrain.org>.
-==== Внутренние ссылки. ====
+==== Внутренние ссылки ====
 Внутренние ссылки создаются посредством квадратных скобок.
@@ Строка 87: / Строка 89: @@
 [[wiki/syntax]]
+Либо дополнительно прописать:
-Либо дополнительно прописать
 <code>
@@ Строка 97: / Строка 98: @@
 [[wiki/syntax|Справка по синтаксису]]
 Имена Wiki-страниц автоматически переводятся в нижний регистр, спецсимволы использовать нельзя.
@@ Строка 111: / Строка 111: @@
 [[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#свойства_показателя|Свойства показателя]])\\
-Поскольку в данном случае мы пишем название статьи вручную, то при смене названия статьи внутри документа придётся также менять название ссылки вручную.\\
+  см. [[ru/bsc/technology#этапы_разработки_и_внедрения_ссп|Этапы разработки и внедрения ССП]]
-Просмотреть полный перечень страниц, которые ссылаются на данную статью(#якорь), можно написав в поисковике в кавычках  “имя_страницы#имя_раздела” (так, как они написаны в ссылке).
-** Типы обращений к ссылкам **
+Результат:
-К ссылкам обращение может быть двух типов
+см. [[ru/bsc/technology#этапы_разработки_и_внедрения_ссп|Этапы разработки и внедрения ССП]]
-  * указание на документ по ходу изложения в тексте (например: …механизм описан в <документ>  и является примером как правильно…)
-  * см.
-В первом случае перед ссылкой на документ (кроме случаев, когда документ - это какое-либо руководство) употребляется слово "методика&quot;. Слова &quot;методика", "глава", "статья" употребляются в предложном падеже.
+Поскольку в данном случае мы пишем название статьи вручную, то при смене названия статьи внутри раздела придётся также менять название ссылки вручную.
+Просмотреть полный перечень страниц, которые ссылаются на данную статью(#якорь), можно написав в поисковике в кавычках “имя_страницы#имя_статьи” (так, как они написаны в ссылке) либо “внутренний_путь(начиная с пространства имён)#имя_статьи” - в этом случае без кавычек.
+**Способы использования ссылок**
+Ссылки могут использоваться двумя способами:
+  - По ходу изложения в тексте
+  - Использование оборота (см. ….)
+**По ходу изложения в тексте**
+Синтаксис:
+  &lt;тип раздела&gt; [[ссылка_на_раздел]]
+Тип раздела -- это: "глава" или "статья".
 Пример:
-...описано в методике [[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/bsc/bsc]], глава [[ru/bsc/develop/data_struct]])
+…описаны в главе [[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/csdesign/csdesign]] внутри текста страницы выглядит как {{wiki/syntax/text.png?nolink}}
+==== Картинки ссылки ====
 Совместив синтаксис ссылки и картинки, можно вставить в текст картинку, которая будет внутренней или внешней ссылкой:
@@ Строка 179: / Строка 225: @@
 Учтите: форматирование картинок это единственная синтаксическая конструкция, которую можно использовать в тексте ссылки.
+===== Картинки в DokuWiki =====
-===== Картинки в DokuWiki. =====
 Здесь приводятся способы вставки картинок при создании страниц в системе DokuWiki.
@@ Строка 229: / Строка 274: @@
 /media/ru/head1/img1.png.
@@ Строка 239: / Строка 283: @@
 Все большие изображение, шириной более 800 пикселей, нужно сжимать.
 Для сжатия использовать FastStown Wiever. Использовать фильтр Lanczos3.\\ \\
+==== Вставка картинок с рамкой и заголовком (плагин Imagebox) ====
+Вставка рисунка внутри рамки с помощью плагина Imagebox осуществляется с помощью тага
+%%[{{ путь?nolink |Рисунок 1. Описание}}]%%
+Здесь:
+  - Путь -- путь к файлу.
+  - ? -- разделитель.
+  - nolink -- команда с помощью которой изображение перестаёт быть ссылкой на само себя (по умолчанию в ДокуВики при нажатии на любое изображение осуществляется переход на него)
+  - %%|%% - разделитель.
+  - Рисунок 1. Описание -- подпись к рисунку. Структура подписи следующая:
+    * Сначала пишется "Рисунок 1." обычным шрифтом (без подчёркивания и курсива) с точкой на конце.
+    * Описание, если такое присутствует. Шрифт обычный (без подчёркивания и курсива).
+**Пример**:  %%[{{ wiki/syntax/dokuwiki-128.png |Логотип DokuWiki}}]%%
+[{{ wiki/syntax/dokuwiki-128.png |Логотип DokuWiki}}]
+Ограничения по размеру вставляемых изображений сохраняются и при работе с данным плагином.
 ===== Прикрепление файлов к статьям =====
-Файлы прикрепляются к статьям по аналогии с картинками, т.е. тот же каталог (/media), тот же синтаксис.\\
+Файлы прикрепляются к статьям по аналогии с картинками, т.е. тот же синтаксис.\\
 Но при этом файл предварительно запаковываем в *.zip. Использование файлов в виде архива zip обязательно для облегчения поиска файлов при обновлении и для совместимости с браузерами.
+Файлы выкладываем в каталог /common в зависимости от языкового пространства.
 Пример:
-  {{common/bs.zip|Файл конфигурации}}
+  {{common/ru/bs.zip|Файл конфигурации}}
 Результат:
 {{common/bs.zip|Файл конфигурации}}
-Поиск файлов осуществлять через ".zip" (включая кавычки).
+Поиск файлов осуществлять через ".zip" (включая кавычки).\\
+Таким образом нужно прикреплять все файлы кроме картинок.\\
-===== Примеры отчётов =====
+\\
+**Внимание!** В ссылках, а также в названиях файлов не должно быть заглавных букв. Иначе ссылки на файлы не будут работать.
-Примеры отчетов даются по тексту методики только как ссылки на страницу сайта BS: http://businessstudio.ru/load/primery_otchetov
-Ссылки ставятся на соответствующий раздел с использованием якоря:
-^  Раздел  ^  Ссылка  ^
-| Регламентирующие документы | http://www.businessstudio.ru/load/primery_otchetov#reg |
-| Автоматизация бизнес-процессов | http://www.businessstudio.ru/load/primery_otchetov#it |
-| Отчеты по сбалансированной системе показателей | http://www.businessstudio.ru/load/primery_otchetov#bsc |
-| Отчеты по Функционально-стоимостному анализу | http://www.businessstudio.ru/load/primery_otchetov#abc |
-| Отчеты по системе менеджмента качества | http://www.businessstudio.ru/load/primery_otchetov#iso |
 ===== Прочий синтаксис. =====
@@ Строка 280: / Строка 337: @@
 Для того, чтобы вставить блок "Внимание" ("Примечания"), нужно использовать заголовок 5-го уровня ( == Внимание! == ), затем продолжать писать, как обычные раздел, а завершать блок пустым заголовком второго уровня ( ===== ===== ).
-===== Правила вставки картинок с использованием плагина imagebox. =====
-Вставка рисунка внутри рамки с помощью плагина imagebox осуществляется с помощью тага
-%%[{{ путь?nolink |Рисунок 1. Описание}}]%%
-Здесь:
-  - Путь -- путь к файлу.
-  - ? -- разделитель.
-  - nolink -- команда с помощью которой изображение перестаёт быть ссылкой на само себя (по умолчанию в ДокуВики при нажатии на любое изображение осуществляется переход на него)
-  - %%|%% - разделитель.
-  - Рисунок 1. Описание -- подпись к рисунку. Структура подписи следующая:
-    * Сначала пишется "Рисунок 1." обычным шрифтом (без подчёркивания и курсива) с точкой на конце.
-    * Описание, если такое присутствует. Шрифт обычный (без подчёркивания и курсива).
-**Пример**:  %%[{{ wiki/syntax/dokuwiki-128.png |Логотип ДокуВики}}]%%
+===== Вставка таблиц  с рамкой и заголовком (плагин Tablebox) =====
-[{{ wiki/syntax/dokuwiki-128.png |Логотип ДокуВики}}]
-===== Правила вставки таблиц с помощью плагина tablebox (таблицы с обрамлением рамкой) =====
 Вставка таблиц внутри рамки осуществляется с помощью следующих тагов:
@@ Строка 327: / Строка 366: @@
         * Описание, если такое присутствует. Шрифт обычный (без подчёркивания и курсива).
+===== Вставка текста кода в статьи =====
+Для вставки кода в статьи нужно воспользоватьмя тегами
+<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 =====
@@ Строка 335: / Строка 425: @@
 Если к странице нужно прикрепить несколько тагов, то разделяются они пробелами.\\
 Таги стоит вводить аккуратно, т.к. лишний символ = новый таг.
+[<contextnavigator>]