Obavijesti (oblačići, bilješke, upozorenja itd.)

DevSite podržava nekoliko stilova obavijesti, predstavljenih kao okviri s različitim bojama pozadine. Boje pozadine unaprijed su definirane, a obavijesti možete stvarati pomoću HTML-a ili Markdowna.

Dostupne vrste obavijesti

Bilješka

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

Note: An ordinary note.

Savjet

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

Tip: An ordinary tip.

Oprez

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

Caution: Suggests proceeding with caution.

Upozorenje

<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."

Važno

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

Important: Defines an important concept.

Ključna točka

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

Key Point: Defines an important takeaway.

Ključni pojam

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

Key Term: Defines important terminology.

Cilj

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

Objective: Defines the goal of a procedure.

Uspjeh

<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.

Beta

<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.

Pregled

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

Preview: A note or tip for a feature preview.

Probna hrana

<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.

Zastarjelo

<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.

Bilješke o korištenju

korištenje HTML-a

Preporučujemo korištenje ovih klasa s HTML5 elementom <aside> , ali umjesto toga možete koristiti drugi element na razini bloka (kao što je <p> ).

HTML klase određuju boju i ikonu obavijesti, ali ne postavljaju automatski podebljanu prvu riječ; morate ručno napisati tu riječ, kao što je prikazano u primjerima. Teoretski biste mogli koristiti neku drugu riječ osim one koja odgovara razredu, ali preporučujemo da se držite prvih riječi prikazanih gore.

U starijim dokumentima možete vidjeti class="special" ili nestandardna imena klasa umjesto class="note" . Ti nazivi klasa stvaraju obavijesti koje su vizualno identične obavijesti note , ali preporučujemo korištenje class="note" umjesto posebnih ili nestandardnih naziva klasa.

Upotreba umanjenja

Markdown stilovi određuju boju i ikonu obavijesti i automatski postavljaju podebljanu prvu riječ obavijesti. Tako, na primjer, bilješka u Markdownu uvijek počinje podebljanom riječju Napomena:.

Za obavijest s više od jednog odlomka umjesto toga koristite HTML <aside> (i <p> ).

Možda ćete vidjeti Važno: umjesto Note: . Taj Markdown stil proizvodi obavijesti koje su vizualno identične Note: obavijesti.

Najbolje prakse

DevSite preporučuje da se pridržavate sljedećih najboljih praksi prilikom dodavanja obavijesti u svoju dokumentaciju:

Preporučeno

• Budite sažeti (nastojte zadržati napomene na jednu ili dvije rečenice).
• Ograničite obavijesti na jednu po stranici ako je moguće (ili jednu po odjeljku ako je potrebno).
• Osigurajte da obavijesti sadrže samo važan sadržaj koji želite istaknuti; nemojte u obavijest uključivati ​​sadržaj s kojim jednostavno niste sigurni što učiniti.
• Koristite obavijesti prije nego što korisniku budu potrebne informacije, a ne nakon.

Nije preporučljivo

• Nemojte uključivati ​​primjere koda, tablice ili slike u obavijesti.
• Izbjegavajte slaganje obavijesti jedne na drugu, čak i ako su različitih vrsta.
• Pokušajte ne umetati obavijesti neposredno nakon naslova.
• Nemojte koristiti obavijesti za navođenje preduvjeta prije postupka.

Uglavnom se ove najbolje prakse odnose na obavijesti tipa note , caution i warning , ali se mogu primijeniti i na druge vrste.

Dobri primjeri

Neka bude jednostavno:

Budite cautions zbog mogućeg gubitka podataka:

Koristite warning za moguće ozljede:

Koristite odgovarajuće vrste obavijesti za sadržaj, kao što je key-term ili success :

Loši primjeri

Obavijesti ne bi trebale biti preopširne ili prenositi informacije koje pripadaju osnovnom sadržaju:

Obavijesti ne bi trebale navoditi preduvjete prije postupka (umjesto toga koristite odjeljak "Preduvjeti"):