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

Правила Энциклопедии    —    Rules Encyclopedia

№	РУС	ENG
1.	Общие положения    —    Terms
1.1.	Зона RU является неотъемлемой и неразрывной частью международного проекта Wiki Template:Documentation/PRODUCTNAME, поэтому все правила и вся документация, далее - Правила, составляются в двуязычном варианте - русском и английском.
1.2.	Для синхронности перевода текст пишется в две колонки. Все пункты Правил нумеруются. Перевод выполняется "пункт в пункт". Номер пункта является общим для русского текста и перевода.
1.3.	В целях визуального отделения страниц Правил от остальных статей wiki, Правила имеют светло-голубой фон. Каждая страница Правил помечается пиктограммой {{Rules}} (за исключением страниц документации шаблонов).
2.	WIKI-кодирование    —    WIKI-coding
2.1.	Общие принципы WIKI-кодирования    —    General principles WIKI-coding
2.1.1.	Для обеспечения единства формы и стиля Правил, разработана система шаблонов (п. 2.4. настоящей Инструкции).
2.1.2.	На всех страницах Правил (в том числе - на страницах документации шаблонов) применяется единая система шаблонов.
2.1.3.	ЗАПРЕЩАЕТСЯ создавать страницы Правил без использования системы шаблонов, указанной в п. 2.4. настоящей Инструкции.
2.2.	Заголовки в Правилах    —    Headlines in the Rules
2.2.1.	ЗАПРЕЩАЕТСЯ использовать прямое wiki-кодирование для создания заголовков всех уровней на страницах Правил.
2.2.2.	Для создания заголовка следует использовать соответствующий шаблон (п. 2.4.3. настоящей Инструкции).
2.2.3.	ЗАПРЕЩАЕТСЯ использовать заголовки 1 (первого) уровня, поскольку данный уровень зарезервирован за заголовком страницы. Уровень заголовка следует указывать от 2 до 6.
2.3.	Создание страницы Правил    —    Create a page of the Rules
2.3.1.	Создание страницы документации шаблона производится с помощью формы, которая автоматически появляется на странице шаблона при первой вставке в код шаблона ссылки на шаблон документации {{doc}}.
2.3.2.	При создании всех прочих страниц Правил целесообразно использовать копирование кода из уже созданных иных страниц Правил.
2.3.3.	Каждая страница Правил (кроме документации шаблонов) должна начинаться кодом, указанным в п. 3 Инструкция. Заголовки статей    —    Guidelines. Article titles.
2.3.4.	Каждая страница Правил (кроме документации шаблонов) должна заканчиваться кодом <section begin=signature/> {{RUsignyear|<Login>|<И. О. Фамилия>|<год ХХХХ>}} {{RUsigntransEng|<Login>|<И. О. Фамилия на английском>}} {{RUrulesBottom}} <section end=signature/>
2.3.5.	Текст страницы Правил должен помещаться внутрь секции toc: <section begin=toc/> ...массив шаблонов с текстом Правил... <section end=toc/>
2.4.	Система шаблонов    —    Templating System
2.4.1.	Шаблон {{Doc/doc/code/tbl/begin}} ОБЯЗАТЕЛЬНЫЙ. Вставляется один раз в начале, сразу после объявления секции <section begin=toc/> Имеет один обязательный именованный параметр: l1=РУС Код: {{Doc/doc/code/tbl/begin |l1=РУС }}
2.4.2.	Шаблон {{Doc/doc/code/tbl/end}} ОБЯЗАТЕЛЬНЫЙ. Вставляется один раз в конце, перед закрытием секции <section end=toc/> без параметров Код: {{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=Templating 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:RUsignyear Template:RUsigntransEng

---

---

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