Difference between revisions of "RU/rules/rules"
From Wiki
Jump to navigationJump to search (Основной текст) |
|||
(14 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
− | <section begin=title /><noinclude>{{DISPLAYTITLE:</noinclude>Инструкция. О написании инструкций и документаций шаблонов{{Doc/doc/code/tbl/titleSeparator}} | + | <includeonly><section begin=rus />Инструкция. О написании инструкций и документаций шаблонов<section end=rus /></includeonly> |
− | {{ | + | <includeonly><section begin=lat />Guidelines. About composing instructions and documentations for templates<section end=lat /></includeonly> |
+ | <section begin=title /><noinclude>{{DISPLAYTITLE:</noinclude>Инструкция. О написании инструкций и документаций шаблонов{{Doc/doc/code/tbl/titleSeparator}}Guidelines. About composing instructions and documentations for templates<noinclude>}}</noinclude><section end=title />{{RUkbUpToc}} | ||
+ | {{BreadCrumbL10n}} | ||
__NOTOC__ | __NOTOC__ | ||
{{Rules}} | {{Rules}} | ||
Line 15: | Line 17: | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
|nom=1.1. | |nom=1.1. | ||
− | |l1= | + | |l1=Все правила и вся документация, далее - Правила, составляются в двуязычном варианте — русском и английском. |
− | |l2= | + | |l2=All the rules and documentations (Rules) are written in a bilingual variant—Russian and English. |
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
|nom=1.2. | |nom=1.2. | ||
− | |l1=Для синхронности перевода текст пишется в две колонки. Все пункты Правил нумеруются. Перевод выполняется | + | |l1=Для синхронности перевода текст пишется в две колонки. Все пункты Правил нумеруются. Перевод выполняется «пункт в пункт». Номер пункта является общим для русского текста и перевода. |
− | |l2= | + | |l2=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. |
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
|nom=1.3. | |nom=1.3. | ||
|l1=В целях визуального отделения страниц Правил от остальных статей wiki, Правила имеют светло-голубой фон. Каждая страница Правил помечается пиктограммой {{Tl|Rules}} (за исключением страниц документации шаблонов). | |l1=В целях визуального отделения страниц Правил от остальных статей wiki, Правила имеют светло-голубой фон. Каждая страница Правил помечается пиктограммой {{Tl|Rules}} (за исключением страниц документации шаблонов). | ||
− | |l2= | + | |l2=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 {{Tl|Rules}} icon (except for the template documentation pages). |
}} | }} | ||
{{Doc/doc/code/tbl/titleL1L2 | {{Doc/doc/code/tbl/titleL1L2 | ||
|nom=2. | |nom=2. | ||
− | |l1= | + | |l1=Wiki-кодирование |
− | |l2= | + | |l2=Wiki-coding |
|level=2 | |level=2 | ||
}} | }} | ||
{{Doc/doc/code/tbl/titleL1L2 | {{Doc/doc/code/tbl/titleL1L2 | ||
|nom=2.1. | |nom=2.1. | ||
− | |l1=Общие принципы | + | |l1=Общие принципы wiki-кодирования |
− | |l2=General principles | + | |l2=General principles of wiki-coding |
|level=3 | |level=3 | ||
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
|nom=2.1.1. | |nom=2.1.1. | ||
− | |l1=Для обеспечения единства формы и стиля Правил, разработана система шаблонов (п. 2.4. настоящей Инструкции). | + | |l1=Для обеспечения единства формы и стиля Правил, разработана система шаблонов (п. 2.4. настоящей Инструкции). |
− | |l2= | + | |l2=For consistency of content and style of the Rules, the template system was developed (paragraph 2.4. of these Instructions). |
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
|nom=2.1.2. | |nom=2.1.2. | ||
− | |l1=На всех страницах Правил (в том числе | + | |l1=На всех страницах Правил (в том числе на страницах документации шаблонов) применяется единая система шаблонов. |
− | |l2= | + | |l2=The unified template system applies to all the Rules pages (particularly to the template documentation pages). |
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
|nom=2.1.3. | |nom=2.1.3. | ||
− | |l1='''ЗАПРЕЩАЕТСЯ''' создавать страницы Правил без использования системы шаблонов, указанной в п. 2.4. настоящей Инструкции. | + | |l1={{Caution|'''ЗАПРЕЩАЕТСЯ''' создавать страницы Правил без использования системы шаблонов, указанной в п. 2.4. настоящей Инструкции.}} |
− | |l2= | + | |l2={{Caution|It is '''PROHIBITED''' to create pages of the Rules without using the template system, mentioned in paragraph 2.4. of these Instructions.}} |
}} | }} | ||
{{Doc/doc/code/tbl/titleL1L2 | {{Doc/doc/code/tbl/titleL1L2 | ||
|nom=2.2. | |nom=2.2. | ||
|l1=Заголовки в Правилах | |l1=Заголовки в Правилах | ||
− | |l2= | + | |l2=Headings in the Rules |
|level=3 | |level=3 | ||
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
|nom=2.2.1. | |nom=2.2.1. | ||
− | |l1='''ЗАПРЕЩАЕТСЯ''' использовать прямое wiki-кодирование для создания заголовков всех уровней на страницах Правил. | + | |l1={{Caution|'''ЗАПРЕЩАЕТСЯ''' использовать прямое wiki-кодирование для создания заголовков всех уровней на страницах Правил.}} |
− | |l2= | + | |l2={{Caution|It is '''PROHIBITED''' to use direct wiki-coding for composing any-level headings on the Rules pages.}} |
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
|nom=2.2.2. | |nom=2.2.2. | ||
− | |l1=Для создания заголовка следует использовать соответствующий шаблон (п. 2.4.3. настоящей Инструкции). | + | |l1=Для создания заголовка следует использовать соответствующий шаблон (п. 2.4.3. настоящей Инструкции). |
− | |l2= | + | |l2=An appropriate template should be used to create a heading (paragraph 2.4.3. of these Instructions). |
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
|nom=2.2.3. | |nom=2.2.3. | ||
− | |l1='''ЗАПРЕЩАЕТСЯ''' использовать заголовки 1 (первого) уровня, поскольку данный уровень зарезервирован за заголовком страницы. Уровень заголовка следует указывать от 2 до 6. | + | |l1={{Caution|'''ЗАПРЕЩАЕТСЯ''' использовать заголовки 1 (первого) уровня, поскольку данный уровень зарезервирован за заголовком страницы. Уровень заголовка следует указывать от 2 до 6. (См. п. 1.2.3.3. {{SecTitleRulesRus|RU/rules/writing_articles}}).}} |
− | |l2= | + | |l2={{Caution|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. {{SecTitleRulesLat|RU/rules/writing_articles}}).}} |
}} | }} | ||
{{Doc/doc/code/tbl/titleL1L2 | {{Doc/doc/code/tbl/titleL1L2 | ||
|nom=2.3. | |nom=2.3. | ||
|l1=Создание страницы Правил | |l1=Создание страницы Правил | ||
− | |l2= | + | |l2=Creating a page of the Rules |
|level=3 | |level=3 | ||
}} | }} | ||
Line 85: | Line 87: | ||
|nom=2.3.1. | |nom=2.3.1. | ||
|l1=Создание страницы документации шаблона производится с помощью формы, которая автоматически появляется на странице шаблона при первой вставке в код шаблона ссылки на шаблон документации {{Tl|doc}}. | |l1=Создание страницы документации шаблона производится с помощью формы, которая автоматически появляется на странице шаблона при первой вставке в код шаблона ссылки на шаблон документации {{Tl|doc}}. | ||
− | |l2= | + | |l2=A page of template documentation is created through an automatically generated form when the tag of documentation template {{Tl|doc}} is initially inserted to the template code. |
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
|nom=2.3.2. | |nom=2.3.2. | ||
|l1=При создании всех прочих страниц Правил целесообразно использовать копирование кода из уже созданных иных страниц Правил. | |l1=При создании всех прочих страниц Правил целесообразно использовать копирование кода из уже созданных иных страниц Правил. | ||
− | |l2= | + | |l2=When creating all other pages of the Rules it`s a good practice to paste code from already made pages of the Rules. |
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
|nom=2.3.3. | |nom=2.3.3. | ||
− | |l1=Каждая страница Правил (кроме документации шаблонов) должна начинаться кодом, указанным в п. 3 {{ | + | |l1=Каждая страница Правил (кроме документации шаблонов) должна начинаться кодом, указанным в п. 3 {{SecTitleRulesRus|RU/rules/titles}}. |
− | |l2= | + | |l2=Every page of the Rules (except for the template documentation) should begin with the code, mentioned in paragraph 3 {{SecTitleRulesLat|RU/rules/titles}}. |
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
Line 102: | Line 104: | ||
<pre> | <pre> | ||
<section begin=signature/> | <section begin=signature/> | ||
− | {{ | + | {{SignYear|<Login>|<И. О. Фамилия>|<год ХХХХ>}} |
− | {{ | + | {{SignTrans|EN|<Login>|<И. О. Фамилия на английском>}} |
+ | {{RUrulesBottom}} | ||
+ | <section end=signature/> | ||
+ | </pre> | ||
+ | |l2=In the end of every page of the Rules (except for the template documentation) there should be the code | ||
+ | <pre> | ||
+ | <section begin=signature/> | ||
+ | {{SignYear|<Login>|<Author`s full name in Russian>|<Year of publication>}} | ||
+ | {{SignTrans|EN|<Login>|<Author`s full name in English>}} | ||
{{RUrulesBottom}} | {{RUrulesBottom}} | ||
<section end=signature/> | <section end=signature/> | ||
</pre> | </pre> | ||
− | |||
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
Line 117: | Line 126: | ||
<section end=toc/> | <section end=toc/> | ||
</pre> | </pre> | ||
− | |l2= | + | |l2=Contents of the Rules page should be placed inside section '''toc''': |
+ | <pre> | ||
+ | <section begin=toc/> | ||
+ | ...templates array with the Rules contents... | ||
+ | <section end=toc/> | ||
+ | </pre> | ||
+ | |||
}} | }} | ||
{{Doc/doc/code/tbl/titleL1L2 | {{Doc/doc/code/tbl/titleL1L2 | ||
|nom=2.4. | |nom=2.4. | ||
|l1=Система шаблонов | |l1=Система шаблонов | ||
− | |l2= | + | |l2=Template system |
|level=3 | |level=3 | ||
}} | }} | ||
Line 136: | Line 151: | ||
}} | }} | ||
</pre> | </pre> | ||
− | | | + | |l2=Template {{Tl|Doc/doc/code/tbl/begin}} |
+ | * '''REQUIRED'''. It is inserted only once in the beginning next to the section begin tag {{Tag|<nowiki>section begin=toc/</nowiki>|1}} | ||
+ | * Has one required named parameter: '''l1=РУС''' | ||
+ | * Code: | ||
+ | <pre> | ||
+ | {{Doc/doc/code/tbl/begin | ||
+ | |l1=РУС | ||
+ | }} | ||
+ | </pre> | ||
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
Line 142: | Line 165: | ||
|l1=Шаблон {{Tl|Doc/doc/code/tbl/end}} | |l1=Шаблон {{Tl|Doc/doc/code/tbl/end}} | ||
* '''ОБЯЗАТЕЛЬНЫЙ'''. Вставляется один раз в конце, перед закрытием секции {{Tag|<nowiki>section end=toc/</nowiki>|1}} | * '''ОБЯЗАТЕЛЬНЫЙ'''. Вставляется один раз в конце, перед закрытием секции {{Tag|<nowiki>section end=toc/</nowiki>|1}} | ||
− | * | + | * Без параметров |
* Код: | * Код: | ||
<pre> | <pre> | ||
{{Doc/doc/code/tbl/end}} | {{Doc/doc/code/tbl/end}} | ||
</pre> | </pre> | ||
− | |l2= | + | |l2=Template {{Tl|Doc/doc/code/tbl/end}} |
+ | * '''REQUIRED'''. It is inserted only once in the end before the section end tag {{Tag|<nowiki>section end=toc/</nowiki>|1}} | ||
+ | * Has no parameters | ||
+ | * Code: | ||
+ | <pre> | ||
+ | {{Doc/doc/code/tbl/end}} | ||
+ | </pre> | ||
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
Line 163: | Line 192: | ||
|nom=2.4. | |nom=2.4. | ||
|l1=Система шаблонов | |l1=Система шаблонов | ||
− | |l2= | + | |l2=Template system |
+ | |level=3 | ||
+ | }} | ||
+ | </pre> | ||
+ | |l2=Template {{Tl|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: | ||
+ | <pre> | ||
+ | {{Doc/doc/code/tbl/titleL1L2 | ||
+ | |nom=2.4. | ||
+ | |l1=Система шаблонов | ||
+ | |l2=Template system | ||
|level=3 | |level=3 | ||
}} | }} | ||
</pre> | </pre> | ||
− | |||
}} | }} | ||
{{Doc/doc/code/tbl/strL10n | {{Doc/doc/code/tbl/strL10n | ||
Line 185: | Line 229: | ||
}} | }} | ||
</pre> | </pre> | ||
− | |l2= | + | |l2=Template {{Tl|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: | ||
+ | <pre> | ||
+ | {{Doc/doc/code/tbl/strL10n | ||
+ | |nom=2.4. | ||
+ | |l1=Текст. | ||
+ | |l2=Text. | ||
+ | }} | ||
+ | </pre> | ||
}} | }} | ||
<!-- |- | <!-- |- | ||
Line 194: | Line 251: | ||
<section begin=signature/> | <section begin=signature/> | ||
− | {{ | + | {{SignYear|Sancho|А. Е. Харламенков|2010}} |
− | {{ | + | {{SignTrans|EN|Lew Wadoo|Evgeny S. Mikhaylov}} |
{{RUrulesBottom}} | {{RUrulesBottom}} | ||
<section end=signature/> | <section end=signature/> |
Latest revision as of 09:35, 6 September 2011
Содержание
- Политика и Условия использования веб-сайта wiki.harlamenkov.ru
- Миссия Энциклопедии
- Принципы дополнения Wiki
- Введение в Wiki-редактирование
- Принципы именования страниц
- Стратегия
- Общие положения
- Инструкции
- Инструкция. Заголовки статей
- Инструкция. Создание новых рубрик
- Инструкция. Создание новых тем
- Инструкция. Создание новых тем в Базе Знаний
- Инструкция по написанию статей в Энциклопедии
- Правила стилевого оформления текстов
- Инструкция. Оформление таблиц
- (Разраб.) Инструкция. Шаблоны, общие для всех национальных языковых страниц
- Инструкция. О написании инструкций и документаций шаблонов
- Технические ограничения при создании заголовков (URL) статей
- Принципы перевода страниц
- Документация
- Обновление Правил
№ | РУС | 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. |
| |||||
2.2. |
Заголовки в Правилах — Headings in the Rules | |||||
2.2.1. | ||||||
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. |
|
| ||||
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/> {{SignYear|<Login>|<И. О. Фамилия>|<год ХХХХ>}} {{SignTrans|EN|<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/> {{SignYear|<Login>|<Author`s full name in Russian>|<Year of publication>}} {{SignTrans|EN|<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}}
{{Doc/doc/code/tbl/begin |l1=РУС }} |
Template {{Doc/doc/code/tbl/begin}}
{{Doc/doc/code/tbl/begin |l1=РУС }} | ||||
2.4.2. | Шаблон {{Doc/doc/code/tbl/end}}
{{Doc/doc/code/tbl/end}} |
Template {{Doc/doc/code/tbl/end}}
{{Doc/doc/code/tbl/end}} | ||||
2.4.3. | Шаблон {{Doc/doc/code/tbl/titleL1L2}}
{{Doc/doc/code/tbl/titleL1L2 |nom=2.4. |l1=Система шаблонов |l2=Template system |level=3 }} |
Template {{Doc/doc/code/tbl/titleL1L2}}
{{Doc/doc/code/tbl/titleL1L2 |nom=2.4. |l1=Система шаблонов |l2=Template system |level=3 }} | ||||
2.4.4. | Шаблон {{Doc/doc/code/tbl/strL10n}}
{{Doc/doc/code/tbl/strL10n |nom=2.4. |l1=Текст. |l2=Text. }} |
Template {{Doc/doc/code/tbl/strL10n}}
{{Doc/doc/code/tbl/strL10n |nom=2.4. |l1=Текст. |l2=Text. }} |