إنشاء helpfile في أتش تي أم أل

Question

أنا مواجهة مهمة ممتعة لإنشاء ملف تعليمات لمشروع كبير. لقد تخلصت من ملفات CHM بسبب القيود وتبحث الآن في الملفات المستندة إلى HTML ولكني ما زلت غير محدد على التنسيق ....

هناك 3 مناطق أركز عليها:

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

SearchFunctionality أود أن أكون قادرا على البحث عن نص مجاني في الملف.

قابلية الطلاء. يمكن للمستخدم تحديد أقسام طباعة أو مستند Wholde.

كنت أعود أولا إلى نهج Wiki وجود إضافات لتصدير Wiki في صفحات ثابتة للتوزيع، لكنني لم أجد هذا الحل ...

أي اقتراحات منك يا رفاق في هذه المسألة؟ هل سأقضي helpfiles إلى معقدة؟

شكرا لك مقدما!

Answer 1

إعادة استخدام

أرى اقترابين. يمكنك إما إنشاء صفحات فردية للأقسام التي تريد إعادة استخدامها، ثم ربطها ببساطة أينما كان ذلك مناسبا. هذا هو تافهة في HTML.

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

بحث

إذا كان الموقع عام، فدع مؤشر Google IT، وتقديم مربع بحث Google. ليس من المرجح أن تحصل على نتائج أفضل من ذلك.

قابلية الطلاء

من السهل وضع "ورقة أنماط الطباعة" في CSS معا، ويمكنها القضاء على جميع العناصر الرسومية التي تجعل الموقع جذابا على الويب، والحفاظ على جميع المحتوى لاستخدامه على الورق.

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

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

Answer 2

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

أنا أستعمل dokuwiki. الذي يدعم تصدير الصفحة. يمكنك تفريغ Wiki بأكملها في نص عادي أو XHTML أو جسم XHTML (لوضع داخل القالب الخاص بك، أو إلحاق ملف واحد للطباعة، إلخ).

امل ان يساعد!