Dokuwiki를 사용하여 일반적인 사용자 설명서를 작성하는 방법

Question

다른 플랫폼에서 동일한 제품에 대해 3 개의 사용자 설명서를 작성해야하며 변경 사항이 매우 적기 때문에 Dokuwiki를 소프트웨어 사용자 설명서 작성에 사용하려고합니다. Dokuwiki에서 다른 제품에 사용할 수있는 공통 사용자 설명서를 만드는 방법이 있습니까?

Answer 1

이 답변은 DokuWiki뿐만 아니라 모든 위키 엔진에 적용됩니다.

기본적으로 문서의 공통 부분을 제품 별 페이지에 포함될 수있는 별도의 페이지로 제외해야합니다. DokuWiki의 경우, include 플러그인 (www.dokuwiki.org/plugin:include)이 필요합니다.하지만 transclusion은 종종 wiki의 핵심 기능입니다. 가장 일반적인 제품에 대한 문서를 작성한 다음 다시 돌아가 공통 문서에 사용하기 위해 어떤 부분을 가져갈 수 있는지 알아볼 것을 제안합니다.

Answer 2

DokuWiki에 대한 구체적인 내용은 site export 플러그인을 사용하는 것이 좋습니다 (주로 제작했기 때문에 설명서에도 사용함).

위키의 일반 페이지처럼 책의 챕터를 만들 수 있습니다. 서로 다른 책을 결합 할 때 다른 이름 공간에 "toc"라는 페이지를 만듭니다.

 

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

지금 당신이 활성화 로코 옵션이 네임 스페이스를 내보낼 수 있습니다 - 그리고 하나 개의 문서로 통합 : 다음과 같은 구문이 있습니다에서 (자세한 내용은 GitHub의 페이지를 참조하십시오). 또한 사용자 정의 책과 같은 스타일로 PDF 내보내기를 사용할 수도 있습니다 (이것이 주로하는 일입니다).