[jbosstools-issues] [JBoss JIRA] Commented: (JBIDE-1703) Mavenize the docbook build

Max Andersen (JIRA) jira-events at lists.jboss.org
Tue Jan 29 06:59:17 EST 2008


    [ http://jira.jboss.com/jira/browse/JBIDE-1703?page=comments#action_12397305 ] 
            
Max Andersen commented on JBIDE-1703:
-------------------------------------

info from Mark Newton on these files:

I've now uploaded the two Maven plugins that I created (jbossorg-docbook-xslt and jbossorg-jdocbook-style) to our remote repository so you don't have to build them locally.

The only steps you have to take now are as follows:

1) Make sure that you have a ~/.m2/settings.xml file like the one attached to this email. This is needed to add the jboss release and snapshot repositories to your maven configuration. If you already have a settings.xml file then you just need to add the jboss.repository profile.

2) You need to have a pom.xml for the documentation that you're trying to generate. This will typically reside in the same directory as the build.xml file you used to use, e.g. http://anonsvn.jboss.org/repos/jbosstools/trunk/documentation/guides/userguide/GettingStartedGuide/pom.xml

I've attached the pom.xml that I used for the above example to generate docs for the JBoss Tools Getting Started Guide.

If you copy this pom.xml and use it for other projects then you need to alter the following xml elements:

<artifactId>

<configuration>
	<sourceDocumentName>
	<sourceDirectory>
	<imageResource>
		<directory>
		<includes>
			<include>

You should get the idea once you look at it. It's pretty self explanatory :)

That's all you should need to do. Maven will download all the dependencies and produce 4 formats (assuming you don't comment any of the <format> elements out in the pom.xml):

HTML
Single-page HTML
Eclipse Help (HTML with toc.xml and plugin.xml - you might need to alter the contents of the plugin.xml by hand still)
PDF

The HTML is actually strict XHTML so it is very consistent :)



> Mavenize the docbook build
> --------------------------
>
>                 Key: JBIDE-1703
>                 URL: http://jira.jboss.com/jira/browse/JBIDE-1703
>             Project: Tools (JBoss Tools)
>          Issue Type: Task
>          Components: Build/Releng
>            Reporter: Max Andersen
>         Assigned To: Max Andersen
>         Attachments: pom.xml, settings.xml
>
>
> Will give us the standard style + eclipse look'n'feel out of the box

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.jboss.com/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        



More information about the jbosstools-issues mailing list