Как использовать Dokuwiki для создания общего руководства пользователя

Question

Я пытаюсь использовать Dokuwiki для создания руководства пользователя программного обеспечения, учитывая, что мне нужно создать 3 руководства пользователя для одного и того же продукта на другой платформе, а изменения очень малы. Есть ли способ в Dokuwiki создать общее руководство пользователя, которое может использоваться для разных продуктов?

Answer 1

Этот ответ применим к любому движку wiki, а не только к DokuWiki.

В основном, что вам нужно сделать, это разделить общую часть документации на отдельные страницы, которые могут быть включены в страницы продукта. Для DokuWiki для этого требуется плагин include (www.dokuwiki.org/plugin:include), хотя переключение часто является основной функциональностью для wiki. Я бы посоветовал начать писать документацию для наиболее распространенного продукта, а затем вернуться, чтобы узнать, какие части этого можно вытащить для использования в общей документации.

Answer 2

Для специфики DokuWiki я рекомендую плагин site export (в первую очередь потому, что я его сделал, и мы также используем его для нашей документации).

Вы можете создать главы своей книги, как обычную страницу в своей вики. Когда дело доходит до объединения их в разные книги, создайте страницу под названием «toc» в другом пространстве имен. В там имеют следующий синтаксис (см страницу GitHub для подробностей):

 

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

Теперь вы можете экспортировать это пространство имен с помощью опции Roc включена - и объединены в один документ. Вы также можете использовать экспорт PDF с пользовательскими книжными стилями сейчас (это то, что мы делаем в первую очередь).