[jbosstools-commits] JBoss Tools SVN: r15331 - in trunk/documentation: jboss-tools-docs-archetype and 8 other directories.

Author: msorokin Date: 2009-05-18 12:50:43 -0400 (Mon, 18 May 2009) New Revision: 15331 Added: trunk/documentation/jboss-tools-docs-archetype/ trunk/documentation/jboss-tools-docs-archetype/pom.xml trunk/documentation/jboss-tools-docs-archetype/readme.txt trunk/documentation/jboss-tools-docs-archetype/src/ trunk/documentation/jboss-tools-docs-archetype/src/main/ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/META-INF/ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/META-INF/maven/ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml trunk/documentation/jboss-tools-docs-archetype/src/main/resources/META-INF/maven/archetype.xml trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/en/ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/en/images/ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/en/master.xml trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/en/modules/ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/en/modules/chapter1.xml trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/pom.xml Log: https://jira.jboss.org/jira/browse/JBDS-708 Archetype is created Added: trunk/documentation/jboss-tools-docs-archetype/pom.xml =================================================================== --- trunk/documentation/jboss-tools-docs-archetype/pom.xml (rev 0) +++ trunk/documentation/jboss-tools-docs-archetype/pom.xml 2009-05-18 16:50:43 UTC (rev 15331) @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="UTF-8"?><project> + <modelVersion>4.0.0</modelVersion> + <groupId>org.jboss.tools</groupId> + <artifactId>jboss-tools-docs-archetype</artifactId> + <packaging>maven-archetype</packaging> + <name>jboss-tools-docs-archetype</name> + <version>1.0-SNAPSHOT</version> + <build> + <extensions> + <extension> + <groupId>org.apache.maven.archetype</groupId> + <artifactId>archetype-packaging</artifactId> + <version>2.0-alpha-4</version> + </extension> + </extensions> + <plugins> + <plugin> + <artifactId>maven-archetype-plugin</artifactId> + <version>2.0-alpha-4</version> + <extensions>true</extensions> + </plugin> + </plugins> + </build> +</project> \ No newline at end of file Added: trunk/documentation/jboss-tools-docs-archetype/readme.txt =================================================================== --- trunk/documentation/jboss-tools-docs-archetype/readme.txt (rev 0) +++ trunk/documentation/jboss-tools-docs-archetype/readme.txt 2009-05-18 16:50:43 UTC (rev 15331) @@ -0,0 +1,8 @@ +jboss-tools-docs-archetype +The "jboss-tools-docs-archetype" archetype help create a skeleton for a new guide. To use it you need to take a few simple steps: +1. Build the archetype in the current folder with "mvn install" +2. Navigate to the folder with the new plugin for which you want to make a new guide. +3. Create the docs folder +4. CD to docs folder +5. Run mvn "archetype:generate -DarchetypeGroupId=org.jboss.tools -DarchetypeArtifactId=jboss-tools-docs-archetype -DarchetypeVersion=1.0-SNAPSHOT -DartifactId=XXX_Guide -DgroupId=org.jboss.tools" +6. That's it. A new guide is created. You can build it (CD to XXX_Guide directory and run "mvn install" ) to see that everything's ok. Added: trunk/documentation/jboss-tools-docs-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml =================================================================== --- trunk/documentation/jboss-tools-docs-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml (rev 0) +++ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/META-INF/maven/archetype-metadata.xml 2009-05-18 16:50:43 UTC (rev 15331) @@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="UTF-8"?><archetype-descriptor name="ref-guide"> + <fileSets> + <fileSet filtered="true" encoding="UTF-8"> + <directory>en/modules</directory> + <includes> + <include>**/*.xml</include> + </includes> + </fileSet> + <fileSet filtered="true" encoding="UTF-8"> + <directory>en</directory> + <includes> + <include>**/*.xml</include> + </includes> + </fileSet> + <fileSet encoding="UTF-8"> + <directory>en/images</directory> + <includes> + <include>**/*.db</include> + <include>**/*.png</include> + <include>**/*.ico</include> + </includes> + </fileSet> + </fileSets> +</archetype-descriptor> \ No newline at end of file Added: trunk/documentation/jboss-tools-docs-archetype/src/main/resources/META-INF/maven/archetype.xml =================================================================== --- trunk/documentation/jboss-tools-docs-archetype/src/main/resources/META-INF/maven/archetype.xml (rev 0) +++ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/META-INF/maven/archetype.xml 2009-05-18 16:50:43 UTC (rev 15331) @@ -0,0 +1,8 @@ +<?xml version="1.0" encoding="UTF-8"?><archetype> + <id>ref-guide</id> + <resources> + <resource>en\images\</resource> + <resource>en\master.xml</resource> + <resource>en\modules\chapter1.xml</resource> + </resources> +</archetype> \ No newline at end of file Added: trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/en/master.xml =================================================================== --- trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/en/master.xml (rev 0) +++ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/en/master.xml 2009-05-18 16:50:43 UTC (rev 15331) @@ -0,0 +1,42 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + + +[<!ENTITY chapter1 SYSTEM "modules/chapter1.xml"> + + +]> +<book> + + <bookinfo> + + <title>XXX Tools Reference Guide</title> + <author><firstname>Name</firstname><surname>Surname</surname></author> + <author&gt;&lt;firstname&gt;Svetlana&lt;/firstname&gt;&lt;surname&gt;Mukhina&lt;/surname&gt;&lt;email&gt;smukhina(a)exadel.com&lt;/email&gt;&lt;/author&gt; + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss, a division of Red Hat</holder> + </copyright> + <releaseinfo> + Version: 3.0.1.GA + </releaseinfo> + +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/pdf/X... version</ulink> + </para> +</abstract> + + + </bookinfo> + <toc/> + +&chapter1; + + +</book> Added: trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/en/modules/chapter1.xml =================================================================== --- trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/en/modules/chapter1.xml (rev 0) +++ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/en/modules/chapter1.xml 2009-05-18 16:50:43 UTC (rev 15331) @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="chapter1" xreflabel="chapter1"> + <?dbhtml filename="chapter1.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction</title> + + <section> + + <title>What is XXX</title> + <para>This introduction will help you to understand what is <property>XXX</property>.</para> + <para><property>XXX</property> is a fully featured application framework.</para> + </section> + + +</chapter> \ No newline at end of file Added: trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/pom.xml =================================================================== --- trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/pom.xml (rev 0) +++ trunk/documentation/jboss-tools-docs-archetype/src/main/resources/archetype-resources/pom.xml 2009-05-18 16:50:43 UTC (rev 15331) @@ -0,0 +1,158 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>${groupId}</groupId> + <artifactId>${artifactId}</artifactId> + <version>${version}</version> + <packaging>jdocbook</packaging> + <name>Reference_Guide</name> + + <profiles> + <profile> + <id>release</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseJBDS</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release-nomarker.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release-nomarker.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> + <cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/com/css/</cssdir> + </properties> + </profile> + <profile> + <id>diffmk</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-diff.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-diff.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf-diff.xsl</xsl-pdf> + </properties> + </profile> + </profiles> + + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.1.0-200803311251UTC-MPJDOCBOOK-8</version> + + <extensions>true</extensions> + <dependencies> + <dependency> + <groupId>com.jboss</groupId> + <artifactId>jbossent-docbook-xslt</artifactId> + <version>1.0.0</version> + </dependency> + <dependency> + <groupId>com.jboss</groupId> + <artifactId>jbossent-jdocbook-style</artifactId> + <version>1.0.0</version> + <type>jdocbook-style</type> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-docbook-xslt</artifactId> + <version>1.1.0</version> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.1.0</version> + <type>jdocbook-style</type> + </dependency> + <dependency> + <groupId>org.jboss.tools</groupId> + <artifactId>jbosstools-docbook-xslt</artifactId> + <version>1.0.0-SNAPSHOT</version> + </dependency> + <dependency> + <groupId>org.apache.xmlgraphics</groupId> + <artifactId>fop</artifactId> + <version>0.95</version> + </dependency> + </dependencies> + + <configuration> + <sourceDocumentName>${master}</sourceDocumentName> + <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <imageResource> + <directory>${pom.basedir}/en</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <cssResource> + <directory>${pom.basedir}/${cssdir}</directory> + </cssResource> + + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>${xsl-pdf}</stylesheetResource> + <finalName>${pom.name}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>${xsl-chunked}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>${xsl-single}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <!-- needed for uri-resolvers; can be ommitted if using 'current' uri scheme --> + <!-- could also locate the docbook dependency and inspect its version... --> + <docbookVersion>1.72.0</docbookVersion> + </options> + </configuration> + </plugin> + </plugins> + </build> + + <distributionManagement> + <repository> + <!-- Copy the dist to the local checkout of the JBoss maven2 repo ${maven.repository.root} --> + <!-- It is anticipated that ${maven.repository.root} be set in user's settings.xml --> + <!-- todo : replace this with direct svn access once the svnkit providers are available --> + <id>repository.jboss.org</id> + <url>file://${maven.repository.root}</url> + </repository> + <snapshotRepository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshot Repository</name> + <url>dav:https://snapshots.jboss.org/maven2</url> + </snapshotRepository> + </distributionManagement> + + <properties> + <stylesdir>../../../documentation/jbosstools-docbook-xslt/src/main/resources/</stylesdir> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + <cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/org/css/</cssdir> + <master>master.xml</master> + <translation>en-US</translation> + </properties> +</project>