Положение. Начала автоматизации    —    Regulations of Beginning of Automation

From Wiki
Jump to navigationJump to search


CardCatalog.png

Содержание

Rules.png





РУС ENG
A. В настоящем документе описываются Начала Автоматизации наполнения и сопровождения содержимого зоны openoffice.org/wiki/RU This Document describes the beginning of automation of filling and tracking the content zone openoffice.org/wiki/RU.


0.

Три Кита автоматизации    —    Three Pillars of automation

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


1.

Соглашения о структуре проекта и его базовых элементах.    —    Agreement on the project and its basic elements.

1.1.

Типы страниц и их обязательные элементы.    —    Types of pages and their mandatory elements.

1.1.1.

Информационные страницы    —    Information Pages

1.1.1.1. Статьи БЗ (номерной URL). KB article (numbered URL).
1.1.1.2. Статьи прочих разделов (традиционный URL). Articles from other sections (traditional URL).
1.1.1.3. Статьи-из-набора (руководства, циклы статей). Article-of-set (manual, a series of articles).
1.1.1.4. Страницы-каталоги/оглавления (иерархия в URL). Pages directories / TOC (hierarchy in URL).
1.1.1.5. Страницы-порталы (RU — структура произвольная). Pages portals (RU - an arbitrary structure).


1.1.2.

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

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


1.1.3.

Обязательные элементы страниц    —    Mandatory elements of the pages

1.1.3.1. Секция: «title». Section: «title».
Обязательна для размещения на всех пользовательских страницах. Описано в Инструкция. Заголовки статей. Предназначена для создания локализованных заголовков страниц. Is mandatory for placement on all user pages. Described in Guidelines. Article titles. Designed to create a localized page titles.
1.1.3.2. Секция: «toc» Section: «toc».
Обязательна для размещения на всех пользовательских страницах. Имеет двоякое предназначение. Для обычных страниц — это собственно содержимое этих страниц, за вычетом заголовка, навигации и общих элементов оформления. Для страниц-каталогов — это список ссылок подраздела (при наличии иерархии) и/или список ссылок по теме для обеспечения навигации. Is mandatory for placement on all user pages. Has a twofold designation. For ordinary pages - it's actually the content of these pages, excluding the header, navigation and overall design elements. For page-directory - a list of references subsection (if the hierarchy) and / or a list of related links for navigation.
1.1.3.3. Секция: «signature» Section: «signature».
Обязательна для размещения на всех пользовательских страницах. Предназначена для размещения подписи и идентификации актуальности статьи через указание даты или номера версии OpenOffice.org. Is mandatory for placement on all user pages. Designed to accommodate the signature and identification of the relevance of articles by specifying a date or version number of OpenOffice.org.


1.2.

Шаблоны    —    Templates

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


1.3.

База Знаний    —    Knowledge base

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

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

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

Knowledge Base - a set of cards. Each card - it is a separate page with a permanent address.

A knowledge base article (card) covers one and only one question. Otherwise, the article should be split into several cards.

Cards are grouped together in the pages of topics. In his text, contain the minimum number of back links to thematic pages (by default - one link).

1.3.2. Иерархия Базы Знаний: секция, рубрика, тема. The hierarchy of the Knowledge Base: section, section, topic.
Тематические страницы группируются в иерархию. Иерархия не является жёсткой и может меняться со временем. Изменение иерархии не приводит к изменению адреса (URL) и кода (номера) статьи. Изменяется лишь обратная ссылка в статье на тематическую страницу. Topic Pages are grouped into a hierarchy. The hierarchy is not rigid and can change over time. Changing the hierarchy does not change the address (URL) and code (number) article. Changes only the reverse link in the article on the thematic pages.
1.3.3. Кодирование статей в базе знаний RU/kb Coding Knowledge Base articles RU/kb
Кодирование статей выполняется с помощью суррогатного (бессмысленного) ключа. На данном ключе строится плоская однотипная адресация всех статей Базы Знаний. Coding of articles is done using a surrogate (nonsensical) key. At this key construct a flat monotonous addressing all Knowledge Base articles.
1.3.4. Индекс. Index.
Специальная страница, в которой указывается минимальный свободный номер статьи Базы Знаний. A special page, which indicates the minimum free Knowledge Base article number.
1.3.5. Список статей. List of articles.
1.3.6. Иерархия страниц-каталогов. The hierarchy of pages-directories.
1.3.7. Автоматизация создания статей. Automating the creation of articles.
Для Базы Знаний реализован механизм автоматического создания статей «одной кнопкой». Для иных разделов Энциклопедии данная автоматизация не представляется целесообразной. For the Knowledge Base is made a mechanism for automatic creation of articles "one button". For other sections of the Encyclopedia, this automation is not appropriate.


2.

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

2.1. Цели (направления) автоматизации:
  • Повышение удобства редакторов;
  • Отделение оформления от содержимого статей, унификация вида страниц;
  • Создание шаблонов статей с примерами вики-кодирования и предустановленными служебными метками;
  • Разделение статей на секции для автоматического их экспорта, при необходимости;
  • Локализация элементов навигации: заголовков страниц, текстов внутритекстовых ссылок на страницы, навигационных меню.
Purpose (direction) of automation:
  • Improving the convenience of editors;
  • Separation of design from the content of articles, the unification of the form pages;
  • Create a template articles with examples of the wiki-coding and pre-official marks;
  • Separation of articles into sections for auto-exporting them, if necessary;
  • Localization navigation elements: title page, text Intratextual links to pages and navigation menus.
Способы автоматизации:
  • В зоне RU разработана система шаблонов, форм и служебных страниц, позволяющая автоматизировать создание статей в едином стиле.
  • Формы применяются в темах, объединяющих однотипные статьи, создаваемые по единому макету.
Methods of automate:
  • In the RU zone system is designed templates, forms and service pages, to automate the creation of articles in the same style.
  • The forms used in the themes that unite the same type of article that are created on a single layout.


3.

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

3.1. Автоматизация проявляется в двух областях:
  1. Создание новой статьи "одной кнопкой" - из формы, расположенной в теме.
  2. Создание локализованных ссылок на статьи. Текстом ссылки становится заголовок статьи, на которую оная ссылка делается, автоматически извлекаемый из неё.
Automation is manifested in two areas:
  1. Create a new article, "one button"- from the form located in the subject.
  2. Creating localized links to articles. Link text becomes a headline, which onaya reference is automatically withdrawn from her.


4.

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

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









  1. Полный список доступных расширений: Help:Extensions.
  2. Complete list of available extensions: Help:Extensions.


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