Minor style changes and improve JBI component doc proposal
git-svn-id: https://svn.apache.org/repos/asf/servicemix/documentation/trunk@1028119 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/webapp/WEB-INF/scalate/layouts/default.ssp b/src/main/webapp/WEB-INF/scalate/layouts/default.ssp
index 9cc8733..9f7dced 100644
--- a/src/main/webapp/WEB-INF/scalate/layouts/default.ssp
+++ b/src/main/webapp/WEB-INF/scalate/layouts/default.ssp
@@ -26,7 +26,7 @@
<head>
<title>${title}</title>
- <link href="${uri("/theme/master.css")}" rel="Stylesheet" type="text/css" />
+ <link href="${uri("/theme/master.css")}" rel="stylesheet" type="text/css" />
<link href="${uri("/theme/pygmentize.css")}" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="${uri("/scripts/jquery.js")}"></script>
diff --git a/src/main/webapp/WEB-INF/scalate/layouts/print.ssp b/src/main/webapp/WEB-INF/scalate/layouts/print.ssp
index fa62737..58ec091 100644
--- a/src/main/webapp/WEB-INF/scalate/layouts/print.ssp
+++ b/src/main/webapp/WEB-INF/scalate/layouts/print.ssp
@@ -16,7 +16,7 @@
limitations under the License.
--%>
<%@ var body: String %>
-<%@ var title: String = "Apache ServiceMix ${servicemix.version}" %>
+<%@ var title: String = "Manual" %>
<% escapeMarkup = false %>
<!DOCTYPE html>
<html>
@@ -28,8 +28,11 @@
</head>
<body>
<div id="titlepage">
- <div id="title">Apache ServiceMix</div>
- <div id="subtitle">Version ${servicemix.version}</div>
+ <div id="title"><%= title %></div>
+ <div id="subtitle">
+ Apache ServiceMix <br/>
+ Version ${servicemix.version}
+ </div>
</div>
<div id="main">
<%= body %>
diff --git a/src/main/webapp/jbi/components/servicemix-saxon.conf b/src/main/webapp/jbi/components/servicemix-saxon.conf
index dacb859..3c0cc33 100644
--- a/src/main/webapp/jbi/components/servicemix-saxon.conf
+++ b/src/main/webapp/jbi/components/servicemix-saxon.conf
@@ -15,11 +15,11 @@
h4. Endpoint types
The servicemix-saxon component defines these endpoints:
-- {{saxon:xslt}} :: Translates the in message content using XSLT to send back the translated content in the out message
-- {{saxon:proxy}} :: Acts as a proxy for an endpoint, translating the message passed to/from the endpoint using XSLT
-- {{saxon:xquery}} :: Use xquery to extract parts of the XML
+* [{{saxon:xslt}}|#xslt]: Translates the in message content using XSLT to send back the translated content in the out message
+* {{saxon:proxy}}: Acts as a proxy for an endpoint, translating the message passed to/from the endpoint using XSLT
+* {{saxon:xquery}}: Use xquery to extract parts of the XML
-h3. Endpoint {{saxon:xslt}}
+h3. Endpoint {{saxon:xslt}} {anchor:xslt}
The XSLT endpoint can be used to apply an XSLT stylesheet to the incoming exchange and will return the transformed result as the output message.
{pygmentize:lang=xml}
@@ -29,25 +29,27 @@
h4. Mandatory properties
The endpoint requires one of these two properties to be specified:
-- {{resource}} ([Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html]) :: the spring resource pointing to the XSLT stylesheet
-- {{expression}} ([ServiceMix expression|http://incubator.apache.org/servicemix/dist/servicemix-3.0-incubating/site/servicemix-core/apidocs/org/apache/servicemix/expression/Expression.html]) :: expression used to dynamically load the stylesheet
+|| Attribute || Type || description ||
+| {{resource}} | ([Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html]) | the spring resource pointing to the XSLT stylesheet |
+| {{expression}} | ([ServiceMix expression|http://incubator.apache.org/servicemix/dist/servicemix-3.0-incubating/site/servicemix-core/apidocs/org/apache/servicemix/expression/Expression.html]) | expression used to dynamically load the stylesheet |
h4. Optional properties
-- {{wsdlResource}} ([Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html]) :: if set, the wsdl will be retrieved from the given Spring resource
-- {{transformerFactory}} (TransformerFactory, defaults to the Saxon implementation) :: TraX factory to create transformers
-- {{configuration}} ([Saxon configuration|http://www.saxonica.com/documentation/javadoc/net/sf/saxon/Configuration.html]) :: Saxon configuration object
-- {{result}} (String, defaults to {{dom}}) :: Allows specifying the output result type, possible values are {{dom}}, {{bytes}}, {{string}}
-- {{copyAttachments}}, {{copyProperties}} and {{copySubject}} (default to {{true}} :: Configure to copy message attachments, properties and security subject over to the result message
-- {{useDomSourceForXslt}} (defaults to {{true}} :: when set to {{true}}, forces the transformation of the xslt stylesheet into a DOM document before giving it to the transformer
-- {{useDomSourceForContent}} (defaults to {{false}}) :: when set to {{true}}, forces the transformation of the incoming JBI message into a DOM document before giving it to the transformer
-- {{parameters}} :: a {{Map}} containing additional parameters to give to the transformation engine
+|| Attribute || Type || description ||
+| {{wsdlResource}} |([Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html]) | if set, the wsdl will be retrieved from the given Spring resource |
+| {{transformerFactory}} | (TransformerFactory, defaults to the Saxon implementation) | TraX factory to create transformers |
+| {{configuration}} | ([Saxon configuration|http://www.saxonica.com/documentation/javadoc/net/sf/saxon/Configuration.html]) | Saxon configuration object |
+| {{result}} | (String, defaults to {{dom}}) | Allows specifying the output result type, possible values are {{dom}}, {{bytes}}, {{string}} |
+| {{copyAttachments}}, {{copyProperties}} and {{copySubject}} | (default to {{true}} | Configure to copy message attachments, properties and security subject over to the result message |
+| {{useDomSourceForXslt}} | (defaults to {{true}} | when set to {{true}}, forces the transformation of the xslt stylesheet into a DOM document before giving it to the transformer |
+| {{useDomSourceForContent}} | (defaults to {{false}}) | when set to {{true}}, forces the transformation of the incoming JBI message into a DOM document before giving it to the transformer |
+| {{parameters}} | a {{Map}} | containing additional parameters to give to the transformation engine |
h4. Using properties and parameters
All properties defined on the JBI exchange and input JBI message will be available for use inside the XSLT stylesheet as parameters.
In addition to those properties and the one specified in the {{parameters}} property on the endpoint, the following objects are also available:
-- {{exchange}} :: the JBI exchange
-- {{in}} :: the input JBI NormalizedMessage
-- {{component}} :: the XsltEndpoint instance being called
+* {{exchange}} : the JBI exchange
+* {{in}} : the input JBI NormalizedMessage
+* {{component}} : the XsltEndpoint instance being called
All those parameters can be accessed using XSLT standard ways using {{<xsl:param/>}}.
@@ -66,20 +68,22 @@
h4. Mandatory properties
Depending on the MEP, you have to set one or more XSL stylesheets to be used for converting the message payloads:
-- {{resource}} :: [Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html] pointing to the XSLT stylesheet used to transform the input message
-- {{outResource}} :: [Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html] pointing to the XSLT stylesheet used to transform the output message
-- {{faultResource}} :: [Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html] pointing to the XSLT stylesheet used to transform the fault message
-- {{expression}} :: [ServiceMix expression|http://incubator.apache.org/servicemix/dist/servicemix-3.0-incubating/site/servicemix-core/apidocs/org/apache/servicemix/expression/Expression.html] used to dynamically load the stylesheet. If set, it will prevail against all resource, outResource and faultResource attributes
+|| Attribute || Type || Description ||
+| {{resource}} | [Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html] | the XSLT stylesheet used to transform the input message |
+| {{outResource}} | [Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html] | the XSLT stylesheet used to transform the output message |
+| {{faultResource}} | [Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html] | the XSLT stylesheet used to transform the fault message |
+| {{expression}} | [ServiceMix expression|http://incubator.apache.org/servicemix/dist/servicemix-3.0-incubating/site/servicemix-core/apidocs/org/apache/servicemix/expression/Expression.html] | used to dynamically load the stylesheet. If set, it will prevail against all resource, outResource and faultResource attributes |
You also have to specify the target service that should be invoked from this endpoint:
-- {{target}} :: ExchangeTarget that specifies the target service for the proxy endpoint
+* {{target}} : ExchangeTarget that specifies the target service for the proxy endpoint
h4. Optional properties
-- {{wsdlResource}} :: if set, the wsdl will be retrieved from the given ([Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html])
-- {{transformerFactory}} (defaults to the Saxon implementation) :: TraX TransformerFactory to create transformers
-- {{configuration}} ([Saxon configuration|http://www.saxonica.com/documentation/javadoc/net/sf/saxon/Configuration.html]) :: Saxon configuration object
-- {{result}} (defaults to {{dom}}) :: Allows specifying the output result type, possible values are {{dom}}, {{bytes}}, {{string}}
-- {{copyAttachments}}, {{copyProperties}} and {{copySubject}} (default to {{true}}) :: Configure to copy message attachments, properties and security subject over to the result message
+|| Attribute || Type || Description ||
+| {{wsdlResource}} | [Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html] | if set, the wsdl will be retrieved from the given ([Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html]) |
+| {{transformerFactory}} (defaults to the Saxon implementation) :: TraX TransformerFactory to create transformers
+| {{configuration}} | ([Saxon configuration|http://www.saxonica.com/documentation/javadoc/net/sf/saxon/Configuration.html]) | Saxon configuration object |
+| {{result}} | (defaults to {{dom}}) :: Allows specifying the output result type, possible values are {{dom}}, {{bytes}}, {{string}}
+| {{copyAttachments}}, {{copyProperties}} and {{copySubject}} | (default to {{true}}) | Configure to copy message attachments, properties and security subject over to the result message |
h3. Endpoint {{saxon:xquery}}
The XQuery endpoint can be used to apply a selected XQuery to the input document.
@@ -90,19 +94,21 @@
h4. Mandatory properties
You need to specify one of {{query}}, {{resource}} or {{expression}}
-- {{query}} :: String containing the inlined XQuery expression
-- {{resource}} :: [Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html] resource pointing to the XQuery
-- {{expression}} :: | [ServiceMix expression|http://incubator.apache.org/servicemix/dist/servicemix-3.0-incubating/site/servicemix-core/apidocs/org/apache/servicemix/expression/Expression.html] to dynamically load the xquery
+|| Attribute || Type || Description ||
+| {{query}} | String | containing the inlined XQuery expression |
+| {{resource}} | [Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html] | resource pointing to the XQuery |
+| {{expression}} | [ServiceMix expression|http://incubator.apache.org/servicemix/dist/servicemix-3.0-incubating/site/servicemix-core/apidocs/org/apache/servicemix/expression/Expression.html] | expression to dynamically load the xquery |
h4. Optional properties
-- {{wsdlResource}} :: if set, the wsdl will be retrieved from the given ([Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html])
-- {{outputProperties}} :: Map containing the Saxon specific output properties
-- {{configuration}} ([Saxon configuration|http://www.saxonica.com/documentation/javadoc/net/sf/saxon/Configuration.html]) :: Saxon configuration object
-- {{result}} (defaults to {{dom}}) :: Allows specifying the output result type, possible values are {{dom}}, {{bytes}}, {{string}}
-- {{copyAttachments}}, {{copyProperties}} and {{copySubject}} (default to {{true}}) :: Configure to copy message attachments, properties and security subject over to the result message
+|| Attribute || Type || Description ||
+| {{wsdlResource}} | ([Spring resource|http://springframework.org/docs/api/org/springframework/core/io/Resource.html]) | WSDL describing the endpoint |
+| {{outputProperties}} | Map | Saxon specific output properties |
+| {{configuration}} | ([Saxon configuration|http://www.saxonica.com/documentation/javadoc/net/sf/saxon/Configuration.html]) | Saxon configuration object |
+| {{result}} | (defaults to {{dom}}) | Allows specifying the output result type, possible values are {{dom}}, {{bytes}}, {{string}} |
+| {{copyAttachments}}, {{copyProperties}} and {{copySubject}} | (default to {{true}}) | Configure to copy message attachments, properties and security subject over to the result message |
h3. Sample configurations
-h4. {{saxon:xslt}} : Dynamic stylesheet selection
+h4. Dynamic stylesheet selection ({{saxon:xslt}})
This endpoint configuration will dynamically load the XSL-T resource that is specified in the {{xslt.source}} property on the {{NormalizedMessage}}
{pygmentize:lang=xml}
<saxon:xslt service="test:xslt-dynamic" endpoint="endpoint">
@@ -114,7 +120,7 @@
</saxon:xslt>
{pygmentize}
-h4. {{saxon:xslt}} : Using parameters in the XSL-T stylesheet
+h4. Using parameters in the XSL-T stylesheet ({{saxon:xslt}})
You can define a Map of parameters on the {{saxon:xslt}} endpoint.
{pygmentize:lang=xml}
<saxon:xslt service="test:xslt-params" endpoint="endpoint"
@@ -142,7 +148,7 @@
</xsl:stylesheet>
{pygmentize}
-h4. {{saxon:xquery}} : Inlined XQuery and specific output configuration
+h4. Inlined XQuery and specific output configuration ({{saxon:xquery}})
{pygmentize:lang=xml}
<saxon:xquery service="test:xquery-inline" endpoint="endpoint">
<saxon:query>
@@ -156,7 +162,7 @@
</saxon:xquery>
{pygmentize}
-h4. {{saxon:xquery}} : Dynamic XQuery selection
+h4. Dynamic XQuery selection ({{saxon:xquery}})
This endpoint configuration will dynamically load the XQuery resource that is specified in the {{xquery.source}} property on the {{NormalizedMessage}}
{pygmentize:lang=xml}
<saxon:xquery service="test:xquery-dynamic" endpoint="endpoint">
diff --git a/src/main/webapp/jbi/jbi-guide.conf b/src/main/webapp/jbi/jbi-guide.conf
index 682a5e3..2ec8943 100644
--- a/src/main/webapp/jbi/jbi-guide.conf
+++ b/src/main/webapp/jbi/jbi-guide.conf
@@ -1,4 +1,5 @@
{attributes:layout=/WEB-INF/scalate/layouts/print.ssp}
+{attributes:title=JBI User's Guide}
h1. Introduction to JBI
{include:jbi/intro/what-is-jbi.conf}
diff --git a/src/main/webapp/theme/master.css b/src/main/webapp/theme/master.css
index ee60c4c..8b062d6 100644
--- a/src/main/webapp/theme/master.css
+++ b/src/main/webapp/theme/master.css
@@ -41,10 +41,49 @@
}
div#body {
- padding-left: 22.5em;
+ padding-left: 23.5em;
margin-bottom: 30px;
}
+div#body h2 {
+ margin-left: -1em;
+ padding-top: 10px;
+}
+
+div#body h3 {
+ padding-top: 20px;
+ margin-left: -1em;
+}
+
+div#body h4 {
+ padding-top: 10px;
+ padding-bottom: 5px;
+}
+
+div#body table tr {
+ border: solid thin black;
+}
+
+div#body table {
+ border-spacing: 0px 0px;
+ border: solid thin #777777;
+ margin-left: 1em;
+ width: 90%
+}
+
+div#body table tr td {
+ border: solid thin #ededed;
+ padding: 2px;
+ font-size: .9em;
+}
+
+div#body table tr th {
+ border: solid thin #ededed;
+ background-color: #ededed;
+ padding: 2px;
+ font-size: .9em;
+}
+
div#page {
border: solid thin black;
}
@@ -56,6 +95,8 @@
margin-left: 1em;
margin-right: 1em;
padding: .5em;
+ margin-top: .5em;
+ margin-bottom: .5em;
}
tt {
diff --git a/src/main/webapp/theme/print.css b/src/main/webapp/theme/print.css
index 160f2ee..be18003 100644
--- a/src/main/webapp/theme/print.css
+++ b/src/main/webapp/theme/print.css
@@ -35,6 +35,7 @@
}
div#titlepage div#subtitle {
+ margin-top: 2em;
text-align: right;
font-size: 2em;
}
@@ -72,6 +73,7 @@
table {
border-spacing: 0px 0px;
border: solid thin #777777;
+ width: 100%;
}
table tr td {
diff --git a/src/main/webapp/users-guide/manual.conf b/src/main/webapp/users-guide/manual.conf
index 0d9a4de..1e34a82 100644
--- a/src/main/webapp/users-guide/manual.conf
+++ b/src/main/webapp/users-guide/manual.conf
@@ -1,4 +1,5 @@
{attributes:layout=/WEB-INF/scalate/layouts/print.ssp}
+{attributes:title=User's Manual}
h1. Getting started
{include:users-guide/getting-started/what-is-smx4.conf}
