Njoftimet (thirrjet, shënimet, paralajmërimet, etj.)

DevSite mbështet disa stile njoftimesh, të paraqitura si kuti me ngjyra të ndryshme sfondi. Ngjyrat e sfondit janë të paracaktuara dhe ju mund të krijoni njoftime duke përdorur HTML ose Markdown.

Llojet e disponueshme të njoftimeve

Shënim

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

Note: An ordinary note.

Këshillë

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

Tip: An ordinary tip.

Kujdes

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

Caution: Suggests proceeding with caution.

Paralajmërim

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

E rëndësishme

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

Important: Defines an important concept.

Pika kryesore

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

Key Point: Defines an important takeaway.

Termi kyç

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

Key Term: Defines important terminology.

Objektiv

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

Objective: Defines the goal of a procedure.

Suksese

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

Parapamje

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

Preview: A note or tip for a feature preview.

Dogfood

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

I zhvlerësuar

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

Shënime përdorimi

Përdorimi i HTML

Ne rekomandojmë përdorimin e këtyre klasave me elementin <aside> HTML5, por në vend të kësaj mund të përdorni një element tjetër të nivelit të bllokut (si p.sh. <p> ).

Klasat HTML përcaktojnë ngjyrën dhe ikonën e një njoftimi, por ato nuk vendosin automatikisht fjalën e parë me shkronja të zeza; ju duhet ta shkruani atë fjalë me dorë, siç tregohet në shembujt. Teorikisht mund të përdorni një fjalë të ndryshme nga ajo që korrespondon me klasën, por ju rekomandojmë që t'i përmbaheni fjalëve të para të treguara më sipër.

Në dokumentet e vjetra, mund të shihni emra class="special" ose jostandarde të klasave në vend të class="note" . Ata emra klasash prodhojnë njoftime që janë vizualisht identike me një njoftim note , por ne rekomandojmë përdorimin e class="note" në vend të emrave të klasave të veçanta ose jo standarde.

Përdorimi i Markdown

Stilet Markdown përcaktojnë ngjyrën dhe ikonën e një njoftimi dhe vendosin automatikisht fjalën e parë me shkronja të zeza të njoftimit. Kështu, për shembull, një shënim në Markdown fillon gjithmonë me fjalën Shënim: me shkronja të zeza.

Për një njoftim me më shumë se një paragraf, përdorni HTML <aside> (dhe <p> ) në vend.

Mund të shihni E rëndësishme: në vend të Note: . Ky stil Markdown prodhon njoftime që janë vizualisht identike me një Note: njoftim.

Praktikat më të mira

DevSite rekomandon që t'i përmbaheni praktikave më të mira të mëposhtme kur shtoni njoftime në dokumentacionin tuaj:

Rekomanduar

• Jini të përmbledhur (përpiquni t'i mbani shënimet në një ose dy fjali).
• Kufizoni njoftimet në një për faqe nëse është e mundur (ose një për seksion nëse është e nevojshme).
• Sigurohuni që njoftimet përmbajnë vetëm përmbajtje të rëndësishme që dëshironi të nënvizoni; mos përfshini përmbajtje në një njoftim me të cilin thjesht nuk jeni të sigurt se çfarë të bëni.
• Përdorni njoftimet përpara se përdoruesi të ketë nevojë për informacionin, jo më pas.

Nuk rekomandohet

• Mos përfshini shembuj kodesh, tabela ose imazhe në njoftime.
• Shmangni vendosjen e njoftimeve njëra mbi tjetrën, edhe nëse ato janë të llojeve të ndryshme.
• Mundohuni të mos futni njoftime menjëherë pas titujve.
• Mos përdorni njoftime për të specifikuar parakushtet përpara një procedure.

Në pjesën më të madhe, këto praktika më të mira zbatohen për njoftimet e tipit note , caution dhe warning , por mund të zbatohen për lloje të tjera.

Shembuj të mirë

Mbajeni të thjeshtë:

Përdorni cautions për humbjen e mundshme të të dhënave:

Përdorni warning për lëndime të mundshme:

Përdorni llojet e duhura të njoftimeve për përmbajtjen, si key-term ose success :

Shembuj të këqij

Njoftimet nuk duhet të jenë tepër të thukëta ose të përcjellin informacione që i përkasin përmbajtjes kryesore:

Njoftimet nuk duhet të specifikojnë parakushtet përpara një procedure (përdorni një seksion "Parakushtet" në vend të kësaj):