Modified: maven/doxia/website/content/developers/sink.html ============================================================================== --- maven/doxia/website/content/developers/sink.html (original) +++ maven/doxia/website/content/developers/sink.html Thu Dec 12 16:16:24 2024 @@ -2,29 +2,28 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from content/apt/developers/sink.apt at 2024-11-05 - | Rendered using Apache Maven Fluido Skin 1.12.0 + | Generated by Apache Maven Doxia Site Renderer 2.0.0 from content/apt/developers/sink.apt at 2024-12-12 + | Rendered using Apache Maven Fluido Skin 2.0.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> <meta name="author" content="Vincent Siveton" /> <meta name="date" content="2008-03-02" /> - <title>Doxia – Doxia Developers Centre</title> - <link rel="stylesheet" href="../css/apache-maven-fluido-1.12.0.min.css" /> + <title>Doxia Developers Centre â Doxia</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.1.min.css" /> <link rel="stylesheet" href="../css/site.css" /> <link rel="stylesheet" href="../css/print.css" media="print" /> - <script src="../js/apache-maven-fluido-1.12.0.min.js"></script> - + <script src="../js/apache-maven-fluido-2.0.1.min.js"></script> <!-- Matomo --> <script> var _paq = window._paq = window._paq || []; - _paq.push(['disableCookies']); - _paq.push(['trackPageView']); - _paq.push(['enableLinkTracking']); - + _paq.push(['disableCookies']); + _paq.push(['trackPageView']); + _paq.push(['enableLinkTracking']); + (function() { var u="https://analytics.apache.org/";; _paq.push(['setTrackerUrl', u+'/matomo.php']); @@ -39,19 +38,19 @@ <div class="container-fluid container-fluid-top"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" style="" /></a></div> - <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/doxia-logo.png" alt="Doxia" style="" /></a></div> + <div class="pull-left"><div id="bannerLeft"><h1><a href="https://www.apache.org/";><img class="class java.lang.Object" src="../../images/apache-maven-project.png" /></a></h1></div></div> + <div class="pull-right"><div id="bannerRight"><h1><a href=".././"><img class="class java.lang.Object" src="../images/doxia-logo.png" /> Doxia</a></h1></div></div> <div class="clear"><hr/></div> </div> <div id="breadcrumbs"> <ul class="breadcrumb"> - <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> - <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li><a href="../index.html" title="Doxia">Doxia</a><span class="divider">/</span></li> - <li class="active ">Doxia Developers Centre <a href="https://github.com/apache/maven-doxia-site/tree/master/content/apt/developers/sink.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-11-05</li> - <li class="pull-right"><a href="../scm.html" title="Get Sources">Get Sources</a></li> + <li><a href="https://www.apache.org/"; class="externalLink">Apache</a><span class="divider">/</span></li> + <li><a href="../../index.html">Maven</a><span class="divider">/</span></li> + <li><a href="../index.html">Doxia</a><span class="divider">/</span></li> + <li class="active">Doxia Developers Centre <a href="https://github.com/apache/maven-doxia-site/tree/master/content/apt/developers/sink.apt";><img src="../images/accessories-text-editor.png" alt="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-07-04</li> + <li class="pull-right"><a href="../scm.html">Get Sources</a></li> </ul> </div> </header> @@ -60,71 +59,70 @@ <nav class="well sidebar-nav"> <ul class="nav nav-list"> <li class="nav-header">About Doxia</li> - <li><a href="../index.html" title="What is Doxia?"><span class="none"></span>What is Doxia?</a></li> - <li><a href="../overview.html" title="Overview"><span class="none"></span>Overview</a></li> - <li><a href="../downloads.html" title="Downloads"><span class="none"></span>Downloads</a></li> - <li><a href="../faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> + <li><a href="../index.html">What is Doxia?</a></li> + <li><a href="../overview.html">Overview</a></li> + <li><a href="../downloads.html">Downloads</a></li> + <li><a href="../faq.html">FAQ</a></li> <li class="nav-header">Documentation</li> - <li><a href="../references/index.html" title="Format References"><span class="icon-chevron-right"></span>Format References</a></li> - <li><a href="../modules/index.html" title="Doxia Modules Guide"><span class="none"></span>Doxia Modules Guide</a></li> - <li><a href="../macros/index.html" title="Doxia Macros Guide"><span class="none"></span>Doxia Macros Guide</a></li> - <li><a href="../book/index.html" title="Writing Books"><span class="none"></span>Writing Books</a></li> - <li><a href="../issues/index.html" title="Issues &amp; Gotchas"><span class="none"></span>Issues &amp; Gotchas</a></li> - <li><a href="../resources.html" title="External Resources"><span class="none"></span>External Resources</a></li> + <li><a href="../references/index.html"><span class="icon-chevron-right"></span>Format References</a></li> + <li><a href="../modules/index.html">Doxia Modules Guide</a></li> + <li><a href="../macros/index.html">Doxia Macros Guide</a></li> + <li><a href="../book/index.html">Writing Books</a></li> + <li><a href="../issues/index.html">Issues &amp; Gotchas</a></li> + <li><a href="../resources.html">External Resources</a></li> <li class="nav-header">Developer Docs</li> - <li><a href="../developers/index.html" title="Developer Centre"><span class="icon-chevron-down"></span>Developer Centre</a> + <li><a href="../developers/index.html"><span class="icon-chevron-down"></span>Developer Centre</a> <ul class="nav nav-list"> - <li><a href="../developers/modules.html" title="Create a Doxia Module"><span class="none"></span>Create a Doxia Module</a></li> - <li><a href="../developers/macros.html" title="Create a Doxia Macro"><span class="none"></span>Create a Doxia Macro</a></li> - <li class="active"><a><span class="none"></span>Using the Sink API</a></li> - <li><a href="../doxia/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> - <li><a href="../doxia-sitetools/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + <li><a href="../developers/modules.html">Create a Doxia Module</a></li> + <li><a href="../developers/macros.html">Create a Doxia Macro</a></li> + <li class="active"><a>Using the Sink API</a></li> + <li><a href="../doxia/index.html">Doxia base</a></li> + <li><a href="../doxia-sitetools/index.html">Doxia Sitetools</a></li> </ul></li> - <li><a href="../doxia-tools/index.html" title="Doxia Tools"><span class="none"></span>Doxia Tools</a></li> + <li><a href="../doxia-tools/index.html">Doxia Tools</a></li> <li class="nav-header">Project Documentation</li> - <li><a href="../project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li> + <li><a href="../project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> <li class="nav-header">Maven Projects</li> - <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> - <li><a href="../../archetypes/index.html" title="Archetypes"><span class="none"></span>Archetypes</a></li> - <li><a href="../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> - <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> - <li><a href="../../plugins/index.html" title="Plugins"><span class="none"></span>Plugins</a></li> - <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> - <li><a href="../" title="Components"><span class="icon-chevron-down"></span>Components</a> + <li><a href="../../ref/current">Maven</a></li> + <li><a href="../../archetypes/index.html">Archetypes</a></li> + <li><a href="../../extensions/index.html">Extensions</a></li> + <li><a href="../../pom/index.html">Parent POMs</a></li> + <li><a href="../../plugins/index.html">Plugins</a></li> + <li><a href="../../skins/index.html">Skins</a></li> + <li><a><span class="icon-chevron-down"></span>Components</a> <ul class="nav nav-list"> - <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> - <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> - <li><a href="../index.html" title="Doxia"><span class="none"></span>Doxia</a></li> - <li><a href="../../maven-indexer/index.html" title="Indexer"><span class="none"></span>Indexer</a></li> - <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> - <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> - <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> - <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> - <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> - <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> - <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> - <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> + <li><a href="../../archetype/index.html">Archetype</a></li> + <li><a href="../../resolver/index.html">Artifact Resolver</a></li> + <li><a href="../index.html">Doxia</a></li> + <li><a href="../../maven-indexer/index.html">Indexer</a></li> + <li><a href="../../jxr/index.html">JXR</a></li> + <li><a href="../../plugin-testing/index.html">Plugin Testing</a></li> + <li><a href="../../plugin-tools/index.html">Plugin Tools</a></li> + <li><a href="../../apache-resource-bundles/index.html">Resource Bundles</a></li> + <li><a href="../../scm/index.html">SCM</a></li> + <li><a href="../../shared/index.html">Shared Components</a></li> + <li><a href="../../surefire/index.html">Surefire</a></li> + <li><a href="../../wagon/index.html">Wagon</a></li> </ul></li> <li class="nav-header">ASF</li> - <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> - <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> - <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> + <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink">How Apache Works</a></li> + <li><a href="https://www.apache.org/foundation/"; class="externalLink">Foundation</a></li> + <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink">Data Privacy</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink">Sponsoring Apache</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink">Thanks</a></li> </ul> </nav> <div class="well sidebar-nav"> <div id="poweredBy"> <div class="clear"></div> <div class="clear"></div> - <div class="clear"></div> -<a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> +<a href="https://maven.apache.org/"; class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> </div> </div> </header> - <main id="bodyColumn" class="span10" > -<section> -<h2><a name="Using_the_Doxia_Sink_API"></a>Using the Doxia Sink API</h2> + <main id="bodyColumn" class="span10"> +<section><a id="Using_the_Doxia_Sink_API"></a> +<h1>Using the Doxia Sink API</h1> <ul> <li><a href="#Transforming_documents">Transforming documents</a></li> <li><a href="#Generating_documents">Generating documents</a></li> @@ -132,9 +130,9 @@ <li><a href="#Avoid_sink.rawText.21">Avoid sink.rawText!</a></li> <li><a href="#How_to_inject_javascript_code_into_HTML">How to inject javascript code into HTML</a></li> <li><a href="#References">References</a></li></ul><section> -<h3><a name="Transforming_documents">Transforming documents</a></h3> +<h2><a id="Transforming_documents">Transforming documents</a></h2> <p>Doxia can be used to transform an arbitrary input document to any supported output format. The following snippet shows how to use a Doxia <i>Parser</i> to transform an apt file to html:</p> -<div class="source"><pre class="prettyprint linenums"> File userDir = new File( System.getProperty ( "user.dir" ) ); +<pre class="prettyprint linenums"><code> File userDir = new File( System.getProperty ( "user.dir" ) ); File inputFile = new File( userDir, "test.apt" ); File outputFile = new File( userDir, "test.html" ); @@ -146,12 +144,12 @@ Reader reader = ReaderFactory.newReader( inputFile, "UTF-8" ); - parser.parse( reader, sink );</pre></div> + parser.parse( reader, sink );</code></pre> <p>It is recommended that you use <a class="externalLink" href="http://plexus.codehaus.org/";>Plexus</a> to look up the parser. In principle you could instantiate the parser directly ( <code>Parser parser = new AptParser();</code> ) but then some special features like macros will not be available.</p> <p>You could also use the <a class="externalLink" href="http://maven.apache.org/doxia/doxia-tools/doxia-converter/index.html";>Doxia Converter Tool</a> to parse a given file/dir to another file/dir.</p></section><section> -<h3><a name="Generating_documents">Generating documents</a></h3> +<h2><a id="Generating_documents">Generating documents</a></h2> <p>The snippet below gives a simple example of how to generate a document using the Doxia Sink API.</p> -<div class="source"><pre class="prettyprint linenums"> /** +<pre class="prettyprint linenums"><code> /** * Generate a simple document and emit it * into the specified sink. The sink is flushed but not closed. * @@ -196,34 +194,34 @@ sink.body_(); sink.flush(); - }</pre></div> + }</code></pre> <p>A more complete example that also shows the 'canonical' order of events to use when generating a document, can be found in the Doxia <a href="./doxia/doxia-core/xref-test/org/apache/maven/doxia/sink/SinkTestDocument.html">SinkTestDocument</a> class.</p></section><section> -<h3><a name="Passing_attributes_to_Sink_events">Passing attributes to Sink events</a></h3> +<h2><a id="Passing_attributes_to_Sink_events">Passing attributes to Sink events</a></h2> <p>A number of methods in the Sink API enable passing a set of attributes to many sink events. A typical use case is:</p> -<div class="source"><pre class="prettyprint linenums">SinkEventAttributeSet atts = new SinkEventAttributeSet(); +<pre class="prettyprint linenums"><code>SinkEventAttributeSet atts = new SinkEventAttributeSet(); atts.addAttribute( SinkEventAttributes.ALIGN, "center" ); -sink.paragraph( atts );</pre></div> +sink.paragraph( atts );</code></pre> <p>The kind of attributes supported depends on the event and the sink implementation. The sink API specifies a list of suggested attribute names that sinks are expected to recognize and parsers are expected to use when emitting events.</p></section><section> -<h3><a name="Avoid_sink.rawText.21"></a><a name="Avoid_sink.rawText">Avoid sink.rawText!</a></h3> +<h2><a id="Avoid_sink.rawText.21">Avoid sink.rawText!</a></h2> <p>In <b>Doxia 1.0</b> it was a common practice to use sink.rawText() to generate elements that were not supported by the Sink API. For example, the following snippet could be used to generate a styled HTML <div> block:</p> -<div class="source"><pre class="prettyprint linenums">sink.RawText( "<div style=\"cool\">" ); +<pre class="prettyprint linenums"><code>sink.RawText( "<div style=\"cool\">" ); sink.text( "A text with a cool style." ); -sink.rawText( "</div>" );</pre></div> +sink.rawText( "</div>" );</code></pre> <p>This has a major drawback however: it only works if the receiving Sink is a HTML Sink. In other words, the above method will not work for target documents in any other format than HTML (think of the FO Sink to generate a pdf, or a LaTeX sink,...).</p> <p>In <b>Doxia 1.1</b> a new method unknown() was added to the Sink API that can be used to emit an arbitrary event without making special assumptions about the receiving Sink. Depending on the parameters, a Sink may decide whether or not to process the event, emit it as raw text, as a comment, log it, etc.</p> <p>The correct way to generate the above <div> block is now:</p> -<div class="source"><pre class="prettyprint linenums">SinkEventAttributeSet atts = new SinkEventAttributeSet(); +<pre class="prettyprint linenums"><code>SinkEventAttributeSet atts = new SinkEventAttributeSet(); atts.addAttribute( SinkEventAttributes.STYLE, "cool" ); sink.unknown( "div", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_START )}, atts ); sink.text( "A text with a cool style." ); -sink.unknown( "div", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_END )}, null );</pre></div> +sink.unknown( "div", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_END )}, null );</code></pre> <p>Read the javadocs of the unknown() method in the <a href="./doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html">Sink</a> interface and the <a href="./doxia/doxia-core/apidocs/org/apache/maven/doxia/sink/XhtmlBaseSink.html">XhtmlbaseSink</a> for information on the method parameters. Note that an arbitrary sink may be expected to ignore the unknown event completely!</p> <p><b>In general, the rawText method should be avoided alltogether when emitting events into an arbitrary Sink.</b></p></section><section> -<h3><a name="How_to_inject_javascript_code_into_HTML">How to inject javascript code into HTML</a></h3> +<h2><a id="How_to_inject_javascript_code_into_HTML">How to inject javascript code into HTML</a></h2> <p>Related to the above, here is the correct way of injecting a javascript snippet into a Sink:</p> -<div class="source"><pre class="prettyprint linenums">// the javascript code is emitted within a commented CDATA section +<pre class="prettyprint linenums"><code>// the javascript code is emitted within a commented CDATA section // so we have to start with a newline and comment the CDATA closing in the end // note that the sink will replace the newline by the system EOL String javascriptCode = "\n function javascriptFunction() {...} \n //"; @@ -233,14 +231,13 @@ atts.addAttribute( SinkEventAttributes.T sink.unknown( "script", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_START )}, atts ); sink.unknown( "cdata", new Object[]{new Integer( HtmlMarkup.CDATA_TYPE ), javascriptCode }, null ); -sink.unknown( "script", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_END )}, null );</pre></div></section><section> -<h3><a name="References">References</a></h3> +sink.unknown( "script", new Object[]{new Integer( HtmlMarkup.TAG_TYPE_END )}, null );</code></pre></section><section> +<h2><a id="References">References</a></h2> <ul> <li><a href="../modules/index.html">Doxia Modules Guide</a></li> <li><a href="../macros/index.html">Doxia Macros Guide</a></li> <li><a href="../doxia/apidocs/index.html">Doxia API Reference</a></li> -<li><a href="../doxia-sitetools/apidocs/index.html">Doxia Sitetools API Reference</a></li></ul></section></section> - </main> +<li><a href="../doxia-sitetools/apidocs/index.html">Doxia Sitetools API Reference</a></li></ul></section></section> </main> </div> </div> <hr/> @@ -253,10 +250,5 @@ sink.unknown( "script", new Ob </div> </div> </footer> -<script> - if(anchors) { - anchors.add(); - } -</script> </body> </html> \ No newline at end of file
Modified: maven/doxia/website/content/downloads.html ============================================================================== --- maven/doxia/website/content/downloads.html (original) +++ maven/doxia/website/content/downloads.html Thu Dec 12 16:16:24 2024 @@ -2,29 +2,28 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from content/apt/downloads.apt at 2024-11-05 - | Rendered using Apache Maven Fluido Skin 1.12.0 + | Generated by Apache Maven Doxia Site Renderer 2.0.0 from content/apt/downloads.apt at 2024-12-12 + | Rendered using Apache Maven Fluido Skin 2.0.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> <meta name="author" content="Vincent Siveton" /> <meta name="date" content="2009-03-02" /> - <title>Doxia – Download</title> - <link rel="stylesheet" href="./css/apache-maven-fluido-1.12.0.min.css" /> + <title>Download â Doxia</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-2.0.1.min.css" /> <link rel="stylesheet" href="./css/site.css" /> <link rel="stylesheet" href="./css/print.css" media="print" /> - <script src="./js/apache-maven-fluido-1.12.0.min.js"></script> - + <script src="./js/apache-maven-fluido-2.0.1.min.js"></script> <!-- Matomo --> <script> var _paq = window._paq = window._paq || []; - _paq.push(['disableCookies']); - _paq.push(['trackPageView']); - _paq.push(['enableLinkTracking']); - + _paq.push(['disableCookies']); + _paq.push(['trackPageView']); + _paq.push(['enableLinkTracking']); + (function() { var u="https://analytics.apache.org/";; _paq.push(['setTrackerUrl', u+'/matomo.php']); @@ -39,19 +38,19 @@ <div class="container-fluid container-fluid-top"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../images/apache-maven-project.png" style="" /></a></div> - <div class="pull-right"><a href="./" id="bannerRight"><img src="images/doxia-logo.png" alt="Doxia" style="" /></a></div> + <div class="pull-left"><div id="bannerLeft"><h1><a href="https://www.apache.org/";><img class="class java.lang.Object" src="../images/apache-maven-project.png" /></a></h1></div></div> + <div class="pull-right"><div id="bannerRight"><h1><a href="./"><img class="class java.lang.Object" src="images/doxia-logo.png" /> Doxia</a></h1></div></div> <div class="clear"><hr/></div> </div> <div id="breadcrumbs"> <ul class="breadcrumb"> - <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> - <li><a href="../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li><a href="index.html" title="Doxia">Doxia</a><span class="divider">/</span></li> - <li class="active ">Download <a href="https://github.com/apache/maven-doxia-site/tree/master/content/apt/downloads.apt";><img src="./images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-11-05</li> - <li class="pull-right"><a href="scm.html" title="Get Sources">Get Sources</a></li> + <li><a href="https://www.apache.org/"; class="externalLink">Apache</a><span class="divider">/</span></li> + <li><a href="../index.html">Maven</a><span class="divider">/</span></li> + <li><a href="index.html">Doxia</a><span class="divider">/</span></li> + <li class="active">Download <a href="https://github.com/apache/maven-doxia-site/tree/master/content/apt/downloads.apt";><img src="./images/accessories-text-editor.png" alt="Edit" /></a></li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-07-04</li> + <li class="pull-right"><a href="scm.html">Get Sources</a></li> </ul> </div> </header> @@ -60,69 +59,67 @@ <nav class="well sidebar-nav"> <ul class="nav nav-list"> <li class="nav-header">About Doxia</li> - <li><a href="index.html" title="What is Doxia?"><span class="none"></span>What is Doxia?</a></li> - <li><a href="overview.html" title="Overview"><span class="none"></span>Overview</a></li> - <li class="active"><a><span class="none"></span>Downloads</a></li> - <li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> + <li><a href="index.html">What is Doxia?</a></li> + <li><a href="overview.html">Overview</a></li> + <li class="active"><a>Downloads</a></li> + <li><a href="faq.html">FAQ</a></li> <li class="nav-header">Documentation</li> - <li><a href="references/index.html" title="Format References"><span class="icon-chevron-right"></span>Format References</a></li> - <li><a href="modules/index.html" title="Doxia Modules Guide"><span class="none"></span>Doxia Modules Guide</a></li> - <li><a href="macros/index.html" title="Doxia Macros Guide"><span class="none"></span>Doxia Macros Guide</a></li> - <li><a href="book/index.html" title="Writing Books"><span class="none"></span>Writing Books</a></li> - <li><a href="issues/index.html" title="Issues &amp; Gotchas"><span class="none"></span>Issues &amp; Gotchas</a></li> - <li><a href="resources.html" title="External Resources"><span class="none"></span>External Resources</a></li> + <li><a href="references/index.html"><span class="icon-chevron-right"></span>Format References</a></li> + <li><a href="modules/index.html">Doxia Modules Guide</a></li> + <li><a href="macros/index.html">Doxia Macros Guide</a></li> + <li><a href="book/index.html">Writing Books</a></li> + <li><a href="issues/index.html">Issues &amp; Gotchas</a></li> + <li><a href="resources.html">External Resources</a></li> <li class="nav-header">Developer Docs</li> - <li><a href="developers/index.html" title="Developer Centre"><span class="icon-chevron-right"></span>Developer Centre</a></li> - <li><a href="doxia-tools/index.html" title="Doxia Tools"><span class="none"></span>Doxia Tools</a></li> + <li><a href="developers/index.html"><span class="icon-chevron-right"></span>Developer Centre</a></li> + <li><a href="doxia-tools/index.html">Doxia Tools</a></li> <li class="nav-header">Project Documentation</li> - <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li> + <li><a href="project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> <li class="nav-header">Maven Projects</li> - <li><a href="../ref/current" title="Maven"><span class="none"></span>Maven</a></li> - <li><a href="../archetypes/index.html" title="Archetypes"><span class="none"></span>Archetypes</a></li> - <li><a href="../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> - <li><a href="../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> - <li><a href="../plugins/index.html" title="Plugins"><span class="none"></span>Plugins</a></li> - <li><a href="../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> - <li><a href="" title="Components"><span class="icon-chevron-down"></span>Components</a> + <li><a href="../ref/current">Maven</a></li> + <li><a href="../archetypes/index.html">Archetypes</a></li> + <li><a href="../extensions/index.html">Extensions</a></li> + <li><a href="../pom/index.html">Parent POMs</a></li> + <li><a href="../plugins/index.html">Plugins</a></li> + <li><a href="../skins/index.html">Skins</a></li> + <li><a><span class="icon-chevron-down"></span>Components</a> <ul class="nav nav-list"> - <li><a href="../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> - <li><a href="../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> - <li><a href="index.html" title="Doxia"><span class="none"></span>Doxia</a></li> - <li><a href="../maven-indexer/index.html" title="Indexer"><span class="none"></span>Indexer</a></li> - <li><a href="../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> - <li><a href="../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> - <li><a href="../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> - <li><a href="../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> - <li><a href="../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> - <li><a href="../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> - <li><a href="../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> - <li><a href="../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> + <li><a href="../archetype/index.html">Archetype</a></li> + <li><a href="../resolver/index.html">Artifact Resolver</a></li> + <li><a href="index.html">Doxia</a></li> + <li><a href="../maven-indexer/index.html">Indexer</a></li> + <li><a href="../jxr/index.html">JXR</a></li> + <li><a href="../plugin-testing/index.html">Plugin Testing</a></li> + <li><a href="../plugin-tools/index.html">Plugin Tools</a></li> + <li><a href="../apache-resource-bundles/index.html">Resource Bundles</a></li> + <li><a href="../scm/index.html">SCM</a></li> + <li><a href="../shared/index.html">Shared Components</a></li> + <li><a href="../surefire/index.html">Surefire</a></li> + <li><a href="../wagon/index.html">Wagon</a></li> </ul></li> <li class="nav-header">ASF</li> - <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> - <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> - <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> + <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink">How Apache Works</a></li> + <li><a href="https://www.apache.org/foundation/"; class="externalLink">Foundation</a></li> + <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink">Data Privacy</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink">Sponsoring Apache</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink">Thanks</a></li> </ul> </nav> <div class="well sidebar-nav"> <div id="poweredBy"> <div class="clear"></div> <div class="clear"></div> - <div class="clear"></div> -<a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> +<a href="https://maven.apache.org/"; class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> </div> </div> </header> - <main id="bodyColumn" class="span10" > -<section> -<h2><a name="Maven_Doxia_Releases"></a>Maven Doxia Releases</h2> + <main id="bodyColumn" class="span10"> +<section><a id="Maven_Doxia_Releases"></a> +<h1>Maven Doxia Releases</h1> <p>Releases of Maven Doxia are made available in both binary and source distributions. Individual JARs are also made available through Apache Maven repositories.</p> <p>Releases of all Doxia sub-project components (currently Doxia, Doxia Sitetools and Doxia Tools) may be downloaded from Maven's central repository:</p> <ul> -<li><a class="externalLink" href="https://repo.maven.apache.org/maven2/org/apache/maven/doxia/";>https://repo.maven.apache.org/maven2/org/apache/maven/doxia/</a></li></ul></section> - </main> +<li><a class="externalLink" href="https://repo.maven.apache.org/maven2/org/apache/maven/doxia/";>https://repo.maven.apache.org/maven2/org/apache/maven/doxia/</a></li></ul></section> </main> </div> </div> <hr/> @@ -135,10 +132,5 @@ </div> </div> </footer> -<script> - if(anchors) { - anchors.add(); - } -</script> </body> </html> \ No newline at end of file Modified: maven/doxia/website/content/doxia-example-book/aegis-binding.html ============================================================================== --- maven/doxia/website/content/doxia-example-book/aegis-binding.html (original) +++ maven/doxia/website/content/doxia-example-book/aegis-binding.html Thu Dec 12 16:16:24 2024 @@ -2,28 +2,27 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-site/xdoc/doxia-example-book/aegis-binding.xml at 2024-11-05 - | Rendered using Apache Maven Fluido Skin 1.12.0 + | Generated by Apache Maven Doxia Site Renderer 2.0.0 from target/generated-site/xdoc/doxia-example-book/aegis-binding.xml at 2024-12-12 + | Rendered using Apache Maven Fluido Skin 2.0.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> <meta name="author" content="XFire User's Guide" /> - <title>Doxia – Aegis Binding</title> - <link rel="stylesheet" href="../css/apache-maven-fluido-1.12.0.min.css" /> + <title>Aegis Binding â Doxia</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.1.min.css" /> <link rel="stylesheet" href="../css/site.css" /> <link rel="stylesheet" href="../css/print.css" media="print" /> - <script src="../js/apache-maven-fluido-1.12.0.min.js"></script> - + <script src="../js/apache-maven-fluido-2.0.1.min.js"></script> <!-- Matomo --> <script> var _paq = window._paq = window._paq || []; - _paq.push(['disableCookies']); - _paq.push(['trackPageView']); - _paq.push(['enableLinkTracking']); - + _paq.push(['disableCookies']); + _paq.push(['trackPageView']); + _paq.push(['enableLinkTracking']); + (function() { var u="https://analytics.apache.org/";; _paq.push(['setTrackerUrl', u+'/matomo.php']); @@ -38,19 +37,19 @@ <div class="container-fluid container-fluid-top"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" style="" /></a></div> - <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/doxia-logo.png" alt="Doxia" style="" /></a></div> + <div class="pull-left"><div id="bannerLeft"><h1><a href="https://www.apache.org/";><img class="class java.lang.Object" src="../../images/apache-maven-project.png" /></a></h1></div></div> + <div class="pull-right"><div id="bannerRight"><h1><a href=".././"><img class="class java.lang.Object" src="../images/doxia-logo.png" /> Doxia</a></h1></div></div> <div class="clear"><hr/></div> </div> <div id="breadcrumbs"> <ul class="breadcrumb"> - <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> - <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li><a href="../index.html" title="Doxia">Doxia</a><span class="divider">/</span></li> - <li class="active ">Aegis Binding <a href="https://github.com/apache/maven-doxia-site/tree/master/target/generated-site/xdoc/doxia-example-book/aegis-binding.xml";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-11-05</li> - <li class="pull-right"><a href="../scm.html" title="Get Sources">Get Sources</a></li> + <li><a href="https://www.apache.org/"; class="externalLink">Apache</a><span class="divider">/</span></li> + <li><a href="../../index.html">Maven</a><span class="divider">/</span></li> + <li><a href="../index.html">Doxia</a><span class="divider">/</span></li> + <li class="active">Aegis Binding</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-07-04</li> + <li class="pull-right"><a href="../scm.html">Get Sources</a></li> </ul> </div> </header> @@ -59,75 +58,74 @@ <nav class="well sidebar-nav"> <ul class="nav nav-list"> <li class="nav-header">About Doxia</li> - <li><a href="../index.html" title="What is Doxia?"><span class="none"></span>What is Doxia?</a></li> - <li><a href="../overview.html" title="Overview"><span class="none"></span>Overview</a></li> - <li><a href="../downloads.html" title="Downloads"><span class="none"></span>Downloads</a></li> - <li><a href="../faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> + <li><a href="../index.html">What is Doxia?</a></li> + <li><a href="../overview.html">Overview</a></li> + <li><a href="../downloads.html">Downloads</a></li> + <li><a href="../faq.html">FAQ</a></li> <li class="nav-header">Documentation</li> - <li><a href="../references/index.html" title="Format References"><span class="icon-chevron-right"></span>Format References</a></li> - <li><a href="../modules/index.html" title="Doxia Modules Guide"><span class="none"></span>Doxia Modules Guide</a></li> - <li><a href="../macros/index.html" title="Doxia Macros Guide"><span class="none"></span>Doxia Macros Guide</a></li> - <li><a href="../book/index.html" title="Writing Books"><span class="none"></span>Writing Books</a></li> - <li><a href="../issues/index.html" title="Issues &amp; Gotchas"><span class="none"></span>Issues &amp; Gotchas</a></li> - <li><a href="../resources.html" title="External Resources"><span class="none"></span>External Resources</a></li> + <li><a href="../references/index.html"><span class="icon-chevron-right"></span>Format References</a></li> + <li><a href="../modules/index.html">Doxia Modules Guide</a></li> + <li><a href="../macros/index.html">Doxia Macros Guide</a></li> + <li><a href="../book/index.html">Writing Books</a></li> + <li><a href="../issues/index.html">Issues &amp; Gotchas</a></li> + <li><a href="../resources.html">External Resources</a></li> <li class="nav-header">Developer Docs</li> - <li><a href="../developers/index.html" title="Developer Centre"><span class="icon-chevron-right"></span>Developer Centre</a></li> - <li><a href="../doxia-tools/index.html" title="Doxia Tools"><span class="none"></span>Doxia Tools</a></li> + <li><a href="../developers/index.html"><span class="icon-chevron-right"></span>Developer Centre</a></li> + <li><a href="../doxia-tools/index.html">Doxia Tools</a></li> <li class="nav-header">Project Documentation</li> - <li><a href="../project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li> + <li><a href="../project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> <li class="nav-header">Maven Projects</li> - <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> - <li><a href="../../archetypes/index.html" title="Archetypes"><span class="none"></span>Archetypes</a></li> - <li><a href="../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> - <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> - <li><a href="../../plugins/index.html" title="Plugins"><span class="none"></span>Plugins</a></li> - <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> - <li><a href="../" title="Components"><span class="icon-chevron-down"></span>Components</a> + <li><a href="../../ref/current">Maven</a></li> + <li><a href="../../archetypes/index.html">Archetypes</a></li> + <li><a href="../../extensions/index.html">Extensions</a></li> + <li><a href="../../pom/index.html">Parent POMs</a></li> + <li><a href="../../plugins/index.html">Plugins</a></li> + <li><a href="../../skins/index.html">Skins</a></li> + <li><a><span class="icon-chevron-down"></span>Components</a> <ul class="nav nav-list"> - <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> - <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> - <li><a href="../index.html" title="Doxia"><span class="none"></span>Doxia</a></li> - <li><a href="../../maven-indexer/index.html" title="Indexer"><span class="none"></span>Indexer</a></li> - <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> - <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> - <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> - <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> - <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> - <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> - <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> - <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> + <li><a href="../../archetype/index.html">Archetype</a></li> + <li><a href="../../resolver/index.html">Artifact Resolver</a></li> + <li><a href="../index.html">Doxia</a></li> + <li><a href="../../maven-indexer/index.html">Indexer</a></li> + <li><a href="../../jxr/index.html">JXR</a></li> + <li><a href="../../plugin-testing/index.html">Plugin Testing</a></li> + <li><a href="../../plugin-tools/index.html">Plugin Tools</a></li> + <li><a href="../../apache-resource-bundles/index.html">Resource Bundles</a></li> + <li><a href="../../scm/index.html">SCM</a></li> + <li><a href="../../shared/index.html">Shared Components</a></li> + <li><a href="../../surefire/index.html">Surefire</a></li> + <li><a href="../../wagon/index.html">Wagon</a></li> </ul></li> <li class="nav-header">ASF</li> - <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> - <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> - <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> + <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink">How Apache Works</a></li> + <li><a href="https://www.apache.org/foundation/"; class="externalLink">Foundation</a></li> + <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink">Data Privacy</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink">Sponsoring Apache</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink">Thanks</a></li> </ul> </nav> <div class="well sidebar-nav"> <div id="poweredBy"> <div class="clear"></div> <div class="clear"></div> - <div class="clear"></div> -<a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> +<a href="https://maven.apache.org/"; class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> </div> </div> </header> - <main id="bodyColumn" class="span10" > + <main id="bodyColumn" class="span10"> <section> -<h2></h2> -<table class="table table-striped" width="100%" align="center" border="0"> +<h1></h1> +<table class="table table-striped" style="text-align: center;"> <tr class="a"> -<td align="center">Previous: <a href="bindings.html">Bindings Overview</a></td> -<td align="center">Up: <a href="bind.html">Bindings</a></td> -<td align="right">Next: <a href="castor.html">Castor</a></td></tr></table><hr /></section><section> -<h2><a name="Aegis_Binding"></a>Aegis Binding</h2> -<p>Aegis is the default XFire binding which maps XML to POJOs. It supports code first development only at this point - i.e. you write your service in POJOs and it will generate the XML schema/wsdl for you.</p></section><section> -<h2><a name="XML_and_Annotation_Mapping_Overview"></a>XML and Annotation Mapping Overview</h2> +<td style="text-align: left;">Previous: <a href="bindings.html">Bindings Overview</a></td> +<td style="text-align: center;">Up: <a href="bind.html">Bindings</a></td> +<td style="text-align: right;">Next: <a href="castor.html">Castor</a></td></tr></table><hr /></section><section><a id="Aegis_Binding"></a> +<h1>Aegis Binding</h1> +<p>Aegis is the default XFire binding which maps XML to POJOs. It supports code first development only at this point - i.e. you write your service in POJOs and it will generate the XML schema/wsdl for you.</p></section><section><a id="XML_and_Annotation_Mapping_Overview"></a> +<h1>XML and Annotation Mapping Overview</h1> <p>Aegis has a flexible mapping system so you can control how your beans are controlled. By default your POJOs are serialized based on their name and namespaces. If you have a class in the "org.codehaus.xfire" package named "Employee" it would be serialized in namespace "http://xfire.codehaus.org" with the local name "YourBean."</p> <p>Fore example, the java class:</p> -<div class="source"><pre class="prettyprint linenums">public class Employee +<pre class="prettyprint linenums"><code>public class Employee { private String name; private String title; @@ -137,21 +135,21 @@ public String getTitle() { return title; } public void setTitle(String title) { this.title = title; } -}</pre></div> +}</code></pre> <p>In XML this translates to:</p> -<div class="source"><pre class="prettyprint linenums"><Employee xmlns="http://xfire.codehaus.org"> +<pre class="prettyprint linenums"><code><Employee xmlns="http://xfire.codehaus.org"> <name>Santa Claus</name> <title>Chief Present Officer (CPO)</title> -</Employee></pre></div> +</Employee></code></pre> <p>In XML Schema this would become a complex type:</p> -<div class="source"><pre class="prettyprint linenums"><xsd:complexType name="Employee"> +<pre class="prettyprint linenums"><code><xsd:complexType name="Employee"> <xsd:sequence> <xsd:element name="name" type="xsd:string" minOccurs="0" maxOccurs="1/> <xsd:element name="title" type="xsd:string" minOccurs="0" maxOccurs="1/> </xsd:sequence> -</xsd:complexType></pre></div> -<p><i>Validate your mapping!</i> You can find an XML Schema for Aegis mapping files <a class="externalLink" href="http://xfire.codehaus.org/schemas/1.0/mapping.xsd";>here</a>.</p><section> -<h3><a name="Supported_Types"></a>Supported Types</h3> +</xsd:complexType></code></pre> +<p><i>Validate your mapping!</i> You can find an XML Schema for Aegis mapping files <a class="externalLink externalLink" href="http://xfire.codehaus.org/schemas/1.0/mapping.xsd";>here</a>.</p><section><a id="Supported_Types"></a> +<h2>Supported Types</h2> <ul> <li>Basic types: int, double, float, long, byte[], short, String, BigDecimal</li> <li>Arrays</li> @@ -162,7 +160,7 @@ <p>If you have constructors defined in your Java beans, make sure a default constructor (i.e. no arguments) is also declared. (Aegis needs a no-argument contstructor to instantiate client Java classes.) Controlling Mappings with XML</p> <p>Its easy to control how your service and its beans are mapped to xml. If you are using Java 5.0 skip straight down to that section otherwise read on to learn how to configure serialization via mapping files.</p> <p>Mapping files must exist in the same package as your bean or service class on the class path. In the above example the mapping file would be named "/org/codehaus/xfire/YourBean.aegis.xml", with the following format:</p> -<div class="source"><pre class="prettyprint linenums"><mappings> +<pre class="prettyprint linenums"><code><mappings> <mapping uri="" name=""> <method name="methodName"> <return-type mappedName="" componentType=""/> @@ -170,60 +168,60 @@ </method> <property name="" mappedName="" style="attribute|element" componentType=""/> </mapping> -</mappings></pre></div> +</mappings></code></pre> <p>Note that <code> <method> </code> is used to configure methods on your service and <i>property</i> is used to configure properties on your javabeans.</p> -<p>The above example highlights many of the possible elements, most are optional and the format encourages minimally specified mappings.</p></section></section><section> -<h2><a name="Controlling_Naming"></a>Controlling Naming</h2> +<p>The above example highlights many of the possible elements, most are optional and the format encourages minimally specified mappings.</p></section></section><section><a id="Controlling_Naming"></a> +<h1>Controlling Naming</h1> <p>Lets pretend that in the above example you would like the elements names to be capatilized and in the namespace "urn:north-pole:operations". You could achieve this through a mapping file like so:</p> -<div class="source"><pre class="prettyprint linenums"><mappings xmlns:np="urn:north-pole:operations"> +<pre class="prettyprint linenums"><code><mappings xmlns:np="urn:north-pole:operations"> <mapping name="np:Employee"> <property name="name" mappedName="Name"/> <property name="title" mappedName="Title"/> </mapping> -</mappings></pre></div> +</mappings></code></pre> <p>Notice that the namespace was declared on the mappings element and then the prefix was used to specify the element QNames for the name/title properties.</p> <p>This will result in a mapping like so:</p> -<div class="source"><pre class="prettyprint linenums"><np:Employee xmlns:np="urn:north-pole:operations"> +<pre class="prettyprint linenums"><code><np:Employee xmlns:np="urn:north-pole:operations"> <np:Name>Santa Claus</np:Name> <np:Title>Chief Present Officer (CPO)</np:Title> -</np:Employee></pre></div><section> -<h3><a name="Ignoring_properties"></a>Ignoring properties</h3> +</np:Employee></code></pre><section><a id="Ignoring_properties"></a> +<h2>Ignoring properties</h2> <p>If you don't want to serialize a certain property it is easy to ignore it:</p> -<div class="source"><pre class="prettyprint linenums"><mappings> +<pre class="prettyprint linenums"><code><mappings> <mapping> <property name="propertyName" ignore="true"/> </mapping> -</mappings></pre></div></section><section> -<h3><a name="Handling_Collections"></a>Handling Collections</h3> +</mappings></code></pre></section><section><a id="Handling_Collections"></a> +<h2>Handling Collections</h2> <p>You undoubtedly use Collections in your code. Pre Java 5 it is impossible to determine the "component type" of a Collection by introspection. So you need to give Aegis some hints. For a service which returned a Collection of employees like so:</p> -<div class="source"><pre class="prettyprint linenums">public class EmployeeService +<pre class="prettyprint linenums"><code>public class EmployeeService { Collection getEmployees(String id) { ... } -}</pre></div> +}</code></pre> <p>You would need to supply metadata which gave the component type in a mapping file like this one:</p> -<div class="source"><pre class="prettyprint linenums"><mappings> +<pre class="prettyprint linenums"><code><mappings> <mapping> <method name="getEmployees"> <return-type componentType="org.codehaus.xfire.Employee" /> </method> </mapping> -</mappings></pre></div></section><section> -<h3><a name="Handling_Maps"></a>Handling Maps</h3> -<p>Java Maps don't map well to XML Schema (no pun intended) because there is no Map concept in XML Schema so your clients. Maps are transformed to a collection of <a name="key_value">key, value</a> tuples instead. In addition to providing the type of the value, you must also provide Aegis with the type of the key:</p> -<div class="source"><pre class="prettyprint linenums">public class GiftService +</mappings></code></pre></section><section><a id="Handling_Maps"></a> +<h2>Handling Maps</h2> +<p>Java Maps don't map well to XML Schema (no pun intended) because there is no Map concept in XML Schema so your clients. Maps are transformed to a collection of <a id="key_value">key, value</a> tuples instead. In addition to providing the type of the value, you must also provide Aegis with the type of the key:</p> +<pre class="prettyprint linenums"><code>public class GiftService { Map getGiftList() { /* returns a map of NiceChild => Present */ } -}</pre></div> +}</code></pre> <p>The mapping file should look like this:</p> -<div class="source"><pre class="prettyprint linenums"><mappings> +<pre class="prettyprint linenums"><code><mappings> <mapping> <method name="getGiftList"> <return-type keyType="org.codehaus.xfire.NiceChild" componentType="org.codehaus.xfire.Present"> </method> </mapping> -</mappings></pre></div> +</mappings></code></pre> <p>This will generate the following type:</p> -<div class="source"><pre class="prettyprint linenums"><xsd:complexType name="NiceChild2PresentMap"> +<pre class="prettyprint linenums"><code><xsd:complexType name="NiceChild2PresentMap"> <xsd:sequence> <xsd:element name="entry" minOccurs="0" maxOccurs="unbounded"> <xsd:complexType> @@ -234,23 +232,22 @@ </xsd:complexType> </xsd:element> </xsd:sequence> -</xsd:complexType></pre></div></section></section><section> -<h2><a name="Interfaces_and_Aegis"></a>Interfaces and Aegis</h2> +</xsd:complexType></code></pre></section></section><section><a id="Interfaces_and_Aegis"></a> +<h1>Interfaces and Aegis</h1> <p>The Aegis binding will automatically create proxies for your interfaces when reading XML. So if you have an interface like this:</p> -<div class="source"><pre class="prettyprint linenums">public interface User { +<pre class="prettyprint linenums"><code>public interface User { public String getUsername(); public String getPasswrod(); -}</pre></div> +}</code></pre> <p>It will then create its own implementation of User and provide a username and password from the XML. You can specify your implementation class (in 1.1+) by setting a property on your service:</p> -<div class="source"><pre class="prettyprint linenums">Service service = ...; -service.setProperty("com.acme.User.implementation", "com.acme.UserImpl");</pre></div></section><section> -<h2></h2><hr /> -<table class="table table-striped" width="100%" align="center" border="0"> +<pre class="prettyprint linenums"><code>Service service = ...; +service.setProperty("com.acme.User.implementation", "com.acme.UserImpl");</code></pre></section><section><a id="null_1"></a> +<h1></h1><hr /> +<table class="table table-striped" style="text-align: center;"> <tr class="a"> -<td align="center">Previous: <a href="bindings.html">Bindings Overview</a></td> -<td align="center">Up: <a href="bind.html">Bindings</a></td> -<td align="right">Next: <a href="castor.html">Castor</a></td></tr></table></section> - </main> +<td style="text-align: left;">Previous: <a href="bindings.html">Bindings Overview</a></td> +<td style="text-align: center;">Up: <a href="bind.html">Bindings</a></td> +<td style="text-align: right;">Next: <a href="castor.html">Castor</a></td></tr></table></section> </main> </div> </div> <hr/> @@ -263,10 +260,5 @@ service.setProperty("com.acme.User. </div> </div> </footer> -<script> - if(anchors) { - anchors.add(); - } -</script> </body> </html> \ No newline at end of file Modified: maven/doxia/website/content/doxia-example-book/bind.html ============================================================================== --- maven/doxia/website/content/doxia-example-book/bind.html (original) +++ maven/doxia/website/content/doxia-example-book/bind.html Thu Dec 12 16:16:24 2024 @@ -2,27 +2,26 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from target/generated-site/xdoc/doxia-example-book/bind.xml at 2024-11-05 - | Rendered using Apache Maven Fluido Skin 1.12.0 + | Generated by Apache Maven Doxia Site Renderer 2.0.0 from target/generated-site/xdoc/doxia-example-book/bind.xml at 2024-12-12 + | Rendered using Apache Maven Fluido Skin 2.0.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> - <title>Doxia – Bindings</title> - <link rel="stylesheet" href="../css/apache-maven-fluido-1.12.0.min.css" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> + <title>Bindings â Doxia</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.1.min.css" /> <link rel="stylesheet" href="../css/site.css" /> <link rel="stylesheet" href="../css/print.css" media="print" /> - <script src="../js/apache-maven-fluido-1.12.0.min.js"></script> - + <script src="../js/apache-maven-fluido-2.0.1.min.js"></script> <!-- Matomo --> <script> var _paq = window._paq = window._paq || []; - _paq.push(['disableCookies']); - _paq.push(['trackPageView']); - _paq.push(['enableLinkTracking']); - + _paq.push(['disableCookies']); + _paq.push(['trackPageView']); + _paq.push(['enableLinkTracking']); + (function() { var u="https://analytics.apache.org/";; _paq.push(['setTrackerUrl', u+'/matomo.php']); @@ -37,19 +36,19 @@ <div class="container-fluid container-fluid-top"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" style="" /></a></div> - <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/doxia-logo.png" alt="Doxia" style="" /></a></div> + <div class="pull-left"><div id="bannerLeft"><h1><a href="https://www.apache.org/";><img class="class java.lang.Object" src="../../images/apache-maven-project.png" /></a></h1></div></div> + <div class="pull-right"><div id="bannerRight"><h1><a href=".././"><img class="class java.lang.Object" src="../images/doxia-logo.png" /> Doxia</a></h1></div></div> <div class="clear"><hr/></div> </div> <div id="breadcrumbs"> <ul class="breadcrumb"> - <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> - <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li><a href="../index.html" title="Doxia">Doxia</a><span class="divider">/</span></li> - <li class="active ">Bindings <a href="https://github.com/apache/maven-doxia-site/tree/master/target/generated-site/xdoc/doxia-example-book/bind.xml";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-11-05</li> - <li class="pull-right"><a href="../scm.html" title="Get Sources">Get Sources</a></li> + <li><a href="https://www.apache.org/"; class="externalLink">Apache</a><span class="divider">/</span></li> + <li><a href="../../index.html">Maven</a><span class="divider">/</span></li> + <li><a href="../index.html">Doxia</a><span class="divider">/</span></li> + <li class="active">Bindings</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-07-04</li> + <li class="pull-right"><a href="../scm.html">Get Sources</a></li> </ul> </div> </header> @@ -58,73 +57,72 @@ <nav class="well sidebar-nav"> <ul class="nav nav-list"> <li class="nav-header">About Doxia</li> - <li><a href="../index.html" title="What is Doxia?"><span class="none"></span>What is Doxia?</a></li> - <li><a href="../overview.html" title="Overview"><span class="none"></span>Overview</a></li> - <li><a href="../downloads.html" title="Downloads"><span class="none"></span>Downloads</a></li> - <li><a href="../faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> + <li><a href="../index.html">What is Doxia?</a></li> + <li><a href="../overview.html">Overview</a></li> + <li><a href="../downloads.html">Downloads</a></li> + <li><a href="../faq.html">FAQ</a></li> <li class="nav-header">Documentation</li> - <li><a href="../references/index.html" title="Format References"><span class="icon-chevron-right"></span>Format References</a></li> - <li><a href="../modules/index.html" title="Doxia Modules Guide"><span class="none"></span>Doxia Modules Guide</a></li> - <li><a href="../macros/index.html" title="Doxia Macros Guide"><span class="none"></span>Doxia Macros Guide</a></li> - <li><a href="../book/index.html" title="Writing Books"><span class="none"></span>Writing Books</a></li> - <li><a href="../issues/index.html" title="Issues &amp; Gotchas"><span class="none"></span>Issues &amp; Gotchas</a></li> - <li><a href="../resources.html" title="External Resources"><span class="none"></span>External Resources</a></li> + <li><a href="../references/index.html"><span class="icon-chevron-right"></span>Format References</a></li> + <li><a href="../modules/index.html">Doxia Modules Guide</a></li> + <li><a href="../macros/index.html">Doxia Macros Guide</a></li> + <li><a href="../book/index.html">Writing Books</a></li> + <li><a href="../issues/index.html">Issues &amp; Gotchas</a></li> + <li><a href="../resources.html">External Resources</a></li> <li class="nav-header">Developer Docs</li> - <li><a href="../developers/index.html" title="Developer Centre"><span class="icon-chevron-right"></span>Developer Centre</a></li> - <li><a href="../doxia-tools/index.html" title="Doxia Tools"><span class="none"></span>Doxia Tools</a></li> + <li><a href="../developers/index.html"><span class="icon-chevron-right"></span>Developer Centre</a></li> + <li><a href="../doxia-tools/index.html">Doxia Tools</a></li> <li class="nav-header">Project Documentation</li> - <li><a href="../project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li> + <li><a href="../project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> <li class="nav-header">Maven Projects</li> - <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> - <li><a href="../../archetypes/index.html" title="Archetypes"><span class="none"></span>Archetypes</a></li> - <li><a href="../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> - <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> - <li><a href="../../plugins/index.html" title="Plugins"><span class="none"></span>Plugins</a></li> - <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> - <li><a href="../" title="Components"><span class="icon-chevron-down"></span>Components</a> + <li><a href="../../ref/current">Maven</a></li> + <li><a href="../../archetypes/index.html">Archetypes</a></li> + <li><a href="../../extensions/index.html">Extensions</a></li> + <li><a href="../../pom/index.html">Parent POMs</a></li> + <li><a href="../../plugins/index.html">Plugins</a></li> + <li><a href="../../skins/index.html">Skins</a></li> + <li><a><span class="icon-chevron-down"></span>Components</a> <ul class="nav nav-list"> - <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> - <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> - <li><a href="../index.html" title="Doxia"><span class="none"></span>Doxia</a></li> - <li><a href="../../maven-indexer/index.html" title="Indexer"><span class="none"></span>Indexer</a></li> - <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> - <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> - <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> - <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> - <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> - <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> - <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> - <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> + <li><a href="../../archetype/index.html">Archetype</a></li> + <li><a href="../../resolver/index.html">Artifact Resolver</a></li> + <li><a href="../index.html">Doxia</a></li> + <li><a href="../../maven-indexer/index.html">Indexer</a></li> + <li><a href="../../jxr/index.html">JXR</a></li> + <li><a href="../../plugin-testing/index.html">Plugin Testing</a></li> + <li><a href="../../plugin-tools/index.html">Plugin Tools</a></li> + <li><a href="../../apache-resource-bundles/index.html">Resource Bundles</a></li> + <li><a href="../../scm/index.html">SCM</a></li> + <li><a href="../../shared/index.html">Shared Components</a></li> + <li><a href="../../surefire/index.html">Surefire</a></li> + <li><a href="../../wagon/index.html">Wagon</a></li> </ul></li> <li class="nav-header">ASF</li> - <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> - <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> - <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> + <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink">How Apache Works</a></li> + <li><a href="https://www.apache.org/foundation/"; class="externalLink">Foundation</a></li> + <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink">Data Privacy</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink">Sponsoring Apache</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink">Thanks</a></li> </ul> </nav> <div class="well sidebar-nav"> <div id="poweredBy"> <div class="clear"></div> <div class="clear"></div> - <div class="clear"></div> -<a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> +<a href="https://maven.apache.org/"; class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> </div> </div> </header> - <main id="bodyColumn" class="span10" > + <main id="bodyColumn" class="span10"> <section> -<h2></h2> -<table border="0" class="table table-striped" width="100%" align="center"> +<h1></h1> +<table class="table table-striped" style="text-align: center;"> <tr class="a"> -<td align="center"> -<div align="left">Previous:<a href="index.html">Table Of Content</a></div></td> <td> -<div align="center">Up: <a href="index.html">Table Of Content</a></div></td> +<div>Previous:<a href="index.html">Table Of Content</a></div></td> <td> -<div align="right">Next: <a href="bindings.html">Bindings Overview</a></div></td></tr></table><hr /></section><section> -<h2><a name="Bindings"></a>Bindings</h2> +<div>Up: <a href="index.html">Table Of Content</a></div></td> +<td> +<div>Next: <a href="bindings.html">Bindings Overview</a></div></td></tr></table><hr /></section><section><a id="Bindings"></a> +<h1>Bindings</h1> <ul> <li><a href="bindings.html">Bindings Overview</a> <ul> @@ -141,18 +139,17 @@ <li><a href="castor.html">Castor</a> <ul> <li><a href="castor.html#Castor">Castor</a></li> -<li><a href="castor.html#Top-down_Approach_starting_with_XML_schema:">Top-down Approach (starting with XML schema):</a></li> -<li><a href="castor.html#Bottom-up_Approach_starting_with_Java_classes:">Bottom-up Approach (starting with Java classes):</a></li></ul></li></ul></section><section> -<h2></h2><hr /> -<table border="0" class="table table-striped" width="100%" align="center"> +<li><a href="castor.html#Top-down_Approach_starting_with_XML_schema.3A">Top-down Approach (starting with XML schema):</a></li> +<li><a href="castor.html#Bottom-up_Approach_starting_with_Java_classes.3A">Bottom-up Approach (starting with Java classes):</a></li></ul></li></ul></section><section><a id="null_1"></a> +<h1></h1><hr /> +<table class="table table-striped" style="text-align: center;"> <tr class="a"> -<td align="center"> -<div align="left">Previous:<a href="index.html">Table Of Content</a></div></td> <td> -<div align="center">Up: <a href="index.html">Table Of Content</a></div></td> +<div>Previous:<a href="index.html">Table Of Content</a></div></td> +<td> +<div>Up: <a href="index.html">Table Of Content</a></div></td> <td> -<div align="right">Next: <a href="bindings.html">Bindings Overview</a></div></td></tr></table></section> - </main> +<div>Next: <a href="bindings.html">Bindings Overview</a></div></td></tr></table></section> </main> </div> </div> <hr/> @@ -165,10 +162,5 @@ </div> </div> </footer> -<script> - if(anchors) { - anchors.add(); - } -</script> </body> </html> \ No newline at end of file
