如何使用Dokuwiki创建一个通用的用户手册

Question

我正在尝试使用Dokuwiki创建软件用户手册，因为我必须在不同的平台上为同一产品创建3个用户手册，而且变化非常少。在Dokuwiki中有什么方法可以创建可用于不同产品的通用用户手册吗？

Answer 1

对于DokuWiki的细节，我建议使用site export插件（主要是因为我制作了它，我们也将它用于我们的文档）。

您可以像维基中的普通页面一样创建图书的章节。在将它们组合到不同的书中时，在不同的命名空间中创建一个名为“toc”的页面。在那里有以下语法（有关详细信息，请参阅github页面）：

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

现在您可以在启用了roc选项的情况下导出此命名空间 - 并将其合并到一个文档中。您现在也可以使用PDF导出和自定义书籍样式（这是我们主要做的）。

Answer 2

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

基本上，您需要做的是将文档的常见部分分解为可以包含在特定于产品的页面中的单独页面。对于DokuWiki，这需要include插件（www.dokuwiki.org/plugin:include），尽管transclusion通常是wiki的核心功能。我建议开始为最常见的产品编写文档，然后回过头来查看可以将哪些部分用于常用文档。