http://git-wip-us.apache.org/repos/asf/polygene-website/blob/538baaf6/content/java/develop/community-docs.html
----------------------------------------------------------------------
diff --git a/content/java/develop/community-docs.html
b/content/java/develop/community-docs.html
index db99d29..50b0721 100644
--- a/content/java/develop/community-docs.html
+++ b/content/java/develop/community-docs.html
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html
xmlns="http://www.w3.org/1999/xhtml";><head><meta http-equiv="Content-Type"
content="text/html; charset=UTF-8" /><title>Polygeneâ¢
Documentation</title><link rel="stylesheet" type="text/css"
href="css/style.css" /><meta name="generator" content="DocBook XSL Stylesheets
V1.76.1" /><link rel="home" href="index.html" title="" /><link rel="up"
href="tutorials.html" title="Tutorials" /><link rel="prev"
href="build-system.html" title="Polygene⢠Build System" /><link rel="next"
href="releasing-apache.html" title="Releasing Polygeneâ¢" />
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";><html
xmlns="http://www.w3.org/1999/xhtml";><head><meta http-equiv="Content-Type"
content="text/html; charset=UTF-8" /><title>Polygeneâ¢
Documentation</title><link rel="stylesheet" type="text/css"
href="css/style.css" /><meta name="generator" content="DocBook XSL Stylesheets
V1.79.1" /><link rel="home" href="index.html" title="" /><link rel="up"
href="tutorials.html" title="Tutorials" /><link rel="prev"
href="build-system.html" title="Polygene⢠Build System" /><link rel="next"
href="releasing-apache.html" title="Releasing Polygeneâ¢" />
<!-- favicon -->
@@ -66,14 +66,14 @@
})();
</script>
- </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common";
class="logo"><a href="index.html"><img src="images/logo-standard.png"
/></a></div><div xmlns="" xmlns:exsl="http://exslt.org/common";
class="top-nav"><div xmlns="http://www.w3.org/1999/xhtml";
class="toc"><dl><dt><span class="section"><a
href="index.html#home">Polygeneâ¢</a></span></dt><dt><span class="section"><a
href="intro.html">Introduction</a></span></dt><dt><span class="section"><span
xmlns="" href="tutorials.html">Tutorials</span></span></dt><dt><span
class="section"><a href="javadocs.html">Javadoc</a></span></dt><dt><span
class="section"><a href="samples.html">Samples</a></span></dt><dt><span
class="section"><a href="core.html">Core</a></span></dt><dt><span
class="section"><a href="libraries.html">Libraries</a></span></dt><dt><span
class="section"><a href="extensions.html">Extensions</a></span></dt><dt><span
class="section"><a href="tools.html">Tools</a></span></dt><dt><span
class="section"><a href="glossary.ht
ml">Glossary </a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common"; class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl><dt><span
class="section"><a
href="tutorials.html#_overview">Overview</a></span></dt><dt><span
class="section"><a href="two-minutes-intro.html">Polygene⢠in 2
minutes</a></span></dt><dt><span class="section"><a
href="ten-minutes-intro.html">Polygene⢠in 10
minutes</a></span></dt><dt><span class="section"><a
href="thirty-minutes-intro.html">Polygene⢠in 30
minutes</a></span></dt><dt><span class="section"><a
href="howto-depend-on-polygene.html">Depend on
Polygeneâ¢</a></span></dt><dt><span class="section"><a
href="howto-assemble-application.html">Assemble an
Application</a></span></dt><dt><span class="section"><a
href="tut-composites.html">Transient Composites
Tutorial</a></span></dt><dt><span class="section"><a
href="tut-services.html">Services Composites Tutorial</a></span></dt><dt><span
class="section"><a
href="howto-contextual-fragments.html">Use contextual
fragments</a></span></dt><dt><span class="section"><a
href="howto-leverage-properties.html">Leverage
Properties</a></span></dt><dt><span class="section"><a
href="howto-create-constraint.html">Create a
Constraint</a></span></dt><dt><span class="section"><a
href="howto-create-concern.html">Create a Concern</a></span></dt><dt><span
class="section"><a href="howto-create-sideeffect.html">Create a
SideEffect</a></span></dt><dt><span class="section"><a
href="howto-create-entity.html">Create an Entity</a></span></dt><dt><span
class="section"><a href="howto-configure-service.html">Configure a
Service</a></span></dt><dt><span class="section"><a
href="howto-invocation-annotation.html">Use
@Invocation</a></span></dt><dt><span class="section"><a
href="build-system.html">Polygene⢠Build System</a></span></dt><dt><span
class="section"><span xmlns="" href="community-docs.html">Polygeneâ¢
Documentation</span></span></dt><dt><span class="sectio
n"><a href="releasing-apache.html">Releasing
Polygeneâ¢</a></span></dt></dl></div></div><div class="section"
title="Polygene⢠Documentation"><div class="titlepage"><div><div><h3
class="title"><a id="community-docs"></a>Polygeneâ¢
Documentation</h3></div></div></div><p>The documents use the asciidoc format,
see:</p><div class="itemizedlist"><ul class="itemizedlist"><li class="listitem">
+ </head><body><div xmlns="" xmlns:exsl="http://exslt.org/common";
class="logo"><a href="index.html"><img src="images/logo-standard.png"
style="width:80%;height:80%; padding-top:20px;" /></a></div><div xmlns=""
xmlns:exsl="http://exslt.org/common"; class="top-nav"><div
xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl class="toc"><dt><span
class="section"><a href="index.html#home">Polygeneâ¢</a></span></dt><dt><span
class="section"><a href="intro.html">Introduction</a></span></dt><dt><span
class="section"><span xmlns=""
href="tutorials.html">Tutorials</span></span></dt><dt><span class="section"><a
href="javadocs.html">Javadoc</a></span></dt><dt><span class="section"><a
href="samples.html">Samples</a></span></dt><dt><span class="section"><a
href="core.html">Core</a></span></dt><dt><span class="section"><a
href="libraries.html">Libraries</a></span></dt><dt><span class="section"><a
href="extensions.html">Extensions</a></span></dt><dt><span class="section"><a
href="tools.html">Tools</
a></span></dt><dt><span class="section"><a href="glossary.html">GlossaryÂ
</a></span></dt></dl></div></div><div xmlns=""
xmlns:exsl="http://exslt.org/common"; class="sub-nav"><div
xmlns="http://www.w3.org/1999/xhtml"; class="toc"><dl class="toc"><dt><span
class="section"><a
href="tutorials.html#_overview">Overview</a></span></dt><dt><span
class="section"><a href="two-minutes-intro.html">Polygene⢠in 2
minutes</a></span></dt><dt><span class="section"><a
href="ten-minutes-intro.html">Polygene⢠in 10
minutes</a></span></dt><dt><span class="section"><a
href="thirty-minutes-intro.html">Polygene⢠in 30
minutes</a></span></dt><dt><span class="section"><a
href="howto-depend-on-polygene.html">Depend on
Polygeneâ¢</a></span></dt><dt><span class="section"><a
href="howto-assemble-application.html">Assemble an
Application</a></span></dt><dt><span class="section"><a
href="tut-composites.html">Transient Composites
Tutorial</a></span></dt><dt><span class="section"><a href="tut-services.html">S
ervices Composites Tutorial</a></span></dt><dt><span class="section"><a
href="howto-contextual-fragments.html">Use contextual
fragments</a></span></dt><dt><span class="section"><a
href="howto-leverage-properties.html">Leverage
Properties</a></span></dt><dt><span class="section"><a
href="howto-create-constraint.html">Create a
Constraint</a></span></dt><dt><span class="section"><a
href="howto-create-concern.html">Create a Concern</a></span></dt><dt><span
class="section"><a href="howto-create-sideeffect.html">Create a
SideEffect</a></span></dt><dt><span class="section"><a
href="howto-create-entity.html">Create an Entity</a></span></dt><dt><span
class="section"><a href="howto-configure-service.html">Configure a
Service</a></span></dt><dt><span class="section"><a
href="howto-invocation-annotation.html">Use
@Invocation</a></span></dt><dt><span class="section"><a
href="build-system.html">Polygene⢠Build System</a></span></dt><dt><span
class="section"><span xmlns="" href="community-docs.h
tml">Polygene⢠Documentation</span></span></dt><dt><span class="section"><a
href="releasing-apache.html">Releasing
Polygeneâ¢</a></span></dt></dl></div></div><div class="section"><div
class="titlepage"><div><div><h3 class="title"><a
id="community-docs"></a>Polygene⢠Documentation</h3></div></div></div><p>The
documents use the asciidoc format, see:</p><div class="itemizedlist"><ul
class="itemizedlist" type="disc"><li class="listitem">
<a class="ulink" href="http://www.methods.co.nz/asciidoc/";
target="_top">Aciidoc Reference</a>
</li><li class="listitem">
<a class="ulink" href="http://powerman.name/doc/asciidoc";
target="_top">AsciiDoc cheatsheet</a>
-</li></ul></div><p>The cheatsheet is really useful!</p><p>You need to install
<code class="literal">asciidoc</code> and <code
class="literal">docbook-xsl</code>.</p><div class="section" title="Overall
Flow"><div class="titlepage"><div><div><h4 class="title"><a
id="community-docs-overall-flow"></a>Overall Flow</h4></div></div></div><div
class="tip" title="Tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Tip</h3><p>To generate the website locally use <code
class="literal">./gradlew website</code>. Output is in <code
class="literal">~/manual/build/docs/website</code>.</p></div><p>Each
(sub)project has its own documentation, in <span
class="emphasis"><em>src/docs/</em></span> and all the Asciidoc documents have
the <code class="literal">.txt</code> file extension.</p><p>The documents can
use code snippets which will extract code from the project. This is preferred
way to include
+</li></ul></div><p>The cheatsheet is really useful!</p><p>You need to install
<code class="literal">asciidoc</code> and <code
class="literal">docbook-xsl</code>.</p><div class="section"><div
class="titlepage"><div><div><h4 class="title"><a
id="community-docs-overall-flow"></a>Overall Flow</h4></div></div></div><div
class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Tip</h3><p>To generate the website locally use <code
class="literal">./gradlew website</code>. Output is in <code
class="literal">~/manual/build/docs/website</code>.</p></div><p>Each
(sub)project has its own documentation, in <span
class="emphasis"><em>src/docs/</em></span> and all the Asciidoc documents have
the <code class="literal">.txt</code> file extension.</p><p>The documents can
use code snippets which will extract code from the project. This is preferred
way to include
source code in the documentation, since any refactoring will be reflected in
the documentation.</p><p>The above files are all consumed by the build of the
manual (by adding them as dependencies).
To get content included in the manual, it has to be explicitly included by a
document in the manual as well.</p><p>The whole documentation set is generated
from the <span class="emphasis"><em>*manual*</em></span> module in the SDK, and
we are currently only creating the website.
-The User Guide and Reference Manual are future projects.</p></div><div
class="section" title="Headings and document structure"><div
class="titlepage"><div><div><h4 class="title"><a
id="_headings_and_document_structure"></a>Headings and document
structure</h4></div></div></div><p>Each document starts over with headings from
level zero (the document title).
+The User Guide and Reference Manual are future projects.</p></div><div
class="section"><div class="titlepage"><div><div><h4 class="title"><a
id="_headings_and_document_structure"></a>Headings and document
structure</h4></div></div></div><p>Each document starts over with headings from
level zero (the document title).
Each document should have an id.
In some cases sections in the document need to have idâs as well, this
depends on where they fit in the overall structure.
To be able to link to content, it has to have an id.
@@ -85,9 +85,9 @@ attribute is used when including the document inside of
another document.</p><p>
=== Subsubheading ===
-content here ...</pre><p>Asciidoc comes with one more syntax for headings, but
in this project itâs not used.</p></div><div class="section"
title="Writing"><div class="titlepage"><div><div><h4 class="title"><a
id="_writing"></a>Writing</h4></div></div></div><p>Try to put one sentence on
each line.
+content here ...</pre><p>Asciidoc comes with one more syntax for headings, but
in this project itâs not used.</p></div><div class="section"><div
class="titlepage"><div><div><h4 class="title"><a
id="_writing"></a>Writing</h4></div></div></div><p>Try to put one sentence on
each line.
Lines without empty lines between them still belongs to the same paragraph.
-This makes it easy to move content around, and also easy to spot (too) long
sentences.</p></div><div class="section" title="Gotchas"><div
class="titlepage"><div><div><h4 class="title"><a
id="_gotchas"></a>Gotchas</h4></div></div></div><div class="itemizedlist"><ul
class="itemizedlist"><li class="listitem">
+This makes it easy to move content around, and also easy to spot (too) long
sentences.</p></div><div class="section"><div class="titlepage"><div><div><h4
class="title"><a id="_gotchas"></a>Gotchas</h4></div></div></div><div
class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
A chapter canât be empty. (the build will fail on the docbook xml validity
check)
</li><li class="listitem">
The document title should be "underlined" by the same
@@ -100,8 +100,8 @@ Always leave a blank line at the end of documents
As <code class="literal">{}</code> are used for Asciidoc attributes,
everything inside will be treated as an attribute.
What you have to do is to escape the opening brace: <code
class="literal">\{</code>.
If you donât, the braces and the text inside them will be removed without
any warning being issued!
-</li></ul></div></div><div class="section" title="Links"><div
class="titlepage"><div><div><h4 class="title"><a
id="_links"></a>Links</h4></div></div></div><p>To link to other parts of the
manual the id of the target is used.
-This is how such a reference looks:</p><pre class="programlisting brush:
plain"><<community-docs-overall-flow>></pre><p>Which will render
like: <a class="xref" href="community-docs.html#community-docs-overall-flow"
title="Overall Flow">Documentation Flow</a></p><div class="note" title="Note"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Note</h3><p>Just write "see <<target-id>>" and
similar, thatâs enough in most cases.</p></div><p>If you need to link to
another document with your own link text, this is what to do:</p><pre
class="programlisting brush: plain"><<target-id, link text that fits in
the context>></pre><div class="note" title="Note" style="margin-left:
0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Having lots of
linked text may work well in a web context but is a pain in print, and we aim
for both!</p></div><p>External links are added like this:</p><pre
class="programlisting brush: plain">https://polyg
ene.apache.org/[Link text here]</pre><p>Which renders like: <a class="ulink"
href="https://polygene.apache.org/"; target="_top">Link text here</a></p><p>For
short links it may be better not to add a link text, just do:</p><pre
class="programlisting brush: plain">https://polygene.apache.org/</pre><p>Which
renders like: <a class="ulink" href="https://polygene.apache.org/";
target="_top">https://polygene.apache.org/</a></p><p>Itâs ok to have a dot
right after the URL, it wonât be part of the link.</p><pre
class="programlisting brush: plain">https://polygene.apache.org/.</pre><p>Which
renders like: <a class="ulink" href="https://polygene.apache.org/";
target="_top">https://polygene.apache.org/</a>.</p></div><div class="section"
title="Text Formatting"><div class="titlepage"><div><div><h4 class="title"><a
id="_text_formatting"></a>Text Formatting</h4></div></div></div><div
class="itemizedlist"><ul class="itemizedlist"><li class="listitem">
+</li></ul></div></div><div class="section"><div
class="titlepage"><div><div><h4 class="title"><a
id="_links"></a>Links</h4></div></div></div><p>To link to other parts of the
manual the id of the target is used.
+This is how such a reference looks:</p><pre class="programlisting brush:
plain"><<community-docs-overall-flow>></pre><p>Which will render
like: <a class="xref" href="community-docs.html#community-docs-overall-flow"
title="Overall Flow">Documentation Flow</a></p><div class="note"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Note</h3><p>Just write "see <<target-id>>" and
similar, thatâs enough in most cases.</p></div><p>If you need to link to
another document with your own link text, this is what to do:</p><pre
class="programlisting brush: plain"><<target-id, link text that fits in
the context>></pre><div class="note" style="margin-left: 0.5in;
margin-right: 0.5in;"><h3 class="title">Note</h3><p>Having lots of linked text
may work well in a web context but is a pain in print, and we aim for
both!</p></div><p>External links are added like this:</p><pre
class="programlisting brush: plain">https://polygene.apache.org/[Link text
here]</pre><p>Which renders like: <a class="ulink"
href="https://polygene.apache.org/"; target="_top">Link text here</a></p><p>For
short links it may be better not to add a link text, just do:</p><pre
class="programlisting brush: plain">https://polygene.apache.org/</pre><p>Which
renders like: <a class="ulink" href="https://polygene.apache.org/";
target="_top">https://polygene.apache.org/</a></p><p>Itâs ok to have a dot
right after the URL, it wonât be part of the link.</p><pre
class="programlisting brush: plain">https://polygene.apache.org/.</pre><p>Which
renders like: <a class="ulink" href="https://polygene.apache.org/";
target="_top">https://polygene.apache.org/</a>.</p></div><div
class="section"><div class="titlepage"><div><div><h4 class="title"><a
id="_text_formatting"></a>Text Formatting</h4></div></div></div><div
class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<span class="strong"><strong>Bold</strong></span> - just donât do it, the
editor in charge is likely to remove it anyhow!
</li><li class="listitem">
_Italics_ is rendered as <span class="emphasis"><em>Italics</em></span>
@@ -111,14 +111,14 @@ _Italics_ is rendered as <span
class="emphasis"><em>Italics</em></span>
`command` is rendered as <code class="literal">command</code> (typically used
for command-line)
</li><li class="listitem">
'my/path/' is rendered as <span class="emphasis"><em>my/path/</em></span>
(used for file names and paths)
-</li></ul></div></div><div class="section" title="Admonitions"><div
class="titlepage"><div><div><h4 class="title"><a
id="_admonitions"></a>Admonitions</h4></div></div></div><p>These are very
useful and should be used where appropriate.
-Choose from the following (write all caps and no, we canât easily add new
ones):</p><div class="note" title="Note" style="margin-left: 0.5in;
margin-right: 0.5in;"><h3 class="title">Note</h3><p>Note.</p></div><div
class="tip" title="Tip" style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Tip</h3><p>Tip.</p></div><div class="important" title="Important"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Important</h3><p>Important</p></div><div class="caution"
title="Caution" style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Caution</h3><p>Caution</p></div><div class="warning"
title="Warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Warning</h3><p>Warning</p></div><p>Hereâs how itâs
done:</p><pre class="programlisting brush: plain">NOTE: Note.</pre><p>A
multiline variation:</p><pre class="programlisting brush: plain">[TIP]
+</li></ul></div></div><div class="section"><div
class="titlepage"><div><div><h4 class="title"><a
id="_admonitions"></a>Admonitions</h4></div></div></div><p>These are very
useful and should be used where appropriate.
+Choose from the following (write all caps and no, we canât easily add new
ones):</p><div class="note" style="margin-left: 0.5in; margin-right:
0.5in;"><h3 class="title">Note</h3><p>Note.</p></div><div class="tip"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Tip</h3><p>Tip.</p></div><div class="important"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Important</h3><p>Important</p></div><div class="caution"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Caution</h3><p>Caution</p></div><div class="warning"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Warning</h3><p>Warning</p></div><p>Hereâs how itâs
done:</p><pre class="programlisting brush: plain">NOTE: Note.</pre><p>A
multiline variation:</p><pre class="programlisting brush: plain">[TIP]
Tiptext.
-Line 2.</pre><p>Which is rendered as:</p><div class="tip" title="Tip"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Tip</h3><p>Tiptext.
-Line 2.</p></div></div><div class="section" title="Images"><div
class="titlepage"><div><div><h4 class="title"><a
id="_images"></a>Images</h4></div></div></div><div class="important"
title="Important" style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Important</h3><p><span class="emphasis"><em>All images in the
entire manual share the same namespace.</em></span></p></div><div
class="section" title="Images Files"><div class="titlepage"><div><div><h5
class="title"><a id="_images_files"></a>Images
Files</h5></div></div></div><p>To include an image file, make sure it resides
in the <span class="emphasis"><em>images/</em></span> directory relative to the
document youâre including it from.
+Line 2.</pre><p>Which is rendered as:</p><div class="tip" style="margin-left:
0.5in; margin-right: 0.5in;"><h3 class="title">Tip</h3><p>Tiptext.
+Line 2.</p></div></div><div class="section"><div
class="titlepage"><div><div><h4 class="title"><a
id="_images"></a>Images</h4></div></div></div><div class="important"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Important</h3><p><span class="emphasis"><em>All images in the
entire manual share the same namespace.</em></span></p></div><div
class="section"><div class="titlepage"><div><div><h5 class="title"><a
id="_images_files"></a>Images Files</h5></div></div></div><p>To include an
image file, make sure it resides in the <span
class="emphasis"><em>images/</em></span> directory relative to the document
youâre including it from.
Then go:</p><pre class="programlisting brush:
plain">image::logo-standard.png[]</pre><p>Which is rendered as:</p><div
class="informalfigure"><a class="ulink" href="images/logo-standard.png"
target="_top">
<span class="inlinemediaobject"><img src="images/logo-standard.png"
alt="logo-standard.png" /></span>
-</a></div><p>Please note that the <span
class="emphasis"><em>images/</em></span> directory is added automatically and
not part of the link.</p><p>There are also global resources, residing in <span
class="emphasis"><em>manual/src/resources</em></span>, which will be copied to
the root of the documentation.</p></div></div><div class="section" title="Code
Snippets"><div class="titlepage"><div><div><h4 class="title"><a
id="_code_snippets"></a>Code Snippets</h4></div></div></div><div
class="section" title="Import from codebase"><div
class="titlepage"><div><div><h5 class="title"><a
id="_import_from_codebase"></a>Import from
codebase</h5></div></div></div><p>Most source code that is included in the
documentation should be extract via <code class="literal">SNIPPET</code>
markers and then included in document with;</p><pre class="programlisting
brush: plain"> [snippet,java]
+</a></div><p>Please note that the <span
class="emphasis"><em>images/</em></span> directory is added automatically and
not part of the link.</p><p>There are also global resources, residing in <span
class="emphasis"><em>manual/src/resources</em></span>, which will be copied to
the root of the documentation.</p></div></div><div class="section"><div
class="titlepage"><div><div><h4 class="title"><a id="_code_snippets"></a>Code
Snippets</h4></div></div></div><div class="section"><div
class="titlepage"><div><div><h5 class="title"><a
id="_import_from_codebase"></a>Import from
codebase</h5></div></div></div><p>Most source code that is included in the
documentation should be extract via <code class="literal">SNIPPET</code>
markers and then included in document with;</p><pre class="programlisting
brush: plain"> [snippet,java]
-----------
source=tutorials/introduction/tenminutes/src/main/java/org/apache/polygene/demo/tenminute/OrderEntity.java
tag=mainClass
@@ -149,7 +149,7 @@ public interface OrderEntity
</pre><p>Note that
1. The START and END doesnât need to be matching.
1. The AsciiDoc plugin will remove the <span class="emphasis"><em>START
SNIPPET</em></span> and <span class="emphasis"><em>END SNIPPET</em></span>
lines.
-1. If you have more than one START/END section with the same tag, the plugin
will insert a "[â¦snipâ¦]" for the excluded lines.</p></div><div
class="section" title="Explicitly defined in the document"><div
class="titlepage"><div><div><h5 class="title"><a
id="_explicitly_defined_in_the_document"></a>Explicitly defined in the
document</h5></div></div></div><div class="warning" title="Warning"
style="margin-left: 0.5in; margin-right: 0.5in;"><h3
class="title">Warning</h3><p>Use this kind of code snippets as little as
possible.
+1. If you have more than one START/END section with the same tag, the plugin
will insert a "[â¦snipâ¦]" for the excluded lines.</p></div><div
class="section"><div class="titlepage"><div><div><h5 class="title"><a
id="_explicitly_defined_in_the_document"></a>Explicitly defined in the
document</h5></div></div></div><div class="warning" style="margin-left: 0.5in;
margin-right: 0.5in;"><h3 class="title">Warning</h3><p>Use this kind of code
snippets as little as possible.
They are well known to get out of sync with reality after a
while.</p></div><p>This is how to do it:</p><pre class="programlisting brush:
plain"> [source,java]
----
HashMap<String,String> result = new HashMap<String,String>();
@@ -163,7 +163,7 @@ public interface OrderEntity
{
if( !"".equals( name ) )
result.put( name, value );
- }</pre></div><div class="section" title="Source code Highlighting"><div
class="titlepage"><div><div><h5 class="title"><a
id="_source_code_highlighting"></a>Source code
Highlighting</h5></div></div></div><p>If thereâs no suitable syntax
highlighter, just omit the language: <code
class="literal">[source]</code>.</p><p>Currently the following syntax
highlighters are enabled:</p><div class="itemizedlist"><ul
class="itemizedlist"><li class="listitem">
+ }</pre></div><div class="section"><div class="titlepage"><div><div><h5
class="title"><a id="_source_code_highlighting"></a>Source code
Highlighting</h5></div></div></div><p>If thereâs no suitable syntax
highlighter, just omit the language: <code
class="literal">[source]</code>.</p><p>Currently the following syntax
highlighters are enabled:</p><div class="itemizedlist"><ul class="itemizedlist"
type="disc"><li class="listitem">
Bash
</li><li class="listitem">
Groovy
@@ -179,9 +179,9 @@ Ruby
Scala
</li><li class="listitem">
XML
-</li></ul></div><p>For other highlighters we could add see <a class="ulink"
href="http://alexgorbatchev.com/SyntaxHighlighter/manual/brushes/";
target="_top">http://alexgorbatchev.com/SyntaxHighlighter/manual/brushes/</a>.</p></div></div><div
class="section" title="Attributes"><div class="titlepage"><div><div><h4
class="title"><a
id="_attributes"></a>Attributes</h4></div></div></div><p>Common attributes you
can use in documents:</p><div class="itemizedlist"><ul class="itemizedlist"><li
class="listitem">
+</li></ul></div><p>For other highlighters we could add see <a class="ulink"
href="http://alexgorbatchev.com/SyntaxHighlighter/manual/brushes/";
target="_top">http://alexgorbatchev.com/SyntaxHighlighter/manual/brushes/</a>.</p></div></div><div
class="section"><div class="titlepage"><div><div><h4 class="title"><a
id="_attributes"></a>Attributes</h4></div></div></div><p>Common attributes you
can use in documents:</p><div class="itemizedlist"><ul class="itemizedlist"
type="disc"><li class="listitem">
</li><li class="listitem">
-</li></ul></div><p>These can substitute part of URLs that point to for example
APIdocs or source code.</p></div><div class="section" title="Toolchain"><div
class="titlepage"><div><div><h4 class="title"><a
id="_toolchain"></a>Toolchain</h4></div></div></div><p>Useful links when
configuring the docbook toolchain:</p><div class="itemizedlist"><ul
class="itemizedlist"><li class="listitem">
+</li></ul></div><p>These can substitute part of URLs that point to for example
APIdocs or source code.</p></div><div class="section"><div
class="titlepage"><div><div><h4 class="title"><a
id="_toolchain"></a>Toolchain</h4></div></div></div><p>Useful links when
configuring the docbook toolchain:</p><div class="itemizedlist"><ul
class="itemizedlist" type="disc"><li class="listitem">
<a class="ulink" href="http://www.methods.co.nz/asciidoc";
target="_top">http://www.methods.co.nz/asciidoc</a>
</li><li class="listitem">
<a class="ulink" href="http://powerman.name/doc/asciidoc";
target="_top">http://powerman.name/doc/asciidoc</a>
