Инструкция. О написании инструкций и документаций шаблонов    —    Guidelines. About composing instructions and documentations for templates

From Wiki
Revision as of 14:57, 13 August 2011 by Sancho (talk | contribs) (Корректировка)
Jump to navigationJump to search


CardCatalog.png

Содержание

Rules.png




№ РУС ENG
1.

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

1.1. Все правила и вся документация, далее - Правила, составляются в двуязычном варианте — русском и английском. All the rules and documentations (Rules) are written in a bilingual variant—Russian and English.
1.2. Для синхронности перевода текст пишется в две колонки. Все пункты Правил нумеруются. Перевод выполняется «пункт в пункт». Номер пункта является общим для русского текста и перевода. Text is written in two columns for simultaneousness of translation. All paragraphs of the Rules are numbered. The text is translated paragraph to paragraph. A paragraph number is common for Russian text and the translated text.
1.3. В целях визуального отделения страниц Правил от остальных статей wiki, Правила имеют светло-голубой фон. Каждая страница Правил помечается пиктограммой {{Rules}} (за исключением страниц документации шаблонов). In order to visually distinguish the Rules pages from other wiki pages, the background of the Rules is light blue. Every page of the Rules is marked by {{Rules}} icon (except for the template documentation pages).


2.

Wiki-кодирование    —    Wiki-coding

2.1.

Общие принципы wiki-кодирования    —    General principles of wiki-coding

2.1.1. Для обеспечения единства формы и стиля Правил, разработана система шаблонов (п. 2.4. настоящей Инструкции). For consistency of content and style of the Rules, the template system was developed (paragraph 2.4. of these Instructions).
2.1.2. На всех страницах Правил (в том числе на страницах документации шаблонов) применяется единая система шаблонов. The unified template system applies to all the Rules pages (particularly to the template documentation pages).
2.1.3.
Documentation caution.png ЗАПРЕЩАЕТСЯ создавать страницы Правил без использования системы шаблонов, указанной в п. 2.4. настоящей Инструкции.
Documentation caution.png It is PROHIBITED to create pages of the Rules without using the template system, mentioned in paragraph 2.4. of these Instructions.


2.2.

Заголовки в Правилах    —    Headings in the Rules

2.2.1.
Documentation caution.png ЗАПРЕЩАЕТСЯ использовать прямое wiki-кодирование для создания заголовков всех уровней на страницах Правил.
Documentation caution.png It is PROHIBITED to use direct wiki-coding for composing any-level headings on the Rules pages.
2.2.2. Для создания заголовка следует использовать соответствующий шаблон (п. 2.4.3. настоящей Инструкции). An appropriate template should be used to create a heading (paragraph 2.4.3. of these Instructions).
2.2.3.
Documentation caution.png ЗАПРЕЩАЕТСЯ использовать заголовки 1 (первого) уровня, поскольку данный уровень зарезервирован за заголовком страницы. Уровень заголовка следует указывать от 2 до 6. (См. п. 1.2.3.3. Инструкция по написанию статей в Энциклопедии).
Documentation caution.png It is PROHIBITED 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 1.2.3.3. Guidelines. Writing articles).


2.3.

Создание страницы Правил    —    Creating a page of the Rules

2.3.1. Создание страницы документации шаблона производится с помощью формы, которая автоматически появляется на странице шаблона при первой вставке в код шаблона ссылки на шаблон документации {{doc}}. A page of template documentation is created through an automatically generated form when the tag of documentation template {{doc}} is initially inserted to the template code.
2.3.2. При создании всех прочих страниц Правил целесообразно использовать копирование кода из уже созданных иных страниц Правил. When creating all other pages of the Rules it`s a good practice to paste code from already made pages of the Rules.
2.3.3. Каждая страница Правил (кроме документации шаблонов) должна начинаться кодом, указанным в п. 3 Инструкция. Заголовки статей. Every page of the Rules (except for the template documentation) should begin with the code, mentioned in paragraph 3 Guidelines. Article titles.
2.3.4. Каждая страница Правил (кроме документации шаблонов) должна заканчиваться кодом 
<section begin=signature/>
{{RUsignyear|<Login>|<И. О. Фамилия>|<год ХХХХ>}}
{{RUsigntransEng|<Login>|<И. О. Фамилия на английском>}}
{{RUrulesBottom}}
<section end=signature/>
In the end of every page of the Rules (except for the template documentation) there should be the code 
<section begin=signature/>
{{RUsignyear|<Login>|<Author`s full name in Russian>|<Year of publication>}}
{{RUsigntransEng|<Login>|<Author`s full name in English>}}
{{RUrulesBottom}}
<section end=signature/>
2.3.5. Текст страницы Правил должен помещаться внутрь секции toc: 
<section begin=toc/>
...массив шаблонов с текстом Правил...
<section end=toc/>
Contents of the Rules page should be placed inside section toc: 
<section begin=toc/>
...templates array with the Rules contents...
<section end=toc/>


2.4.

Система шаблонов    —    Template system

2.4.1. Шаблон {{Doc/doc/code/tbl/begin}}
  • ОБЯЗАТЕЛЬНЫЙ. Вставляется один раз в начале, сразу после объявления секции <section begin=toc/>
  • Имеет один обязательный именованный параметр: l1=РУС
  • Код:
{{Doc/doc/code/tbl/begin
 |l1=РУС
}}
Template {{Doc/doc/code/tbl/begin}}
  • REQUIRED. It is inserted only once in the beginning next to the section begin tag <section begin=toc/>
  • Has one required named parameter: l1=РУС
  • Code:
{{Doc/doc/code/tbl/begin
 |l1=РУС
}}
2.4.2. Шаблон {{Doc/doc/code/tbl/end}}
  • ОБЯЗАТЕЛЬНЫЙ. Вставляется один раз в конце, перед закрытием секции <section end=toc/>
  • Без параметров
  • Код:
{{Doc/doc/code/tbl/end}}
Template {{Doc/doc/code/tbl/end}}
  • REQUIRED. It is inserted only once in the end before the section end tag <section end=toc/>
  • Has no parameters
  • Code:
{{Doc/doc/code/tbl/end}}
2.4.3. Шаблон {{Doc/doc/code/tbl/titleL1L2}}
  • Шаблон для создания двуязычных заголовков.
  • Имеет 4 (четыре) обязательных именованных параметра:
    • nom=<Номер пункта>
    • l1=<Заголовок на русском языке>
    • l2=<Заголовок на английском языке>
    • level=<Уровень заголовка. Указывается одной цифрой от 2 до 6>
  • Код:
{{Doc/doc/code/tbl/titleL1L2
 |nom=2.4.
 |l1=Система шаблонов
 |l2=Template system
 |level=3
}}
Template {{Doc/doc/code/tbl/titleL1L2}}
  • For creating bilingual headings.
  • Has 4 (four) required named paremeters:
    • nom=<Paragraph number>
    • l1=<Heading name in Russian>
    • l2=<Heading name in English>
    • level=<Heading level. It is specified by one digit 2 to 6>
  • Code:
{{Doc/doc/code/tbl/titleL1L2
 |nom=2.4.
 |l1=Система шаблонов
 |l2=Template system
 |level=3
}}
2.4.4. Шаблон {{Doc/doc/code/tbl/strL10n}}
  • Шаблон для создания двуязычных строк.
  • Имеет 3 (три) обязательных именованных параметра:
    • nom=<Номер пункта>
    • l1=<Текст пункта на русском языке>
    • l2=<Текст пункта на английском языке>
  • Код:
{{Doc/doc/code/tbl/strL10n
 |nom=2.4.
 |l1=Текст.
 |l2=Text.
}}
Template {{Doc/doc/code/tbl/strL10n}}
  • For creating bilingual lines.
  • Has 3 (three) required named parameters:
    • nom=<Paragraph number>
    • l1=<Paragraph text in Russian>
    • l2=<Paragraph text in English>
  • Code:
{{Doc/doc/code/tbl/strL10n
 |nom=2.4.
 |l1=Текст.
 |l2=Text.
}}



Template:RUsignyear Template:RUsigntransEng




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


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