2008-11-05 83 views
7

我只是在重新審視maven。我們的團隊在上次看到這個時遇到了一個不好的經歷,就像在maven從1.x重新構建到2.x的時期一樣,所以我們需要的很多依賴沒有移到新的存儲庫中。但是,我現在有時間重新考慮了。用maven創建文檔

我感興趣的使用maven,要麼乳膠或DocBook中創建的文檔,我想知道如果任何人有任何經驗分享,項目/模塊結構,良好的插件使用,等等。

許多感謝:-)

編輯:

只是爲了澄清,我一直在尋找寫技術文章/書了,我想要的神器很可能是一個PDF。

回答

0

我最近使用docbook和docbkx插件爲maven實現了我的maven多模塊項目的項目文檔。我現在每次創建項目網站時都會自動生成html和pdf文件。我認爲docbkx真的很不錯,所以我建議你使用它。

它的真實 - 你可以創建一個非常好的網站,只需使用maven網站和doxia插件。事實上,我正在使用這兩個來生成我的項目站點,但doxia對docbook的支持非常有限,並且不會讓您模塊化文檔,例如包括主文檔中的文檔部分。所以對於我使用docbkx的大參考手冊。

如果你想看一眼,我的項目是here。您可以實際下載源代碼並查看它的實質。當然,如果您對此設置有任何疑問,我會很樂意提供幫助。

乾杯 卡洛斯

6

您可以輕鬆創建一個網站(包含文檔)與使用Maven的MVN網站命令(使用plugin site即)。

這個插件創建技術報告(如Javadoc,單元測試報告,代碼覆蓋...),但也可以用來創建一個「真實網站」。 您在this page中有更多詳細信息。

基本上,你寫使用APT幾乎純文本這是很容易理解),或基於XML的格式,Xdoc你的頁面。

2年前,我創造我開發一個應用程序的完整用戶指南,使用格式XDOC和網站Maven插件。在全球範圍內,創建起來相當容易!

我希望這會幫助你!

-3

AFAIK沒有官方或半官方插件可以處理LaTeX或DocBook,但您可以做的(除了使用上述網站插件外)是配置exec插件以在網站期間處理您的LaTeX/DocBook源代碼生命週期,即在項目網站建立的同時。

例如,像

<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

爲什麼這個問題downvoted這麼多?如果有人使用乳膠格式的文檔,是否有另一種方法來構建它? – 2014-07-22 06:48:27

2

你一定要來看看的Maven Docbkx Plugin。它可能適合您的需求。 Doxia對DocBook的支持是 - uhm-不理想的。事實上,上次我嘗試它時,它產生了一些新的東西 - 據我所知 - 不是DocBook。

那我指的是支持世界上所有的自定義設置(通過插件參數,或XSLT覆蓋,如果你進入的是)+設有一些機制,將其與Maven構建整合的Maven插件Docbkx。 (如處理將Maven pom屬性包含到文檔中的說明。)

請注意,野心是有一個插件,可以防止你自己手動放置一個處理鏈。所以這個插件將同時轉換爲FO,並將其轉換爲PDF。

0

雖然這個問題是很老,我想給這個更新。如果你想爲你的文檔使用LaTeX,你應該使用maven插件來生成文檔。有幾個Maven插件可以做到這一點,但是很多都不再被維護。 有一個新的maven插件,它不需要或者更少的配置就可以使其工作,並且生成的PDF(或PS或DVI)可以作爲工件發佈。

看一看:mathan-latex-maven-plugin