Ειδοποιήσεις (επεξηγήσεις, σημειώσεις, προειδοποιήσεις κ.λπ.)

Το DevSite υποστηρίζει πολλά στυλ ειδοποιήσεων, που παρουσιάζονται ως πλαίσια με διαφορετικά χρώματα φόντου. Τα χρώματα φόντου είναι προκαθορισμένα και μπορείτε να δημιουργήσετε ειδοποιήσεις χρησιμοποιώντας είτε HTML είτε Markdown.

Διαθέσιμοι τύποι ειδοποιήσεων

Σημείωμα

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

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.

Καταργήθηκε

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

Σημειώσεις χρήσης

Χρήση HTML

Συνιστούμε τη χρήση αυτών των κλάσεων με το στοιχείο <aside> HTML5, αλλά μπορείτε να χρησιμοποιήσετε ένα άλλο στοιχείο σε επίπεδο μπλοκ (όπως <p> ).

Οι κλάσεις HTML καθορίζουν το χρώμα και το εικονίδιο μιας ειδοποίησης, αλλά δεν ορίζουν αυτόματα την πρώτη λέξη με έντονη γραφή. πρέπει να γράψετε αυτή τη λέξη χειροκίνητα, όπως φαίνεται στα παραδείγματα. Θα μπορούσατε θεωρητικά να χρησιμοποιήσετε μια λέξη διαφορετική από αυτή που αντιστοιχεί στην τάξη, αλλά σας συνιστούμε να μείνετε με τις πρώτες λέξεις που φαίνονται παραπάνω.

Σε παλαιότερα έγγραφα, ενδέχεται να δείτε class="special" ή μη τυπικά ονόματα κλάσεων αντί για class="note" . Αυτά τα ονόματα κλάσεων παράγουν ειδοποιήσεις που είναι οπτικά πανομοιότυπες με μια note , αλλά συνιστούμε τη χρήση class="note" αντί για ειδικά ή μη τυπικά ονόματα κλάσεων.

Χρήση Markdown

Τα στυλ Markdown καθορίζουν το χρώμα και το εικονίδιο μιας ειδοποίησης και ορίζουν αυτόματα την πρώτη λέξη με έντονη γραφή της ειδοποίησης. Έτσι, για παράδειγμα, μια σημείωση στο Markdown ξεκινά πάντα με τη λέξη Σημείωση: με έντονη γραφή.

Για μια ειδοποίηση με περισσότερες από μία παραγράφους, χρησιμοποιήστε HTML <aside> (και <p> ) αντί.

Μπορεί να δείτε Σημαντικό: αντί για Note: . Αυτό το στυλ Markdown παράγει ειδοποιήσεις που είναι οπτικά πανομοιότυπες με μια Note: ειδοποίηση.

Βέλτιστες πρακτικές

Το DevSite συνιστά να τηρείτε τις ακόλουθες βέλτιστες πρακτικές κατά την προσθήκη ειδοποιήσεων στην τεκμηρίωσή σας:

Συνιστάται

• Να είστε συνοπτικοί (προσπαθήστε να κρατήσετε τις ειδοποιήσεις σε μία ή δύο προτάσεις).
• Περιορίστε τις ειδοποιήσεις σε μία ανά σελίδα εάν είναι δυνατόν (ή μία ανά ενότητα εάν είναι απαραίτητο).
• Βεβαιωθείτε ότι οι ειδοποιήσεις περιέχουν μόνο σημαντικό περιεχόμενο που θέλετε να επισημάνετε. μην συμπεριλάβετε περιεχόμενο σε μια ειδοποίηση που απλά δεν είστε σίγουροι τι να κάνετε.
• Χρησιμοποιήστε τις ειδοποιήσεις πριν ο χρήστης χρειαστεί τις πληροφορίες, όχι μετά.

Δεν συνιστάται

• Μην συμπεριλαμβάνετε παραδείγματα κώδικα, πίνακες ή εικόνες στις ειδοποιήσεις.
• Αποφύγετε τη στοίβαξη ειδοποιήσεων το ένα πάνω στο άλλο, ακόμα κι αν είναι διαφορετικού τύπου.
• Προσπαθήστε να μην εισάγετε ειδοποιήσεις αμέσως μετά τις επικεφαλίδες.
• Μην χρησιμοποιείτε ειδοποιήσεις για να καθορίσετε προϋποθέσεις πριν από μια διαδικασία.

Ως επί το πλείστον, αυτές οι βέλτιστες πρακτικές ισχύουν για ειδοποιήσεις τύπου note , caution και warning , αλλά μπορούν να ισχύουν και για άλλους τύπους.

Καλά παραδείγματα

Κρατήστε το απλό:

Χρησιμοποιήστε cautions για πιθανή απώλεια δεδομένων:

Χρησιμοποιήστε warning για πιθανό τραυματισμό:

Χρησιμοποιήστε κατάλληλους τύπους ειδοποιήσεων για περιεχόμενο, όπως key-term ή success :

Κακά παραδείγματα

Οι ειδοποιήσεις δεν πρέπει να είναι υπερβολικά αναλυτικές ή να μεταφέρουν πληροφορίες που ανήκουν στο βασικό περιεχόμενο:

Οι ειδοποιήσεις δεν πρέπει να καθορίζουν προϋποθέσεις πριν από μια διαδικασία (αντ' αυτού χρησιμοποιήστε μια ενότητα "Προαπαιτούμενα"):