موسوعة حسوب:دليل المساهمين

توفِّر هذه الصفحة معلومات ومصادر عن تحرير وإنشاء صفحات في موسوعة حسوب.

هدف موسوعة حسوب

هدفنا الأساسي هو توفير توثيق لغات البرمجة باللغة العربية الفصيحة، بجودة عالية وبدقة كبيرة، بما في ذلك توثيق أساس اللغات ودوالها وخاصياتها كلها، مع توفير أمثلة عملية عليها يمكن للمطور الاستفادة منها.

كيف تبدأ بالمساهمة

تواصل معنا عبر البريد wiki@hsoub.com وسنتابع معك لإعطائك الصلاحيات التي تحتاج لها.

كيفية المساهمة في الموسوعة

الموسوعة هي مشروعٌ قائمٌ على مساهمة المجتمع فيها، ولا تكون المساهمة هي إنشاء الصفحات فقط، وإنما تتضمن تصحيح الأخطاء (في المعلومات، أو اللغوية)، وتحديث المحتوى، وإضافة أمثلة، وغير ذلك.

كيفية التعديل

تدعم صفحات الموسوعة نوعين من المحررات: المحرر المرئي والمحرر المصدري.

المحرر المرئي (VisualEditor) يوفِّر طريقةً سهلةً لتعديل الصفحات مرئيًا، أي أنَّه يشبه ما تستعمله في برامج التحرير المكتبي مثل Mircosoft Word أو Libreoffice Writer أو Google Docs.

المحرر المصدري يُظهِر الصفحة بصيغة wikitext التي تستعملها برمجية MediaWiki، وتمنح طريقة التعديل هذه مرونةً كبيرةً في التحرير وتعطي إمكانيات أكبر من المحرر المرئي، لكنها تعلمها أصعب من تعلم المحرر المرئي.

عند حفظ المستند، سيُطلَب منك إدخال ملخص للتعديلات التي أجريتها، هذه الملخص سيساعد الآخرين على فهم ما الذي عدّلتَه، حاول أن يكون هذه الملخص قصيرًا ويوضِّح ما الذي فعلتَه. إذا كان التعديلات التي أجريتها على الصفحة بسيطة، ففعِّل الحقل «هذا تعديل طفيف».

أنواع المساهمات

• إنشاء صفحات جديدة في توثيق إحدى اللغات.
• إنشاء أقسام جديدة في صفحات موجودة مسبقًا، تشرح أمورًا لم تتطرق لها الصفحة من قبل.
• إضافة أمثلة مرتبطة بالصفحة.
• توضيح بعض الأمور التي قد يلبس فهمها على القارئ.
• إعادة صياغة الفقرات والجملة الركيكة.
• توحيد المصطلحات بين صفحات الموسوعة.
• إصلاح الأخطاء اللغوية والمطبعية.
• إضافة رسومات توضيحية للمفاهيم المشروحة.

بنية التوثيق

نستعمل في الموسوعة الصفحات الفرعية لإنشاء هيكلية للتوثيق، وتكون هنالك صفحة رئيسية لكل لغة أو تقنية مثل PHP أو SQL، وتنحدر الصفحات الفرعية التابعة لها منها مثل CSS/background أو HTML/img. يُضاف رابط الصفحة بعد إنشائها إلى الفهرس في المكان.

بنية صفحات الموسوعة

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

من المهم استقاء المعلومات التي ستضعها في الصفحة من مصادر حرة تسمح لك بإعادة نشر المحتوى، لاحظ أنَّ محتوى الموسوعة منشور تحت رخصة المشاع الإبداعي نَسب المُصنَّف -غير تجاري- الترخيص بالمثل 4.0 (CC BY-NC-SA 4.0)، لذا احرص على توافقية المحتوى معها.

عند إنشائك لصفحة جديدة في توثيق لغةٍ ما، فاطلع على صفحات ذاك التوثيق لتأخذ فكرةً عن طريقة تنظيم صفحات التوثيق، وحاول قدر الإمكان أن تكون بنية الصفحة الجديدة شبيهة قدر الإمكان ببقية الصفحات.

احرص على تضمين تصنيفات مناسبة في كل صفحة، واجعل أوّل تصنيف هو اسم اللغة، فأوّل تصنيف في صفحات توثيق PHP هو PHP، وأوّل تصنيف في صفحات CSS هو CSS (فعل ذلك سيُسهِّل الوصول إلى جميع صفحات التوثيق).

اسم الصفحة

يكون اسم الصفحة عادةً باللغة الإنكليزية، واحرص على استخدام حالة الأحرف المناسبة، يجدر بالذكر أنَّ معظم صفحات الويكي تستخدم شيفرة خاصة لتعديل اسم الصفحة الظاهر إلى اسمٍ آخر، وبهذا نستطيع الحصول على روابط URL ذات بنية موحّدة للصفحات، إضافةً إلى توفير عنوان دقيق (وباللغة العربية إن لزم الأمر). الشيفرة التي يجب أن تضعها في أوّل صفحتك هي:

<noinclude>{{DISPLAYTITLE:عنوان الصفحة}}</noinclude>

تنسيق الصفحات

من المهم أن يكون تنسيق الصفحة سليمًا لتسهيل فهرسة الصفحة من محركات البحث وتوليد جدول محتويات وإلى ما هنالك.

احرص على وضع ترويسة H2 لعناوين الصفحة الرئيسية، وضع ضمنها ترويسات H3 وهكذا... لا تستعمل الترويسة H1 أبدًا؛ يجدر بالذكر أنَّ من غير المُفضَّل استخدام وسوم HTML (أي <h1>-<h6>) للإشارة إلى الترويسات، ذلك لأنَّها غير قابلة للتفسير من MediaWiki ولن يُنشَأ لها جدول محتويات...

من المهم عدم إغفال وضع الروابط الداخلية بين صفحات الموسوعة، فحاول أن تضع رابطًا داخليًا حيثما استطعت.

انظر إلى هذه الصفحة لمزيدٍ من المعلومات حول صيغة wikitext.