Шаблон:No-doc

Документация

[просмотр | править | история | обновить]

Шаблон используется в шаблонах, включаемых на страницы документации шаблонов (например, {{эзотерический шаблон}}). Он позволяет избежать попадания документации в категории, проставляемой такими шаблонами, а также проводит проверку на пространство имен «Шаблон» или «Модуль». С помощью параметра |nocat= можно добавить возможность отключения категоризации.

Использование

{{no-doc}} совмещает в себе функцию {{tc}} и {{pre}}. С его помощью удобно создавать примеры использования шаблонов в их документациях.

Например, чтобы показать синтаксис шаблона {{перенесено с}}, мы можем в его документации написать так:

{{tpre||''Вики-страница''{{optp|''подпись и/или текст в конце''|текст{{=}}''Текст вместо «Перенесено со страницы»''}}}}
{{optp/comment}}

и получим:

Серым показаны необязательные параметры.

Про такой стиль оформления синтаксисов шаблонов в документациях см. | вместо использования специального параметра --> | Шаблон:Tc § В оформлении документации | Шаблон:Tc#В оформлении документации }}.

Между тем в многострочных примерах этот шаблон лучше не использовать по причине съедания пробелов до вертикальных черт, прибегая вместо него к оформлению при помощи пробела в начале строк. Это тоже позволяет включать разметку в код. Например (в начале каждой строки — пробел):

 {{((}}main
  |''Статья 1''
  |''Статья 2''
  |l1=''Отображаемый текст ссылки 1''
  |l2=''Отображаемый текст ссылки 2''
 }}

который даст:

{{main
 |Статья 1
 |Статья 2
 |l1=Отображаемый текст ссылки 1
 |l2=Отображаемый текст ссылки 2
}}

Настройки

Если задать |_spaced=1, параметры шаблона будут отбиты пробелами:

{{no-doc|ш|параметр 1{{=}}значение|параметр 2{{=}}значение|_spaced=1}}

↓

ш

См. также

• {{*tpre}} — то же самое с маркером списка (иначе его нельзя использовать напрямую)
• {{sp↓}} — отбитая от левого края стрелка вниз, чтобы оформить ею результат обработки того, что показано в шаблоне {{tpre}}
• {{пример}} — код вызова шаблона → результат; см. там стиль pre
• {{pre}}
• {{между pre}}

Во избежание поломок страниц, использующих этот шаблон, экспериментируйте в песочнице (создать | зеркало) или своём личном пространстве.
Пожалуйста, добавляйте категории на подстраницу /doc. Подстраницы этого шаблона.