在HTML中创建帮助文件

Question

我面临为大型项目创建帮助文件的有趣任务。我已经丢弃CHM文件，由于限制和目前正在处理中基于HTML文件，但我仍然对格式未定....

有3个方面，我重点关注：

部分的可重用性（许多页面可以引用一个文本） 由于某些部分将在helpfile中多次使用，因此我需要创建主节，然后链接到每个子节中的主节。这样做可以避免在进行编辑时更改标题多个位置。

Searchfunctionality 我想能够搜索到该文件中自由文本。

印刷适性。 用户可以选择打印节或wholde文档。

我第一次靠在具有插件的wiki导出到分配静态页面维基的方法，但我还没有找到解决办法...

从你在这件事情你们有什么建议？我是否在帮助文件变得复杂？

在此先感谢！

Answer 1

重用

我看到两种方法。您可以为要重复使用的部分创建单独的页面，然后在适当的地方简单链接。这在HTML中是微不足道的。

您也可以创建HTML与信息该节段或片段，然后使用服务器端包含（或类似的技术），无论它的需要内嵌包括它。这样，内容将显示在每个单独的页面上，但是当您需要进行编辑时，它仍然只在一个地方。

搜索

如果网站是公开的，让谷歌索引它，只是提供了一个谷歌搜索框。你不可能获得比这更好的结果。

印刷适性

“打印样式表”，在CSS是很容易放在一起，并能消除所有的图形元素，使该网站在网页上有吸引力，维持对纸张使用的所有内容。

打印整个文档一次性将需要编程的一些小一点的所有内容一起组合成单页打印的目的。就个人而言，我宁愿提供这项服务，也不鼓励人们浪费纸张。

当然，我们可以提供洞察一切的方式将如何实现这些事情，但因为它听起来像你后，此刻的一般建议，那是我的。

Answer 2

我相信维基百科是完美的文档，特别是当不止一个人（或即将）参与该项目。 Wiki页面或命名空间之间的链接很容易实现。重命名页面将更改其他文档中的所有超链接。尽可能避免重复内容，但如果这是您的建议。我使用DokuWiki支持页面导出。您可以将整个维基转储为纯文本，XHTML或XHTML主体（用于放入自己的模板，或附加到单个文件进行打印等）。

希望有帮助！