2008-11-05 2 views
7

나는 maven을 다시 방문하는 중이다. 우리가 마지막으로 이것을 보았을 때 우리 팀은 maven이 1.x에서 2.x로 재구성되는시기 였기 때문에 나쁜 경험을했습니다. 그래서 우리가 필요로했던 많은 의존성이 새로운 저장소로 이동하지 않았습니다 . 그러나 지금은 재고 할 시간이 있습니다.maven을 사용한 문서 작성

내가 받는다는 및 문서 작성을위한 LaTeX의 또는의 DocBook을 사용하여에 관심이 있어요, 나는 등, 사람이 공유 할 수있는 경험이 있다면, 프로젝트/모듈 구조, 좋은 플러그인을 사용하는 것이 궁금 ...

많은에게 덕분에

편집 :-) :

그냥 명확하게, 나는 기술 문서/책을 쓸 찾고 있었어요, 내 원하는 유물은 아마 PDF 될 것이다.

답변

0

나는 최근에 docbook과 maven 용 docbkx 플러그인을 사용하여 maven 다중 모듈 프로젝트를위한 프로젝트 문서를 구현했다. 프로젝트 사이트를 구축 할 때마다 자동으로 html 및 pdf 파일을 생성합니다. 나는 docbkx가 정말로 바위 같아서, 당신이 그것을 사용할 것을 제안 할 것입니다.

사실 - 당신은 메이븐 사이트와 doxia 플러그인을 사용하여 아주 멋진 사이트를 만들 수 있습니다. 사실 나는이 두 가지를 사용하여 프로젝트 사이트를 생성하지만 docbook에 대한 doxia 지원은 매우 제한적이며 예를 들어 메인 문서에있는 문서의 일부를 포함하여 문서를 모듈화 할 수 없습니다. 그래서 큰 참고 매뉴얼에 대해서는 docbkx를 사용하고 있습니다.

엿보기를 원하면 내 프로젝트는 here입니다. 당신은 실제로 소스를 다운로드하고 그것의 핵심을 볼 수 있습니다. 물론,이 설정과 관련하여 질문이 있으면 기꺼이 도와 드리겠습니다. 건배 카를로스

6

mvn 사이트 명령을 사용하여 (예 : plugin site을 사용하여) Maven으로 사이트를 쉽게 만들 수 있습니다.

이 플러그인은 기술 보고서 ​​(예 : Javadoc, 단위 테스트 보고서, 코드 범위 ...)를 작성하지만 "실제 사이트"를 만드는데도 사용할 수 있습니다. 자세한 내용은 this page입니다.

기본적으로, 당신은 APT (이해하기 매우 간단 거의 일반 텍스트) 또는 XML 기반 형식, Xdoc을 사용하여 페이지를 작성합니다.

2 년 전, XDoc 형식과 사이트 메이븐 플러그인을 사용하여 내가 개발 한 하나의 응용 프로그램에 대한 완전한 사용자 안내서를 만듭니다. 전 세계적으로, 그것은 아주 쉽게 만들 수있었습니다!

이 정보가 도움이되기를 바랍니다.

-3

LaTeX 또는 DocBook을 처리 할 AFAIK 플러그인이 없지만 (위의 사이트 플러그인을 사용하는 것 외에) 사이트에서 LaTeX/DocBook 소스를 처리하도록 exec 플러그인을 구성하는 것입니다 즉 프로젝트의 웹 사이트가 구축되는 것과 동시에.

예를 들면,

<plugin> 
    <groupId>org.codehaus.mojo</groupId> 
    <artifactId>exec-maven-plugin</artifactId> 
    <executions> 
    <execution> 
    <id>latex</id> 
    <goals> 
     <goal>exec</goal> 
    </goals> 
    <phase>site</phase> 
     <configuration> 
      ... 
     </configuration> 
    </execution> 
    </executions> 
</plugin> 
+0

이 질문은 왜 그렇게 많이 줄 었습니까? 한 문서에 latex 형식의 문서가있는 경우 다른 방법으로 문서를 만들 수 있습니까? –

7

의 DocBook 같은 것이 Doxia, 받는다는하여 문서를 생성하는 데 사용되는 엔진에 많은 지원되는 입력 중 하나입니다. 여기를 참조하십시오 : 나는 Maven 플러그인 Docbkx 성공을 사용하고 http://maven.apache.org/doxia/book/index.html

2

시도에게 그것을 제공해야합니다. 그것은 아마도 당신의 필요에 맞을 것입니다. DocBook에 대한 Doxia의 지원은 부적절합니다. 사실, 제가 시도한 지난 번에, 그것은 제가 말할 수있는 한 DocBook이 아닌 새로운 것을 만들어 냈습니다.

내가 언급 한 Maven Docbkx 플러그인은 플러그인 매개 변수 또는 XSLT 무시를 통해 모든 사용자 정의를 지원하며 + Maven 빌드와 통합하기위한 몇 가지 메커니즘을 제공합니다. (예 : Maven pom 속성을 문서에 포함시키기위한 지침 처리.)

당신이 처리 체인을 직접 조립할 필요가 없도록하는 플러그인이 있어야한다는 점에 유의하십시오. 따라서이 플러그인은 FO 로의 변환을 수행하고이를 PDF로 변환합니다.

0

문제는 상당히 오래된이지만

나는이에 대한 업데이 트를주고 싶다. 문서에 LaTeX을 사용하려면 Maven 플러그인을 사용하여 문서를 생성해야합니다. 이 작업을 수행하는 몇 가지 메이븐 플러그인이 있지만 그 중 많은 플러그인은 더 이상 유지 관리되지 않습니다. 작동 시키려면 구성이 필요 없으며 생성 된 PDF (또는 PS 또는 DVI)를 아티팩트로 게시 할 수있는 새로운 maven-plugin이 있습니다.

다음을보십시오 : mathan-latex-maven-plugin