Difference between revisions of "RU/rules/writing articles"

Revision as of 20:00, 16 May 2010

О статьях

Настоящая Инструкция регулирует вопросы создания статей в пределах национальной языковой страницы RU и исполняет Положение о национальной языковой странице RU и информационную политику.

База Знаний является сборником статей, в лаконичной форме описывающих решение тех или иных вопросов.

В Базу Знаний отбираются проверенные и испытанные на практике решения, представляющие ценность для конечного пользователя.

Создание статей

Что представляют собой статьи

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

Объединение нескольких тем в одну статью не допускается.

Заголовки статей и их URL

При создании нового заголовка следует учитывать технические ограничения.

URL

Каждая русскоязычная страница является дочерней по отношению к национальной языковой странице RU.

Поэтому каждая страница должна начинаться с имени «RU» и следующего за ним символа «/».

Таким образом, в имени каждой статьи используется следующий префикс:

RU/

Запрещается создание статей без префикса «RU/» в имени (URL'е)

Template:Documentation/Note

Запрещается использование в URL заглавных букв (кроме префикса RU/) Исключением является пространство имён «Template:».

Запрещается создание статей с названиями транслитом (название статьи должно быть переведено на английский язык, а не транслитерировано). Для раздела "База Знаний" действуют особые условия наименования статей.

Запрещается использование кирилических символов в URL

Запрещается использование в URL знаков препинания (кроме подчёркивания и дефиса) и пробелов

Каждая статья создаётся со следующем именем:
RU/name_page где:

RU/ - являются обязательным префиксом имени статьи.

name_page - переведённое на английский язык название статьи.

Если есть необходимость объединить несколько статей в группу, то применяется следующее правило:
RU/group/name_page где:

group - общая для статей группа. Групп, следующих через слеш «/» может быть несколько.

Заголовки статей

Первой строкой в статье должен быть указан отображаемый заголовок статьи.
Например:

{{DISPLAYTITLE:База Знаний: Как сделать, чтобы графический объект при печати был не виден?}}

__NOTOC__

Запрещается создание статей без тега {{DISPLAYTITLE:}}

Категоризация статей

Каждая статья обязательно должна быть включена минимум в одну категорию.

Обычно, тэг категории указывают в первых строках статьи, до начала текста.

Например:

[[Category:RU/kb]]

Для большинства разделов страницы RU и Базы Знаний разработаны шаблоны подвалов (обязательные к применению в соответствующих рубриках), в которых уже указана соответствующая категория. В этом случае использовать тэг [[Category:ххх]] не нужно.

Подписи статей

Каждая статья подписывается автором, её создавшим. При внесении корректировок изменение имени автора не допускается.
Под именем автора проставляется номер версии Apache OpenOffice, текущей на момент написания статьи.

Имя автора проставляется с помощью шаблона

{{RU/documentation/sign|login|Фамилия_И_О}}

где:

Номер версии Apache OpenOffice проставляется с помощью шаблона

{{RU/documentation/oooversion|3.x}}

где 3.x - № версии.

Например:

{{RU/documentation/sign|NGarbuz|Н. Е. Гарбуз}}
{{RU/documentation/oooversion|3.x}}

Если статья не имеет прямого отношения к версии Apache OpenOffice, указывается год написания статьи без указания версии Apache OpenOffice. В этом случае используется другой шаблон.
Например:

{{RU/documentation/signyear|AEroshin|А. В. Ерошин|2010}}

Статьи оканчиваются обязательной вставкой шаблона после подписи:

{{xxxxxВottom}}

где ххххх - имя соответствующего раздела.

Создание перенаправления

При необходимости для некоторых статей создаются страницы перенаправления с русским названием.
Статьи содержат команду редиректа и шаблон категории.
Например:

#Redirect [[RU/kb/00000000]]
{{xxxxxВottom}}

Ссылки на статьи

Ссылки на внутренние статьи данной wiki оформляются следующим образом:

[[RU/kb/00000000|00000000 Положение о Базе Знаний]]

Вставка кода Star Basic

Для вставки в статьи кода Star Basic (Apache OpenOffice Basic) следует использовать следующую конструкцию:

<source lang="oobas">
...
</source>

<source lang="oobas">
function MyFunc()
   MyFunc = 1
end function
</source>

function MyFunc()
   MyFunc = 1
end function

Употребление наименований Apache OpenOffice и OpenOffice.org pro

При написании статей и в заголовках статей при упоминании названий Apache OpenOffice и OpenOffice.org pro следует использовать специальные шаблоны: Template:RU/code Template:RU/code Если в статье (в заголовке статьи) встречается прямое употребление названия Apache OpenOffice и/или OpenOffice.org pro, их следует заменить на соответствующий шаблон.

Обязательные элементы построения статей

{{DISPLAYTITLE:Русское наименование статьи}}

Если статья Базы Знаний, то указывается ссылка на рубрику

[[RU/kb/xxx|База Знаний: Рубрика]]

Затем отключаем оглавление (необязательно, но желательно)

__NOTOC__

Далее

Основной текст статьи.

Если статья Базы Знаний, то указывается ссылка на индекс (соответствующий)

[[RU/kb/index/20|Индекс: Calc]]

В конце ставится подпись

{{RU/documentation/signyear|Ivanov|И. И. Иванов|2010}}

Если статья касается конкретной версии Apache OpenOffice, то вместо предыдущего шаблона, применяются два других:

{{RU/documentation/sign|Ivanov|И. И. Иванов}}
{{RU/documentation/oooversion|3.3.x}}

Последней строкой указывается шаблон подвала

{{Kb____рубрика______Вottom}}

Template:RU/documentation/signyear