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

Revision as of 14:34, 22 May 2010

0. О статьях

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

0.2. Для публикации отбираются статьи, удовлетворяющие следующим критериям:

0.2.1 соответствие тематике ресурса - рассмотрение вопросов, связанных с Apache OpenOffice.

0.2.2 актуальность - изложенный материал должен иметь практическую ценность;

0.2.3 цельность - отдельный, самодостаточный информационный объект;

0.2.4 системность - интегрироваться в установленную информационную структуру;

0.2.5 завершённость - статья может находиться в состоянии "черновика" разумное время, далее - удаляется;

0.2.6 соответствие настоящему своду Правил.

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

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

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

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

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

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

1.2.2. URL

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

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

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

RU/

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

Template:Documentation/Note

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

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

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

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

1.2.2.10. Каждая статья создаётся со следующем именем:

RU/name_page где:

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

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

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

RU/group/name_page где:

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

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

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

Например:

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

__NOTOC__

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

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

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

Например:

[[Category:RU/kb]]

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

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

1.4.1. Каждая статья подписывается пользователем, её создавшим (создателя). При внесении корректировок изменение имени создателя не допускается.

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

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

где:

1.4.2. Под именем автора проставляется номер версии Apache OpenOffice, текущей на момент написания статьи.

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

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

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

Например:

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

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

Например:

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

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

{{xxxxxВottom}}

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

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

1.5.1 При необходимости для некоторых статей создаются страницы перенаправления с русским названием.

1.5.2. Статьи-перенаправления содержат команду редиректа и шаблон категории.

Например:

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

2. Вставка специальных элементов

2.1. Ссылки на внутренние статьи

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

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

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

2.2.1. Для вставки в статьи кода 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

2.2.2. source lang поддерживет синтаксис следующих языков:

abap, actionscript, actionscript3, ada, apache, applescript, apt_sources, asm, asp, autoit, avisynth, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, cil, cmake, cobol, cpp, cpp-qt, csharp, css, d, dcs, delphi, diff, div, dos, dot, eiffel, email, erlang, fo, fortran, freebasic, genero, gettext, glsl, gml, gnuplot, groovy, haskell, hq9plus, html4strict, idl, ini, inno, intercal, io, java, java5, javascript, kixtart, klonec, klonecpp, latex, lisp, locobasic, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, make, matlab, mirc, modula3, mpasm, mxml, mysql, nsis, oberon2, objc, ocaml, ocaml-brief, oobas, oracle11, oracle8, pascal, per, perl, php, php-brief, pic16, pixelbender, plsql, povray, powershell, progress, prolog, properties, providex, python, qbasic, rails, rebol, reg, robots, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, tcl, teraterm, text, thinbasic, tsql, typoscript, vb, vbnet, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, whois, winbatch, xml, xorg_conf, xpp, z80

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

3.1. При написании статей и в заголовках статей при упоминании названий Apache OpenOffice и OpenOffice.org pro следует использовать специальные шаблоны:

Template:RU/code Template:RU/code

3.2. Если в статье встречается прямое употребление названия Apache OpenOffice и/или OpenOffice.org pro, их следует заменить на соответствующий шаблон.

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

4.1. Для создания русскоязычного заголовка следует использовать тег:

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

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

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

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

__NOTOC__

4.4. Далее следует основной текст статьи.

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

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

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

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

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

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

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

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

Template:RU/documentation/signyear