创建 HTML 帮助文件
我面临着为大型项目创建帮助文件的有趣任务。 由于限制，我已经放弃了 CHM 文件，现在正在研究基于 HTML 的文件，但我仍未决定格式......
我关注的领域有 3 个：
部分的可重用性（许多页面可以引用一个文本） ） 由于某些部分将在帮助文件中多次使用，因此我需要创建一个主部分，然后链接到每个小节中的主部分。 这样我就可以避免在编辑时必须在多个位置更改标题。
搜索功能 我希望能够搜索文件中的自由文本。
适印性。 用户可以选择打印部分或整个文档。
我首先倾向于使用 wiki 方法，通过插件将 wiki 导出到静态页面进行分发，但我还没有找到解决方案...
你们对这件事有什么建议吗？ 我使帮助文件变得复杂吗？
提前致谢！
I am facing the fun task of creating a Help File for a large project. I have discarded CHM files due to the constraints and are now looking into HTML based files but I am still undecided on the format....
There are 3 areas I'm focusing on:
Reusability of sections (many pages can refer to one text)
Since some sections will be used more than once in the helpfile, i need to create a master section and then link to the master sections in each subsection. This so I avoid having to change the caption multiple places when doing edits.
Searchfunctionality
I would like to be able to search free text in the file.
Printability.
The user can select to print sections or wholde document.
I was first leaning to the wiki approach having plugins to export the wiki into static pages for distribution, but I have not found that solution...
Any suggestions from you guys in this matter? Am i making helpfiles to complicated?
Thanks in advance!
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（2）
可重用性
我看到两种方法。 您可以为要重用的部分创建单独的页面，然后在适当的地方简单地链接到它们。 这在 HTML 中是微不足道的。
您也可以使用该部分的信息创建 HTML 片段或片段，然后使用服务器端包含（或类似技术）将其内联包含在需要的地方。 这样，内容似乎已写在每个单独的页面上，但当您需要进行编辑时，它仍然只在一个位置。
搜索
如果网站是公开的，则让 Google 将其编入索引，并仅提供 Google 搜索框。 您不可能获得比这更好的结果。
可打印性
CSS 中的“打印样式表”很容易组合在一起，并且可以消除使网站在网络上有吸引力的所有图形元素，保留所有在纸上使用的内容。
一次打印整个文档需要一些少量的编程才能将所有内容组合到一个页面中以进行打印。 就我个人而言，我什至更愿意提供这项服务，以阻止人们浪费纸张。
当然，我们可以提供有关如何实现这些目标的各种见解，但由于听起来您目前正在寻求一般建议，所以这是我的建议。
Reusability
I see two approaches. You can either create individual pages for the sections that you want to reuse, and then simply link to them wherever appropriate. This is trivial in HTML.
You can alternatively create a snippet or fragment of HTML with the information for that section, and then use Server-Side Includes (or a similar technology) to include it inline wherever it's needed. This way the content will appear to have been written on every individual page, but when you need to make an edit it's still only in one place.
Search
If the site is public, let Google index it, and just offer a Google search box. You're not likely to get better results than that.
Printability
A "print stylesheet" in CSS is easy to put together, and can eliminate all the graphical elements that make the site attractive on the web, preserving all the content for use on paper.
Printing the whole document at once would require some small bit of programming to combine all the contents together into a single page for the purpose of printing. Personally, I'd prefer to even offer that service, to discourage people from wasting the paper.
Of course, we can offer all manner of insight into how to achieve any of these things, but since it sounds like you're after general advice at the moment, that's mine.
我相信 wiki 非常适合记录文档，尤其是当不止一个人（或将要）参与该项目时。 维基页面或命名空间之间的链接很容易实现。 重命名页面将更改其他文档中的所有超链接。 如果这是您的建议，我会尽可能避免内容重复。
我使用支持页面导出的 DokuWiki 。 您可以将整个 wiki 转储为纯文本、XHTML 或 XHTML 正文（用于放入您自己的模板中，或附加到单个文件进行打印等）。
希望有帮助！
I believe wikis are perfect for documentation, especially when more than one person is (or will be) involved in the project. Linking between wiki pages or namespaces is easily achieved. Renaming a page will change all hyperlinks in other documents. I would avoid duplication of content wherever possible though, if that's what you were suggesting.
I use DokuWiki which supports page exporting. You can dump your entire wiki into plain text, XHTML or XHTML body (for putting inside your own template, or to append to a single file for printing, etc).
Hope that helps!