2011-02-09 14 views
3

異なるプラットフォームで同じ製品に対して3つのユーザーマニュアルを作成する必要があり、その変更は非常に少ないため、Dokuwikiをソフトウェアユーザーマニュアルの作成に使用しようとしています。 Dokuwikiには、さまざまな製品に共通のユーザーマニュアルを作成する方法はありますか?共通のユーザーマニュアルを作成するためにDokuwikiを使用する方法

答えて

1

この回答は、DokuWikiだけでなく、どんなwikiエンジンにも当てはまります。

基本的に、ドキュメントの一般的な部分を製品固有のページに含めることができる別々のページに分解する必要があります。 DokuWikiの場合、インクルードプラグイン(www.dokuwiki.org/plugin:include)が必要ですが、移行はwikiのコア機能となることが多いです。私は、最も一般的な製品のドキュメントを書いてから、共通のドキュメンテーションで使用するためにどの部分を引き出すかを見直すことをお勧めします。

2

DokuWikiの詳細については、site exportプラグインをお勧めします(主に私が作成したものであり、私たちのドキュメントにも使用しています)。

あなたのwikiの通常のページのように本の章を作成できます。異なる書籍に結合する場合は、別の名前空間に "toc"というページを作成します。

 

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

は今、あなたは有効ROCオプションでこの名前空間をエクスポートすることができます - と、一つの文書にマージ:次の構文をそこに持っているでは(詳細については、githubのページを参照してください)。また、カスタムのブックライクなスタイルでPDFエクスポートを使用することもできます(これは主にやります)。