Шаблон:Tpre/doc

Материал из Буквицы
Перейти к навигации Перейти к поиску

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

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

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

и получим:

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

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

Про такой стиль оформления синтаксисов шаблонов в документациях см. Шаблон:Ссылка на раздел.

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

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

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

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

Настройки

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

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

Шаблон:Sp↓

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

См. также

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

Шаблон:Шаблоны для документирования