Шаблон:Ambox/документація

Меташаблони контейнерів повідомлень
шаблон	контекст
{{Ambox}}	стаття
{{Cmbox}}	категорія
{{Imbox}}	зображення
{{Tmbox}}	обговорення
{{Fmbox}}	верхній/нижній колонтитул
{{Ombox}}	інші сторінки
{{Mbox}}	автовизначення
{{Asbox}}	стаб статті
{{Dmbox}}	неоднозначність

Це меташаблон {{Ambox}} (англ. [A]rticle [m]essage [box]).

Він використовується для побудови шаблонів контейнеру (вікна) повідомлення статті, таких як {{Брак посилань}}. Він пропонує декілька різних кольорів, використовує задані зображення, якщо окремо не визначено параметром та має деякі інші властивості.

Загальні параметри

Поле, розташоване нижче, показує найпоширеніші параметри, які приймає {{Ambox}}. Призначення кожного з них описано нижче.

{{Ambox
| name  = 
| subst = <includeonly>{{subst:substcheck}}</includeonly>
| small = {{{small|}}}
| type  = 
| image = 
| sect  = {{{1|}}}
| issue = 
| talk  = {{{talk|}}}
| fix   = 
| date  = {{{date|}}}
| cat   = 
| all   = 
}}

name

|name= визначає назву шаблону, без префіксу простору назв Шаблон:. Наприклад {{Брак посилань}} визначається |name=Брак посилань.

Цей параметр потрібно оновлювати у випадку переміщення шаблону. Цей параметр має два призначення:

• Якщо некоректно підставлено, він дозволяє меташаблону помітити назву шаблону, який було підставлено, що може допомогти редакторам вирішити проблему.
• Він дозволяє шаблону мати зручніше відображення на його власній сторінці, наприклад, показувати дату, навіть якщо її не зазначено та застосовувати категоризацію самого себе.

subst

|subst= — обов'язковий параметр — дозволяє меташаблонам виявляти коли шаблон було некоректно використано з підстановкою, та надавати відповідне попередження. Він також буде додавати такі сторінки до К:Сторінки з некоректно підставленими шаблонами (0). Просто скопіюйте код, зображений на картинці в полі.

small

|small= повинен бути пропущений через шаблон, оскільки це дозволить редакторам використовувати маленький формат через зазначення |small=left у статті:

Інакше стандартний формат буде виконувати:

Інші варіації:

• Для шаблонів, які повинні бути маленькими ніколи, зазначте |small=no або не пропускайте параметр small взагалі.
• Для шаблонів, які повинні бути маленькими завжди, просто зазначте |small=left.
• Для шаблонів, які повинні бути маленькими за замовчуванням, спробуйте |small={{{small|left}}}. Це дозволить редакторам перевизначити параметр за допомогою |small=no у статті.

Див. § sect, нижче, задля пояснення того, як обмежити відображення |small= у випадках, коли шаблон використовується для розділу замість усієї статті (рекомендовано для попередження неузгодженого розміщення на початку статті).

type

|type= визначає колір лівої панелі та зображення, що використовується за замовчуванням. Тип обирається не з естетичних міркувань, а базуючись на типі призначення, яке шаблон мусить виконувати і описувати. Сім, доступних за замовчуванням, типів та їх стандартні зображення показані нижче.

Якщо не задано параметр type, шаблон прийме стандартне значення |type=notice.

image

Ви можете обрати специфічне зображення для використання у шаблоні задавши його у параметрі image. Зображення визначаються із використанням стандартного синтаксису для вставлення файлу у Вікіпедії (див. Вікіпедія:Стиль/Зображення#Як розміщувати зображення.) ширина у 40-50пкс є типовою. Наприклад:

• {{Нейтральність}} визначає |image=[[Файл:Unbalanced scales.svg|40пкс|link=|alt=]] і виглядає приблизно так:

• {{Брак посилань}} визначає |image=[[Файл:Wikitext-uk.svg|50x40пкс|link=|alt=]] і виглядає приблизно так:

Будь ласка, зауважте:

• Якщо зображення не було визначене, тоді буде використовуватись зображення стандартне для даного type. (Див. #type вище.)
• Якщо визначено |image=none, тоді не буде жодного зображення, а текст буде використовувати усю поверхню контейнеру повідомлення.
• Якщо іконка грає чисто декоративну роль та також знаходиться у суспільному надбанні, доступність може бути поліпшена шляхом придушення посилання на сторінку файлу, додавши "|link=|alt=" як видно вище.

sect

Багато шаблонів повідомлень для статей починаються текстом Ця стаття ... і досить часто виникає потреба у зміні формулювання на Цей розділ ... якщо шаблон використовується у розділі. Значення цього параметру буде заміщувати слово "стаття". Різні можливості для використання включають: |sect=list, |sect=table, |sect=у матеріалі "Популярної культури", і т.д.

При використанні цієї функції, впевніться, що видалили перші два слова ("Ця стаття") з тексту шаблону, інакше він буде дублюватися.

Найбільш поширений спосіб, щоб полегшити цю функціональність, це пропустити |sect={{{1|}}}. Це дозволить редакторам набирати розділ, наприклад, в якості першого неназваного параметра шаблону змінювати формулювання. Наприклад, {{Реклама|Цей розділ}} виведе:

Інший підхід полягає в передачі |sect={{{section|{{{sect|}}}}}} щоб забезпечити значення імені. Іншим способом є використання {{Yesno}} розібрати значення для формування позитивного, і передати |sect=section якщо значення дійсне.

Ці підходи можуть бути поєднані, і таке використання є рекомендованим. Наступний готовий до використання код:

| sect = {{#ifeq:{{yesno|def=|1={{{sect|{{{section}}}}}} }}|yes|section|{{{sect|{{{section|{{{1|}}}}}}}}} }}

забезпечує наступне:

• Будь-яке позитивне значення, яке {{Yesno}} може виявити використовуватиметься з названим параметром в шаблоні на основі Ambox, щоб отримати "section" замість "article": |section=y, |sect=True, і т.д. Рекомендується дозвіл обох: |sect= та |section= так щоб редактори не гадали, який буде працювати. Приклад коду вище робить це для вас.
• Будь-яке інше значення передане в будь-якому порядку, замінить "article": |section and its subsections, |1=list, |sect=section, |section=table, і т.д.

Бажано також, обмежити використання параметру |small= таким чином, щоб зробити можливим використання шаблону у випадку розділу (або що), а не до всієї статті, щоб запобігти використанню маленької версії шаблону у верхній частині статті, де це було б несумісним з іншими широкими банерами впорядкування/диспуту:

| small = {{#if:{{{sect|{{{section|{{{1|}}}}}}}}}|{{#if:{{{small|{{{left|}}}}}}|left}} }}

(У цьому випадку, будь-яке значення |small= або |left= викликатиме маленький, по лівому краю, до тих пір, поки якесь значення |sect= або одне з його значень, також не буде визначено у шаблоні.) Цей код може бути вставлений копіюванням і використовуватись з вище наведеним блоком коду. Див., наприклад, Шаблон:Дрібниці та його Шаблон:Дрібниці/тести для спостереження поєднаного функціоналу.

issue та fix

|issue= використовується для опису проблеми статті. Намагайтеся робити його коротким і по ділу (не більше 10-20 слів) і впевніться у включенні посилання на відповідну політику або настанову.

|fix= містить деякий текст, що описує порядок дій для покращення статті. Він може мати довший текст, ніж issue, але, зазвичай, не повинен бути довшим за два речення.

Коли шаблон знаходиться у своїй компактній формі (коли розміщено всередині {{Проблеми}}) або маленькій формі (коли використовується |small=left), issue буде єдиним текстом, що відображається. Наприклад, {{Стиль цитування}} визначає

• |issue=Ця стаття '''має незрозумілий стиль цитування'''.
• |fix=Використані посилання можуть бути покращені за допомогою різних, або послідовних стилів [[Вікіпедія:Посилання на джерела|цитування]], [[Довідка:Виноски|виносок]], або [[Вікіпедія:Зовнішні посилання|зовнішніх посилань]].

Коли використовується самостійно він показує весь текст:

Але коли всередині {{Проблеми}} або з |small=left він показує тільки issue:

talk

Деякі шаблони повідомлень для статей включають посилання на сторінки обговорення, і дозволяють редактору визначати заголовок розділу для прямого посилання на потрібний. для забезпечення цього функціоналу, просто передайте параметр talk крізь, тобто, |talk={{{talk|}}}

Цей параметр в такому випадку може використовуватись редактором таким чином:

• |talk=SECTION HEADING - посилання буде вказувати на визначену ділянку сторінки обговорення статті, наприклад, |talk=Foo
• |talk=FULL PAGE NAME - шаблон буде посилатися на визначену сторінку (що може включати якорі розділів), наприклад, |talk=Talk:Banana#Foo

Зауваження:

• Коли цей параметр використовується шаблоном, посилання на сторінку обговорення з'являється на самому шаблоні (для того, щоб продемонструвати функціональність) але це буде показано у статті, лише, якщо параметр буде дійсно визначено.
• З метою впевнитися, що посилання на сторінку обговорення завжди присутнє, ви можете використовувати |talk={{{talk|#}}}.
• Якщо сторінка обговорення не існує, посилання також не буде, яке б значення параметра не було.

date

Пропускаючи параметр date через меташаблон означає, що дата, якою помічено статтю може бути визначена редактором (або частіше ботом). Це буде відображатися після повідомлення, меншим шрифтом.

Пропускання цього параметру також задіює категоризацію щомісячного впорядкування коли параметр cat також визначений.

cat

Цей параметр визначає щомісячні категорії очищення. Якщо |cat=CATEGORY, тоді:

• статтю буде розміщено у Категорія:CATEGORY з DATE якщо |date=DATE визначено.
• статтю буде розміщено у Категорія:CATEGORY якщо дату не було визначено.

На приклад, {{No footnotes}} визначає |cat=Статті без виносок, таким чином стаття із шаблоном {{No footnotes|date=June 2010}} буде розміщена у Категорія:Статті без виносок з червня 2010.

Параметр cat не повинен визначатися посиланням, як і не повинен містити префіксу Категорія:.

all

Параметр all визначає категорію, у яку будуть розміщені усі статті.

Параметр all не повинен містити у собі посилання, як і не повинен використовувати префікс Категорія:.

Інші параметри

Контейнер справа показує усі можливі параметри для цього шаблону. Тим не менш, не рекомендується копіювати їх усі у шаблон, адже вони ніколи усі разом не будуть використовуватись одночасно.

Усі параметри
{{Ambox | name = | subst = <includeonly>{{subst:substcheck}}</includeonly> | small = {{{small|}}} | type = | image = | imageright = | smallimage = | smallimageright = | class = | style = | textstyle = | sect = {{{1|}}} | issue = | talk = {{{talk|}}} | fix = | date = {{{date|}}} | text = | smalltext = | cat = | all = | cat2 = | all2 = | cat3 = | all3 = }}<noinclude> {{Документація}} </noinclude>

imageright

Зображення по правій стороні контейнера повідомлення можна задати використовуючи цей параметр. Синтаксис такий самий, як і для параметру image, за виключенням того, що тут стандартно немає зображення.

smallimage та smallimageright

Цими параметрами визначаються зображення для маленького формату контейнера. Вони не матимуть ефекту доки не буде визначено |small=left.

class

Спеціальний клас CSS, для застосування у контейнері.

style та textstyle

Необов'язкові значення CSS можуть бути визначені без використання лапок " ", але із закінченням крапко-коми ;.

• style визначає стиль, який використовує уся таблиця повідомлення.
• textstyle відноситься до текстових полів.

text та smalltext

Замість визначення issue та fix, натомість, є можливість використовувати параметр text.

Окремий текст для малого формату може бути визначений за допомогою smalltext.

Додаткові параметри категоризації

• cat2 та cat3 забезпечують додаткові щомісячні категорії; див. #cat.
• all2 та all3 забезпечують додаткові категорії у яких розміщуються усі статті, так само як #all.

Технічні зауваження

• Цей меташаблон використовує класи ambox CSS у MediaWiki:Common.css. Також ці класи можна використовувати безпосередньо у вікітаблицях, якщо необхідна спеціальна функціональність. Див. настанови використання задля подробиць.
• Якщо вам потрібно використовувати спеціальні символи в текстовому параметрі, то необхідно уникнути їх, як це показано нижче:

{{Ambox
| text  = <div>
Знак рівності = та дужки початку та кінця { } працюють і так.
Але тут є вертикальна риска &#124; та дві дужки закінчення <nowiki>}}</nowiki>.
А тепер риска та дужки закінчення <nowiki>|}}</nowiki>.
</div>
}}

• Теґи <div>, що оточують текст у прикладі вище, зазвичай не потрібні. Але якщо текст містить розриви рядків, то іноді ми отримуємо дивний міжрядковий інтервал. Це зазвичай трапляється при використанні вертикальних пунктирних переліків. Тоді для виправлення цього використовуйте їх.
• Цей шаблон використовує класи CSS у MediaWiki:Common.css для більшості його оформлення, таким чином, він повністю підтримує скіни.
• Цей шаблон викликає Модуль:Message box, який містить переважну частину коду для {{Ambox}}, поки сам {{Ambox}} виконує обробку параметрів.
• Внутрішньо, цей меташаблон замість вікірозмітки використовує розмітку HTML для табличного коду. Це звичайний метод виконання меташаблонів, оскільки вікірозмітка має декілька недоліків. Наприклад, це ускладнює використання парсерних функцій та деяких спеціальних символів у параметрах.
• Стандартні зображення цього меташаблону мають формат png замість svg. Основною причиною є те, що деякі старіші браузери мають проблеми із прозорим фоном, що утворює MediaWiki для svg зображень. Зображення png у цьому випадку мають гарну оптимізацію кольору прозорого фону, і таким чином вони добре виглядають у всіх браузерах. Зауважте, що svg іконки програють у рендері тільки у старих браузерах, таким чином, така ручна оптимізація потрібна тільки для іконок найширшого використання.
• задля технічних подробиць дивіться сторінку обговорення і посилання "Див. також" нижче. Оскільки цей шаблон працює майже так само як і {{Tmbox}}, {{Imbox}}, {{Cmbox}} та {{Ombox}} їх сторінки обговорення і пов'язані сторінки також можуть містити більше подробиць.

Категорія спостереження

• К:Шаблони-повідомлення для статей з відсутніми параметрами (25)

Див. також

До сімейства меташаблонів Модуль:Message box входить сім шаблонів:

• {{Ambox}}, для контейнерів повідомлень на сторінках статей.
• {{Cmbox}}, для контейнерів повідомлень на сторінках категорій.
• {{Imbox}}, для контейнерів повідомлень на сторінках файлів (зображень).
• {{Tmbox}}, для контейнерів повідомлень на сторінках обговорень.
• {{Fmbox}}, для контейнерів повідомлень у верхньому/нижньому колонтитулі сторінки.
• {{Ombox}}, для контейнерів повідомлень на сторінках інших типів.
• {{Mbox}}, для контейнерів повідомлень, що використовуються у різних просторах назв та змінюють свій вигляд відповідно.

Тісно пов'язані меташаблони:

• {{Asbox}}, для контейнерів повідомлень на сторінках стабів статей.
• {{Dmbox}}, для контейнерів повідомлень на сторінках неоднозначностей або визначеного індексу.
• {{Ivmbox}}, простий контейнер, повної ширини, із заданим фоном кольору слонової кістки, призначений для оформлення важливих повідомлень або нагадувань.

Інші сторінки:

• Вікіпедія:Класи Ambox CSS – Описує, як використовувати класи ambox CSS безпосередньо у вікітаблицях та таблицях HTML.
• Вікіпедія:Контейнери повідомлень статей – Настанови стилів для створення контейнерів повідомлень статей.