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

From Wiki
Jump to navigationJump to search
(Перевод 0.1.)
(Перевод 0.2.)
Line 21: Line 21:
 
  |nom=0.2.
 
  |nom=0.2.
 
  |l1=Для публикации отбираются статьи, удовлетворяющие следующим критериям:
 
  |l1=Для публикации отбираются статьи, удовлетворяющие следующим критериям:
  |l2=
+
  |l2=For publish selected articles that meet the following criteria:
 
}}
 
}}
 
{{Doc/doc/code/tbl/strL10n
 
{{Doc/doc/code/tbl/strL10n

Revision as of 11:22, 5 November 2010

Rules.png




РУС ENG
0.

О статьях    —    About Articles

0.1. Настоящая Инструкция регулирует вопросы создания статей в пределах национальной языковой страницы RU и исполняет Положение о национальной языковой странице RU и информационную политику. This manual governs the creation of articles in the national language page RU and execute Rules and information policy of national language page RU.
0.2. Для публикации отбираются статьи, удовлетворяющие следующим критериям: For publish selected articles that meet the following criteria:
0.2.1. соответствие тематике ресурса — рассмотрение вопросов, связанных с OpenOffice.org.
0.2.2. актуальность — изложенный материал должен иметь практическую ценность;
0.2.3. цельность — отдельный, самодостаточный информационный объект;
0.2.4. системность — интегрироваться в установленную информационную структуру;
0.2.5. завершённость — статья может находиться в состоянии "черновика" разумное время, далее — удаляется;
0.2.6. достоверность — несомненная верность приводимых в статье сведений, проверка которых на опыте показала, что они соответствуют действительности, что даёт возможность использовать их без дополнительной проверки.
0.2.7. непротиворечивость — отсутствие расхождений с другими статьями.
0.2.7. неповторимость — на одну и ту же тему и по одному и тому же вопросу не может быть двух статей.
0.2.9. соответствие настоящему своду Правил.
0.3. Статьи, опубликованные с нарушением п. 0.2. удаляются.


1.

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

1.1.

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

1.1.1. Каждая статья представляет собой законченное сообщение по отдельной теме. При необходимости статья может быть разбита не несколько частей.
1.1.2.
Documentation caution.png ЗАПРЕЩАЕТСЯ объединение нескольких тем в одну статью.


1.2.

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

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


1.2.2.

URL    —    URL

1.2.2.1. Каждая русскоязычная страница является дочерней по отношению к национальной языковой странице RU.
1.2.2.2. Поэтому каждая страница должна начинаться с имени «RU» и следующего за ним символа «/».
1.2.2.3. Таким образом, в имени каждой статьи используется следующий префикс:
RU/
1.2.2.4.
Documentation caution.png ЗАПРЕЩАЕТСЯ создание статей без префикса «RU/» в имени (URL'е)
1.2.2.5.
Documentation note.png Регистр важен! URL wiki чувствителен к регистру.
1.2.2.6.
Documentation caution.png ЗАПРЕЩАЕТСЯ использование в URL заглавных букв (кроме префикса RU/). Исключением является пространство имён «Template:».
1.2.2.7.
Documentation caution.png ЗАПРЕЩАЕТСЯ создание статей с названиями транслитом (название статьи должно быть переведено на английский язык, а не транслитерировано). Для раздела «База Знаний» действуют особые условия наименования статей.
1.2.2.8.
Documentation caution.png ЗАПРЕЩАЕТСЯ использование кирилических символов в URL
1.2.2.9.
Documentation caution.png ЗАПРЕЩАЕТСЯ использование в 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. Заголовки статей создаются в соответствии с инструкцией: Инструкция. Заголовки статей    —    Guidelines. Article titles
1.2.3.2.
Documentation caution.png ЗАПРЕЩАЕТСЯ создание статей, заголовок которых создан с нарушением Инструкция. Заголовки статей    —    Guidelines. Article titles.


1.3.

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

1.3.1. Каждая статья обязательно должна быть включена минимум в одну категорию. Поскольку, для каждого раздела, рубрики и темы в зоне RU разработаны обязательные к применению соответствующие шаблоны подвалов, то тег категории уже в них включён. Если же подходящего для статьи шаблона подвала не найдено, то тег категории следует указать в последней строке статьи, после текста.
Например:
[[Category:RU/kb]]


1.4.

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

1.4.1. Каждая статья подписывается пользователем, её создавшим (создателя). При внесении корректировок изменение имени создателя не допускается.
Имя создателя проставляется с помощью шаблона {{RUsign}} с двумя параметрами, где: 1-й параметр — регистрационное имя автора в системе; 2-й параметр — Имя, которое будет отображено в подписи.
Например:
Шаблон    —    template Результат    —    result
{{RUsign|NGarbuz|Н. Е. Гарбуз}} Template:RUsign
1.4.2. Под шаблоном с подписью автора указывается номер версии OpenOffice.org, текущей на момент написания статьи. Номер версии OpenOffice.org проставляется с помощью шаблона {{RUoooversion}} с одним параметром, в котором указывается номер версии.
Например:
Шаблон    —    template Результат    —    result
{{RUoooversion|3.x}} Template:RUoooversion
1.4.3. Если статья не имеет прямого отношения к версии OpenOffice.org, то указывается год написания статьи без указания версии OpenOffice.org. В этом случае используется другой шаблон подписи.
Например:
Шаблон    —    template Результат    —    result
{{RUsignyear|AEroshin|А. В. Ерошин|2010}} Template:RUsignyear
1.4.4. Последним в статье, после шаблона подписи, вставляется шаблон подвала статьи {{xxxxxВottom}}, где ххххх — имя соответствующего раздела. Подробно все шаблоны подвалов описаны в [[RU/templates|RU/templates]].


2.

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

2.1.

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

2.1.1. Ссылки на внутренние статьи в зоне RU данной wiki оформляются с помощью специального шаблона {{SecTitle}} с одним обязательным параметром — wiki-URL. Например
Шаблон    —    template Результат    —    result
{{SecTitle|RU/kb/00000000}} Шаблоны. Шаблон по умолчанию
2.1.2. Ссылки на статьи из прочих языковых зон данной wiki оформляются следующим образом:
Шаблон    —    template Результат    —    result
[[Main_Page|Главная страница wiki]] Главная страница wiki
2.2.

Вставка кода Star Basic и других языков программирования    —    

2.2.1. Для вставки в статьи кода Star Basic (OpenOffice.org Basic) следует использовать следующую конструкцию:
<source lang="oobas">
 ...
 </source>
Шаблон    —    template Результат    —    result
<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.

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

3.1. При написании статей и в заголовках статей при упоминании названий OpenOffice.org, OpenOffice.org 1.x, OpenOffice.org 2.x, OpenOffice.org 3.x и OpenOffice.org pro следует использовать специальные шаблоны: {{OOo}}, {{OOo1}}, {{OOo2}}, {{OOo3}}, {{OOoPro}}.
3.2. Если в статье встречается прямое употребление названия OpenOffice.org и/или OpenOffice.org pro, их следует заменить на соответствующий шаблон.


4.

Употребление наименований Microsoft Office и отдельных его приложений    —    

4.1. При написании статей и в заголовках статей при упоминании названий Microsoft Office, Microsoft Office 2003, Microsoft Office 2010, MS Word, MS Excel, MS Access, MS Power Point и MS Equation следует использовать специальные шаблоны: {{MSO}}, {{MSO2003}}, {{MSO2010}}, {{MSW}}, {{MSE}}, {{MSA}}, {{MSPP}}, {{MSEq}}.
4.2. Если в статье встречается прямое употребление названий Microsoft Office, Microsoft Office 2003, Microsoft Office 2010, MS Word, MS Excel, MS Access, MS Power Point и/или MS Equation, их следует заменить на соответствующий шаблон.


5.

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

5.1. Создания русскоязычного заголовка описано в п. 1.2.3.1.
5.2. Сразу за заголовком следует шаблон «хлебных крошек» {{BreadCrumbL10n}} без параметра. Для статей из «Базы Знаний» в шаблоне {{BreadCrumbL10n}} следует указать в качестве параметра wiki-URL темы, к которой относиться статья.
5.3. Следом за «хлебными крошками» указывается магическое слово __NOTOC__ для отключения локального оглавления статьи. Включать локальное оглавление в статье следует только в виде исключения при наличии серьёзной необходимости. Для этого указывается магическое слово __TOC__
5.4. Далее следует основной текст статьи, который помещается внутрь секции toc:
<section begin=toc/>
...Основной текст статьи...
<section end=toc/>
5.5. В конце ставится подпись
{{RUsignyear|Ivanov|И. И. Иванов|2010}}
5.6. Если статья касается конкретной версии OpenOffice.org, то вместо предыдущего шаблона, применяются два других:
{{RU/documentation/sign|Ivanov|И. И. Иванов}}
{{RU/documentation/oooversion|3.3.x}}
5.7. Последней строкой указывается шаблон подвала, описанный в п. 1.4.4.



Template:RUsignyear Template:RUsigntransEng






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