Якорь/doc
- 1 year ago
- 0
- 0
Мне кажется неудачной сама идея такого шаблона.
— Alex Smotrov 17:25, 10 февраля 2007 (UTC)
Я думаю, что для этих ссылок нужны всплывающие подсказки в виде пояснений.
Например:
А, вот, назначение ссылки
[обновить]
мне не совсем ясно, что, собственно, и подвигло меня предложить идею с подсказками.
Если не ошибаюсь, для этого надо заключить ссылки в тег
<span title="НУЖНЫЙ_ТЕКСТ">...</span>
. —
, 5 мая 2008
Ещё предлагаю сделать логотип ссылкой на подстраницу документации:
<imagemap> Image:Information.svg|20px default [[{{FULLPAGENAME}}/Документация|Документация]] desc none </imagemap>
Думаю, это будет лучше, чем ссылка в никуда. — , 5 мая 2008
{{ template navigation }} с главной страницы шаблона: он же ведь только для подстраниц документации. — , 5 мая 2008
Кстати, предлагаю убратьВ целях улучшения внешнего вида страниц документации шаблонов предлагаю заменить иллюстрацию из верхней части страницы страницы с на . Этим достигается сразу несколько целей:
Я отменил Ваши правки также и потому, что этот вариант оформления (не побоюсь этого слова) безобразен: большая картинка, да ещё и в двух фигурных скобках режет глаз и привлекает на себя излишнее внимание, что совершенно ненужно. Ведь не документация делается для значка, а всего лишь значок указывает, что это документация.
Думаю, что "режет глаз" - это очень субъективная оценка, поэтому с ней трудно работать. Но отмечу, что основной текст документации шаблона тоже находится на голубом фоне, который сглаживает контраст между страницей и значком (вот если бы фон был, например, зеленоватым, как в en.wiki, то было бы хуже, но такого я и не предлагаю). — Эта реплика добавлена участником Sergey Liverko ( о • в ) 10:19, 23 января 2010 (UTC)
Чтобы участники могли оценить, как будет выглядеть результат, приведу пример документации к самому шаблону {{ doc }} в новом формате:
__NOEDITSECTION__
Включает подстраницу с документаций для текущего шаблона. Точнее, включает шаблон
название страницы
/doc
. Работает также и в обсуждении шаблона, то есть включает одну и ту же страницу как из шаблона, так и из его обсуждения. И всё же включение документации в обсуждение является нежелательным.
Проще всего вставить вызов этого шаблона, а потом перейти по появившейся ссылке и создать или скопировать туда документацию. Достаточно добавить код
<noinclude>{{doc}}</noinclude>
.
Документация шаблона {{ doc }} сформирована по тому же принципу, так что можно посмотреть код.
Основная цель выноса документации на отдельную страницу — избежать перегенерации HTML для всех страниц, использующих шаблон, при редактировании его документации. Также это сокращает страницу самого шаблона, что делает редактирование проще.
Шаблон поддерживает необязательный параметр. При вводе
{{
doc
|
Полное название страницы
}}
вместо страницы
/doc
будет включена любая необходимая. Это удобно для создания общей документации для однотипных шаблонов.
См. также проект по документированию шаблонов .
— Эта реплика добавлена участником Sergey Liverko ( о • в )
Админы! Обратите внимание, подшаблон
{{
Doc/begin
}}
вызывается с параметром
notoc
, несмотря на то, что последний оттуда
.—
Bandar Lego
10:08, 4 февраля 2011 (UTC)
Предлагаю добавить в нижний колонтитул текст со ссылками на песочницу и документацией по ее использованию, как в английском варианте {{ }}. Немного стандартизации в тестировании изменений шаблонов, на мой взгляд, не помешает. Чтобы каждому не приходилось изобретать свой "велосипед" для тестирования. --14:30, 13 сентября 2011 (UTC)
Было бы неплохо добавить параметр
|
content
=
по образцу англовики:
|
1
=
and the
|
content
=
parameter can also be combined, like this:
<!--Last line of your template code--><noinclude>
{{Documentation |1=Template:Any page/doc
| content =
{{Template:Any page/doc |parameters}}
}}</noinclude>
Then the pagename fed as parameter 1 is used for the [edit] [purge] links and for the /doc link in the link box below the doc box. But the
content
parameter is used for the content shown in the doc box. The above code means that the content is transcluded as
{{
Template:Any page/doc|parameters
}}
. In this example a parameter is also fed to the /doc page being loaded.
К примеру, у меня есть общая документация для шаблонов семейства {{ tr- x }} для указания перевода. Ей я хочу кормить параметры (код языка, название языка в родительном падеже, слово для примера, перевод слова для примера), что из шаблона {{ doc }} сделать невозможно — можно только указать адрес страницы. Из-за этого я вынужден делать не общую документацию, а обычную для каждого шаблона и в неё вставлять код, как, например, на :
<noinclude>{{docpage}}</noinclude> {{tr/doc-lang | код языка = la | род. п. = латинского | терм = in situ | перевод = на месте }} <includeonly>[[Категория:Шаблоны языков|{{str sub|{{ROOTPAGENAME}}|3|10}}]]</includeonly>
(Даже категорию туда убрать не могу, потому что тут нужен как бы двойной инклюдонли, равно как для
{{
docpage
}}
двойной ноинклюд. Мм, хотя
{{
docpage
}}
в таком случае будет бессмыслен, ибо не будет той подстраницы, на которой он будет виден с ссылками для конкретного шаблона.) —
Джек, который построил дом
21:42, 15 февраля 2016 (UTC)
Предлагается следующее изменение оформления документаций шаблонов/модулей. Изменение было предварительно обсуждено в кругу техников проекта.
, . Причины, я полагаю, будут понятны — сейчас оформление, по сути, случайно: используются произвольные параметры шрифта, отступы, рамка, кнопки в меню не оформлены в стандартном стиле. Предлагался также с меню в стандартном месте (справа от заголовка), но он предварительно не получил поддержки (как, впрочем, и явно негативных отзывов). — Джек ( обс. ) 14:48, 11 июня 2018 (UTC)
Быть может, в документации к {{ doc }} следует сразу упомянуть {{ docpage }} ? Или появление документации в некатегоризованных шаблонах кому-то помогает выявить несовершенство? Microzaur 15:14, 6 июля 2012 (UTC)