Added: maven/doxia/website/content/developers/sink.html URL: http://svn.apache.org/viewvc/maven/doxia/website/content/developers/sink.html?rev=1829011&view=auto ============================================================================== --- maven/doxia/website/content/developers/sink.html (added) +++ maven/doxia/website/content/developers/sink.html Thu Apr 12 21:22:02 2018 @@ -0,0 +1,297 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from content/apt/developers/sink.apt at 2018-04-12 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="author" content="Vincent Siveton" /> + <meta name="Date-Creation-yyyymmdd" content="20080302" /> + <meta name="Date-Revision-yyyymmdd" content="20180412" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Doxia – Doxia Developers Centre</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + <script type="text/javascript" src="../js/apache-maven-fluido-1.7.min.js"></script> + <!-- Google Analytics --> + <script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-140879-1']); + _gaq.push(['_trackPageview']); + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Doxia Site"/></a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/doxia-logo.png" alt="Doxia"/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> + <li class=""><a href="http://maven.apache.org/doxia/index.html"; class="externalLink" title="Doxia">Doxia</a><span class="divider">/</span></li> + <li class="active ">Doxia Developers Centre</li> + <li id="publishDate" class="pull-right">Last Published: 2018-04-12</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div 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="../upgrading.html" title="Upgrading"><span class="icon-chevron-right"></span>Upgrading</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 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 & Gotchas"><span class="none"></span>Issues & Gotchas</a></li> + <li><a href="../resources.html" title="External Resources"><span class="none"></span>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> + <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 href="#"><span class="none"></span>Using the Sink API</a></li> + </ul> +</li> + <li><a href="../doxia/index.html" title="Doxia 1.8"><span class="icon-chevron-down"></span>Doxia 1.8</a> + <ul class="nav nav-list"> + <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> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.7/index.html" title="Doxia 1.7"><span class="icon-chevron-down"></span>Doxia 1.7</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.7/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.7.5/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.6/index.html" title="Doxia 1.6"><span class="icon-chevron-down"></span>Doxia 1.6</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.6/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.6/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia/index.html" title="Doxia 1.5"><span class="icon-chevron-down"></span>Doxia 1.5</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.5/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.4/index.html" title="Doxia 1.4"><span class="icon-chevron-down"></span>Doxia 1.4</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.4/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.4/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.3/index.html" title="Doxia 1.3"><span class="icon-chevron-down"></span>Doxia 1.3</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.3/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.3/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.2/index.html" title="Doxia 1.2"><span class="icon-chevron-down"></span>Doxia 1.2</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.2/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.2/index.html" title="Doxia Sitetools"><span class="none"></span>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-ide.html" title="Doxia IDE"><span class="none"></span>Doxia IDE</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 class="nav-header">Maven Projects</li> + <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="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> + <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</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="../../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="../../skins/index.html" title="Skins"><span class="none"></span>Skins</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 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://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> +</ul> +<form id="search-form" action="https://www.google.com/search"; method="get" > + <input value="$sitesearchValue" name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div id="twitter"> + <a href="https://twitter.com/ASFMavenProject"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a> + <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> + </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> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > +<div class="section"> +<h2><a name="Using_the_Doxia_Sink_API"></a>Using the Doxia Sink API</h2> +<ul> +<li><a href="#Transforming_documents">Transforming documents</a></li> +<li><a href="#Generating_documents">Generating documents</a></li> +<li><a href="#Passing_attributes_to_Sink_events">Passing attributes to Sink events</a></li> +<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> +<div class="section"> +<h3><a name="Transforming_documents">Transforming documents</a></h3> +<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" ) ); + File inputFile = new File( userDir, "test.apt" ); + File outputFile = new File( userDir, "test.html" ); + + SinkFactory sinkFactory = (SinkFactory) lookup( SinkFactory.ROLE, "html" ); // Plexus lookup + + Sink sink = sinkFactory.createSink( outputFile.getParentFile(), outputFile.getName() ) ); + + Parser parser = (AptParser) lookup( Parser.ROLE, "apt" ); // Plexus lookup + + Reader reader = ReaderFactory.newReader( inputFile, "UTF-8" ); + + parser.parse( reader, sink );</pre></div> +<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 ( <tt>Parser parser = new AptParser();</tt> ) 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></div> +<div class="section"> +<h3><a name="Generating_documents">Generating documents</a></h3> +<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"> /** + * Generate a simple document and emit it + * into the specified sink. The sink is flushed but not closed. + * + * @param sink The sink to receive the events. + */ + public static void generate( Sink sink ) + { + sink.head(); + + sink.title(); + sink.text( "Title" ); + sink.title_(); + + sink.author(); + sink.text( "Author" ); + sink.author_(); + + sink.date(); + sink.text( "Date" ); + sink.date_(); + + sink.head_(); + + + sink.body(); + + sink.paragraph(); + sink.text( "A paragraph of text." ); + sink.paragraph_(); + + sink.section1(); + sink.sectionTitle1(); + sink.text( "Section title" ); + sink.sectionTitle1_(); + + sink.paragraph(); + sink.text( "Paragraph in section." ); + sink.paragraph_(); + + sink.section1_(); + + sink.body_(); + + sink.flush(); + }</pre></div> +<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></div> +<div class="section"> +<h3><a name="Passing_attributes_to_Sink_events">Passing attributes to Sink events</a></h3> +<p>With Doxia 1.1 a number of methods have been added to the Sink API that allow to pass a set of attributes to many sink events. A typical use case would be:</p> +<div class="source"><pre class="prettyprint linenums">SinkEventAttributeSet atts = new SinkEventAttributeSet(); +atts.addAttribute( SinkEventAttributes.ALIGN, "center" ); + +sink.paragraph( atts );</pre></div> +<p>What kind of attributes are 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 preferably when emitting events.</p></div> +<div class="section"> +<h3><a name="Avoid_sink.rawText.21"></a><a name="Avoid_sink.rawText">Avoid sink.rawText!</a></h3> +<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\">" ); +sink.text( "A text with a cool style." ); +sink.rawText( "</div>" );</pre></div> +<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(); +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> +<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></div> +<div class="section"> +<h3><a name="How_to_inject_javascript_code_into_HTML">How to inject javascript code into HTML</a></h3> +<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 +// 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 //"; + +SinkEventAttributeSet atts = new SinkEventAttributeSet(); +atts.addAttribute( SinkEventAttributes.TYPE, "text/javascript" ); + +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></div> +<div class="section"> +<h3><a name="References">References</a></h3> +<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></div></div> + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>Copyright ©2005–2018 +<a href="https://www.apache.org/";>The Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html> \ No newline at end of file
Added: maven/doxia/website/content/doap_Doxia.rdf URL: http://svn.apache.org/viewvc/maven/doxia/website/content/doap_Doxia.rdf?rev=1829011&view=auto ============================================================================== --- maven/doxia/website/content/doap_Doxia.rdf (added) +++ maven/doxia/website/content/doap_Doxia.rdf Thu Apr 12 21:22:02 2018 @@ -0,0 +1,82 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> +<rdf:RDF xml:lang="en" xmlns="http://usefulinc.com/ns/doap#"; xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"; xmlns:asfext="http://projects.apache.org/ns/asfext#"; xmlns:foaf="http://xmlns.com/foaf/0.1/";> + <Project rdf:about="http://Maven.rdf.apache.org/";> + <created>2001</created> + <license rdf:resource="http://www.apache.org/licenses/LICENSE-2.0.txt"/> + <name>Apache Maven Doxia</name> + <homepage rdf:resource="https://maven.apache.org/doxia/"/> + <asfext:pmc rdf:resource="http://maven.apache.org/"/> + <shortdesc>Doxia is a content generation framework, which supports many markup languages.</shortdesc> + <description>Doxia is a content generation framework which aims to provide its users with powerful techniques for generating static and dynamic content: Doxia can be used in web-based publishing context to generate static sites, in addition to being incorporated into dynamic content generation systems like blogs, wikis and content management systems.</description> + <bug-database rdf:resource="https://issues.apache.org/jira/browse/DOXIA"/> + <bug-database rdf:resource="https://issues.apache.org/jira/browse/DOXIASITETOOLS"/> + <bug-database rdf:resource="https://issues.apache.org/jira/browse/DOXIATOOLS"/> + <mailing-list rdf:resource="https://maven.apache.org/doxia/mail-lists.html"/> + <download-page rdf:resource="https://maven.apache.org/doxia/download.html"/> + <programming-language>Java</programming-language> + <category rdf:resource="http://projects.apache.org/category/build-management"/> + <release> + <Version> + <name>Doxia base</name> + <created>2016-02-06</created> + <revision>1.7</revision> + <file-release>http://archive.apache.org/dist/maven/doxia/doxia-1.7-source-release.zip</file-release> + </Version> + </release> + <release> + <Version> + <name>Doxia Sitetools</name> + <created>2016-11-08</created> + <revision>1.7.4</revision> + <file-release>http://archive.apache.org/dist/maven/doxia/doxia-sitetools-1.7.4-source-release.zip</file-release> + </Version> + </release> + <repository> + <SVNRepository> + <location rdf:resource="http://svn.apache.org/repos/asf/maven/doxia/doxia/trunk/"/> + <browse rdf:resource="http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/"/> + </SVNRepository> + </repository> + <repository> + <SVNRepository> + <location rdf:resource="http://svn.apache.org/repos/asf/maven/doxia/doxia-sitetools/trunk/"/> + <browse rdf:resource="http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/"/> + </SVNRepository> + </repository> + <repository> + <SVNRepository> + <location rdf:resource="http://svn.apache.org/repos/asf/maven/doxia/doxia-tools/trunk/"/> + <browse rdf:resource="http://svn.apache.org/viewvc/maven/doxia/doxia-tools/trunk/"/> + </SVNRepository> + </repository> + <repository> + <SVNRepository> + <location rdf:resource="http://svn.apache.org/repos/asf/maven/doxia/site/trunk/"/> + <browse rdf:resource="http://svn.apache.org/viewvc/maven/doxia/site/trunk/"/> + </SVNRepository> + </repository> + <maintainer> + <foaf:Person> + <foaf:name>Apache Maven PMC</foaf:name> + <foaf:mbox rdf:resource="mailto:d...@maven.apache.org"/> + </foaf:Person> + </maintainer> + </Project> +</rdf:RDF> Added: maven/doxia/website/content/downloads.html URL: http://svn.apache.org/viewvc/maven/doxia/website/content/downloads.html?rev=1829011&view=auto ============================================================================== --- maven/doxia/website/content/downloads.html (added) +++ maven/doxia/website/content/downloads.html Thu Apr 12 21:22:02 2018 @@ -0,0 +1,174 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from content/apt/downloads.apt at 2018-04-12 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="author" content="Vincent Siveton" /> + <meta name="Date-Creation-yyyymmdd" content="20090302" /> + <meta name="Date-Revision-yyyymmdd" content="20180412" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Doxia – Download</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="./css/site.css" /> + <link rel="stylesheet" href="./css/print.css" media="print" /> + <script type="text/javascript" src="./js/apache-maven-fluido-1.7.min.js"></script> + <!-- Google Analytics --> + <script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-140879-1']); + _gaq.push(['_trackPageview']); + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../images/apache-maven-project.png" alt="Doxia Site"/></a></div> + <div class="pull-right"><a href="./" id="bannerRight"><img src="images/doxia-logo.png" alt="Doxia"/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="../index.html" title="Maven">Maven</a><span class="divider">/</span></li> + <li class=""><a href="http://maven.apache.org/doxia/index.html"; class="externalLink" title="Doxia">Doxia</a><span class="divider">/</span></li> + <li class="active ">Download</li> + <li id="publishDate" class="pull-right">Last Published: 2018-04-12</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div 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="upgrading.html" title="Upgrading"><span class="icon-chevron-right"></span>Upgrading</a></li> + <li class="active"><a href="#"><span class="none"></span>Downloads</a></li> + <li><a href="faq.html" title="FAQ"><span class="none"></span>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 & Gotchas"><span class="none"></span>Issues & Gotchas</a></li> + <li><a href="resources.html" title="External Resources"><span class="none"></span>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/index.html" title="Doxia 1.8"><span class="icon-chevron-down"></span>Doxia 1.8</a> + <ul class="nav nav-list"> + <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> + </ul> +</li> + <li><a href="doxia-archives/doxia-1.7/index.html" title="Doxia 1.7"><span class="icon-chevron-down"></span>Doxia 1.7</a> + <ul class="nav nav-list"> + <li><a href="doxia-archives/doxia-1.7/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="doxia-sitetools-archives/doxia-sitetools-1.7.5/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="doxia-archives/doxia-1.6/index.html" title="Doxia 1.6"><span class="icon-chevron-down"></span>Doxia 1.6</a> + <ul class="nav nav-list"> + <li><a href="doxia-archives/doxia-1.6/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="doxia-sitetools-archives/doxia-sitetools-1.6/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="doxia/index.html" title="Doxia 1.5"><span class="icon-chevron-down"></span>Doxia 1.5</a> + <ul class="nav nav-list"> + <li><a href="doxia-archives/doxia-1.5/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + </ul> +</li> + <li><a href="doxia-archives/doxia-1.4/index.html" title="Doxia 1.4"><span class="icon-chevron-down"></span>Doxia 1.4</a> + <ul class="nav nav-list"> + <li><a href="doxia-archives/doxia-1.4/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="doxia-sitetools-archives/doxia-sitetools-1.4/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="doxia-archives/doxia-1.3/index.html" title="Doxia 1.3"><span class="icon-chevron-down"></span>Doxia 1.3</a> + <ul class="nav nav-list"> + <li><a href="doxia-archives/doxia-1.3/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="doxia-sitetools-archives/doxia-sitetools-1.3/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="doxia-archives/doxia-1.2/index.html" title="Doxia 1.2"><span class="icon-chevron-down"></span>Doxia 1.2</a> + <ul class="nav nav-list"> + <li><a href="doxia-archives/doxia-1.2/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="doxia-sitetools-archives/doxia-sitetools-1.2/index.html" title="Doxia Sitetools"><span class="none"></span>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-ide.html" title="Doxia IDE"><span class="none"></span>Doxia IDE</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 class="nav-header">Maven Projects</li> + <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="../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> + <li><a href="../ref/current" title="Maven"><span class="none"></span>Maven</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="../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="../skins/index.html" title="Skins"><span class="none"></span>Skins</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 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://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> +</ul> +<form id="search-form" action="https://www.google.com/search"; method="get" > + <input value="$sitesearchValue" name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div id="twitter"> + <a href="https://twitter.com/ASFMavenProject"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a> + <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> + </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> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > +<div class="section"> +<h2><a name="Maven_Doxia_Releases"></a>Maven Doxia Releases</h2> +<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="http://repo.maven.apache.org/maven2/org/apache/maven/doxia/";>http://repo.maven.apache.org/maven2/org/apache/maven/doxia/</a></li></ul></div> + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>Copyright ©2005–2018 +<a href="https://www.apache.org/";>The Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html> \ No newline at end of file Added: maven/doxia/website/content/doxia URL: http://svn.apache.org/viewvc/maven/doxia/website/content/doxia?rev=1829011&view=auto ============================================================================== --- maven/doxia/website/content/doxia (added) +++ maven/doxia/website/content/doxia Thu Apr 12 21:22:02 2018 @@ -0,0 +1 @@ +link components/doxia \ No newline at end of file Propchange: maven/doxia/website/content/doxia ------------------------------------------------------------------------------ svn:special = * Added: maven/doxia/website/content/doxia-1.8.pdf URL: http://svn.apache.org/viewvc/maven/doxia/website/content/doxia-1.8.pdf?rev=1829011&view=auto ============================================================================== Binary file - no diff available. Propchange: maven/doxia/website/content/doxia-1.8.pdf ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: maven/doxia/website/content/doxia-archives URL: http://svn.apache.org/viewvc/maven/doxia/website/content/doxia-archives?rev=1829011&view=auto ============================================================================== --- maven/doxia/website/content/doxia-archives (added) +++ maven/doxia/website/content/doxia-archives Thu Apr 12 21:22:02 2018 @@ -0,0 +1 @@ +link components/doxia-archives \ No newline at end of file Propchange: maven/doxia/website/content/doxia-archives ------------------------------------------------------------------------------ svn:special = * Added: maven/doxia/website/content/doxia-example-book/aegis-binding.html URL: http://svn.apache.org/viewvc/maven/doxia/website/content/doxia-example-book/aegis-binding.html?rev=1829011&view=auto ============================================================================== --- maven/doxia/website/content/doxia-example-book/aegis-binding.html (added) +++ maven/doxia/website/content/doxia-example-book/aegis-binding.html Thu Apr 12 21:22:02 2018 @@ -0,0 +1,311 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from target/generated-site/xdoc/doxia-example-book/aegis-binding.xml at 2018-04-12 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="author" content="XFire User's Guide" /> + <meta name="Date-Revision-yyyymmdd" content="20180412" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Doxia – Aegis Binding</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + <script type="text/javascript" src="../js/apache-maven-fluido-1.7.min.js"></script> + <!-- Google Analytics --> + <script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-140879-1']); + _gaq.push(['_trackPageview']); + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Doxia Site"/></a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/doxia-logo.png" alt="Doxia"/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> + <li class=""><a href="http://maven.apache.org/doxia/index.html"; class="externalLink" title="Doxia">Doxia</a><span class="divider">/</span></li> + <li class="active ">Aegis Binding</li> + <li id="publishDate" class="pull-right">Last Published: 2018-04-12</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div 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="../upgrading.html" title="Upgrading"><span class="icon-chevron-right"></span>Upgrading</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 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 & Gotchas"><span class="none"></span>Issues & Gotchas</a></li> + <li><a href="../resources.html" title="External Resources"><span class="none"></span>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/index.html" title="Doxia 1.8"><span class="icon-chevron-down"></span>Doxia 1.8</a> + <ul class="nav nav-list"> + <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> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.7/index.html" title="Doxia 1.7"><span class="icon-chevron-down"></span>Doxia 1.7</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.7/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.7.5/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.6/index.html" title="Doxia 1.6"><span class="icon-chevron-down"></span>Doxia 1.6</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.6/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.6/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia/index.html" title="Doxia 1.5"><span class="icon-chevron-down"></span>Doxia 1.5</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.5/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.4/index.html" title="Doxia 1.4"><span class="icon-chevron-down"></span>Doxia 1.4</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.4/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.4/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.3/index.html" title="Doxia 1.3"><span class="icon-chevron-down"></span>Doxia 1.3</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.3/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.3/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.2/index.html" title="Doxia 1.2"><span class="icon-chevron-down"></span>Doxia 1.2</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.2/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.2/index.html" title="Doxia Sitetools"><span class="none"></span>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-ide.html" title="Doxia IDE"><span class="none"></span>Doxia IDE</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 class="nav-header">Maven Projects</li> + <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="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> + <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</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="../../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="../../skins/index.html" title="Skins"><span class="none"></span>Skins</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 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://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> +</ul> +<form id="search-form" action="https://www.google.com/search"; method="get" > + <input value="$sitesearchValue" name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div id="twitter"> + <a href="https://twitter.com/ASFMavenProject"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a> + <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> + </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> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > +<div class="section"> +<h2></h2> +<table class="table table-striped" width="100%" align="center" border="0"> +<tr class="a"> +<td align="left">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 /></div> +<div class="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></div> +<div class="section"> +<h2><a name="XML_and_Annotation_Mapping_Overview"></a>XML and Annotation Mapping Overview</h2> +<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 +{ + private String name; + private String title; + + public String getName() { return name; } + public void setName(String name) { this.name = name; } + + public String getTitle() { return title; } + public void setTitle(String title) { this.title = title; } +}</pre></div> +<p>In XML this translates to:</p> +<div class="source"><pre class="prettyprint linenums"><Employee xmlns="http://xfire.codehaus.org"> + <name>Santa Claus</name> + <title>Chief Present Officer (CPO)</title> +</Employee></pre></div> +<p>In XML Schema this would become a complex type:</p> +<div class="source"><pre class="prettyprint linenums"><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> +<div class="section"> +<h3><a name="Supported_Types"></a>Supported Types</h3> +<ul> +<li>Basic types: int, double, float, long, byte[], short, String, BigDecimal</li> +<li>Arrays</li> +<li>Collections</li> +<li>Dates: java.util.Date, java.util.Calendar, java.sql.Timestamp, java.sql.Date, java.sql.Time</li> +<li>XML: org.w3c.dom.Docmument, org.jdom.Element, XMLStreamReader, Source</li> +<li>Complex types which are aggregations of the above</li></ul> +<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> + <mapping uri="" name=""> + <method name="methodName"> + <return-type mappedName="" componentType=""/> + <parameter index="" mappedName=""/> + </method> + <property name="" mappedName="" style="attribute|element" componentType=""/> + </mapping> +</mappings></pre></div> +<p>Note that <tt> <method> </tt> 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></div></div> +<div class="section"> +<h2><a name="Controlling_Naming"></a>Controlling Naming</h2> +<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"> + <mapping name="np:Employee"> + <property name="name" mappedName="Name"/> + <property name="title" mappedName="Title"/> + </mapping> +</mappings></pre></div> +<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"> + <np:Name>Santa Claus</np:Name> + <np:Title>Chief Present Officer (CPO)</np:Title> +</np:Employee></pre></div> +<div class="section"> +<h3><a name="Ignoring_properties"></a>Ignoring properties</h3> +<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> + <mapping> + <property name="propertyName" ignore="true"/> + </mapping> +</mappings></pre></div></div> +<div class="section"> +<h3><a name="Handling_Collections"></a>Handling Collections</h3> +<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 +{ + Collection getEmployees(String id) { ... } +}</pre></div> +<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> + <mapping> + <method name="getEmployees"> + <return-type componentType="org.codehaus.xfire.Employee" /> + </method> + </mapping> +</mappings></pre></div></div> +<div class="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 +{ + Map getGiftList() { /* returns a map of NiceChild => Present */ } +}</pre></div> +<p>The mapping file should look like this:</p> +<div class="source"><pre class="prettyprint linenums"><mappings> + <mapping> + <method name="getGiftList"> + <return-type keyType="org.codehaus.xfire.NiceChild" componentType="org.codehaus.xfire.Present"> + </method> + </mapping> +</mappings></pre></div> +<p>This will generate the following type:</p> +<div class="source"><pre class="prettyprint linenums"><xsd:complexType name="NiceChild2PresentMap"> + <xsd:sequence> + <xsd:element name="entry" minOccurs="0" maxOccurs="unbounded"> + <xsd:complexType> + <xsd:sequence> + <xsd:element name="key" type="ns1:NiceChild" minOccurs="0" maxOccurs="1"/> + <xsd:element name="value" type="ns1:Present" minOccurs="0" maxOccurs="1"/> + </xsd:sequence> + </xsd:complexType> + </xsd:element> + </xsd:sequence> +</xsd:complexType></pre></div></div></div> +<div class="section"> +<h2><a name="Interfaces_and_Aegis"></a>Interfaces and Aegis</h2> +<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 { + public String getUsername(); + public String getPasswrod(); +}</pre></div> +<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></div> +<div class="section"> +<h2></h2><hr /> +<table class="table table-striped" width="100%" align="center" border="0"> +<tr class="a"> +<td align="left">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></div> + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>Copyright ©2005–2018 +<a href="https://www.apache.org/";>The Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html> \ No newline at end of file Added: maven/doxia/website/content/doxia-example-book/bind.html URL: http://svn.apache.org/viewvc/maven/doxia/website/content/doxia-example-book/bind.html?rev=1829011&view=auto ============================================================================== --- maven/doxia/website/content/doxia-example-book/bind.html (added) +++ maven/doxia/website/content/doxia-example-book/bind.html Thu Apr 12 21:22:02 2018 @@ -0,0 +1,206 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from target/generated-site/xdoc/doxia-example-book/bind.xml at 2018-04-12 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="Date-Revision-yyyymmdd" content="20180412" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Doxia – Bindings</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + <script type="text/javascript" src="../js/apache-maven-fluido-1.7.min.js"></script> + <!-- Google Analytics --> + <script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-140879-1']); + _gaq.push(['_trackPageview']); + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Doxia Site"/></a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/doxia-logo.png" alt="Doxia"/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> + <li class=""><a href="http://maven.apache.org/doxia/index.html"; class="externalLink" title="Doxia">Doxia</a><span class="divider">/</span></li> + <li class="active ">Bindings</li> + <li id="publishDate" class="pull-right">Last Published: 2018-04-12</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div 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="../upgrading.html" title="Upgrading"><span class="icon-chevron-right"></span>Upgrading</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 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 & Gotchas"><span class="none"></span>Issues & Gotchas</a></li> + <li><a href="../resources.html" title="External Resources"><span class="none"></span>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/index.html" title="Doxia 1.8"><span class="icon-chevron-down"></span>Doxia 1.8</a> + <ul class="nav nav-list"> + <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> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.7/index.html" title="Doxia 1.7"><span class="icon-chevron-down"></span>Doxia 1.7</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.7/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.7.5/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.6/index.html" title="Doxia 1.6"><span class="icon-chevron-down"></span>Doxia 1.6</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.6/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.6/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia/index.html" title="Doxia 1.5"><span class="icon-chevron-down"></span>Doxia 1.5</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.5/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.4/index.html" title="Doxia 1.4"><span class="icon-chevron-down"></span>Doxia 1.4</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.4/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.4/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.3/index.html" title="Doxia 1.3"><span class="icon-chevron-down"></span>Doxia 1.3</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.3/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.3/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.2/index.html" title="Doxia 1.2"><span class="icon-chevron-down"></span>Doxia 1.2</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.2/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.2/index.html" title="Doxia Sitetools"><span class="none"></span>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-ide.html" title="Doxia IDE"><span class="none"></span>Doxia IDE</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 class="nav-header">Maven Projects</li> + <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="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> + <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</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="../../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="../../skins/index.html" title="Skins"><span class="none"></span>Skins</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 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://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> +</ul> +<form id="search-form" action="https://www.google.com/search"; method="get" > + <input value="$sitesearchValue" name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div id="twitter"> + <a href="https://twitter.com/ASFMavenProject"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a> + <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> + </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> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > +<div class="section"> +<h2></h2> +<table border="0" class="table table-striped" width="100%" align="center"> +<tr class="a"> +<td> +<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> +<td> +<div align="right">Next: <a href="bindings.html">Bindings Overview</a></div></td></tr></table><hr /></div> +<div class="section"> +<h2><a name="Bindings"></a>Bindings</h2> +<ul> +<li><a href="bindings.html">Bindings Overview</a> +<ul> +<li><a href="bindings.html#Bindings_Overview">Bindings Overview</a></li> +<li><a href="bindings.html#Using_another_binding">Using another binding</a></li> +<li><a href="bindings.html#Convenience_ServiceFactorys">Convenience ServiceFactorys</a></li> +<li><a href="bindings.html#The_MessageBinding">The MessageBinding</a></li></ul></li> +<li><a href="aegis-binding.html">Aegis Binding</a> +<ul> +<li><a href="aegis-binding.html#Aegis_Binding">Aegis Binding</a></li> +<li><a href="aegis-binding.html#XML_and_Annotation_Mapping_Overview">XML and Annotation Mapping Overview</a></li> +<li><a href="aegis-binding.html#Controlling_Naming">Controlling Naming</a></li> +<li><a href="aegis-binding.html#Interfaces_and_Aegis">Interfaces and Aegis</a></li></ul></li> +<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></div> +<div class="section"> +<h2></h2><hr /> +<table border="0" class="table table-striped" width="100%" align="center"> +<tr class="a"> +<td> +<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> +<td> +<div align="right">Next: <a href="bindings.html">Bindings Overview</a></div></td></tr></table></div> + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>Copyright ©2005–2018 +<a href="https://www.apache.org/";>The Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html> \ No newline at end of file
