Modified: maven/doxia/website/content/overview.html ============================================================================== --- maven/doxia/website/content/overview.html (original) +++ maven/doxia/website/content/overview.html Thu Dec 12 16:16:24 2024 @@ -2,29 +2,28 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from content/xdoc/overview.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 content/xdoc/overview.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="Vincent Siveton" /> <meta name="date" content="2009-03-02" /> - <title>Doxia – Overview Of The Doxia Framework</title> - <link rel="stylesheet" href="./css/apache-maven-fluido-1.12.0.min.css" /> + <title>Overview Of The Doxia Framework â 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 ">Overview Of The Doxia Framework <a href="https://github.com/apache/maven-doxia-site/tree/master/content/xdoc/overview.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">Overview Of The Doxia Framework <a href="https://github.com/apache/maven-doxia-site/tree/master/content/xdoc/overview.xml";><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,73 +59,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 class="active"><a><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 class="active"><a>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><a name="Overview_Of_The_Doxia_Framework"></a>Overview Of The Doxia Framework</h2> + <section><a id="Overview_Of_The_Doxia_Framework"></a> +<h1>Overview Of The Doxia Framework</h1> <p> The following figure represents the main components of the Doxia Framework. </p> <p> - <img src="images/architecture.png" width="574" height="439" border="0" usemap="#Doxia_Framework" alt="Doxia Framework" /> + <img src="images/architecture.png" width="574" height="439" usemap="#Doxia_Framework" alt="Doxia Framework" /> <map id="Doxia_Framework" name="Doxia_Framework"> <area shape="rect" coords="87,45,172,99" alt="Sink API" href="http://maven.apache.org/doxia/doxia/doxia-sink-api/"; /> <area shape="rect" coords="66,170,193,232" alt="Core" href="http://maven.apache.org/doxia/doxia/doxia-core/"; /> @@ -147,11 +145,11 @@ <p> <b>Note</b>: Just like Maven, Doxia uses - <a class="externalLink" href="https://codehaus-plexus.github.io/";>Plexus</a> extensively. + <a class="externalLink externalLink" href="https://codehaus-plexus.github.io/";>Plexus</a> extensively. </p> - <section> -<h3><a name="Sink_API"></a>Sink API</h3> + <section><a id="Sink_API"></a> +<h2>Sink API</h2> <p> The <i>Sink</i> interface is a generic markup language interface. It contains @@ -163,34 +161,31 @@ For instance, you could do things like: </p> -<div class="source"><pre class="prettyprint linenums"> -sink.paragraph(); +<pre class="prettyprint linenums"><code>sink.paragraph(); sink.text( "my text" ); -sink.paragraph_(); </pre></div> +sink.paragraph_(); </code></pre> <p> similar to this HTML markup: </p> -<div class="source"><pre class="prettyprint linenums"> -<p>my text</p></pre></div> +<pre class="prettyprint linenums"><code><p>my text</p></code></pre> <p>To find out more about the Sink API, you could read the Javadoc - <a class="externalLink" href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html";>here</a>. + <a class="externalLink externalLink" href="http://maven.apache.org/doxia/doxia/doxia-sink-api/apidocs/org/apache/maven/doxia/sink/Sink.html";>here</a>. </p> </section> - <section> -<h3><a name="Doxia_Core"></a>Doxia Core</h3> + <section><a id="Doxia_Core"></a> +<h2>Doxia Core</h2> <p> The <i>Core</i> is the API to parse a source and populate it in a <i>Sink</i> object. The <i>Parser</i> interface contains only one method: </p> -<div class="source"><pre class="prettyprint linenums"> -void parse( Reader source, Sink sink ) - throws ParseException; </pre></div> +<pre class="prettyprint linenums"><code>void parse( Reader source, Sink sink ) + throws ParseException; </code></pre> <p> The <i>ParseException</i> class has the responsibility to catch all parsing @@ -211,8 +206,8 @@ void parse( Reader source, Sink sink ) </p> </section> - <section> -<h3><a name="Doxia_Modules"></a>Doxia Modules</h3> + <section><a id="Doxia_Modules"></a> +<h2>Doxia Modules</h2> <p> A Doxia module is an implementation of a given markup language like APT or Xdoc. @@ -237,16 +232,16 @@ void parse( Reader source, Sink sink ) </p> </section> - <section> -<h3><a name="Doxia_Site_Tools"></a>Doxia Site Tools</h3> + <section><a id="Doxia_Site_Tools"></a> +<h2>Doxia Site Tools</h2> <p> The <i>Site Tools</i> are a collection of tools to renderer an output. The main tool used by Maven, specifically the - <a class="externalLink" href="http://maven.apache.org/plugins/maven-site-plugin/";>Maven Site Plugin</a>, + <a class="externalLink externalLink" href="http://maven.apache.org/plugins/maven-site-plugin/";>Maven Site Plugin</a>, is the <i>doxia-site-renderer</i> which renders in HTML any documents written with supported markup syntax. It uses - <a class="externalLink" href="http://velocity.apache.org/";>Velocity templates</a> + <a class="externalLink externalLink" href="http://velocity.apache.org/";>Velocity templates</a> to customize the renderer and the <i>site-decoration-model</i> tool to decorate the renderer. This component describes the layout of the site defined in the <i>site.xml</i> @@ -260,7 +255,6 @@ void parse( Reader source, Sink sink ) </section> </section> - </main> </div> </div> @@ -274,10 +268,5 @@ void parse( Reader source, Sink sink ) </div> </div> </footer> -<script> - if(anchors) { - anchors.add(); - } -</script> </body> </html> \ No newline at end of file
Modified: maven/doxia/website/content/project-info.html ============================================================================== --- maven/doxia/website/content/project-info.html (original) +++ maven/doxia/website/content/project-info.html Thu Dec 12 16:16:24 2024 @@ -2,27 +2,26 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-site-plugin:3.12.1:CategorySummaryDocumentRenderer at 2024-11-05 - | Rendered using Apache Maven Fluido Skin 1.12.0 + | Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-site-plugin:3.21.0:project-info 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 – Project Information</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>Project Information â 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 ">Project Information</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">Project Information</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,97 +57,95 @@ <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 class="active"><a><span class="icon-chevron-down"></span>Project Information</a> <ul class="nav nav-list"> - <li><a href="index.html" title="About"><span class="none"></span>About</a></li> - <li><a href="team.html" title="Team"><span class="none"></span>Team</a></li> - <li><a href="mailing-lists.html" title="Mailing Lists"><span class="none"></span>Mailing Lists</a></li> - <li><a href="scm.html" title="Source Code Management"><span class="none"></span>Source Code Management</a></li> - <li><a href="issue-management.html" title="Issue Management"><span class="none"></span>Issue Management</a></li> - <li><a href="ci-management.html" title="CI Management"><span class="none"></span>CI Management</a></li> + <li><a href="index.html">About</a></li> + <li><a href="team.html">Team</a></li> + <li><a href="mailing-lists.html">Mailing Lists</a></li> + <li><a href="scm.html">Source Code Management</a></li> + <li><a href="issue-management.html">Issue Management</a></li> + <li><a href="ci-management.html">CI Management</a></li> </ul></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><a name="Project_Information"></a>Project Information</h2> -<p>This document provides an overview of the various documents and links that are part of this project's general information. All of this content is automatically generated by <a class="externalLink" href="http://maven.apache.org";>Maven</a> on behalf of the project.</p><section> -<h3><a name="Overview"></a>Overview</h3> -<table border="0" class="table table-striped"> +<h1>Project Information</h1> +<p>This document provides an overview of the various documents and links that are part of this project's general information. All of this content is automatically generated by <a class="externalLink" href="https://maven.apache.org";>Maven</a> on behalf of the project.</p><section> +<h2>Overview</h2> +<table class="table table-striped"> <tr class="a"> <th>Document</th> <th>Description</th></tr> <tr class="b"> -<td align="left"><a href="index.html">About</a></td> -<td align="left">Site of the Maven Doxia Framework</td></tr> +<td><a href="index.html">About</a></td> +<td>Site of the Maven Doxia Framework</td></tr> <tr class="a"> -<td align="left"><a href="team.html">Team</a></td> -<td align="left">This document provides information on the members of this project. These are the individuals who have contributed to the project in one form or another.</td></tr> +<td><a href="team.html">Team</a></td> +<td>This document provides information on the members of this project. These are the individuals who have contributed to the project in one form or another.</td></tr> <tr class="b"> -<td align="left"><a href="mailing-lists.html">Mailing Lists</a></td> -<td align="left">This document provides subscription and archive information for this project's mailing lists.</td></tr> +<td><a href="mailing-lists.html">Mailing Lists</a></td> +<td>This document provides subscription and archive information for this project's mailing lists.</td></tr> <tr class="a"> -<td align="left"><a href="scm.html">Source Code Management</a></td> -<td align="left">This document lists ways to access the online source repository.</td></tr> +<td><a href="scm.html">Source Code Management</a></td> +<td>This document lists ways to access the online source repository.</td></tr> <tr class="b"> -<td align="left"><a href="issue-management.html">Issue Management</a></td> -<td align="left">This document provides information on the issue management system used in this project.</td></tr> +<td><a href="issue-management.html">Issue Management</a></td> +<td>This document provides information on the issue management system used in this project.</td></tr> <tr class="a"> -<td align="left"><a href="ci-management.html">CI Management</a></td> -<td align="left">This document lists the continuous integration management system of this project for building and testing code on a frequent, regular basis.</td></tr></table></section></section> - </main> +<td><a href="ci-management.html">CI Management</a></td> +<td>This document lists the continuous integration management system of this project for building and testing code on a frequent, regular basis.</td></tr></table></section></section> </main> </div> </div> <hr/> @@ -161,10 +158,5 @@ </div> </div> </footer> -<script> - if(anchors) { - anchors.add(); - } -</script> </body> </html> \ No newline at end of file Modified: maven/doxia/website/content/references/apt-format.html ============================================================================== --- maven/doxia/website/content/references/apt-format.html (original) +++ maven/doxia/website/content/references/apt-format.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/references/apt-format.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/references/apt-format.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="Jason van Zyl" /> <meta name="date" content="2009-03-02" /> - <title>Doxia – The APT format</title> - <link rel="stylesheet" href="../css/apache-maven-fluido-1.12.0.min.css" /> + <title>The APT format â 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 ">The APT format <a href="https://github.com/apache/maven-doxia-site/tree/master/content/apt/references/apt-format.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">The APT format <a href="https://github.com/apache/maven-doxia-site/tree/master/content/apt/references/apt-format.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,140 +59,139 @@ <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-down"></span>Format References</a> + <li><a href="../references/index.html"><span class="icon-chevron-down"></span>Format References</a> <ul class="nav nav-list"> <li class="active"><a><span class="icon-chevron-down"></span>Apt Format</a> <ul class="nav nav-list"> - <li><a href="../references/doxia-apt.html" title="Doxia Apt Enhancements"><span class="none"></span>Doxia Apt Enhancements</a></li> + <li><a href="../references/doxia-apt.html">Doxia Apt Enhancements</a></li> </ul></li> - <li><a href="../references/fml-format.html" title="FML Format"><span class="none"></span>FML Format</a></li> - <li><a href="../references/xdoc-format.html" title="Xdoc Format"><span class="none"></span>Xdoc Format</a></li> + <li><a href="../references/fml-format.html">FML Format</a></li> + <li><a href="../references/xdoc-format.html">Xdoc Format</a></li> </ul></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="../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="The_APT_format"></a>The APT format</h2> + <main id="bodyColumn" class="span10"> +<section><a id="The_APT_format"></a> +<h1>The APT format</h1> <p>APT stands for "Almost Plain Text". APT is a markup language that takes the hassle out of documentation writing by striving for simplicity. Its syntax resembles plain-text more than it resembles most other markup formats (such as HTML).</p> -<p>This document provides some examples of available APT formatting.</p><section> -<h3><a name="Important_Notice"></a>Important Notice</h3> +<p>This document provides some examples of available APT formatting.</p><section><a id="Important_Notice"></a> +<h2>Important Notice</h2> <p>The information contained in this document corresponds to the original APT format as published by <a class="externalLink" href="http://www.xmlmind.com/";>Xmlmind</a>. In version 1.1 Maven Doxia has applied several modifications to this original format, see this separate <a href="./doxia-apt.html">document</a> for a detailed description. Notable differences are highlighted below with a <a href="./doxia-apt.html">[Change]</a> link.</p> <p>The following sections contain formatted text that demonstrates the use of APT to create paragraphs, headers, sections, lists, code samples, figures, tables, rules, breaks, and text level elements such as font styles, anchors, and special characters. Boxes containing text in typewriter-like font are examples of APT source.</p></section><section> -<h3><a name="Document_structure">Document structure</a></h3> +<h2><a id="Document_structure">Document structure</a></h2> <p>A short APT document is contained in a single text file. A longer document may be contained in a ordered list of text files. For instance, first text file contains section 1, second text file contains section 2, and so on.</p> <dl> <dt>Note:</dt> <dd>Splitting the APT document in several text files on a section boundary is not mandatory. The split may occur anywhere. However doing so is recommended because a text file containing a section is by itself a valid APT document.</dd></dl> <p>A file contains a sequence of paragraphs and ``displays'' (non paragraphs such as tables) separated by open lines.</p> <p>A paragraph is simply a sequence of consecutive text lines.</p> -<div class="source"><pre class="prettyprint linenums"> First line of first paragraph. +<pre class="prettyprint linenums"><code> First line of first paragraph. Second line of first paragraph. Third line of first paragraph. Line 1 of paragraph 2 (separated from first paragraph by an open line). - Line 2 of paragraph 2.</pre></div> + Line 2 of paragraph 2.</code></pre> <p>The indentation of the first line of a paragraph is the main method used by an APT processor to recognize the type of the paragraph. For example, a section title must not be indented at all.</p> <p>A ``plain'' paragraph must be indented by a certain amount of space. For example, a plain paragraph which is not contained in a list may be indented by two spaces.</p> -<div class="source"><pre class="prettyprint linenums">My section title (not indented). +<pre class="prettyprint linenums"><code>My section title (not indented). - My paragraph first line (indented by 2 spaces).</pre></div> + My paragraph first line (indented by 2 spaces).</code></pre> <p>Indentation is not rigid. Any amount of space will do. You don't even need to use a consistent indentation all over your document. What really matters for an APT processor is whether the paragraph is not indented at all or, when inside a list, whether a paragraph is more or less indented than the first item of the list (more about this later).</p> -<div class="source"><pre class="prettyprint linenums"> First paragraph has its first line indented by four +<pre class="prettyprint linenums"><code> First paragraph has its first line indented by four spaces. Then the author did not even bother to indent the other lines of the paragraph. Second paragraph contains several lines which are all indented by two spaces. This style is much nicer than - the one used for the previous paragraph.</pre></div> -<p>Note that tabs are expanded with a tab width set to 8.</p></section><section> -<h3><a name="Document_elements"></a>Document elements</h3><section> -<h4><a name="Block_level_elements"></a>Block level elements</h4><section> -<h5><a name="Title"></a>Title</h5> + the one used for the previous paragraph.</code></pre> +<p>Note that tabs are expanded with a tab width set to 8.</p></section><section><a id="Document_elements"></a> +<h2>Document elements</h2><section><a id="Block_level_elements"></a> +<h3>Block level elements</h3><section><a id="Title"></a> +<h4>Title</h4> <p>A title is optional. If used, it must appear as the first block of the document.</p> -<div class="source"><pre class="prettyprint linenums"> ------ +<pre class="prettyprint linenums"><code> ------ Title ------ Author ------ - Date</pre></div> + Date</code></pre> <p>A title block is indented (centering it is nicer). It begins with a line containing at least 3 dashes (<code>---</code>).</p> <p>After the first <code>---</code> line, one or several consecutive lines of text (implicit line break after each line) specify the title of the document.</p> <p>This text may immediately be followed by another <code>---</code> line and one or several consecutive lines of text which specifies the author(s) of the document. Each line represents an individual author.</p> <p>The author sub-block may optionally be followed by a date sub-block using the same syntax.</p> <p>The following example is used for a document with an title and a date but with no declared author.</p> -<div class="source"><pre class="prettyprint linenums"> ------ +<pre class="prettyprint linenums"><code> ------ Title ------ ------ Date - ------</pre></div> + ------</code></pre> <p>The last line is ignored. It is just there to make the block nicer.</p> <p><b>Note</b>: the date has no specific format and will be parsed as string. But we recommend to use the ISO-8601 standard, since formatting a date varies around the world:</p> <p><b>YYYY-MM-DD</b></p> -<p>where <b>YYYY</b> is the year in the Gregorian calendar, <b>MM</b> is the month of the year between 01 (January) and 12 (December), and <b>DD</b> is the day of the month between 01 and 31.</p></section><section> -<h5><a name="Paragraph"></a>Paragraph</h5> +<p>where <b>YYYY</b> is the year in the Gregorian calendar, <b>MM</b> is the month of the year between 01 (January) and 12 (December), and <b>DD</b> is the day of the month between 01 and 31.</p></section><section><a id="Paragraph"></a> +<h4>Paragraph</h4> <p>Paragraphs other than the title block may appear before the first section.</p> -<div class="source"><pre class="prettyprint linenums"> Paragraph 1, line 1. +<pre class="prettyprint linenums"><code> Paragraph 1, line 1. Paragraph 1, line 2. Paragraph 2, line 1. - Paragraph 2, line 2.</pre></div> -<p>Paragraphs are indented. They have already been described in the <a href="#Document_structure">Document structure</a> section.</p></section><section> -<h5><a name="Section"></a>Section</h5> + Paragraph 2, line 2.</code></pre> +<p>Paragraphs are indented. They have already been described in the <a href="#Document_structure">Document structure</a> section.</p></section><section><a id="Section"></a> +<h4>Section</h4> <p>Sections are created by inserting section titles into the document. Simple documents need not contain sections.</p> -<div class="source"><pre class="prettyprint linenums">Section title +<pre class="prettyprint linenums"><code>Section title * Sub-section title @@ -201,10 +199,10 @@ other lines of the paragraph. *** Sub-sub-sub-section title -**** Sub-sub-sub-sub-section title</pre></div> -<p>Section titles are not indented. A sub-section title begins with one asterisk (<code>*</code>), a sub-sub-section title begins with two asterisks (<code>**</code>), and so forth up to four sub-section levels.</p></section><section> -<h5><a name="List"></a>List</h5> -<div class="source"><pre class="prettyprint linenums"> * List item 1. +**** Sub-sub-sub-sub-section title</code></pre> +<p>Section titles are not indented. A sub-section title begins with one asterisk (<code>*</code>), a sub-sub-section title begins with two asterisks (<code>**</code>), and so forth up to four sub-section levels.</p></section><section><a id="List"></a> +<h4>List</h4> +<pre class="prettyprint linenums"><code> * List item 1. * List item 2. @@ -214,22 +212,22 @@ other lines of the paragraph. * Sub-list item 2. - * List item 3.</pre></div> + * List item 3.</code></pre> <p>List items are indented and begin with a asterisk (<code>*</code>).</p> <p>Plain paragraphs more indented than the first list item are nested in that list. Displays such as tables (not indented) are always nested in the current list.</p> <p>To nest a list inside a list, indent its first item more than its parent list. To end a list, add a paragraph or list item less indented than the current list.</p> <p>Section titles always end a list. Displays cannot end a list but the <code>[]</code> pseudo-element may be used to force the end of a list.</p> -<div class="source"><pre class="prettyprint linenums"> * List item 3. +<pre class="prettyprint linenums"><code> * List item 3. Force end of list: [] -------------------------------------------- Verbatim text not contained in list item 3 ---------------------------------------------</pre></div> +--------------------------------------------</code></pre> <p>In the previous example, without the <code>[]</code>, the verbatim text (not indented as all displays) would have been contained in list item 3.</p> <p>A single <code>[]</code> may be used to end several nested lists at the same time. The indentation of <code>[]</code> may be used to specify exactly which lists should be ended. Example:</p> -<div class="source"><pre class="prettyprint linenums"> * List item 1. +<pre class="prettyprint linenums"><code> * List item 1. * List item 2. @@ -241,15 +239,15 @@ Verbatim text not contained in list item ------------------------------------------------------------------- Verbatim text contained in list item 2, but not in sub-list item 2 --------------------------------------------------------------------</pre></div> +-------------------------------------------------------------------</code></pre> <p>There are three kind of lists, the bulleted lists we have already described, the numbered lists and the definition lists.</p> -<div class="source"><pre class="prettyprint linenums"> [[1]] Numbered item 1. +<pre class="prettyprint linenums"><code> [[1]] Numbered item 1. [[A]] Numbered item A. [[B]] Numbered item B. - [[2]] Numbered item 2.</pre></div> + [[2]] Numbered item 2.</code></pre> <p>A numbered list item begins with a label between two square brackets. The label of the first item establishes the numbering scheme for the whole list:</p> <dl> <dt><code>[[1]]</code></dt> @@ -263,92 +261,91 @@ Verbatim text contained in list item 2, <dt><code>[[I]]</code></dt> <dd>Upper-roman numbering: I, II, III, IV, etc.</dd></dl> <p>The labels of the items other than the first one are ignored. It is recommended to take the time to type the correct label for each item in order to keep the APT source document readable.</p> -<div class="source"><pre class="prettyprint linenums"> [Defined term 1] of definition list 2. +<pre class="prettyprint linenums"><code> [Defined term 1] of definition list 2. - [Defined term 2] of definition list 2.</pre></div> -<p>A definition list item begins with a defined term: text between square brackets.</p></section><section> -<h5><a name="Verbatim_text"></a>Verbatim text</h5> -<div class="source"><pre class="prettyprint linenums">---------------------------------------- + [Defined term 2] of definition list 2.</code></pre> +<p>A definition list item begins with a defined term: text between square brackets.</p></section><section><a id="Verbatim_text"></a> +<h4>Verbatim text</h4> +<pre class="prettyprint linenums"><code>---------------------------------------- Verbatim text, preformatted, escaped. -----------------------------------------</pre></div> +----------------------------------------</code></pre> <p>A verbatim block is not indented. It begins with a non indented line containing at least 3 dashes (<code>---</code>). It ends with a similar line.</p> <p><code>+--</code> instead of <code>---</code> draws a box around verbatim text.</p> -<p>Like in HTML, verbatim text is preformatted. Unlike HTML, verbatim text is escaped: inside a verbatim display, markup is not interpreted by the APT processor.</p></section><section> -<h5><a name="Figure"></a>Figure</h5> -<div class="source"><pre class="prettyprint linenums">[Figure name] Figure caption</pre></div> +<p>Like in HTML, verbatim text is preformatted. Unlike HTML, verbatim text is escaped: inside a verbatim display, markup is not interpreted by the APT processor.</p></section><section><a id="Figure"></a> +<h4>Figure</h4> +<pre class="prettyprint linenums"><code>[Figure name] Figure caption</code></pre> <p>A figure block is not indented. It begins with the figure name between square brackets. The figure name is optionally followed by some text: the figure caption.</p> <p>The figure name is the pathname of the file containing the figure but without an extension. Example: if your figure is contained in <code>/home/joe/docs/mylogo.jpeg</code>, the figure name is <code>/home/joe/docs/mylogo</code>. <a href="./doxia-apt.html#Figure_extensions">[Change]</a></p> <p>If the figure name comes from a relative pathname (recommended practice) rather than from an absolute pathname, this relative pathname is taken to be relative to the directory of the current APT document (a la HTML) rather than relative to the current working directory.</p> -<p>Why not leave the file extension in the figure name? This is better explained by an example. You need to convert an APT document to PostScript and your figure name is <code>/home/joe/docs/mylogo</code>. An APT processor will first try to load <code>/home/joe/docs/mylogo.eps</code>. When the desired format is not found, a APT processor tries to convert one of the existing formats. In our example, the APT processor tries to convert <code>/home/joe/docs/mylogo.jpeg</code> to encapsulated PostScript.</p></section><section> -<h5><a name="Table"></a>Table</h5> +<p>Why not leave the file extension in the figure name? This is better explained by an example. You need to convert an APT document to PostScript and your figure name is <code>/home/joe/docs/mylogo</code>. An APT processor will first try to load <code>/home/joe/docs/mylogo.eps</code>. When the desired format is not found, a APT processor tries to convert one of the existing formats. In our example, the APT processor tries to convert <code>/home/joe/docs/mylogo.jpeg</code> to encapsulated PostScript.</p></section><section><a id="Table"></a> +<h4>Table</h4> <p>A table block is not indented. It begins with a non indented line containing an asterisk and at least 2 dashes (<code>*--</code>). It ends with a similar line.</p> <p>The first line is not only used to recognize a table but also to specify column justification. In the following example,</p> <ul> <li>the second asterisk (<code>*</code>) is used to specify that column 1 is centered,</li> <li>the plus sign (<code>+</code>) specifies that column 2 is left aligned,</li> <li>the colon (<code>:</code>) specifies that column 3 is right aligned.</li></ul> -<div class="source"><pre class="prettyprint linenums">*----------*--------------+----------------: +<pre class="prettyprint linenums"><code>*----------*--------------+----------------: | Centered | Left-aligned | Right-aligned | | cell 1,1 | cell 1,2 | cell 1,3 | *----------*--------------+----------------: | cell 2,1 | cell 2,2 | cell 2,3 | *----------*--------------+----------------: -Table caption</pre></div> +Table caption</code></pre> <p>Rows are separated by a non indented line beginning with <code>*--</code>.</p> <p>An optional table caption (non indented text) may immediately follow the table.</p> <p>Rows may contain single line or multiple line cells. Each line of cell text is separated from the adjacent cell by the pipe character (<code>|</code>). (<code>|</code> may be used in the cell text if quoted: <code>\|</code>.)</p> <p>The last <code>|</code> is only used to make the table nicer. The first <code>|</code> is not only used to make the table nicer, but also to specify that a grid is to be drawn around table cells.</p> <p>The following example shows a simple table with no grid and no caption.</p> -<div class="source"><pre class="prettyprint linenums">*-----*------* +<pre class="prettyprint linenums"><code>*-----*------* cell | cell *-----*------* cell | cell -*-----*------*</pre></div></section><section> -<h5><a name="Horizontal_rule"></a>Horizontal rule</h5> -<div class="source"><pre class="prettyprint linenums">=====================</pre></div> -<p>A non indented line containing at least 3 equal signs (<code>===</code>).</p></section><section> -<h5><a name="Page_break"></a>Page break</h5> -<div class="source"><pre class="prettyprint linenums">^L</pre></div> -<p>A non indented line containing a single form feed character (Control-L).</p></section></section><section> -<h4><a name="Text_level_elements"></a>Text level elements</h4><section> -<h5><a name="Font"></a>Font</h5> -<div class="source"><pre class="prettyprint linenums"> <Italic> font. <<Bold>> font. <<<Monospaced>>> font.</pre></div> +*-----*------*</code></pre></section><section><a id="Horizontal_rule"></a> +<h4>Horizontal rule</h4> +<pre class="prettyprint linenums"><code>=====================</code></pre> +<p>A non indented line containing at least 3 equal signs (<code>===</code>).</p></section><section><a id="Page_break"></a> +<h4>Page break</h4> +<pre class="prettyprint linenums"><code>^L</code></pre> +<p>A non indented line containing a single form feed character (Control-L).</p></section></section><section><a id="Text_level_elements"></a> +<h3>Text level elements</h3><section><a id="Font"></a> +<h4>Font</h4> +<pre class="prettyprint linenums"><code> <Italic> font. <<Bold>> font. <<<Monospaced>>> font.</code></pre> <p>Text between < and > must be rendered in italic. Text between << and >> must be rendered in bold. Text between <<< and >>> must be rendered using a monospaced, typewriter-like font.</p> <p>Font elements may appear anywhere except inside other font elements.</p> -<p>It is not recommended to use font elements inside titles, section titles, links and defined terms because an APT processor automatically applies appropriate font styles to these elements.</p></section><section> -<h5><a name="Anchor_and_link"></a>Anchor and link</h5> -<div class="source"><pre class="prettyprint linenums"> {Anchor}. Link to {{anchor}}. Link to {{http://www.pixware.fr}}. +<p>It is not recommended to use font elements inside titles, section titles, links and defined terms because an APT processor automatically applies appropriate font styles to these elements.</p></section><section><a id="Anchor_and_link"></a> +<h4>Anchor and link</h4> +<pre class="prettyprint linenums"><code> {Anchor}. Link to {{anchor}}. Link to {{http://www.pixware.fr}}. Link to {{{anchor}showing alternate text}}. - Link to {{{http://www.pixware.fr}Pixware home page}}.</pre></div> + Link to {{{http://www.pixware.fr}Pixware home page}}.</code></pre> <p>Text between curly braces (<code>{}</code>) specifies an anchor. Text between double curly braces (<code>{{}}</code>) specifies a link.</p> <p>It is an error to create a link element that does not refer to an anchor of the same name. The name of an anchor/link is its text with all non alphanumeric characters stripped. <a href="./doxia-apt.html#Anchor_construction">[Change]</a></p> <p>This rule does not apply to links to <i>external</i> anchors. Text beginning with <code>http:/</code>, <code>https:/</code>, <code>ftp:/</code>, <code>file:/</code>, <code>mailto:</code>, <code>../</code>, <code>./</code> (<code>..\</code> and <code>.\</code> on Windows) is recognized as an external anchor name.</p> <p>When the construct <b>{{{</b><i>name</i><b>}</b><i>text</i><b>}}</b> is used, the link text <i>text</i> may differ from the link name <i>name</i>.</p> <p>Anchor/link elements may appear anywhere except inside other anchor/link elements.</p> -<p>Section titles are implicitly defined anchors. <a href="./doxia-apt.html#Anchors_for_section_titles">[Change]</a></p></section><section> -<h5><a name="Line_break"></a>Line break</h5> -<div class="source"><pre class="prettyprint linenums"> Force line\ - break.</pre></div> +<p>Section titles are implicitly defined anchors. <a href="./doxia-apt.html#Anchors_for_section_titles">[Change]</a></p></section><section><a id="Line_break"></a> +<h4>Line break</h4> +<pre class="prettyprint linenums"><code> Force line\ + break.</code></pre> <p>A backslash character (<code>\</code>) followed by a newline character.</p> -<p>Line breaks must not be used inside titles and tables (which are line oriented blocks with implicit line breaks).</p></section><section> -<h5><a name="Non_breaking_space"></a>Non breaking space</h5> -<div class="source"><pre class="prettyprint linenums"> Non\ breaking\ space.</pre></div> -<p>A backslash character (<code>\</code>) followed by a space character.</p></section><section> -<h5><a name="Special_character"></a>Special character</h5> -<div class="source"><pre class="prettyprint linenums"> Escaped special characters: \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\.</pre></div> +<p>Line breaks must not be used inside titles and tables (which are line oriented blocks with implicit line breaks).</p></section><section><a id="Non_breaking_space"></a> +<h4>Non breaking space</h4> +<pre class="prettyprint linenums"><code> Non\ breaking\ space.</code></pre> +<p>A backslash character (<code>\</code>) followed by a space character.</p></section><section><a id="Special_character"></a> +<h4>Special character</h4> +<pre class="prettyprint linenums"><code> Escaped special characters: \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\.</code></pre> <p>In certain contexts, these characters have a special meaning and therefore must be escaped if needed as is. They are escaped by adding a backslash in front of them. The backslash may itself be escaped by adding another backslash in front of it.</p> <p>Note that an asterisk, for example, needs to be escaped only if its begins a paragraph. (<code>*</code> has no special meaning in the middle of a paragraph.)</p> -<div class="source"><pre class="prettyprint linenums"> Copyright symbol: \251, \xA9, \u00a9.</pre></div> +<pre class="prettyprint linenums"><code> Copyright symbol: \251, \xA9, \u00a9.</code></pre> <p>Latin-1 characters (whatever is the encoding of the APT document) may be specified by their codes using a backslash followed by one to three octal digits or by using the <code>\x</code><i>NN</i> notation, where <i>NN</i> are two hexadecimal digits.</p> -<p>Unicode characters may be specified by their codes using the <code>\u</code><i>NNNN</i> notation, where <i>NNNN</i> are four hexadecimal digits.</p></section><section> -<h5><a name="Comment"></a>Comment</h5> -<div class="source"><pre class="prettyprint linenums">~~Commented out.</pre></div> +<p>Unicode characters may be specified by their codes using the <code>\u</code><i>NNNN</i> notation, where <i>NNNN</i> are four hexadecimal digits.</p></section><section><a id="Comment"></a> +<h4>Comment</h4> +<pre class="prettyprint linenums"><code>~~Commented out.</code></pre> <p>Text found after two tildes (<code>~~</code>) is ignored up to the end of line.</p> <p>A line of <code>~</code> is often used to ``underline'' section titles in order to make them stand out of other paragraphs.</p><!-- PB --> -<div> <pre> ------ Title ------ @@ -453,8 +450,7 @@ Table caption Copyright symbol: \251, \xA9, \u00a9. ~~Commented out. -</pre></div></section></section></section></section> - </main> +</pre></section></section></section></section> </main> </div> </div> <hr/> @@ -467,10 +463,5 @@ Table caption </div> </div> </footer> -<script> - if(anchors) { - anchors.add(); - } -</script> </body> </html> \ No newline at end of file
