نوٹس (کال آؤٹ، نوٹس، وارننگز، وغیرہ)

DevSite متعدد نوٹس شیلیوں کو سپورٹ کرتی ہے، جنہیں مختلف پس منظر کے رنگوں کے ساتھ بکس کے طور پر پیش کیا گیا ہے۔ پس منظر کے رنگ پہلے سے طے شدہ ہیں، اور آپ HTML یا مارک ڈاؤن کا استعمال کرتے ہوئے نوٹس بنا سکتے ہیں۔

دستیاب نوٹس کی اقسام

نوٹ

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

استعمال کے نوٹ

ایچ ٹی ایم ایل کا استعمال

ہم ان کلاسوں کو HTML5 <aside> عنصر کے ساتھ استعمال کرنے کی تجویز کرتے ہیں، لیکن آپ اس کے بجائے ایک اور بلاک لیول عنصر (جیسے <p> ) استعمال کر سکتے ہیں۔

ایچ ٹی ایم ایل کلاس نوٹس کے رنگ اور آئیکن کا تعین کرتی ہیں، لیکن وہ خود بخود بولڈ پہلا لفظ سیٹ نہیں کرتے ہیں۔ آپ کو اس لفظ کو دستی طور پر لکھنا ہوگا، جیسا کہ مثالوں میں دکھایا گیا ہے۔ آپ نظریاتی طور پر کلاس سے متعلقہ لفظ کے علاوہ کوئی دوسرا لفظ استعمال کر سکتے ہیں، لیکن ہم تجویز کرتے ہیں کہ آپ اوپر دکھائے گئے پہلے الفاظ پر قائم رہیں۔

پرانی دستاویزات میں، آپ class="note" کے بجائے class="special" یا غیر معیاری کلاس کے نام دیکھ سکتے ہیں۔ وہ کلاس کے نام ایسے نوٹس تیار کرتے ہیں جو بصری طور پر ایک note نوٹس سے ملتے جلتے ہیں، لیکن ہم خصوصی یا غیر معیاری کلاس کے ناموں کی بجائے class="note" استعمال کرنے کی تجویز کرتے ہیں۔

مارک ڈاؤن استعمال

مارک ڈاؤن اسٹائل نوٹس کے رنگ اور آئیکن کا تعین کرتے ہیں، اور وہ خود بخود نوٹس کا بولڈ پہلا لفظ سیٹ کرتے ہیں۔ لہذا، مثال کے طور پر، مارک ڈاؤن میں ایک نوٹ ہمیشہ لفظ Note: سے بولڈ میں شروع ہوتا ہے۔

ایک سے زیادہ پیراگراف والے نوٹس کے لیے، اس کے بجائے HTML <aside> (اور <p> ) استعمال کریں۔

آپ Note: کے بجائے Important: دیکھ سکتے ہیں۔ وہ مارک ڈاؤن اسٹائل نوٹس تیار کرتا ہے جو کہ ایک Note: نوٹس سے بصری طور پر ایک جیسے ہوتے ہیں۔

بہترین طریقے

DevSite تجویز کرتی ہے کہ آپ اپنی دستاویزات میں نوٹس شامل کرتے وقت درج ذیل بہترین طریقوں پر عمل کریں:

تجویز کردہ

• مختصر رہیں (ایک یا دو جملوں پر نوٹس رکھنے کی کوشش کریں)۔
• اگر ممکن ہو تو نوٹس کو فی صفحہ ایک تک محدود کریں (یا اگر ضروری ہو تو فی سیکشن ایک)۔
• اس بات کو یقینی بنائیں کہ نوٹس میں صرف اہم مواد موجود ہے جسے آپ اجاگر کرنا چاہتے ہیں۔ نوٹس میں ایسا مواد شامل نہ کریں جس کے بارے میں آپ کو یقین نہیں ہے کہ اس کے ساتھ کیا کرنا ہے۔
• صارف کو معلومات کی ضرورت سے پہلے نوٹس استعمال کریں، بعد میں نہیں۔

تجویز کردہ نہیں

• نوٹس میں کوڈ کی مثالیں، ٹیبلز یا تصاویر شامل نہ کریں۔
• ایک دوسرے کے اوپر نوٹس اسٹیک کرنے سے گریز کریں، چاہے وہ مختلف قسم کے ہوں۔
• کوشش کریں کہ سرخیوں کے فوراً بعد نوٹس داخل نہ کریں۔
• کسی طریقہ کار سے پہلے ضروری شرائط بتانے کے لیے نوٹس کا استعمال نہ کریں۔

زیادہ تر حصے کے لیے، یہ بہترین طرز عمل note ، caution ، اور warning کے نوٹسز پر لاگو ہوتے ہیں، لیکن دوسری اقسام پر لاگو ہو سکتے ہیں۔

اچھی مثالیں۔

اسے سادہ رکھیں:

ڈیٹا کے ممکنہ نقصان کے لیے cautions برتیں:

ممکنہ چوٹ کے لیے warning استعمال کریں:

مواد کے لیے نوٹس کی مناسب اقسام استعمال کریں، جیسے key-term یا success :

بری مثالیں۔

نوٹسز کو ضرورت سے زیادہ لفظی نہیں ہونا چاہیے اور نہ ہی ایسی معلومات فراہم کی جانی چاہیے جو بنیادی مواد سے تعلق رکھتی ہیں:

نوٹسز کو کسی طریقہ کار سے پہلے شرائط کی وضاحت نہیں کرنی چاہیے (اس کے بجائے "ضرورتیں" سیکشن استعمال کریں):