Инструкция по написанию статей в Энциклопедии    —    Guidelines. Writing articles

From Wiki
Revision as of 11:01, 11 April 2019 by Sancho (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search


CardCatalog.png

Содержание

Rules.png




№ РУС ENG
0.

О статьях    —    About Articles

0.1. Настоящая Инструкция регулирует вопросы создания статей в пределах Энциклопедии и исполняет Информационная стратегия Энциклопедии. These Instructions govern the creation of articles on the Encyclopedia and satisfy the Information Strategy of Encyclopedia.
0.2. Для публикации отбираются статьи, удовлетворяющие следующим критериям: Encyclopedia articles are published if they meet the following content policies:
0.2.1. соответствие тематике ресурса: рассмотрение вопросов, связанных с OpenOffice.org; relevance to the topic: addressing issues relevant to the OpenOffice.org;
0.2.2. актуальность: изложенный материал должен иметь практическую ценность; applicability: the article must be applicable;
0.2.3. цельность: отдельный, самодостаточный информационный объект; wholeness: a separate, all-sufficient information object;
0.2.4. системность: интегрируется в установленную информационную структуру; systemic: can be integrated into the established information structure;
0.2.5. завершённость: статья может находиться в состоянии «черновика» разумное время, далее — удаляется; completeness: an article may be in a "draft" state during a reasonable time, after that it shall be deleted;
0.2.6. достоверность: несомненная верность приводимых в статье сведений, проверка которых на опыте показала, что они соответствуют действительности, что даёт возможность использовать их без дополнительной проверки; factual accuracy: unquestioned truth of the article contents. The trustworthiness of an article is verified by experience, what makes additional verifying unneeded;
0.2.7. непротиворечивость (последовательность): отсутствие расхождений с другими статьями; consistency: no discrepancy with other articles;
0.2.8. неповторимость: на одну и ту же тему и по одному и тому же вопросу не может быть двух статей; uniqueness: there may not be two articles on the same subject or on the same issue;
0.2.9. соответствие настоящему своду Правил. compliance with this set of Policies.
0.3. Статьи, опубликованные с нарушением п. 0.2. удаляются. Articles published in violation of Paragraph 0.2. shall be deleted.


1.

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

1.1.

Что представляют собой статьи    —    What is an article?

1.1.1. Каждая статья представляет собой законченное сообщение по отдельной теме. При необходимости статья может быть разбита не несколько частей. Each article is a complete message on a particular topic. If necessary, an article can be broken down into several parts.
1.1.2.
Documentation caution.png ЗАПРЕЩАЕТСЯ объединение нескольких тем в одну статью!
Documentation caution.png Combining several topics in one article is PROHIBITED!


1.2.

Заголовки статей и их URL    —    Article titles and their URL

1.2.1. При создании нового заголовка следует учитывать Технические ограничения при создании заголовков (URL) статей. When creating a new title the Technical limitations URL should be taken into account.


1.2.2.

URL    —    URL

1.2.2.1. Каждая русскоязычная страница является дочерней по отношению к языковой странице RU. Each Russian-language page is subsidiary of the language page RU.
1.2.2.2. На основании п. 1.2.2.1., URL каждой страницы должен начинаться с имени «RU» и следующего за ним символа «/». According to Paragraph 1.2.2.1., URL of each page should begin with the name "RU" and a slash "/".
1.2.2.3. На основании пп. 1.2.2.1., 1.2.2.2. в имени каждой статьи используется следующий префикс: According to Paragraphs 1.2.2.1., 1.2.2.2. in the name of each article one should use the following prefix: 
RU/
1.2.2.4.
Documentation caution.png ЗАПРЕЩАЕТСЯ создание статей без префикса «RU/» в имени (URL'е)!
Documentation caution.png It is PROHIBITED to write articles without the prefix "RU/" in their name (URL)!
1.2.2.5.
Documentation note.png Регистр важен! URL wiki чувствителен к регистру.
Documentation note.png Case matters! Wiki URL is case sensitive.
1.2.2.6.
Documentation caution.png ЗАПРЕЩАЕТСЯ использование в URL заглавных букв (кроме префикса RU/). Исключением является пространство имён Template:.
Documentation caution.png It is PROHIBITED to use uppercase letters in the URL (except for the prefix RU/). The only exception is the namespace Template:.
1.2.2.7.
Documentation caution.png ЗАПРЕЩАЕТСЯ создание статей с названиями транслитом (название статьи должно быть переведено на английский язык, а не транслитерировано). Для раздела «База знаний» действуют особые условия наименования статей, изложенные в Положение о Базе Знаний.
Documentation caution.png It is PROHIBITED to entitle articles using transliteration (an article name may only be translated into English, not transliterated). There are special rules for article entitling which apply to the Section "Knowledge Base".
1.2.2.8.
Documentation caution.png ЗАПРЕЩАЕТСЯ использование кирилических символов в URL!
Documentation caution.png It is PROHIBITED to use Cyrillic characters in the URL!
1.2.2.9.
Documentation caution.png ЗАПРЕЩАЕТСЯ использование в URL знаков препинания и пробелов (кроме подчёркивания и дефиса)!
Documentation caution.png It is PROHIBITED to use punctuation marks and white-spaces (except for underscores and hyphens) in the URL!
1.2.2.10. Каждая статья создаётся со следующем именем:
RU/name_page, где:
RU/ — является обязательным префиксом имени статьи;
name_page — переведённое на английский язык название статьи.
 Every article has the following name:
RU/name_page, where:
RU/ is a required prefix of the article name;
name_page is an article name translated into English.
1.2.2.11. Если есть необходимость объединить несколько статей в группу, то применяется следующее правило:
RU/group/name_page, где:
group — общая для статей группа. Групп, следующих через слеш «/», может быть несколько.
 If there is a need to join several articles in a group, then the following rule applies:
RU/group/name_page, where:
group is the common group for the joint articles. There can be several groups next to the slash symbol "/".


1.2.3.

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

1.2.3.1. Заголовки статей создаются в соответствии с инструкцией: Инструкция. Заголовки статей Article titles shall be named according to the Instructions: Guidelines. Article titles
1.2.3.2.
Documentation caution.png ЗАПРЕЩАЕТСЯ создание статей, заголовок которых создан с нарушением Инструкция. Заголовки статей!
Documentation caution.png Entitling articles in violation of Guidelines. Article titles is PROHIBITED!
1.2.3.3.
Documentation caution.png ЗАПРЕЩАЕТСЯ внутри текста статей использовать заголовки 1 (первого) уровня, поскольку данный уровень зарезервирован за заголовком страницы. Уровень заголовка следует указывать от 2 до 6. (См. п. 2.2.3. Инструкция. О написании инструкций и документаций шаблонов).
Documentation caution.png It is PROHIBITED within the text of articles to use a top-level (1) heading, because it's reserved for a page title. The appropriate heading levels are 2 to 6. (See paragraph 2.2.3. Guidelines. About composing instructions and documentations for templates).


1.3.

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

1.3.1. Каждая статья обязательно должна быть включена минимум в одну категорию. Поскольку для каждого раздела, рубрики и темы в Энциклопедии разработаны обязательные к применению соответствующие шаблоны подвалов (п. 7. (Разраб.) Инструкция. Шаблоны, общие для всех национальных языковых страниц), то тег категории уже в них включён. Если же подходящего для статьи шаблона подвала не найдено, то тег категории следует указать в последней строке статьи, после текста. Every article is supposed to belong to at least one category. Since there are templates for bottom parts of every section (p.7. Guidelines. Templates that are common to all national language pages), subsection and topic in Encyclopedia, so the category tag is already included there. If there is no appropriate template for the bottom part of an article, then its category tag should be placed at the end of the wikitext.
Например: Example: 
[[Category:RU/kb]]
1.4.

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

1.4.1. Каждая статья подписывается пользователем, её создавшим (создателем). При внесении корректировок изменение имени создателя не допускается.
Имя создателя проставляется с помощью шаблона {{Sign}} с двумя параметрами: 1-й параметр — регистрационное имя пользователя в системе; 2-й параметр — имя, которое будет отображено в подписи.
Например:
 A user that created an article should sign it. It is prohibited to change a user signature when editing the article.
The author's name of an article is stamped by the template {{Sign}} which has two parameters: the 1st parameter is the registered name of the user in the system; the 2nd parameter is the name, shown in the signature.
Example:
Шаблон    —    template Результат    —    result
{{Sign|Sancho|А. Е. Харламенков}}
1.4.2. Под шаблоном с подписью создателя указывается номер версии OpenOffice.org, текущей на момент написания статьи. Номер версии OpenOffice.org проставляется с помощью шаблона {{OOoVersion}} с одним параметром, в котором указывается номер версии.
Например:
 Under the template with the creator's signature there should be a version number of the OpenOffice.org, which was current to the moment of writing the article. The version number of the OpenOffice.org is stamped by the template {{OOoVersion}} which has one parameter—the version number.
Example:
Шаблон    —    template Результат    —    result
{{OOoVersion|RU|3.x}} Версия OpenOffice.org 3.x
1.4.3. Если статья не имеет прямого отношения к версии OpenOffice.org, то указывается год написания статьи без указания версии OpenOffice.org. В этом случае используется другой шаблон подписи.
Например:
 If an article has no direct relationship to the OpenOffice.org version, then a year of writing that article is stamped without specifying the OpenOffice.org version number. In this case another signature template is used.
Example:
Шаблон    —    template Результат    —    result
{{SignYear|AEroshin|А. В. Ерошин|2010}}


1.4.4. Не допускается изменение или удаление имени создателя статьи и переводчика, в том числе, в случае редактирования. Ответственность редакторов существующих статей фиксируется в «Истории правок». It is not allowed to change or delete the creator's or translator's name of an article, particularly in the case of editing. The responsibility of contributing editors of existing articles is recorded in the "histories".
1.4.5. Последним в статье, после шаблона подписи, вставляется шаблон подвала статьи {{RUxxxxxВottom}}, где ххххх — имя соответствующего раздела. Подробно все шаблоны подвалов описаны в (Разраб.) Инструкция. Шаблоны, общие для всех национальных языковых страниц. The last in an article, next to the signature template, there is the template for an article bottom {{RUxxxxxВottom}}, where ххххх is the name of the relevant section. All the templates for a section bottom are described in detail in Guidelines. Templates that are common to all national language pages.


2.

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

2.1.

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

2.1.1. Ссылки на внутренние статьи в зоне RU данной wiki оформляются с помощью специального шаблона {{SecTitle}} с одним обязательным параметром — wiki-URL. Например Internal links in Zone RU of this wiki are formed by the special template {{SecTitle}} with one required parameter—wiki-URL. For example
Шаблон    —    template Результат    —    result
{{SecTitle|RU/kb/00000000}} Шаблоны. Шаблон по умолчанию
2.1.2. Ссылки на статьи из прочих языковых зон данной wiki оформляются следующим образом: Links to pages from other language zones of this wiki should look as follows:
Шаблон    —    template Результат    —    result
[[Main_Page|Главная страница wiki]] Главная страница wiki
2.2.

Вставка кода Star Basic и других языков программирования    —    Inserting listings of Star Basic and other programming languages

2.2.1. Для вставки в статьи кода Star Basic (OpenOffice.org Basic) следует использовать следующую конструкцию: The following marking is used for inserting listings of the Star Basic (OpenOffice.org Basic) code: 
<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 поддерживет синтаксис следующих языков: source lang supports the syntax of the following programming languages:
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    —    Using the names "OpenOffice.org" and "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}}. In order to write the following names: OpenOffice.org, OpenOffice.org 1.x, OpenOffice.org 2.x, OpenOffice.org 3.x and OpenOffice.org pro in article text and headings, the special templates are used: {{OOo}}, {{OOo1}}, {{OOo2}}, {{OOo3}}, {{OOoPro}}.
3.2. Если в статье встречается прямое употребление названия OpenOffice.org и/или OpenOffice.org pro, их следует заменить на соответствующий шаблон. If there is the direct using of the name OpenOffice.org and/or OpenOffice.org pro in an article, it should be changed to the appropriate template.
3.2.1. Исключением из п. 3.2. является упоминание конкретных версий программы (например текст «OpenOffice.org 1.2.3» не нужно заменять на «{{OOo}} 1.2.3»). The specific versions of the program is the exception to p.3.2. (e.g. text "OpenOffice.org 1.2.3" should not be replaced by the text "{{OOo}} 1.2.3").
3.2.2. Для вставки на странице статичного текста из шаблона рекомендуется использовать конструкцию вида: {{subst:OOo}} 1.2.3. To insert a static text from a template on the page it is recommended to use the following form: {{subst:OOo}} 1.2.3.


4.

Употребление наименований Microsoft Office и отдельных его приложений    —    Using the names of the Microsoft Office and its applications

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}}. In order to write the following names: Microsoft Office, Microsoft Office 2003, Microsoft Office 2010, MS Word, MS Excel, MS Access, MS Power Point and MS Equation in article text and headings, the special templates are used: {{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, их следует заменить на соответствующий шаблон. If there is the direct using of the names Microsoft Office, Microsoft Office 2003, Microsoft Office 2010, MS Word, MS Excel, MS Access, MS Power Point or MS Equation in an article, they should be changed to the appropriate template.
4.2.1. Исключением из п. 4.2. является упоминание конкретных версий программы (например текст "MS Word 5.0" не нужно заменять на "{{MSW}} 5.0"). The specific versions of the program is the exception to p.4.2. (e.g. text "MS Word 5.0" should not be replaced by the text "{{MSW}} 5.0").
4.2.2. Для вставки на странице статичного текста из шаблона рекомендуется использовать конструкцию вида: {{subst:MSW}} 5.0. To insert a static text from a template on the page it is recommended to use the following form: {{subst:MSW}} 5.0.


5.

Обязательные элементы построения статей    —    The required elements for writing articles

5.1. Создание русскоязычного заголовка описано в п. 1.2.3.1. The policies of creating a Russian-language title are described in Paragraph 1.2.3.1.
5.2. Сразу за заголовком следует шаблон «хлебных крошек» {{BreadCrumbL10n}} без параметра. Для статей из «Базы Знаний» в шаблоне {{BreadCrumbL10n}} следует указать в качестве параметра wiki-URL темы, к которой относится статья. Right next to the title there is the "bread crumbs" {{BreadCrumbL10n}} template with no parameters. For articles in the "Knowledge Base" the wiki-URL of the applying article topic should be specified as a parameter in the {{BreadCrumbL10n}} template.
5.3. Следом за «хлебными крошками» указывается магическое слово __NOTOC__ для отключения локального оглавления статьи. Включать локальное оглавление в статье следует только в виде исключения при наличии серьёзной необходимости. Для этого указывается магическое слово __TOC__ Right next to the "bread crumbs" there goes the magic word __NOTOC__ for disabling the local article table of contents. Enabling the local table of contents in an article should be made only as an exception in serious need. For that the magic word __TOC__ is specified.
5.4. Далее следует основной текст статьи, который помещается внутрь секции toc: Next goes the general text of an article inside the section toc: 
<section begin=toc/>
…Основной текст статьи…
<section end=toc/>
5.5. В конце ставится подпись, которая помещается внутрь секции signature. Если статья не имеет отношения к конкретной версии OpenOffice.org, то для подписи используется шаблон

{{SignYear|<Login>|<И. О. Фамилия>|<год ХХХХ>}}

At the end of an article there should be a signature inside the section signature. If the article is not related to a specific version of OpenOffice.org, then the following template is used for the signature:

{{SignYear|<Login>|<Full name>|<Year ХХХХ>}}

Например: Example: 
<section begin=signature/>
{{SignYear|<Login>|<И. О. Фамилия>|<год ХХХХ>}}
<section end=signature/>
5.6. Если статья относится к определённой версии OpenOffice.org, то вместо шаблона из п. 5.5. используются следующие два шаблона:

{{Sign|<Login>|<И. О. Фамилия>}} {{OOoVersion|3.3.x}}

If the article refers to a specific version of OpenOffice.org, then the following two templates are used instead of the template mentioned in p.5.5. :

{{Sign|<Login>|<Full name>}} {{OOoVersion|3.3.x}}

Например: Example: 
<section begin=signature/>
{{Sign|<Login>|<И. О. Фамилия>}}
{{OOoVersion|3.3.x}}
<section end=signature/>
5.7. Последней строкой указывается шаблон подвала, описанный в п. 1.4.5. In the last line of a page there is the template of the bottom part, described in Paragraph 1.4.5.







Translator:
Evgeny S. Mikhaylov







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


Retrieved from "https://wiki.harlamenkov.ru/index.php?title=RU/rules/writing_articles&oldid=23478"