http://git-wip-us.apache.org/repos/asf/river-container/blob/f17fe38e/user-docs/src/docbkx/resources/xsl/html.xsl ---------------------------------------------------------------------- diff --git a/user-docs/src/docbkx/resources/xsl/html.xsl b/user-docs/src/docbkx/resources/xsl/html.xsl new file mode 100644 index 0000000..a4bc87f --- /dev/null +++ b/user-docs/src/docbkx/resources/xsl/html.xsl @@ -0,0 +1,133 @@ +<?xml version="1.0" encoding="UTF-8"?> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. The + ASF licenses this file to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable + law or agreed to in writing, software distributed under the License is + distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the specific + language governing permissions and limitations under the License. + --> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform"; + version="1.0"> + + <!-- import the docbook-stylesheet without chunking --> + <xsl:import href="urn:docbkx:stylesheet" /> + + <!-- ================ Customization Layer =========== --> + <!-- + customhtml/component.xsl must be imported not included since the + template would not get the right priority otherwise. + --> + <xsl:import href="customhtml/component.xsl" /> + <xsl:import href="customhtml/sections.xsl" /> + + <xsl:include href="customhtml/admon.xsl" /> + <xsl:include href="customhtml/autoidx.xsl" /> + <xsl:include href="customhtml/inline.xsl" /> + <xsl:include href="customhtml/titlepage.xsl" /> + <xsl:include href="customhtml/highlight.xsl" /> + + <!-- ================ Header and Footer data ============== --> + <xsl:param name="apache.logo.src" select="concat($img.src.path, 'asf-logo.gif')" /> + <xsl:param name="apache.logo.alt" select="'Apache Software Foundation'" /> + <xsl:param name="document.logo.src" select="concat($img.src.path, 'river.png')" /> + <xsl:param name="document.logo.alt" select="'Apache River Container'" /> + <xsl:param name="document.copyright" select="'© 2013 Apache Software Foundation'" /> + + <!-- =============== Customized I18n ============== --> + <xsl:param name="local.l10n.xml" select="document('customcommon/en.xml')" /> + + <!-- ================ Fileextension, rootname and path =========== --> + <xsl:param name="html.ext" select="'.html'" /> + <xsl:param name="root.filename" select="'index'" /> + <xsl:param name="use.id.as.filename" select="'0'" /> + + <!-- ================ Chunking-Level ============================= --> + <xsl:param name="chunk.section.depth" select="2" /> + <!-- + chunk.first.sections: if non-zero, first-sections will appear on their + own page + --> + <xsl:param name="chunk.first.sections" select="1" /> + + <!-- ================ CSS Stylesheet ============================= --> + <xsl:param name="css.decoration" select="1" /> + + <!-- ================ Enumeration of Sections ==================== --> + <xsl:param name="section.autolabel" select="1" /> + <xsl:param name="section.label.includes.component.label" select="1" /> + + <!-- ================ ToC ======================================== --> + <xsl:param name="toc.max.depth"> + 1 + </xsl:param> + <xsl:param name="toc.section.depth"> + 3 + </xsl:param> + <xsl:param name="generate.section.toc.level" select="1" /> + + <!-- ================ Glossary =================================== --> + <xsl:param name="glossentry.show.acronym" select="'primary'" /> + <xsl:param name="glossterm.auto.link" select="1" /> + + <!-- ================ Index =================================== --> + <xsl:param name="generate.index" select="1" /> + <xsl:param name="index.on.type" select="0" /> + <xsl:param name="index.on.role" select="0" /> + <xsl:param name="index.prefer.titleabbrev" select="1" /> + + <!-- ================ Images ================================= --> + <xsl:param name="draft.mode" select="'no'" /> + <!-- ignore scaling-options for html-output --> + <xsl:param name="ignore.image.scaling" select="1" /> + <xsl:param name="graphic.default.extension" select="'.png'" /> + <xsl:param name="draft.watermark.image" select="concat($img.src.path, 'admons/draft.png')" /> + + <!-- ================ Admontation ================================ --> + <xsl:param name="admon.graphics" select="1" /> + <xsl:param name="admon.graphics.extension" select="'.png'" /> + <xsl:param name="admon.graphics.path" select="concat($img.src.path, 'admons/')" /> + <!-- + 1 = Admontation are presented with a generated text label such as Note + or Warning + --> + <xsl:param name="admon.textlabel" select="1" /> + <xsl:param name="admon.style"> + <xsl:text><!-- no default margins; use css instead --></xsl:text> + </xsl:param> + + <!-- ================ Callout =================================== --> + <xsl:param name="callout.graphics" select="'1'" /> + <xsl:param name="callouts.extension" select="'1'" /> + <xsl:param name="callout.graphics.extension" select="'.png'" /> + <xsl:param name="callout.graphics.path" select="concat($img.src.path, 'callouts/')" /> + + <!-- ================ Refentry =================================== --> + <xsl:param name="refentry.generate.name" select="0" /> + <xsl:param name="refentry.generate.title" select="1" /> + <xsl:param name="annotate.toc" select="1" /> + + <!-- ================ Navigation ================================= --> + <xsl:param name="navig.graphics" select="1" /> + <xsl:param name="navig.graphics.path" select="concat($img.src.path, 'admons/')" /> + <xsl:param name="navig.graphics.extension" select="'.gif'" /> + <xsl:param name="navig.showtitles" select="1" /> + <xsl:param name="header.rule" select="0" /> + <xsl:param name="footer.rule" select="0" /> + + <!-- ================ Tabledesign ================================ --> + <xsl:param name="default.table.width" select="'700'" /> + <xsl:param name="html.cellspacing" select="'0'" /> + <xsl:param name="html.cellpadding" select="'1'" /> + + <!-- Code highlighting --> + <xsl:param name="highlight.source" select="1" /> + +</xsl:stylesheet>
http://git-wip-us.apache.org/repos/asf/river-container/blob/f17fe38e/user-docs/src/docbkx/userguide.xml ---------------------------------------------------------------------- diff --git a/user-docs/src/docbkx/userguide.xml b/user-docs/src/docbkx/userguide.xml new file mode 100644 index 0000000..0501d5e --- /dev/null +++ b/user-docs/src/docbkx/userguide.xml @@ -0,0 +1,102 @@ +<?xml version="1.0" encoding="UTF-8"?> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. The + ASF licenses this file to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable + law or agreed to in writing, software distributed under the License is + distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the specific + language governing permissions and limitations under the License. + --> + +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd";[ + + <!ENTITY % entities SYSTEM "entities.ent"> + %entities; +]> + +<book lang="en"><?dbhtml dir="userguide" ?> + <bookinfo> + <title>User Guide - Apache River Container</title> + <subtitle>Jini - A Java-based Service Oriented Architecture</subtitle> + <releaseinfo><!-- State of the document -->draft</releaseinfo> + <edition><!-- Mandatory! Should be equal to the latest revision-number -->&productversion;</edition> + <authorgroup> + <author> + <firstname>Greg</firstname> + <surname>Trasuk</surname> + <affiliation> + <orgname>The Apache Software Foundation</orgname> + <orgdiv>Apache River</orgdiv> + </affiliation> + </author> + </authorgroup> + <revhistory> + <revision> + <revnumber>0.1</revnumber> + <date>2013/12/23</date> + <authorinitials>gmt</authorinitials> + <revremark>Initial draft</revremark> + </revision> + </revhistory> + <author><!-- contact person: --> + <firstname>Greg</firstname><surname>Trasuk</surname> + <email>gtrasuk at apache dot org</email> + </author> + + <!-- Abstract --> + <xi:include href="common/abstract.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + + <subjectset><!-- keywords --> + <subject> + <subjectterm>Documentation</subjectterm> + </subject> + <subject> + <subjectterm>Reference</subjectterm> + </subject> + </subjectset> + + <pubdate>&date;</pubdate> + <productname>&productnamecomplete;</productname> + <productnumber>&productversion;</productnumber> + <address> + <!-- postal address, keep line breaks --> + © &companyname; + <!-- + &departmentname; + &companyaddress1; + &companyaddress2; + --> + </address> + <legalnotice> + &legalnotice; + </legalnotice> + <copyright> + <year>&year;</year> + <holder>&companyname;</holder> + </copyright> + + </bookinfo> + + <xi:include href="userguide/preface.xml" + xmlns:xi="http://www.w3.org/2001/XInclude"; /> + + <xi:include href="userguide/Quickstart.xml" + xmlns:xi="http://www.w3.org/2001/XInclude"; /> + + <xi:include href="userguide/PackagingAndDeploying.xml" + xmlns:xi="http://www.w3.org/2001/XInclude"; /> + + <xi:include href="userguide/ConfiguringTheContainer.xml" + xmlns:xi="http://www.w3.org/2001/XInclude"; /> + + + <index id="chapter.index"/> + +</book> http://git-wip-us.apache.org/repos/asf/river-container/blob/f17fe38e/user-docs/src/docbkx/userguide/ConfiguringTheContainer.xml ---------------------------------------------------------------------- diff --git a/user-docs/src/docbkx/userguide/ConfiguringTheContainer.xml b/user-docs/src/docbkx/userguide/ConfiguringTheContainer.xml new file mode 100644 index 0000000..0edd882 --- /dev/null +++ b/user-docs/src/docbkx/userguide/ConfiguringTheContainer.xml @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. The + ASF licenses this file to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable + law or agreed to in writing, software distributed under the License is + distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the specific + language governing permissions and limitations under the License. + --> + +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd";[ + + <!ENTITY % entities SYSTEM "../entities.ent"> + %entities; +]> +<chapter id="chapter3"> + <title>Using OpenWebBeans within OpenEJB</title> + + <section> + <title>OpenWebBeans within OpenEJB</title> + <para> + TODO + </para> + +</section> +<!-- End of SECTION What is OpenWebBeans --> + +</chapter> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/river-container/blob/f17fe38e/user-docs/src/docbkx/userguide/PackagingAndDeploying.xml ---------------------------------------------------------------------- diff --git a/user-docs/src/docbkx/userguide/PackagingAndDeploying.xml b/user-docs/src/docbkx/userguide/PackagingAndDeploying.xml new file mode 100644 index 0000000..1ce34e2 --- /dev/null +++ b/user-docs/src/docbkx/userguide/PackagingAndDeploying.xml @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8"?> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. The + ASF licenses this file to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable + law or agreed to in writing, software distributed under the License is + distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the specific + language governing permissions and limitations under the License. + --> + +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd";[ + + <!ENTITY % entities SYSTEM "../entities.ent"> + %entities; +]> +<chapter id="chapter2"> + <title>Using OpenWebBeans within Java EE Web</title> + + <!-- What is OpenWebBeans --> + <section> + <title>OpenWebBeans in 5 Minute</title> + <para> + In this part of the user guide, we will look at how to configure and use OpenWebBeans in a <emphasis>Java EE + Web</emphasis> projects. + </para> + + <section> + <title>Simple JSP Application</title> + <para>TODO</para> + </section> + + <section> + <title>Using with JSF</title> + <para>TODO</para> + </section> + + <section> + <title>Using with JPA</title> + <para>TODO</para> + </section> + +</section> +<!-- End of SECTION What is OpenWebBeans --> + +</chapter> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/river-container/blob/f17fe38e/user-docs/src/docbkx/userguide/Quickstart.xml ---------------------------------------------------------------------- diff --git a/user-docs/src/docbkx/userguide/Quickstart.xml b/user-docs/src/docbkx/userguide/Quickstart.xml new file mode 100644 index 0000000..40fcd50 --- /dev/null +++ b/user-docs/src/docbkx/userguide/Quickstart.xml @@ -0,0 +1,44 @@ +<?xml version="1.0" encoding="UTF-8"?> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. The + ASF licenses this file to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable + law or agreed to in writing, software distributed under the License is + distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the specific + language governing permissions and limitations under the License. +--> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd";[ + + <!ENTITY % entities SYSTEM "../entities.ent" > + %entities; +]> + +<chapter> + + <chapterinfo id="chapter.intro"> + <keywordset> + <keyword>Quick Start</keyword> + </keywordset> + <authorinitials>gmt</authorinitials> + </chapterinfo> + <title>Quick Start</title> + + <!-- Quick Start --> + <section id="quickstart"> + <title>Apache River Container QuickStart</title> + <para> + The Apache River Container is a quick and easy way to launch services and + clients that conform the the Jini Technology Specification. + </para> + + </section> + + +</chapter> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/river-container/blob/f17fe38e/user-docs/src/docbkx/userguide/preface.xml ---------------------------------------------------------------------- diff --git a/user-docs/src/docbkx/userguide/preface.xml b/user-docs/src/docbkx/userguide/preface.xml new file mode 100644 index 0000000..e9543cd --- /dev/null +++ b/user-docs/src/docbkx/userguide/preface.xml @@ -0,0 +1,141 @@ +<?xml version="1.0" encoding="UTF-8"?> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. The + ASF licenses this file to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance with the + License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable + law or agreed to in writing, software distributed under the License is + distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the specific + language governing permissions and limitations under the License. + --> +<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd";[ + + <!ENTITY % entities SYSTEM "../entities.ent" > + %entities; +]> + +<preface> + <title>Preface</title> + <para> + In this guide we merged all kind of information needed to + configure parts of the + &productnamecomplete; + (from now on simply called + &productname; + throughout the rest of this document). A comprehensive index has + been provided which should help you to quickly find the + information you are looking for. We have also included a + glossary that contains explanations of terms that are mentioned + throughout this guide. + </para> + <para> + We hope that this user guide helps you to increase your + knowledge and understanding of + &productname;. We are sure that it will make development of applications + based on + &productname; + a lot easier for you. Feedback is always welcome. + </para> + + <bridgehead renderas="sect2">Conventions used in this document</bridgehead> + <bridgehead renderas="sect3">Typography</bridgehead> + <para> + the following typographical conventions are used in this + document: + </para> + <variablelist> + <varlistentry> + <term> + <database>database</database> + </term> + <listitem> + <para> + used for database elements (tables, fields, keys, + views,...) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <classname>class</classname> + , + <interfacename>interface</interfacename> + , + <methodname>method</methodname> + </term> + <listitem> + <para> + used for (Java) classes, interfaces and methods + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <sgmltag class="emptytag">tag</sgmltag> + , + <sgmltag class="attribute">attribute</sgmltag> + , + <sgmltag class="attvalue">value</sgmltag> + </term> + <listitem> + <para> + used for XML elements (tags, attributes and values) + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <property> + property + <replaceable>N</replaceable> + </property> + , + <parameter> + parameter + <replaceable>N</replaceable> + </parameter> + </term> + <listitem> + <para> + used for property- and parameternames. The ' + <replaceable>N</replaceable> + ' (or other literal) is a variable part of the name, + which usually stands for a running number. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <literal>value</literal> + </term> + <listitem> + <para> + used for defined values. This can be a default value + an example or the value of a constant. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term> + <code>bean name="myBean"</code> + </term> + <listitem> + <para>used for inline sourcecode examples</para> + </listitem> + </varlistentry> + </variablelist> + <para> + <programlisting language="xml"><![CDATA[<bean name="beanName" class="fqn.of.the.bean"> + <property name="beanPropertyName" ref="with its value"/> +</bean>]]></programlisting> + used for longer source code examples + </para> + <note><para>Indicates a tip, suggestion or general note</para></note> + <warning><para>Indicates a warning</para></warning> +</preface> \ No newline at end of file
