如何使用 Dokuwiki 创建通用用户手册

发布于 2024-10-16 14:40:08 字数 103 浏览 5 评论 0原文

我正在尝试使用 Dokuwiki 来创建软件用户手册,因为我必须在不同平台上为同一产品创建 3 个用户手册,并且更改非常少。 Dokuwiki 有没有办法创建一个可用于不同产品的通用用户手册?

I am trying to use Dokuwiki for creating a software user manual, given that I have to create 3 user manuals for the same product in different platform and the changes is very less. Is there any way in Dokuwiki to create a common user manual that can be used for different products?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

携余温的黄昏 2024-10-23 14:40:08

对于 DokuWiki 的具体细节,我推荐 站点导出 插件(主要是因为我制作了它并且我们也将它用于我们的文档)。

您可以像 wiki 中的普通页面一样创建书籍的章节。当要将它们组合到不同的书籍中时,请在不同的名称空间中创建一个名为“toc”的页面。其中有以下语法(有关详细信息,请参阅 github 页面):

  * [[namespace:chapter1]]
    * [[namespace:chapter1.1]]
    * [[namespace:chapter1.2]]
  * [[namespace:chapter2]]
    * [[namespace:chapter2.1]]
    * [[namespace:chapter2.2]]

现在,您可以在启用 roc 选项的情况下导出此命名空间 - 并合并到一个文档中。您现在还可以使用具有自定义书籍样式的 PDF 导出(这是我们主要做的)。

For the specifics of DokuWiki I'd recommend the site export plugin (primarily because I made it and we use it for our documentation as well).

You can create the chapters of your book just like a normal page in your wiki. When it comes to combining them into different books, create a page called "toc" in a different namespace. In there have the following syntax (see the github page for details):

  * [[namespace:chapter1]]
    * [[namespace:chapter1.1]]
    * [[namespace:chapter1.2]]
  * [[namespace:chapter2]]
    * [[namespace:chapter2.1]]
    * [[namespace:chapter2.2]]

Now you can export this namespace with the roc option enabled - and merged into one document. You could also use the PDF export with custom book-like styles now (this is what we do primarily).

南风起 2024-10-23 14:40:08

这个答案适用于任何 wiki 引擎,而不仅仅是 DokuWiki。

基本上,您需要做的是将文档的公共部分分解为单独的页面,这些页面可以包含在特定于产品的页面中。对于 DokuWiki,这需要包含插件 (www.dokuwiki.org/plugin:include),尽管嵌入通常是 wiki 的核心功能。我建议开始为最常见的产品编写文档,然后回去看看可以提取哪些部分用于通用文档。

This answer applies to any wiki engine, not just DokuWiki.

Basically, what you need to do is factor out the common part of the documentation into separate pages that can be included in the product-specific pages. For DokuWiki this requires the include plugin (www.dokuwiki.org/plugin:include), although transclusion is often core functionality for a wiki. I'd suggest starting to write documentation for the most common product and then go back to see what portions of that can be pulled out to use for the common documentation.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文