Notiser (texttexter, anteckningar, varningar, etc.),Meddelanden (texttexter, anteckningar, varningar, etc.)

DevSite stöder flera meddelandestilar, presenterade som rutor med olika bakgrundsfärger. Bakgrundsfärgerna är fördefinierade och du kan skapa meddelanden med antingen HTML eller Markdown.

Tillgängliga meddelandetyper

Notera

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

Note: An ordinary note.

Dricks

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

Tip: An ordinary tip.

Försiktighet

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

Caution: Suggests proceeding with caution.

Varning

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

Viktig

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

Important: Defines an important concept.

Nyckelpunkt

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

Key Point: Defines an important takeaway.

Nyckelterm

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

Key Term: Defines important terminology.

Mål

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

Objective: Defines the goal of a procedure.

Framgång

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

Förhandsvisning

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

Utfasad

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

Användningsanteckningar

HTML-användning

Vi rekommenderar att du använder dessa klasser med HTML5-elementet <aside> , men du kan använda ett annat element på blocknivå (som <p> ) istället.

HTML-klasserna bestämmer färgen och ikonen för ett meddelande, men de anger inte automatiskt det första ordet i fetstil; du måste skriva det ordet manuellt, som visas i exemplen. Du kan teoretiskt använda ett annat ord än det som motsvarar klassen, men vi rekommenderar att du håller dig till de första orden som visas ovan.

I äldre dokument kan du se class="special" eller icke-standardklassnamn istället för class="note" . Dessa klassnamn producerar notiser som är visuellt identiska med en note , men vi rekommenderar att du använder class="note" istället för speciella eller icke-standardiserade klassnamn.

Markdown användning

Markdown-stilarna bestämmer färgen och ikonen för ett meddelande, och de anger automatiskt det första ordet i fetstil i meddelandet. Så, till exempel, en anteckning i Markdown börjar alltid med ordet Note: i fetstil.

För ett meddelande med mer än ett stycke, använd HTML <aside> (och <p> ) istället.

Du kanske ser Viktigt: istället för Note: . Den Markdown-stilen producerar meddelanden som är visuellt identiska med en Note: -notis.

Bästa metoder

DevSite rekommenderar att du följer följande bästa praxis när du lägger till meddelanden i din dokumentation:

Rekommenderad

• Var kortfattad (försök att hålla meddelanden till en eller två meningar).
• Begränsa meddelanden till ett per sida om möjligt (eller ett per avsnitt om det behövs).
• Se till att meddelanden endast innehåller viktigt innehåll som du vill lyfta fram; inkludera inte innehåll i ett meddelande som du helt enkelt inte är säker på vad du ska göra med.
• Använd meddelanden innan användaren behöver informationen, inte efter.

Rekommenderas inte

• Inkludera inte kodexempel, tabeller eller bilder i meddelanden.
• Undvik att stapla anslag på varandra, även om de är av olika slag.
• Försök att inte infoga meddelanden direkt efter rubriker.
• Använd inte meddelanden för att specificera förutsättningar innan ett förfarande.

För det mesta gäller dessa bästa tillvägagångssätt för meddelanden av typ note , caution och warning , men kan gälla andra typer.

Bra exempel

Håll det enkelt:

Var cautions för potentiell förlust av data:

Använd warning för potentiell skada:

Använd lämpliga meddelandetyper för innehåll, till exempel key-term eller success :

Dåliga exempel

Meddelanden får inte vara alltför utförliga eller förmedla information som hör hemma i kärninnehållet:

Meddelanden bör inte ange förutsättningar före en procedur (använd ett avsnitt "Förutsättningar" istället):