Author: sohil.shah(a)jboss.com Date: 2009-02-09 15:51:20 -0500 (Mon, 09 Feb 2009) New Revision: 12801 Added: modules/authorization/trunk/documentation/ modules/authorization/trunk/documentation/pom.xml modules/authorization/trunk/documentation/reference-guide/ modules/authorization/trunk/documentation/reference-guide/en/ modules/authorization/trunk/documentation/reference-guide/en/images/ modules/authorization/trunk/documentation/reference-guide/en/images/sample/ modules/authorization/trunk/documentation/reference-guide/en/images/sample/partial-refresh.png modules/authorization/trunk/documentation/reference-guide/en/master.xml modules/authorization/trunk/documentation/reference-guide/en/modules/ modules/authorization/trunk/documentation/reference-guide/en/modules/sample.xml modules/authorization/trunk/documentation/reference-guide/pom.xml modules/authorization/trunk/documentation/reference-guide/src/ modules/authorization/trunk/documentation/reference-guide/src/assemble/ modules/authorization/trunk/documentation/reference-guide/src/assemble/reference-guide.xml Modified: modules/authorization/trunk/pom.xml Log: Starting the Reference Guide Added: modules/authorization/trunk/documentation/pom.xml =================================================================== --- modules/authorization/trunk/documentation/pom.xml (rev 0) +++ modules/authorization/trunk/documentation/pom.xml 2009-02-09 20:51:20 UTC (rev 12801) @@ -0,0 +1,71 @@ +<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/maven-v4_0_0.xsd"> + + <parent> + <groupId>org.jboss.portal</groupId> + <artifactId>jboss-portal-docs-parent</artifactId> + <version>1.0.0</version> + </parent> + + + <modelVersion>4.0.0</modelVersion> + <groupId>org.jboss.security.authz</groupId> + <artifactId>jboss-authz-documentation-parent</artifactId> + <version>trunk-SNAPSHOT</version> + <packaging>pom</packaging> + <name>JBoss Authorization Documentation</name> + <url>http://www.jboss.org</url> + <description>JBoss Authorization Documentation</description> + + <modules> + <module>reference-guide</module> + </modules> + + <repositories> + <repository> + <id>repository.jboss.org</id> + <name>JBoss Repository</name> + <layout>default</layout> + <url>http://repository.jboss.org/maven2/</url> + <snapshots> + <enabled>false</enabled> + </snapshots> + </repository> + <repository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshots Repository</name> + <layout>default</layout> + <url>http://snapshots.jboss.org/maven2/</url> + <snapshots> + <enabled>true</enabled> + </snapshots> + <releases> + <enabled>false</enabled> + </releases> + </repository> + </repositories> + + <pluginRepositories> + <pluginRepository> + <id>repository.jboss.org</id> + <name>JBoss Repository</name> + <layout>default</layout> + <url>http://repository.jboss.org/maven2/</url> + <snapshots> + <enabled>false</enabled> + </snapshots> + </pluginRepository> + <pluginRepository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshots Repository</name> + <layout>default</layout> + <url>http://snapshots.jboss.org/maven2/</url> + <snapshots> + <enabled>true</enabled> + </snapshots> + <releases> + <enabled>false</enabled> + </releases> + </pluginRepository> + </pluginRepositories> +</project> Added: modules/authorization/trunk/documentation/reference-guide/en/images/sample/partial-refresh.png =================================================================== (Binary files differ) Property changes on: modules/authorization/trunk/documentation/reference-guide/en/images/sample/partial-refresh.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: modules/authorization/trunk/documentation/reference-guide/en/master.xml =================================================================== --- modules/authorization/trunk/documentation/reference-guide/en/master.xml (rev 0) +++ modules/authorization/trunk/documentation/reference-guide/en/master.xml 2009-02-09 20:51:20 UTC (rev 12801) @@ -0,0 +1,20 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<book lang="en"> + <bookinfo> + <title>Change Title in master.xml</title> + <subtitle>Change SubTitle in master.xml</subtitle> + <releaseinfo>Change Release Info in master.xml</releaseinfo> + <releaseinfo>Change Release Info Date in master.xml</releaseinfo> + <author> + <firstname>Your first name</firstname> + <surname>Your last name</surname> + <email&gt;your.email(a)your.domain.com&lt;/email&gt; + </author> + </bookinfo> + <toc/> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/sample.xml" /> + +</book> Property changes on: modules/authorization/trunk/documentation/reference-guide/en/master.xml ___________________________________________________________________ Name: svn:executable + * Added: modules/authorization/trunk/documentation/reference-guide/en/modules/sample.xml =================================================================== --- modules/authorization/trunk/documentation/reference-guide/en/modules/sample.xml (rev 0) +++ modules/authorization/trunk/documentation/reference-guide/en/modules/sample.xml 2009-02-09 20:51:20 UTC (rev 12801) @@ -0,0 +1,262 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="sample"> + <chapterinfo> + <author> + <firstname>Your first name</firstname> + <surname>Your last name</surname> + <email&gt;your.email(a)your.domain.com&lt;/email&gt; + </author> + </chapterinfo> + <title>Sample chapter</title> + <para>This is the beginning of the sample chapter.</para> + <sect1> + <title>sample section</title> + <para>This is the beginning of the sample section. It contains examples of how docbook should be used in the context + of a documentation for a Java related product.</para> + + <sect2> + <title>Bullet points</title> + <programlisting><![CDATA[ +<itemizedlist> + <listitem>Item1</listitem> + <listitem>Item2</listitem> + <listitem>Item3</listitem> +</itemizedlist> +]]></programlisting> + <para> + <itemizedlist> + <listitem>Item1</listitem> + <listitem>Item2</listitem> + <listitem>Item3</listitem> + </itemizedlist> + </para> + </sect2> + + <sect2> + <title>Interface or annotation reference</title> + <programlisting><![CDATA[ +<interfacename>mypackage.MyInterface</interfacename> +<interfacename>@MyAnnotation</interfacename> +]]></programlisting> + <para> + <interfacename>mypackage.MyInterface</interfacename> + <interfacename>@MyAnnotation</interfacename> + </para> + </sect2> + + <sect2> + <title>Class reference</title> + <programlisting><![CDATA[ +<classname>mypackage.MyClass</classname> +]]></programlisting> + <para> + <classname>mypackage.MyClass</classname> + </para> + </sect2> + + <sect2> + <title>Parameter reference</title> + <programlisting><![CDATA[ +<parameter>MyParameter</parameter> +]]></programlisting> + <para> + <parameter>MyParameter</parameter> + </para> + </sect2> + + <sect2> + <title>Method referece</title> + <programlisting><![CDATA[ +<methodname>myMethod()</methodname> +]]></programlisting> + <para> + <methodname>myMethod()</methodname> + </para> + </sect2> + + <sect2> + <title>Exception reference</title> + <programlisting><![CDATA[ +<exceptionname>mypackage.MyException</exceptionname> +]]></programlisting> + <para> + <exceptionname>mypackage.MyException</exceptionname> + </para> + </sect2> + + <sect2> + <title>A variable name</title> + <programlisting><![CDATA[ +<varname>myVariable</varname> +]]></programlisting> + <para> + <varname>myVariable</varname> + </para> + </sect2> + + <sect2> + <title>File reference</title> + <programlisting><![CDATA[ +<filename>MyFile</filename> +]]></programlisting> + <para> + <filename>MyFile</filename> + </para> + </sect2> + + <sect2> + <title>Literal reference</title> + <programlisting><![CDATA[ +<literal>null</literal> +<literal>1</literal> +<literal>"foo"</literal> +]]></programlisting> + <para> + <literal>null</literal> + <literal>1</literal> + <literal>"foo"</literal> + </para> + </sect2> + + <sect2> + <title>A constant</title> + <programlisting><![CDATA[ +<constant>MAX_VALUE</constant> +]]></programlisting> + <para> + <constant>MAX_VALUE</constant> + </para> + </sect2> + + <sect2> + <title>Inline code</title> + <programlisting><![CDATA[ +<code>System.out.println()</code> +]]></programlisting> + <para> + <code>System.out.println()</code> + </para> + </sect2> + + <sect2> + <title>Code or XML with a caption</title> + <programlisting> +&lt;example&gt; + &lt;programlisting&gt;&lt;![CDATA[public class MyClass +{ +} +]]&gt;&lt;/programlisting&gt; + &lt;caption&gt;This is the MyClass class&lt;/caption&gt; +&lt;/example&gt; +</programlisting> + <para> + <example> + <programlisting><![CDATA[public class MyClass +{ +} +]]></programlisting> + <caption>This is the MyClass class</caption> + </example> + </para> + </sect2> + + <sect2> + <title>A database name</title> + <programlisting><![CDATA[ +<database>MyDatabase</database> +]]></programlisting> + <para> + <database>MyDatabase</database> + </para> + </sect2> + + <sect2> + <title>A shell command</title> + <programlisting><![CDATA[ +<command>ls -l</command> +]]></programlisting> + <para> + <command>ls -l</command> + </para> + </sect2> + + <sect2> + <title>A shell example</title> + <programlisting><![CDATA[ +<screen>&lt;![CDATA[julien-viets-computer:~/java/jboss-portal-template/user-guide julien$ ls -l +total 8 +drwxr-xr-x 3 julien julien 102 Oct 19 18:14 build +-rwxr-xr-x 1 julien julien 923 Oct 19 17:40 build.xml +drwxr-xr-x 6 julien julien 204 Oct 19 17:42 en +]]&gt;</screen> +]]></programlisting> + <para> + <screen><![CDATA[julien-viets-computer:~/java/jboss-portal-template/user-guide julien$ ls -l +total 8 +drwxr-xr-x 3 julien julien 102 Oct 19 18:14 build +-rwxr-xr-x 1 julien julien 923 Oct 19 17:40 build.xml +drwxr-xr-x 6 julien julien 204 Oct 19 17:42 en +]]></screen> + </para> + </sect2> + + <sect2> + <title>Coloration</title> + <programlisting><![CDATA[ +<programlisting role="JAVA">&lt;![CDATA[ +package org.jboss.portal.foo; +public class Bar +{ +}]]&gt;</programlisting>]]></programlisting> + <programlisting role="JAVA"><![CDATA[ +package org.jboss.portal.foo; +public class Bar +{ +}]]></programlisting> + </sect2> + <sect2> + <title>Annotations</title> + <programlisting><![CDATA[ +<programlistingco> + <areaspec> + <area id="sample.annotation.line2" coords='2' /> + <area id="sample.annotation.line4" coords='4' /> + </areaspec> + <programlisting>&lt;![CDATA[Line 1: Foo +Line 2: Bar +Line 3: Toto +Line 4: FooBar +Line 5: Titi]]&gt;</programlisting> + <calloutlist> + <callout arearefs="sample.annotation.line2"> + <para>This is line 2</para> + </callout> + <callout arearefs="sample.annotation.line4"> + <para>This is line 4</para> + </callout> + </calloutlist> +</programlistingco> +]]></programlisting> + <programlistingco> + <areaspec> + <area id="sample.annotation.line2" coords='2' /> + <area id="sample.annotation.line4" coords='4' /> + </areaspec> + <programlisting><![CDATA[Line 1: Foo +Line 2: Bar +Line 3: Toto +Line 4: FooBar +Line 5: Titi]]></programlisting> + <calloutlist> + <callout arearefs="sample.annotation.line2"> + <para>This is line 2</para> + </callout> + <callout arearefs="sample.annotation.line4"> + <para>This is line 4</para> + </callout> + </calloutlist> + </programlistingco> + </sect2> + </sect1> + +</chapter> Added: modules/authorization/trunk/documentation/reference-guide/pom.xml =================================================================== --- modules/authorization/trunk/documentation/reference-guide/pom.xml (rev 0) +++ modules/authorization/trunk/documentation/reference-guide/pom.xml 2009-02-09 20:51:20 UTC (rev 12801) @@ -0,0 +1,42 @@ +<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> + + <parent> + <groupId>org.jboss.security.authz</groupId> + <artifactId>jboss-authz-documentation-parent</artifactId> + <version>trunk-SNAPSHOT</version> + <relativePath>../pom.xml</relativePath> + </parent> + + <groupId>org.jboss.security.authz</groupId> + <artifactId>reference-guide</artifactId> + <name>Reference_Guide</name> + <version>trunk-SNAPSHOT</version> + <packaging>jdocbook</packaging> + + <build> + <plugins> + <plugin> + <artifactId>maven-assembly-plugin</artifactId> + <configuration> + <!--finalName>reference-guide</finalName--> + <descriptors> + <descriptor>src/assemble/reference-guide.xml</descriptor> + </descriptors> + </configuration> + <executions> + <execution> + <id>make-assembly</id> + <phase>package</phase> + <goals> + <goal>attached</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> + </build> +</project> \ No newline at end of file Added: modules/authorization/trunk/documentation/reference-guide/src/assemble/reference-guide.xml =================================================================== --- modules/authorization/trunk/documentation/reference-guide/src/assemble/reference-guide.xml (rev 0) +++ modules/authorization/trunk/documentation/reference-guide/src/assemble/reference-guide.xml 2009-02-09 20:51:20 UTC (rev 12801) @@ -0,0 +1,16 @@ +<assembly> + <!--id>referenceGuide</id--> + <formats> + <format>zip</format> + </formats> + <!--baseDirectory>referenceGuide</baseDirectory--> + <fileSets> + <fileSet> + <directory>target/docbook/publish/en-US</directory> + <outputDirectory>/</outputDirectory> + <includes> + <include>**/*</include> + </includes> + </fileSet> + </fileSets> +</assembly> Modified: modules/authorization/trunk/pom.xml =================================================================== --- modules/authorization/trunk/pom.xml 2009-02-09 09:17:04 UTC (rev 12800) +++ modules/authorization/trunk/pom.xml 2009-02-09 20:51:20 UTC (rev 12801) @@ -14,10 +14,8 @@ <module>core-components</module> <module>enforcement</module> <module>policy-server</module> - <module>http-profile</module> - <!-- - <module>security-console</module> - --> + <module>http-profile</module> + <module>documentation</module> </modules> <properties>