[jboss-dev-forums] [Design of JBoss Build System] - Re: Using jdocbook

[Anne-Marie Barthe]

Hello,

I am using jdocbook with a maven project.

My problem is the following : the tree structure of our projects is not compatible with the one used by default by the JDocbook plugin (like the path and name of the staging directory). 
It is impossible to generate the documentations with pictures, using a CSS for the HTML generation, etc.

I  tried a solution : I  modified the sources of the JDocbook plugin. In the AbstractDocBookMojo class (package : org.jboss.maven.plugins.jdocbook), I  removed the "@readonly" annotation.
So, I set my own name and path for this directory into the POM file (see configuration below). With this modification, the documentation is perfectly generated.


  | 				<configuration>
  | 					<imageResource>
  | 						<directory>${basedir}/src/doc/resources/images</directory>
  | 					</imageResource>					
  | 					<cssResource>
  | 						<directory>${basedir}/src/doc/resources/css</directory>
  | 					</cssResource>
  | 					
  | 					<!-- I have added this parameter to configure the path of stagingDirectory  (which is no more "read only")-->
  | 					<stagingDirectory>${basedir}/target/docbook/publish/resources</stagingDirectory>
  | 					
  | 					<sourceDirectory>${basedir}/src/doc/docbook/doc-en</sourceDirectory>
  | 					<sourceDocumentName>dragon-doc.xml</sourceDocumentName>
  | 					<publishDirectory>${basedir}/target/docbook/publish</publishDirectory>					
  | 							
  | 					<formats>
  | 			            		<format>
  | 			                		<formatName>pdf</formatName>
  | 			                		<stylesheetResource>file:${basedir}/tools/stylesheets/fo.xsl</stylesheetResource>
  | 							<finalName>dragon-docbook-${version}.pdf</finalName>
  | 			            		</format> 
  | 						<format>
  | 			               			<formatName>html</formatName>
  | 			                		<stylesheetResource>file:${basedir}/tools/stylesheets/html.xsl</stylesheetResource>
  | 							<finalName>dragon-docbook-${version}.html</finalName>
  | 			          		</format>
  | 			       		</formats>
  | 				
  | 					<options>
  | 						<xincludeSupported>true</xincludeSupported>
  | 						<xmlTransformerType>saxon</xmlTransformerType>
  |            			        </options>
  | 				</configuration>
  | 



I would know if the deleting of the "@readonly" has consequences on other classes, methods, etc. ?
In the future, the attribute stagingDirectory will be editable by the user ? Or will it remain with the "read only status" (if stagingDirectory will remain "read only", I will create a patch to be able to use it in our projects).

Thank you for your help !


View the original post : http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4167834#4167834

Reply to the post : http://www.jboss.com/index.html?module=bb&op=posting&mode=reply&p=4167834