Template:Doc/doc/ru

This is a documentation subpage for Template:Doc.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Purge base's cache

Шаблон {{doc}} предназначен для добавления блока документации на различные страницы (в основном, на страницы шаблонов). От языка интерфейса пользователя, зависит какая подстраница будет загружаться в блок документации. В случае с русским языком, документация будет браться с подстраницы /doc/ru. Однако, только в случае с английским языком, документация будет браться с подстраницы /doc.

Инструменты

Справа сверху, прямо из блока документации, выступает основной инструментарий:

• Создать — открывает создание страницы документации. Появляется только в случае, если страница документации не существует.
• Просмотр — открывает страницу документации.
• Править — открывает редактирование страницы документации.
• История — открывает историю изменений страницы документации.

Примечание:если нет ни одного вышеперечисленного инструмента, то текст документации был записан через параметр {{{content}}} или параметр {{{tools}}} был выставлен на 0.

Также, в правом верхнем углу есть кнопка помеченная многоточием [ … ]. Она разворачивает/сворачивает дополнительные инструменты:

• Песочница — открывает создание подстраницы /sandbox и копирует код оригинальной страницы, или, если данная страница существует, просто открывает её.
• Тестирование — открывает создание подстраницы /testcases. Полезно для тестирования шаблона в разных ситуациях.
• Подстраницы — открывает Special:PrefixIndex и вставляет название страницы для поиска всех подстраниц.
• Очистить кэш — открывает окно с сообщением об очистке кэша страницы.

Языковая строка

Справа сверху, под инструментами, находятся флаги, переключающие документацию на другой язык. Переключение реализовано путём вставки &uselang=<код языка> в ссылку страницы, поэтому если вы нажмёте на другой язык, то вместе с документацией, поменяется язык интерфейса.

Языковую строку можно убрать, если установить {{{nolang}}} на 1.

Если документации на том или ином языке нет, будет отображено сообщение «Страница документации <страница> не существует». Eсли {{{pagespace}}} или само пространство страницы — User, то будет показано другое сообщение с учётом выставленного пола в настройках пользователя:

• Нейтрально — «Пользователь <ник_пользователя> не предоставил информацию о себе на данном языке (<страница>)».
• Она — «<ник_пользователя> не предоставила информацию о себе на данном языке (<страница>)».
• Он — «<ник_пользователя> не предоставил информацию о себе на данном языке (<страница>)».

Параметры

• {{{1}}}: параметр для переключения назначения шаблона:
  • Если нужен стандартный блок документации, ничего не вписывайте в этот параметр.
  • 0 — отобразит сообщение «Это подстраница документации для <страница>».
  • 1 — отобразит сообщение «Это подстраница песочницы для <страница>».
  • 2 — отобразит сообщение «Эта страница не является песочницей».
  • 3 — отобразит сообщение «Это подстраница c информацией о пользователе <страница>».
  • 4 — отобразит сообщение «Это подстраница документации для использования на нескольких страницах». Если используется параметр {{{list}}}, то текст будет дополнен, в зависимости от пространства указанной страницы:
    • Category → «Это подстраница документации для использования на нескольких страницах указанных в категории <list страница>».
    • Во всех других случаях будет «Это подстраница документации для использования на нескольких страницах указанных на странице <list страница>».
• {{{list}}}: указывает страницу или категорию, в которой перечислены страницы, использующие определённую страницу документации. Используется только когда {{{1}}} выставлен на 4.
• {{{docpage}}}: страница которая будет использоваться в качестве документации.
• {{{content</код языка>}}}: контент который будет использоваться в качестве документации, вместо отдельной страницы. При использовании, основные инструменты скрываются.
• {{{pagespace}}}: пространство страницы, определяется автоматически, но можно вписать свой вариант. От этого параметра зависит текст в заголовке:
  • Template → «Документация шаблона».
  • File → «Описание».
  • User → «О пользователе».
  • Во всех других случаях будет «Документация».

Примечание:Eсли {{{pagespace}}} или само пространство страницы — User, то текст документации будет взят с подстраницы /about, а не с /doc.

• {{{tools}}}: определяет, какие кнопки инструментов должны отображаться:
  • 0 – никаких кнопок.
  • 1 – Только кнопки «Создать», «Просмотр», «Править» и «История».
  • При других значениях будут отображаться все кнопки.
• {{{nolang}}}: убирает языковую строку, если установить на 1.
• {{{examples}}}: сюда вписываются примеры которые можно скопировать и использовать на других страницах. При использовании, появляется кнопка «Примеры», слева прямо под заголовком блока документации.
• {{{noscroll}}}: если вы используете параметр {{{examples}}} с малым количеством примеров, этот параметр отключит правое доп. заполнение (scrollbar-gutter), необходимое для полосы прокрутки.

Создание документации

Warning:Если вы хотите добавить символ «|» где-то в тексте (шаблонов и других MediaWiki элементов не касается), используйте |.

Чтобы начать создание документации, нажмите на кнопку «Создать» справа сверху. В самом начале документации, добавьте шаблон {{doc}} и впишите 0 в параметр {{{1}}}. После этого у вас появится сообщение о том, что это подстраница документации. А чтобы это сообщение не появлялось в блоке документации, оно должно записываться таким образом:

<noinclude>{{doc|0}}</noinclude>

Далее записывается текст самой документации. Сперва идёт краткое описание, а после — в зависимости от того, на что пишется документация.