Обавештења (облачићи, белешке, упозорења, итд.)

ДевСите подржава неколико стилова обавештења, представљених као кутије са различитим бојама позадине. Боје позадине су унапред дефинисане и можете креирати обавештења користећи ХТМЛ или Маркдовн.

Доступни типови обавештења

Напомена

<aside class="note">
<b>Note:</b> An ordinary note.
</aside>

Note: An ordinary note.

Савет

<aside class="tip">
<b>Tip:</b> An ordinary tip.
</aside>

Tip: An ordinary tip.

Опрез

<aside class="caution">
<b>Caution:</b> Suggests proceeding with caution.
</aside>

Caution: Suggests proceeding with caution.

Упозорење

<aside class="warning">
<b>Warning:</b> Stronger than caution; it means "Don't do this."
</aside>

Warning: Stronger than caution; it means "Don't do this."

Важно

<aside class="special">
<b>Important:</b> Defines an important concept.
</aside>

Important: Defines an important concept.

Кључна тачка

<aside class="key-point">
<b>Key Point:</b> Defines an important takeaway.
</aside>

Key Point: Defines an important takeaway.

Кеи Терм

<aside class="key-term">
<b>Key Term:</b> Defines important terminology.
</aside>

Key Term: Defines important terminology.

Циљ

<aside class="objective">
<b>Objective:</b> Defines the goal of a procedure.
</aside>

Objective: Defines the goal of a procedure.

Успех

<aside class="success">
<b>Success:</b> Describes a successful action or an error-free status.
Used only in interactive or dynamic content; don't use in ordinary
static pages.
</aside>

Success: Describes a successful action or an error-free status. Used only
in interactive or dynamic content; don't use in ordinary static pages.

Бета

<aside class="beta">
<b>Beta:</b> A notice that describes a beta-release feature, which is
subject to change or removal in new minor versions of the product.
</aside>

Beta: A notice that describes a beta-release feature, which is subject to
change or removal in new minor versions of the product.

Преглед

<aside class="preview">
<b>Preview:</b> A note or tip for a feature preview.
</aside>

Preview: A note or tip for a feature preview.

интерна верзија

<aside class="dogfood">
<b>Dogfood:</b> A notice that applies only temporarily, during internal
dogfood testing. Remove all Dogfood notices before making a document
publicly visible.
</aside>

Dogfood: A notice that applies only temporarily, during internal dogfood
testing. Remove all Dogfood notices before making a document publicly
visible.

Застарело

<aside class="deprecated">
<b>Deprecated:</b> A note or tip for a deprecated feature, product, or
service.
</aside>

Deprecated: A note or tip for a deprecated feature, product, or service.

Напомене о употреби

Употреба ХТМЛ-а

Препоручујемо коришћење ових класа са ХТМЛ5 <aside> елементом, али уместо тога можете користити други елемент на нивоу блока (као што је <p> >).

ХТМЛ класе одређују боју и икону обавештења, али не постављају аутоматски подебљану прву реч; ту реч треба да напишете ручно, као што је приказано у примерима. Теоретски бисте могли да користите другу реч осим оне која одговара класи, али препоручујемо да се држите првих речи приказаних изнад.

У старијим документима можете видети class="special" или нестандардна имена класа уместо class="note" . Та имена класа производе обавештења која су визуелно идентична обавештењу note , али препоручујемо коришћење class="note" уместо специјалних или нестандардних назива класа.

Маркдовн употреба

Стилови Маркдовн одређују боју и икону обавештења и аутоматски постављају подебљану прву реч обавештења. Тако, на пример, белешка у Маркдовну увек почиње речју Напомена: подебљано.

За обавештење са више од једног пасуса, уместо тога користите ХТМЛ <aside> (и <p> ).

Можда ћете видети Важно: уместо Note: . Тај Маркдовн стил производи обавештења која су визуелно идентична обавештењу Note: :.

Најбоље праксе

ДевСите препоручује да се придржавате следећих најбољих пракси када додајете обавештења у своју документацију:

Препоручено

• Будите сажети (покушајте да обавештења буду у једној или две реченице).
• Ограничите обавештења на једно по страници ако је могуће (или једно по одељку ако је потребно).
• Уверите се да обавештења садрже само важан садржај који желите да истакнете; немојте укључивати садржај у обавештење са којим једноставно нисте сигурни шта да радите.
• Користите обавештења пре него што кориснику затребају информације, а не после.

Не препоручује се

• Немојте укључивати примере кода, табеле или слике у обавештења.
• Избегавајте слагање обавештења једно на друго, чак и ако су различите врсте.
• Покушајте да не убацујете обавештења одмах после наслова.
• Немојте користити обавештења да бисте навели предуслове пре процедуре.

Углавном, ове најбоље праксе се примењују на обавештења типа note , caution и warning , али се могу применити и на друге врсте.

Добри примери

Нека буде једноставно:

Будите cautions у случају потенцијалног губитка података:

Користите warning за потенцијалне повреде:

Користите одговарајуће типове обавештења за садржај, као што су key-term или success :

Лоши примери

Обавештења не би требало да буду превише опсежна или да преносе информације које припадају основном садржају:

Обавештења не треба да наводе предуслове пре процедуре (уместо тога користите одељак „Предуслови“):