Шаблон:Примечания/doc

Материал из NikiWiki
Перейти к:навигация, поиск

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

Используйте этот шаблон для создания списка примечаний. В отличие от шаблона {{subst:footnotes}}, шаблон {{примечания}} не содержит заголовка секции, что делает чтение исходного текста статей более удобным. Например:

== Содержание ==
Мама мыла раму<ref>Аннотированный список видов рам</ref>.

Раму мыла мама<ref>Пособие по мытью рам</ref>.

== Примечания ==
{{примечания}}

Параметры

С помощью атрибута name можно задавать имя примечания, и в дальнейшем использовать его по имени.

== Содержание ==
Мама мыла раму<ref name="list">Аннотированный список видов рам</ref>.

Раму мыла мама<ref>Пособие по мытью рам</ref>.

Еще одна мама мыла раму<ref name="list" />.

== Примечания ==
{{примечания}}

Для облегчения чтения текста при редактировании саму сноску можно разместить не в тексте, а ниже — в параметре refs этого шаблона. А в тексте использовать сноски по имени (name).

== Содержание ==
Мама мыла раму<ref name="link"/>.

Раму мыла мама<ref name="list"/>.

== Примечания ==
{{примечания|refs=
<ref name="list">Аннотированный список видов рам</ref>
<ref name="link">Аннотированный список видов ламп</ref>
}}

Используя атрибут group, можно группировать примечания.

== Содержание ==
Мама мыла раму<ref group="rama">Аннотированный список видов рам</ref>.

Раму мыла мама<ref group="rama">Пособие по мытью рам</ref>.

== Примечания ==
{{примечания|group=rama}}

При этом примечания без указания группы тоже, по сути, входят в отдельную группу.

Выводить примечания повторно нельзя.

Используя атрибут group и атрибут name можно группировать именованные примечания.

== Содержание ==
Нас ждёт рассказ о возмездии и воздаянии<ref>Было это давным-давно</ref>

Столько лет прошло…<ref name="Награда1" group="Награды">Награда нашла героя</ref>

Потом у героя отобрали награду<ref name="Награда1" group="Награды"/>.

Героя наказали<ref name="Наказание1" group="Наказания">Поделом имяреку!</ref>.

Позже он описал и это<ref name="Наказание2" group="Наказания">К ответу!</ref>.

Так раньше наказывали<ref name="Наказание1" group="Наказания"/>.

== Примечания ==
{{примечания}}
; Награды
{{примечания|group=Награды}}
; Наказания
{{примечания|group=Наказания}}

Несколько колонок

Используя {{примечания|2}} можно создавать двухколоночные списки примечаний, а {{примечания|3}} позволяет создать трёхколоночный список.

При указании ширины колонки, например: {{примечания|colwidth=30em}}, браузер автоматически выберет число колонок, основываясь на ширине страницы. Указывайте ширину колонки, достаточную для отображения средней ширины используемых примечаний.

Замечание: несколько колонок в настоящее время поддерживаются только в Gecko- и WebKit-браузерах (Firefox, Google Chrome, Safari), однако эта опция включена в CSS3, а следовательно, будет поддерживаться в будущем и другими браузерами[1].

Замечание: не стоит злоупотреблять многоколоночностью — во многих случаях примечания в несколько колонок по высоте занимают не намного меньше места, а в некоторых — даже больше, чем примечания в одну колонку.

Сворачивание

Длинные блоки примечаний (больше 300 пикселов по высоте) пользователи могут сворачивать; при этом для не поместившихся примечаний организуется прокрутка. Состояние запоминается при переходе между страницами.

Разные браузеры организуют прокрутку многоколоночных списков по-разному: Firefox (до версии 22.0) показывает вертикальную прокрутку, а Chrome, Safari и Firefox (с версии 22.0) — горизонтальную (если задано количество колонок, то ровно столько колонок будут видны на экране одновременно).

На версии для печати сворачивание отключено.

Зарегистрированные пользователи могут поставить для сносок сворачивание по умолчанию, добавив в свой monobook.js следующую строку: document.cookie = 'refcoll=min', затем очистив кэш браузера:

Множественное использование

Если шаблон {{примечания}} используется в тексте статьи несколько раз и без параметров, то при каждом использовании он будет выводить в виде списка все сноски, которые были сделаны в статье вплоть до места вставки такого шаблона. Для того, чтобы потребовать от парсера, чтобы он «закрывал» уже сформированные списки сносок, надо при каждом использовании шаблона {{примечания}} передавать ему хоть какие-нибудь параметры. Даже неопределёные параметры, например {{примечания|close=1}}, могут быть использованы для таких целей.

Параметры шаблона

<TemplateData> {

"description": "Используйте этот шаблон для создания списка примечаний. В отличие от шаблона {{subst:footnotes}}, шаблон

  1. CSS3 module: Multi-column layout. W3C (2005-12-15). Проверено 24 ноября 2006.

не содержит заголовка секции, что делает чтение исходного текста статей более удобным. См. Шаблон:Примечания",

       "params": {
               "refs": {
                       "label": "сноски",
                       "description": "Для облегчения чтения текста при редактировании саму сноску можно разместить не в тексте, а ниже — в этом параметре шаблона. А в тексте использовать сноски по имени (name).",
                       "type": "string",
                       "required": false
               },
               "group": {
                       "label": "группа",
                       "description": "Параметр для группировки примечаний.",
                       "type": "string",
                       "required": false
               },
               "1": {
                       "label": "число колонок",
                       "description": "Параметр для создания двухколоночных и трёхколоночных списков примечаний.",
                       "type": "number",
                       "default": "1",
                       "required": false
               },
               "height": {
                       "label": "компактно",
                       "description": "Добавляет возможность показывать компактно с полосой прокрутки.",
                       "type": "string",
                       "default": "1",
                       "required": false
               },
               "colwidth": {
                       "label": "ширина колонки",
                       "description": "При указании ширины колонки браузер автоматически выберет число колонок, основываясь на ширине страницы. Указывайте ширину колонки, достаточную для отображения средней ширины используемых примечаний.",
                       "type": "string",
                       "default": "30em",
                       "required": false
               },
               "close": {
                       "label": "закрыть",

"description": "Если шаблон

используется в тексте статьи несколько раз и без параметров, то при каждом использовании он будет выводить в виде списка все сноски, которые были сделаны в статье вплоть до места вставки такого шаблона. Для того, чтобы потребовать от парсера, чтобы он «закрывал» уже сформированные списки сносок, надо при каждом использовании шаблона

передавать ему хоть какие-нибудь параметры. Этот параметр используется для таких целей.",

                       "type": "number",
                       "default": "1",
                       "required": false
               }
       }

} </TemplateData>

Примечания

См. также