Author: tolusha Date: 2010-03-22 09:58:36 -0400 (Mon, 22 Mar 2010) New Revision: 2096 Added: kernel/trunk/docs/ kernel/trunk/docs/pom.xml kernel/trunk/docs/reference/ kernel/trunk/docs/reference/en/ kernel/trunk/docs/reference/en/build.cmd kernel/trunk/docs/reference/en/pom.xml kernel/trunk/docs/reference/en/src/ kernel/trunk/docs/reference/en/src/main/ kernel/trunk/docs/reference/en/src/main/docbook/ kernel/trunk/docs/reference/en/src/main/docbook/en-US/ kernel/trunk/docs/reference/en/src/main/docbook/en-US/master.xml kernel/trunk/docs/reference/en/src/main/docbook/en-US/modules/ kernel/trunk/docs/reference/en/src/main/docbook/en-US/modules/services.xml kernel/trunk/docs/reference/en/src/main/docbook/en-US/modules/services/ kernel/trunk/docs/reference/en/src/main/docbook/en-US/modules/services/initial-context-binder-service.xml kernel/trunk/docs/reference/en/src/main/resources/ kernel/trunk/docs/reference/pom.xml Modified: kernel/trunk/pom.xml Log: EXOJCR-573: add InitialContextBinder docbook Added: kernel/trunk/docs/pom.xml =================================================================== --- kernel/trunk/docs/pom.xml (rev 0) +++ kernel/trunk/docs/pom.xml 2010-03-22 13:58:36 UTC (rev 2096) @@ -0,0 +1,38 @@ +<!-- + + Copyright (C) 2009 eXo Platform SAS. + + This is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + This software is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this software; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + 02110-1301 USA, or see the FSF site: http://www.fsf.org. + +--> +<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.exoplatform.kernel</groupId> + <artifactId>kernel-parent</artifactId> + <version>2.2.1-GA-SNAPSHOT</version> + </parent> + + <modelVersion>4.0.0</modelVersion> + <artifactId>docs</artifactId> + + <name>Kernel project documentation</name> + <packaging>pom</packaging> + + <modules> + <module>reference</module> + </modules> +</project> Added: kernel/trunk/docs/reference/en/build.cmd =================================================================== --- kernel/trunk/docs/reference/en/build.cmd (rev 0) +++ kernel/trunk/docs/reference/en/build.cmd 2010-03-22 13:58:36 UTC (rev 2096) @@ -0,0 +1 @@ +@start mvn clean install jdocbook:resources jdocbook:generate \ No newline at end of file Added: kernel/trunk/docs/reference/en/pom.xml =================================================================== --- kernel/trunk/docs/reference/en/pom.xml (rev 0) +++ kernel/trunk/docs/reference/en/pom.xml 2010-03-22 13:58:36 UTC (rev 2096) @@ -0,0 +1,128 @@ +<!-- + + Copyright (C) 2009 eXo Platform SAS. + + This is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + This software is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this software; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + 02110-1301 USA, or see the FSF site: http://www.fsf.org. + +--> +<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.exoplatform.kernel</groupId> + <artifactId>reference-docs</artifactId> + <version>2.2.1-GA-SNAPSHOT</version> + </parent> + + <modelVersion>4.0.0</modelVersion> + <artifactId>reference-docs-${translation}</artifactId> + + <name>Kernel reference documentation (${translation})</name> + <packaging>jdocbook</packaging> + + <properties> + <translation>en</translation> + <enforcer.skip>true</enforcer.skip> + </properties> + + <build> + <finalName>${project.parent.artifactId}_${translation}-${version}</finalName> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-dependency-plugin</artifactId> + </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>xml-maven-plugin</artifactId> + <!-- version>1.0-beta-2</version --> + </plugin> + + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.1.1</version> + <extensions>true</extensions> + <dependencies> + <dependency> + <groupId>org.exoplatform.doc</groupId> + <artifactId>exo-docbook-xslt</artifactId> + <version>${org.exoplatform.doc-style.version}</version> + </dependency> + <dependency> + <groupId>org.exoplatform.doc</groupId> + <artifactId>exo-jdocbook-style</artifactId> + <version>${org.exoplatform.doc-style.version}</version> + <type>jdocbook-style</type> + </dependency> + <!-- dependency> + <groupId>xalan</groupId> + <artifactId>xalan</artifactId> + <version>2.7.1</version> + </dependency --> + <!-- dependency> + <groupId>net.sf.saxon</groupId> + <artifactId>saxon</artifactId> + <version>9.1.0.8</version> + </dependency --> + </dependencies> + <configuration> + <sourceDocumentName>master.xml</sourceDocumentName> + + <!--sourceDocumentName>modules/lock-manager-config.xml</sourceDocumentName--> + <imageResource> + <directory>${pom.basedir}/src/main/resources</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + + <formats> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/exojcr/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/exojcr/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <!-- format> + <formatName>pdf</formatName> + <stylesheetResource>classpath://xslt/org/exojcr/pdf.xsl</stylesheetResource> + <finalName>${pom.name}.pdf</finalName> + </format --> + <!-- format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/exojcr/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.74.0</docbookVersion> + </options> + + </configuration> + </plugin> + </plugins> + </build> + +</project> Added: kernel/trunk/docs/reference/en/src/main/docbook/en-US/master.xml =================================================================== --- kernel/trunk/docs/reference/en/src/main/docbook/en-US/master.xml (rev 0) +++ kernel/trunk/docs/reference/en/src/main/docbook/en-US/master.xml 2010-03-22 13:58:36 UTC (rev 2096) @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + + Copyright (C) 2009 eXo Platform SAS. + + This is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + This software is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this software; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + 02110-1301 USA, or see the FSF site: http://www.fsf.org. + +--> +<!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>Kernle Reference Manual</title> + + <subtitle>Kernel</subtitle> + + <copyright> + <year>2009, 2010</year> + <holder>eXoPlatform</holder> + </copyright> + </bookinfo> + + <toc></toc> + + <xi:include href="modules/services.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</book> Added: kernel/trunk/docs/reference/en/src/main/docbook/en-US/modules/services/initial-context-binder-service.xml =================================================================== --- kernel/trunk/docs/reference/en/src/main/docbook/en-US/modules/services/initial-context-binder-service.xml (rev 0) +++ kernel/trunk/docs/reference/en/src/main/docbook/en-US/modules/services/initial-context-binder-service.xml 2010-03-22 13:58:36 UTC (rev 2096) @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<chapter> + <?dbhtml filename="ch-initial-context-binder-service.html"?> + + <title>Initial Context Binder</title> + + <section> + <title>About</title> + + <para>Initial Context Binder is responsible for binding references at + runtime, persisting in file and automatically rebinding after restart. + Java temp directory is used to persist references in bind-references.xml + file.</para> + </section> + + <section> + <title>API</title> + + <para>Service provide methods for binding reference.</para> + + <programlisting>public void bind(String bindName, String className, String factory, String factoryLocation, Map&lt;String, String&gt; refAddr) throws NamingException, FileNotFoundException, XMLStreamException;</programlisting> + + <itemizedlist> + <listitem> + <para>bindName - name of binding</para> + </listitem> + + <listitem> + <para>className - the fully-qualified name of the class of the object + to which this Reference refers</para> + </listitem> + + <listitem> + <para>factory - the name of the factory class for creating an instance + of the object to which this Reference refers</para> + </listitem> + + <listitem> + <para>factoryLocation - the location of the factory class</para> + </listitem> + + <listitem> + <para>refAddr - object's properties map</para> + </listitem> + </itemizedlist> + </section> + + <section> + <title>A configuration examples</title> + + <para>Service's configuration.</para> + + <programlisting>&lt;component&gt; + &lt;key&gt;org.exoplatform.services.naming.InitialContextBinder&lt;/key&gt; + &lt;type&gt;org.exoplatform.services.naming.InitialContextBinder&lt;/type&gt; +&lt;/component&gt;</programlisting> + </section> +</chapter> Added: kernel/trunk/docs/reference/en/src/main/docbook/en-US/modules/services.xml =================================================================== --- kernel/trunk/docs/reference/en/src/main/docbook/en-US/modules/services.xml (rev 0) +++ kernel/trunk/docs/reference/en/src/main/docbook/en-US/modules/services.xml 2010-03-22 13:58:36 UTC (rev 2096) @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<part> + <?dbhtml filename="part-services.html"?> + + <title>Kernel</title> + + <xi:include href="services/initial-context-binder-service.xml" + xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</part> Added: kernel/trunk/docs/reference/pom.xml =================================================================== --- kernel/trunk/docs/reference/pom.xml (rev 0) +++ kernel/trunk/docs/reference/pom.xml 2010-03-22 13:58:36 UTC (rev 2096) @@ -0,0 +1,38 @@ +<!-- + + Copyright (C) 2009 eXo Platform SAS. + + This is free software; you can redistribute it and/or modify it + under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation; either version 2.1 of + the License, or (at your option) any later version. + + This software is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this software; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA + 02110-1301 USA, or see the FSF site: http://www.fsf.org. + +--> +<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.exoplatform.kernel</groupId> + <artifactId>docs</artifactId> + <version>2.2.1-GA-SNAPSHOT</version> + </parent> + + <modelVersion>4.0.0</modelVersion> + <artifactId>reference-docs</artifactId> + + <name>Kernel reference documentation</name> + <packaging>pom</packaging> + + <modules> + <module>en</module> + </modules> +</project> Modified: kernel/trunk/pom.xml =================================================================== --- kernel/trunk/pom.xml 2010-03-22 13:34:06 UTC (rev 2095) +++ kernel/trunk/pom.xml 2010-03-22 13:58:36 UTC (rev 2096) @@ -38,7 +38,8 @@ <properties> <exo.product.name>exo-kernel</exo.product.name> <exo.product.specification>2.2</exo.product.specification> - <org.exoplatform.framework.junit.version>1.2.2-GA-SNAPSHOT</org.exoplatform.framework.junit.version> + <org.exoplatform.framework.junit.version>1.2.2-GA-SNAPSHOT</org.exoplatform.framework.junit.version> + <org.exoplatform.doc-style.version>2-SNAPSHOT</org.exoplatform.doc-style.version> <forkMode>always</forkMode> </properties>