دليل بيانات الترويسة الأمامية

جميع حقول بيانات الترويسة الأمامية الممكنة:

banner

• غير مطلوب
• من نوع منطقي (boolean)
• يضيف صورة banner.svg الموجودة في جذر المشروع إلى أعلى الصفحة.
• انتبه! لا تُضاف صورة الغلاف إلا إذا كانت information_page تساوي true

hidden

• غير مطلوب
• من نوع منطقي (boolean)
• لا تظهر الصفحة في الشريط الجانبي (انتبه! يُفضَّل استخدام الحقل hide_in_sidebar إذا أردت إخفاء الصفحة من الشريط الجانبي فقط)
• يُطلق خطأ 404 إذا حاول أحد الذهاب إلى عنوان url الخاص بالصفحة

hide_in_sidebar

• غير مطلوب
• من نوع منطقي (boolean)
• يخفي الصفحة من الشريط الجانبي لو كانت ستظهر فيه بغير ذلك. ويظهر في الشريط الجانبي افتراضيًا جميع الملفات المسمّاة index.md، وكذلك جميع ملفات markdown الموجودة في جذر مجلد data.

information_page

• غير مطلوب
• من نوع منطقي (boolean)
• من أجل الشريط الجانبي. والملفات التي تكون فيها information_page تساوي true تظهر أولًا في الشريط الجانبي

overview

• غير مطلوب
• من نوع منطقي (boolean)
• مُخصّص لصفحات فهرس أجزاء الدورة (مثل osa-01/index.md). يُخفي قائمة الصفحات الفرعية للجزء الموجودة أسفل الصفحات. انتبه! هذه الصفحات مخفية أيضًا في صفحات information_page، أي لا حاجة إلى ضبط هذا الحقل على false بشكل منفصل في صفحات information_page

path

• مطلوب
• من نوع سلسلة نصية (string)
• المسار إلى الملف في عنوان url، بصيغة baseurl/path

separator_after

• غير مطلوب
• من نوع سلسلة نصية (string)
• يضيف فاصلًا إلى الشريط الجانبي بعد رابط الصفحة.
• إذا ضُبط على نص فارغ (separator_after: "")، فيكون فاصلًا مجردًا بلا عنوان. وإذا لم يكن فارغًا، فيظهر النص المضبوط عنوانًا فوق الفاصل.

sidebar_priority

• غير مطلوب
• من نوع عدد صحيح (integer)
• مُخصّص لصفحات information_page فقط
• يتيح هذا الحقل إعادة ترتيب روابط صفحات information_page في الشريط الجانبي. ويظهر في الشريط الجانبي افتراضيًا صفحات information_page أولًا، ثم بقية الصفحات. وتُرتَّب صفحات information_page وسائر الصفحات ترتيبًا أبجديًا.
• تسبق الصفحات التي تحمل الحقل sidebar_priority بقية الصفحات، وتُرتَّب تنازليًا من الأكبر إلى الأصغر (sidebar_priority: 5000 تسبق sidebar_priority: 2000)

title

• مطلوب
• من نوع سلسلة نصية (string)
• عنوان الصفحة في أعلى المتصفّح، وفي تبويب المتصفّح، وكذلك في أعلى الملف نفسه

upcoming

• غير مطلوب
• من نوع سلسلة نصية (string)
• إذا كان مضبوطًا، فإن رابط الصفحة في الشريط الجانبي يظهر رماديًا وغير قابل للنقر، ويظهر بجانبه النص المضبوط.
• نوصي بأن يُضبط النص على تاريخ نشر الصفحة بالصيغة "يوم.شهر"، لأن الحقل صغير بما يكفي بحيث لا يتّسع له رقم السنة بالكامل.

vocabulary_page

• غير مطلوب
• من نوع منطقي (boolean)
• مُخصّص حصريًا لصفحة المفردات. وإذا ضُبط هذا الحقل، تتوفّر في الصفحة إمكانية الوصول إلى بيانات مفردات المعجم.