Редактирование: Проект:Технические работы/Шаблоны/Документирование (раздел)

=== Оформительские тонкости ===
* В шаблонах, предназначенных для обычных редакторов, шаблон и его параметры предпочтительно называть на русском языке (хотя у латиницы есть тот плюс, что не приходится переключать раскладку клавиатуры при вводе названия шаблона{{Sp/}}его параметров).
* Есть несколько способов представить код примера использования шаблона (или его синтаксиса) в документации. Это:
** тег {{Tago|pre}}, создающий большие поля вокруг кода. Это единственный возможный способ оформления примеров использования многострочных шаблонов. Этот тег не позволяет использовать вики-разметку внутри себя, поэтому, если разметка необходима, нужно либо, вместо использования {{Tago|pre}}, начинать каждую строку примера с пробела, либо использовать шаблон {{Tl|Tpre}} (это удобно для однострочных шаблонов).{{Абзац
}}Чтобы подсветить код шаблона внутри длинного кода, используйте шаблон {{Tl|highlight}} или {{Tl|oncolor}} (так сделано, например, в документациях шаблонов {{Tl|переход}} и {{Tl|ref+}}). Пример синтаксиса однострочного шаблона, оформленного с помощью {{Tl|Tpre}}:{{Tpre|[[t:перенесено с|перенесено с]]|''Вики-страница''{{Optp|''подпись и/или текст в конце''|текст{{=}}''Текст вместо «Перенесено со страницы»''}}}}
** комбинация тегов {{Tago|code}} и {{Tago|nowiki}}, создающая маленькие поля вокруг кода.{{Абзац
}}Чтобы не писать в примерах использования шаблонов каждый раз длинную конструкцию <code><nowiki><code>&lt;nowiki>&lt;/nowiki></code></nowiki></code>, можно воспользоваться шаблоном {{Tl|Tc}} и аналогичными (см. ссылки в «См. также» его документации). Для вывода примеров включения шаблона рядом с кодами включения можно использовать шаблон {{Tl|Пример}} и аналогичные (в том числе {{Tl|стопка примеров}}, {{Tl|таблица примеров}}; покликайте по ссылкам в разделах «См. также»).{{Абзац
}}Пример синтаксиса шаблона, оформленного с помощью {{Tl|Tc}}:{{Абзац
}}{{Tcl|переход|''название раздела или якоря''{{Optp|''тип значка''|''название раздела''}}}}{{^|1em}}
* Существуют разные способы представить синтаксис шаблона (в понятие «синтаксиса» здесь входит только список параметров и их обязательность, хотя, если понимать это шире, это будет включать тип/формат данных, значение по умолчанию, зависимости параметров, возможность загрузки из Викиданных и прочее). Можно перечислить варианты обращения к шаблону в столбик, как сделано в документации шаблона {{Tl|Флаг}}, а можно представить единой записью, как в документации шаблона {{Tl|Перенесено с}}. Часто хорошая идея — дать «базовый» и «продвинутый» вариант записи (а ещё бывает «минимальный», «рекомендуемый», «полный»…). При этом не путайте ''представление синтаксиса шаблона'' с ''примером его использования''. Один из возможных вариантов оформления синтаксиса единой записью представлен по ссылке {{Ссылка на раздел|Шаблон:Tc#В оформлении документации}}.
* Для описания параметров (полей) крупных шаблонов, кроме списков{{sp/}}таблиц, можно пользоваться хорошо оформленным шаблоном {{Tl|Описание шаблона}} (как это будет выглядеть, см. [[Шаблон:Публикация#Поля|здесь]]).
* Для упоминания шаблонов используйте шаблон {{Tl|Tl}}: {{Пример|Tl|Пример}}.
* Названия параметров обычно записываются со строчной буквы, при необходимости в них используются пробелы. Что касается названий самих шаблонов — дело вкуса, но вряд ли названия узкоспециальных шаблонов технического характера (как то: {{Tl|Lang-en}}, {{Tl|Примечания}}) стоит писать с прописной. В то же время в названиях шаблонов-карточек (как то: {{Tl|Персона}}, {{Tl|Фильм}}) устоялась первая прописная.
* Ещё одна мелочь — как в коде включения многострочных шаблонов отбивать вертикальные черты от начала строк, а названия параметров — от вертикальных черт. В английском разделе часто либо нет отбития вовсе, либо отбиваются названия параметров от вертикальных черт на один символ. У нас в этом деле разнобой.{{Абзац
}}В свою очередь, в длинных однострочных шаблонах для лучшей читаемости целесообразно отбивать каждый следующий параметр пробелом, как в шаблоне {{Tl|Cite web}}: {{Tc|<nowiki>cite web |url= |title= |author= |date= |work= |publisher= |accessdate=2016-01-27 |lang= </nowiki>}}.