تتم حاليًا مراجعة واجهات ومستندات Discourse وتحريرها لتتوافق مع هذه الإرشادات. نحن نعمل على تحقيق التوافق الكامل في أسرع وقت ممكن.
عند الكتابة لـ Discourse، لاحظ الإرشادات التالية لتنسيق النص. تنطبق هذه الإرشادات على النص في جميع المناطق، لا سيما المستندات وواجهة Discourse.
الأحرف الكبيرة
عند كتابة المستندات أو نصوص الواجهة، استخدم حالة الجملة افتراضيًا (أي يتم تحويل الحرف الأول من العبارة إلى حرف كبير ولا شيء آخر).
تذكيرات هامة:
- تستخدم العناوين والعناوين وأسماء الفئات حالة الجملة.
- أسماء ميزات Discourse لا يتم تحويلها إلى أحرف كبيرة، باستثناء ما يلي فقط:
- مستكشف البيانات
لا تستخدم أي تنسيق آخر لأسماء الميزات، بما في ذلك عدم استخدام الخط العريض أو المائل أو علامات الاقتباس أو أي شيء آخر.
تشمل استثناءات الأحرف الكبيرة:
- يجب دائمًا تحويل الاختصارات إلى أحرف كبيرة بشكل مناسب.
- يجب تحويل أسماء المنتجات والعلامات التجارية وفقًا لإرشادات علامتها التجارية.
- يجب تحويل أسماء الإضافات والسمات إلى أحرف كبيرة بشكل مناسب.
- عند الإشارة إلى عناصر القائمة أو تسميات الأزرار أو خيارات النموذج، قم بتحويل الحرف الأول من الكلمة الأولى إلى حرف كبير - على سبيل المثال، “انقر فوق الزر موضوع جديد لبدء الكتابة.”
- إذا تم تحويل شيء ما إلى حرف كبير في الواجهة لسبب وجيه، فاستخدم نفس التحويل عند كتابة المستندات عنه.
- عناوين URL والشرائح دائمًا بأحرف صغيرة.
عند الشك، استخدم حالة الجملة.
النقاط
لا تستخدم نقطة لما يلي:
- التلميحات أو تسميات الصور أو عناصر الواجهة الأخرى التي تحتوي على جملة واحدة فقط
- تسميات الأزرار
- عناصر القائمة
- عناصر القائمة التي لا تتضمن فعلًا
استخدم نقطة لما يلي:
- الجمل العادية
- التلميحات أو تسميات الصور أو عناصر الواجهة الأخرى التي تحتوي على أكثر من جملة واحدة
- عناصر القائمة التي تتضمن فعلًا
- نص
altللصورة
تنبيه لعناصر القائمة: إذا كنت تكتب قائمة بعناصر مختلطة (أي أن بعضها يتطلب نقطة وبعضها لا)، فاستخدم النقاط لجميعها.
التأكيد
للتأكيد على الكلمات، استخدم المائل افتراضيًا. يمكنك أيضًا استخدام الخط العريض إذا شعرت أنه يناسب السياق.
علامات الاقتباس
استخدم علامات الاقتباس (``) للكود المضمن وعناوين URL النموذجية وأسماء الإعدادات. لا تستخدمها لأي غرض آخر.
كتل الكود
عند تضمين كتل من الكود، حدد لغة البرمجة كلما أمكن ذلك بإضافتها مباشرة بعد السياج الافتتاحي (الثلاث علامات اقتباس الأولى) - على سبيل المثال، ```css.
