在HTML中创建帮助文件

时间:2009-08-14 13:09:57

标签: html helpfile

我正面临为大型项目创建帮助文件的有趣任务。由于受到限制,我已经丢弃了CHM文件,现在正在查看基于HTML的文件,但我仍未确定格式....

我关注的有三个方面:

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

Searchfunctionality 我希望能够在文件中搜索自由文本。

印刷适性。 用户可以选择打印部分或者压缩文档。

我第一次倾向于使用插件将wiki导出到静态页面以进行分发,但我还没有找到解决方案......

你们在这件事上有什么建议吗?我的帮助文件是否复杂?

提前致谢!

2 个答案:

答案 0 :(得分:1)

<强>可重用性

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

您也可以使用该部分的信息创建HTML代码段或片段,然后使用服务器端包含(或类似技术)将其包含在需要的任何位置。这样,内容似乎已经写在每个页面上,但是当您需要进行编辑时,它仍然只在一个地方。

搜索

如果网站是公开的,请让Google为其编制索引,然后只提供Google搜索框。你不可能获得比这更好的结果。

<强>印刷适性

CSS中的“打印样式表”很容易组合在一起,可以消除使网站在网络上具有吸引力的所有图形元素,保留所有在纸上使用的内容。

立即打印整个文档需要一些小的编程才能将所有内容组合到一个页面中以进行打印。就个人而言,我更愿意提供这项服务,以阻止人们浪费纸张。

当然,我们可以提供各种有关如何实现这些事情的见解,但是因为听起来你现在已经接受了一般性的建议,那就是我的。

答案 1 :(得分:0)

我认为wiki是完美的文档,特别是当多个人(或将会)参与该项目时。可以轻松实现Wiki页面或命名空间之间的链接。重命名页面将更改其他文档中的所有超链接。如果那是你的建议,我会尽可能避免重复内容。

我使用支持页面导出的DokuWiki。您可以将整个wiki转储为纯文本,XHTML或XHTML正文(用于放入自己的模板,或附加到单个文件进行打印等)。

希望有所帮助!