Erstellen der Dokumentation mit Maven

Question

Ich bin gerade in der Mitte Maven von erneuten Besuch. Unser Team hatte eine schlechte Erfahrung, als wir zuletzt bei ausgesehen, wie es in der Zeit war, als Maven wurde von 1.x auf 2.x rearchitecting, so viele Abhängigkeiten wir über den neuen Repositories nicht verschoben benötigt worden war . Allerdings habe ich jetzt die Zeit zu überdenken.

Ich interessiere mich für mit Maven und entweder LaTeX oder DocBook-Dokumentation für das Erstellen, und ich habe mich gefragt, ob jemand irgendwelche Erfahrungen teilen mußte, Projekt- / Modulstruktur, gute Plugins zu verwenden, etc ...

Vielen Dank: -)

Edit:

Nur um zu klären, ich war auf der Suche ein technischen Artikel / Buch zu schreiben, und mein gewünschter Artefakt wäre wahrscheinlich eine PDF sein.

Answer 1

I umgesetzt kürzlich die Projektdokumentation für mein Maven-Multi-Modul-Projekt DocBook und das docbkx Plugin für Maven verwenden. Ich habe jetzt Dateien html und pdf es jedes Mal, wenn ich das Projekt vor Ort automatische Generierung bauen. Ich denke, docbkx wirklich Felsen, so würde ich vorschlagen, dass Sie verwenden.

Es ist wahr -Sie eine sehr schöne Website erstellen können nur die Maven-Website und doxia Plugins. In der Tat bin ich mit diese beiden mein Projekt vor Ort zu erzeugen, aber doxia Unterstützung für DocBook ist sehr begrenzt und Sie Dokumentation modularisieren nicht zulässt, einschließlich Teile von Dokumenten in einem Hauptdokument, zum Beispiel. Also für die großen Referenz-Handbücher Ich verwende docbkx.

Wenn Sie einen Blick nehmen wollen, ist mein Projekt hier . Sie können tatsächlich die Quelle herunterladen und die Nitty Gritty davon sehen. Und natürlich, wenn Sie Fragen haben, diese Einstellung in Bezug auf, ich werde mehr als froh zu helfen.

Prost Carlos

Answer 2

DocBook ist eine der vielen unterstützten Eingänge doxia, den Motor zur Erzeugung von docs maven verwendet. Siehe hier: http://maven.apache.org/doxia/modules/index.html

In der Tat, die doxia Website beantwortet Ihre genaue Frage: http: //maven.apache .org / doxia / Buch / index.html

Answer 3

Sie können ganz einfach eine Website erstellen (die Dokumentation enthält) mit Maven dem MVN Website-Befehl (dh mit dem Plugin-Website ).

Dieses Plugin erstellt technische Berichte (wie Javadoc, Unit-Tests berichten, Code-Coverage ...), kann aber auch eine „echte Website“ erstellen verwendet werden. Sie haben mehr Informationen über die in dieser Seite .

Im Grunde schreiben Sie Ihre Seite mit APT ( Fast Plain Text , die zu verstehen, ganz einfach ist) oder ein XML-basiertes Format, xDoc .

Vor 2 Jahren, erstelle ich eine komplette Bedienungsanleitung für eine Anwendung, die ich entwickeln, das XDoc Format und die Website Maven Plugin. Weltweit war es ganz einfach erstellen!

Ich hoffe, dies wird Ihnen helfen!

Answer 4

Ich habe mit Erfolg wurde mit der Maven Plugin Docbkx. Sie sollten es versuchen

Docbkx

Answer 5

Sie sollten auf jeden Fall einen Blick auf die Maven Plugin Docbkx . Sie paßt wahrscheinlich Ihre Bedürfnisse. Doxia Unterstützung von DocBook ist -uhm- suboptimal. In der Tat, ich das letzte Mal versucht, erzeugt es etwas Neues, dass - soweit ich sehen konnte - war nicht DocBook.

Das Maven Docbkx Plugin, das ich unterstützt die Anpassungen aller Welt beziehen würde (durch Plugin-Parameter oder XSLT überschreibt, wenn Sie, dass sind) + es verfügt über einige Mechanismen es zu integrieren, mit dem Maven-Build. (Wie Verarbeitungsanleitung einschließlich Maven pom Eigenschaften in Ihre Dokumente.)

Beachten Sie, dass der Ehrgeiz ein Plugin haben, ist, dass Sie davon ab, verhindert manuell zusammen, um eine Verarbeitungskette selbst zu setzen. So wird dieses Plugin tut sowohl die Transformation zu FO und Transformieren, dass in PDF.

Answer 6

Auch wenn die Frage schon recht alt ist möchte ich auf dieses Update geben. Wenn Sie LaTeX für Ihre Dokumentation verwenden möchten, sollten Sie ein Maven-Plugin verwenden, um die Dokumentation zu erzeugen. Es gibt ein paar von Maven-Plugins dies zu tun, aber viele von ihnen sind nicht länger gepflegt.  Es gibt eine neue Maven-Plugin, das keine oder weniger Konfiguration erfordert, um es zu arbeiten und die erzeugte PDF (oder PS oder DVI) als Artefakt veröffentlicht werden.

Hier finden Sie: mathan-Latex-Maven-Plugin

Answer 7

Es gibt AFAIK keine offizielle oder halboffizielle Plugin, das LaTeX oder DocBook verarbeiten, aber was konnte man tun (außer die oben genannte Website-Plugin) ist die exec-Plugin zu konfigurieren LaTeX / DocBook-Quellen während des Site-Lebenszyklus zu verarbeiten , zugleich das heißt, dass die Website des Projekts erstellt wird.

z. B. so etwas wie

<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>