在HTML中創建幫助文件

Question

我面臨爲大型項目創建幫助文件的有趣任務。我已經丟棄CHM文件，由於限制和目前正在處理中基於HTML文件，但我仍然對格式未定....

有3個方面，我重點關注：

部分的可重用性（許多頁面可以引用一個文本） 由於某些部分將在helpfile中多次使用，因此我需要創建主節，然後鏈接到每個子節中的主節。這樣做可以避免在進行編輯時更改標題多個位置。

Searchfunctionality 我想能夠搜索到該文件中自由文本。

印刷適性。 用戶可以選擇打印節或wholde文檔。

我第一次靠在具有插件的wiki導出到分配靜態頁面維基的方法，但我還沒有找到解決辦法...

從你在這件事情你們有什麼建議？我是否在幫助文件變得複雜？

在此先感謝！

Answer 1

重用

我看到兩種方法。您可以爲要重複使用的部分創建單獨的頁面，然後在適當的地方簡單鏈接。這在HTML中是微不足道的。

您也可以創建HTML與信息該節段或片段，然後使用服務器端包含（或類似的技術），無論它的需要內嵌包括它。這樣，內容將顯示在每個單獨的頁面上，但是當您需要進行編輯時，它仍然只在一個地方。

搜索

如果網站是公開的，讓谷歌索引它，只是提供了一個谷歌搜索框。你不可能獲得比這更好的結果。

印刷適性

「打印樣式表」，在CSS是很容易放在一起，並能消除所有的圖形元素，使該網站在網頁上有吸引力，維持對紙張使用的所有內容。

打印整個文檔一次性將需要編程的一些小一點的所有內容一起組合成單頁打印的目的。就個人而言，我寧願提供這項服務，也不鼓勵人們浪費紙張。

當然，我們可以提供洞察一切的方式將如何實現這些事情，但因爲它聽起來像你後，此刻的一般建議，那是我的。

Answer 2

我相信維基百科是完美的文檔，特別是當不止一個人（或即將）參與該項目。 Wiki頁面或命名空間之間的鏈接很容易實現。重命名頁面將更改其他文檔中的所有超鏈接。儘可能避免重複內容，但如果這是您的建議。我使用DokuWiki支持頁面導出。您可以將整個維基轉儲爲純文本，XHTML或XHTML主體（用於放入自己的模板，或附加到單個文件進行打印等）。

希望有幫助！