DevSite acceptă mai multe stiluri de notificare, prezentate ca casete cu culori diferite de fundal. Culorile de fundal sunt predefinite și puteți crea notificări folosind HTML sau Markdown.
Tipuri de notificări disponibile
Nota
HTML
<aside class="note">
<b>Note:</b> An ordinary note.
</aside>
Markdown
Note: An ordinary note.
Sfat
HTML
<aside class="tip">
<b>Tip:</b> An ordinary tip.
</aside>
Markdown
Tip: An ordinary tip.
Atenţie
HTML
<aside class="caution">
<b>Caution:</b> Suggests proceeding with caution.
</aside>
Markdown
Caution: Suggests proceeding with caution.
Avertizare
HTML
<aside class="warning">
<b>Warning:</b> Stronger than caution; it means "Don't do this."
</aside>
Markdown
Warning: Stronger than caution; it means "Don't do this."
Important
HTML
<aside class="special">
<b>Important:</b> Defines an important concept.
</aside>
Markdown
Important: Defines an important concept.
Punct cheie
HTML
<aside class="key-point">
<b>Key Point:</b> Defines an important takeaway.
</aside>
Markdown
Key Point: Defines an important takeaway.
Termen cheie
HTML
<aside class="key-term">
<b>Key Term:</b> Defines important terminology.
</aside>
Markdown
Key Term: Defines important terminology.
Obiectiv
HTML
<aside class="objective">
<b>Objective:</b> Defines the goal of a procedure.
</aside>
Markdown
Objective: Defines the goal of a procedure.
Succes
HTML
<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>
Markdown
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
HTML
<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>
Markdown
Beta: A notice that describes a beta-release feature, which is subject to
change or removal in new minor versions of the product.
Previzualizare
HTML
<aside class="preview">
<b>Preview:</b> A note or tip for a feature preview.
</aside>
Markdown
Preview: A note or tip for a feature preview.
Test de testare
HTML
<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>
Markdown
Dogfood: A notice that applies only temporarily, during internal dogfood
testing. Remove all Dogfood notices before making a document publicly
visible.
Depreciat
HTML
<aside class="deprecated">
<b>Deprecated:</b> A note or tip for a deprecated feature, product, or
service.
</aside>
Markdown
Deprecated: A note or tip for a deprecated feature, product, or service.
Note de utilizare
Utilizarea HTML
Vă recomandăm să utilizați aceste clase cu elementul HTML5 <aside> , dar puteți utiliza un alt element la nivel de bloc (cum ar fi <p> ).
Clasele HTML determină culoarea și pictograma unei notificări, dar nu stabilesc automat primul cuvânt îngroșat; trebuie să scrieți acel cuvânt manual, așa cum se arată în exemple. Teoretic ai putea folosi un alt cuvânt decât cel corespunzător clasei, dar îți recomandăm să rămâi cu primele cuvinte afișate mai sus.
În documentele mai vechi, este posibil să vedeți nume de clasă class="special" sau nonstandard în loc de class="note" . Aceste nume de clase produc notificări care sunt vizual identice cu o note , dar vă recomandăm să folosiți class="note" în loc de nume de clasă speciale sau nestandard.
Utilizarea reducerii
Stilurile Markdown determină culoarea și pictograma unei notificări și stabilesc automat primul cuvânt aldine al notificării. Deci, de exemplu, o notă din Markdown începe întotdeauna cu cuvântul Notă: îngroșat.
Pentru o notificare cu mai mult de un paragraf, utilizați în schimb HTML <aside> (și <p> ).
Este posibil să vedeți Important: în loc de Note: . Acest stil Markdown produce notificări care sunt vizual identice cu o Note: Notă:.
Cele mai bune practici
DevSite vă recomandă să respectați următoarele bune practici atunci când adăugați notificări la documentația dvs.:
Recomandat
- Fii succint (încercați să păstrați notificările la una sau două propoziții).
- Limitați notificările la una pe pagină, dacă este posibil (sau una pe secțiune, dacă este necesar).
- Asigurați-vă că notificările conțin numai conținut important pe care doriți să îl evidențiați; nu includeți conținut într-o notificare cu care pur și simplu nu sunteți sigur cu ce să faceți.
- Utilizați notificările înainte ca utilizatorul să aibă nevoie de informații, nu după.
Nerecomandat
- Nu includeți exemple de cod, tabele sau imagini în notificări.
- Evitați stivuirea notificărilor una peste alta, chiar dacă sunt de diferite tipuri.
- Încercați să nu introduceți notificări imediat după titluri.
- Nu utilizați notificări pentru a specifica cerințe preliminare înainte de o procedură.
În cea mai mare parte, aceste bune practici se aplică notificărilor de tip note , caution și warning , dar se pot aplica și altor tipuri.
Exemple bune
Păstrați-l simplu:
Utilizați cautions pentru pierderea potențială de date:
Utilizați warning pentru potențiale răniri:
Utilizați tipuri de notificări adecvate pentru conținut, cum ar fi key-term sau success :
Exemple proaste
Notificările nu trebuie să fie prea detaliate sau să transmită informații care aparțin conținutului de bază:
Notificările nu trebuie să specifice cerințele preliminare înainte de o procedură (utilizați în schimb o secțiune „Crințe preliminare”):