DevSite, farklı arka plan renklerine sahip kutular olarak sunulan çeşitli bildirim stillerini destekler. Arka plan renkleri önceden tanımlanmıştır. HTML veya Markdown kullanarak bildirim oluşturabilirsiniz.
Kullanılabilir bildirim türleri
Not
HTML
<aside class="note">
<b>Note:</b> An ordinary note.
</aside>
Markdown
Note: An ordinary note.
İpucu
HTML
<aside class="tip">
<b>Tip:</b> An ordinary tip.
</aside>
Markdown
Tip: An ordinary tip.
Dikkat
HTML
<aside class="caution">
<b>Caution:</b> Suggests proceeding with caution.
</aside>
Markdown
Caution: Suggests proceeding with caution.
Uyarı
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."
Önemli
HTML
<aside class="special">
<b>Important:</b> Defines an important concept.
</aside>
Markdown
Important: Defines an important concept.
Önemli nokta
HTML
<aside class="key-point">
<b>Key Point:</b> Defines an important takeaway.
</aside>
Markdown
Key Point: Defines an important takeaway.
Anahtar Terim
HTML
<aside class="key-term">
<b>Key Term:</b> Defines important terminology.
</aside>
Markdown
Key Term: Defines important terminology.
Hedef
HTML
<aside class="objective">
<b>Objective:</b> Defines the goal of a procedure.
</aside>
Markdown
Objective: Defines the goal of a procedure.
Başarılı
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.
Önizleme
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 sürümü
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.
Kullanımdan kaldırıldı
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.
Kullanım notları
HTML kullanımı
Bu sınıfları HTML5 <aside> öğesiyle kullanmanızı öneririz ancak bunun yerine başka bir blok düzeyinde öğe (<p> gibi) de kullanabilirsiniz.
HTML sınıfları bir bildirimin rengini ve simgesini belirler ancak kalın yazılan ilk kelimeyi otomatik olarak ayarlamaz. Bu kelimeyi örneklerde gösterildiği gibi manuel olarak yazmanız gerekir. Teorik olarak sınıfa karşılık gelenden farklı bir kelime kullanabilirsiniz ancak yukarıda gösterilen ilk kelimeleri kullanmanızı öneririz.
Eski dokümanlarda class="note" yerine class="special" veya standart olmayan sınıf adları görebilirsiniz. Bu sınıf adları, görsel olarak note bildirimiyle aynı bildirimler oluşturur ancak özel veya standart olmayan sınıf adları yerine class="note" kullanmanızı öneririz.
Markdown kullanımı
Markdown stilleri, bir bildirimin rengini ve simgesini belirler ve bildirimin ilk kelimesini otomatik olarak kalın olarak ayarlar. Örneğin, Markdown'da bir not her zaman kalın harflerle Not: kelimesiyle başlar.
Birden fazla paragraf içeren bir bildirim için bunun yerine HTML <aside> (ve <p>) kullanın.
Note: yerine Önemli: ifadesini görebilirsiniz. Bu Markdown stili, Note: bildirimiyle görsel olarak aynı olan bildirimler oluşturur.
En iyi uygulamalar
DevSite, dokümanlarınıza bildirim eklerken aşağıdaki en iyi uygulamalara uymanızı önerir:
Önerilen
- Özlü olun (bildirimlerinizi bir veya iki cümleyle sınırlamaya çalışın).
- Mümkünse bildirimleri sayfa başına bir taneyle (veya gerekirse bölüm başına bir taneyle) sınırlayın.
- Bildirimlerde yalnızca vurgulamak istediğiniz önemli içeriklerin yer aldığından emin olun. Ne yapmanız gerektiğinden emin olmadığınız içerikleri bildirimlere eklemeyin.
- Bildirimleri, kullanıcının bilgiye ihtiyaç duymasından önce kullanın.
Önerilmez
- Bildirimlere kod örnekleri, tablolar veya resimler eklemeyin.
- Farklı türde olsalar bile bildirimleri birbirinin üzerine yığmayın.
- Bildirimleri başlıklardan hemen sonra eklememeye çalışın.
- Bir işlemden önce ön koşulları belirtmek için bildirimler kullanmayın.
Bu en iyi uygulamalar çoğunlukla note, caution ve warning türündeki bildirimler için geçerlidir ancak diğer türler için de geçerli olabilir.
Doğru kullanım örnekleri
Basit tutun:
Potansiyel veri kaybı için cautions simgesini kullanın:
Olası yaralanmalar için warning simgesini kullanın:
İçerik için key-term veya success gibi uygun bildirim türlerini kullanın:
Yanlış kullanım örnekleri
Bildirimler çok ayrıntılı olmamalı veya temel içeriğe ait bilgileri aktarmamalıdır:
Bildirimlerde, işlemden önce ön koşullar belirtilmemelidir (bunun yerine "Ön koşullar" bölümü kullanın):