Difference between revisions of "RU/rules/regulations of automatization"

From Wiki
Jump to navigationJump to search
(rus / lat)
(No difference)

Revision as of 12:33, 18 December 2010


CardCatalog.png

Содержание

Rules.png





РУС ENG
В настоящем документе описываются Начала Автоматизации наполнения и сопровождения содержимого зоны openoffice.org/wiki/RU


0.

Три Кита автоматизации    —    

0.1. Соглашения.
0.2. Расширения.
0.3. Шаблоны.


1.

Соглашения о структуре проекта и его базовых элементах    —    

1.1.

Типы страниц и их обязательные элементы    —    

1.1.1.

Пользовательские страницы    —    

1.1.1.1. Статьи БЗ (нумерованные)
1.1.1.2. Статьи-из-набора (руководства, циклы статей)
1.1.1.3. Страницы-каталоги/оглавления (иерархия в URL)
1.1.1.4. Страницы-порталы (RU — структура произвольная)


1.1.2.

Служебные страницы    —    

1.1.2.1. Страница-индекс RU/kb/index
1.1.2.2. Страницы-формы (./form)
1.1.2.3. Страницы предзагрузки (./preload)
1.1.2.4. Страницы-документы (./doc)


1.1.3.

Обязательные элементы страниц    —    

1.1.3.1. Секция: «title»
Обязательна для размещения на всех пользовательских страницах. Описано в Инструкция. Заголовки статей. Предназначена для создания локализованных заголовков страниц.
1.1.3.2. Секция: «toc»
Обязательна для размещения на всех пользовательских страницах. Имеет двоякое предназначение. Для обычных страниц — это собственно содержимое этих страниц, за вычетом заголовка, навигации и общих элементов оформления. Для страниц-каталогов — это список ссылок подраздела (при наличии иерархии) и/или список ссылок по теме для обеспечения навигации.


1.2.

Шаблоны    —    

1.2.1. Внутритекстовые ({{OOo}}, {{MSO}},..)
1.2.2. Обёртки ({{Doc/doc/code/tbl/titleL1L2}}, {{RUforTemplateAllBottom}},...)
1.2.3. Навигационные ({{RUkbUpToc}}, {{BreadCrumbL10n}},...).
1.2.4. Штампы ({{RUsignyear}},...).


1.3.

База Знаний    —    

1.3.1. Описание Базы Знаний
База знаний — это набор карточек. Каждая карточка — это отдельная страница с постоянным адресом.

Статья в Базе Знаний (карточка) освещает один и только один вопрос. В противном случае статью следует разделять на несколько карточек.

Карточки группируются на страницах тем. В своём тексте содержат минимальное число обратных ссылок на тематические страницы (по умолчанию — одну ссылку).

1.3.2. Иерархия Базы Знаний: секция, рубрика, тема.
Тематические страницы группируются в иерархию. Иерархия не является жёсткой и может меняться со временем. Изменение иерархии не приводит к изменению адреса (URL) и кода (номера) статьи. Изменяется лишь обратная ссылка в статье на тематическую страницу.
1.3.3. Кодирование статей в базе знаний RU/kb
Кодирование статей выполняется с помощью суррогатного (бессмысленного) ключа. На данном ключе строится плоская однотипная адресация всех статей Базы Знаний.
1.3.4. Индекс
Специальная статья, в которой указывается минимальный свободный номер статьи Базы Знаний.
1.3.5. Список статей
1.3.6. Иерархия страниц-каталогов
1.3.7. Автоматизация создания статей
Для Базы Знаний реализован механизм автоматического создания статей «одной кнопкой». Для иных разделов Энциклопедии данная автоматизация не представляется целесообразной.


2.

Общие положения    —    Terms

2.1. Цели (направления) автоматизации:
  • Повышение удобства редакторов;
  • Отделение оформления от содержимого статей, унификация вида страниц;
  • Создание шаблонов статей с примерами вики-кодирования и предустановленными служебными метками;
  • Размещение метаданных документов в специальных секциях, для автоматического экспорта их, при необходимости;
  • Локализация элементов навигации: заголовков страниц, текстов внутритекстовых ссылок на страницы, навигационных меню.
Способы автоматизации:
  • В зоне RU разработана система шаблонов, форм и служебных страниц, позволяющая автоматизировать создание статей в едином стиле.
  • Формы применяются в темах, объединяющих однотипные статьи, создаваемые по единому макету.


3.

Области автоматизации    —    The field of automation

3.1. Автоматизация проявляется в двух областях:
  1. Создание новой статьи "одной кнопкой" - из формы, расположенной в теме.
  2. Создание локализованных ссылок на статьи. Текстом ссылки становится заголовок статьи, на которую оная ссылка делается, автоматически извлекаемый из неё.


4.

Технологический базис автоматизации    —    Technological basis of automation

4.1. Ядром автоматизации являются:
4.1.1. шаблоны из категории Category:Core_Critical_Template
4.1.2. функции wiki:
{{#lst:<...>|<...>}}
{{#ifexist:<...>}} [1]
{{#rel2abs:<...>}} [2]
4.1.3. расширения wiki[1]:
<inputbox>
4.1.4. Секции
<section begin=section_name />...<section end=section_name />


Template:RUsignyear Template:RUsigntransEng




  1. Полный список доступных расширений: Help:Extensions.


К началу страницы