You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by bu...@apache.org on 2015/11/21 03:03:06 UTC
svn commit: r973095 [19/24] - in
/websites/staging/maven-doxia/trunk/content: ./ book/ css/ developers/
doxia-example-book/ fonts/ images/ images/profiles/ img/ issues/ js/
macros/ modules/ references/
Modified: websites/staging/maven-doxia/trunk/content/references/apt-format.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/references/apt-format.html (original)
+++ websites/staging/maven-doxia/trunk/content/references/apt-format.html Sat Nov 21 02:03:05 2015
@@ -1,259 +1,508 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-01
- | Rendered using Apache Maven Stylus Skin 1.5
+ | Generated by Apache Maven Doxia 1.6 at 2015-11-21
+ | Rendered using Apache Maven Fluido Skin 1.4
-->
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
- <title>Doxia - The APT format</title>
- <style type="text/css" media="all">
- @import url("../css/maven-base.css");
- @import url("../css/maven-theme.css");
- @import url("../css/site.css");
- </style>
- <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- <meta name="author" content="Jason van Zyl" />
- <meta name="Date-Creation-yyyymmdd" content="20090302" />
- <meta name="Date-Revision-yyyymmdd" content="20140701" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Jason van Zyl" />
+ <meta name="Date-Creation-yyyymmdd" content="20090302" />
+ <meta name="Date-Revision-yyyymmdd" content="20151121" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Doxia – The APT format</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.4.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.4.min.js"></script>
+
+
+
+<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+
<script type="text/javascript">_uacct = "UA-140879-1";
urchinTracker();</script>
- </head>
- <body class="composite">
- <div id="banner">
- <a href="../../" id="bannerLeft">
- <img src="../images/apache-maven-project-2.png" alt="" />
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://www.apache.org/" id="bannerLeft">
+ <img src="../../images/apache-maven-project.png" alt="Apache Maven"/>
</a>
- <a href=".././" id="bannerRight">
- <img src="../images/maven-logo-2.gif" alt="" />
+ </div>
+ <div class="pull-right"> <a href="../../" id="bannerRight">
+ <img src="../../images/maven-logo-black-on-white.png" />
</a>
- <div class="clear">
- <hr/>
</div>
- </div>
- <div id="breadcrumbs">
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://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="../index.html" title="Doxia">
+ Doxia</a>
+ <span class="divider">/</span>
+ </li>
+ <li class="active ">The APT format</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2015-11-21</li>
- <div class="xleft">
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
- <a href="../../index.html">Maven</a>
- >
- <a href="../index.html">Doxia</a>
- >
- The APT format
- </div>
- <div class="xright">
- Last Published: 2014-07-01
- </div>
- <div class="clear">
- <hr/>
+ </ul>
</div>
- </div>
- <div id="leftColumn">
- <div id="navcolumn">
-
- <h5>About Doxia</h5>
- <ul>
- <li class="none">
- <a href="../index.html">What is Doxia?</a>
- </li>
- <li class="none">
- <a href="../overview.html">Overview</a>
- </li>
- <li class="collapsed">
- <a href="../upgrading.html">Upgrading</a>
+
+
+ <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="none">
- <a href="../downloads.html">Downloads</a>
- </li>
- <li class="none">
- <a href="../faq.html">FAQ</a>
- </li>
- </ul>
- <h5>Documentation</h5>
- <ul>
- <li class="expanded">
- <a href="../references/index.html">Format References</a>
- <ul>
- <li class="expanded">
- <strong>Apt Format</strong>
- <ul>
- <li class="none">
- <a href="../references/doxia-apt.html">Doxia Apt Enhancements</a>
+
+ <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-down"></span>
+ Format References</a>
+ <ul class="nav nav-list">
+
+ <li class="active">
+
+ <a href="#"><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>
</ul>
</li>
- <li class="none">
- <a href="../references/fml-format.html">FML Format</a>
- </li>
- <li class="none">
- <a href="../references/xdoc-format.html">Xdoc Format</a>
+
+ <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>
</ul>
</li>
- <li class="none">
- <a href="../modules/index.html">Doxia Modules Guide</a>
- </li>
- <li class="none">
- <a href="../macros/index.html">Doxia Macros Guide</a>
- </li>
- <li class="none">
- <a href="../book/index.html">Writing Books</a>
- </li>
- <li class="none">
- <a href="../issues/index.html">Issues & Gotchas</a>
- </li>
- <li class="none">
- <a href="../resources.html">External Resources</a>
- </li>
- </ul>
- <h5>Developer Docs</h5>
- <ul>
- <li class="collapsed">
- <a href="../developers/index.html">Developer Centre</a>
+
+ <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 class="expanded">
- <a href="../doxia/index.html">Doxia 1.6</a>
- <ul>
- <li class="none">
- <a href="../doxia/index.html">Doxia base</a>
- </li>
- <li class="none">
- <a href="../doxia-sitetools/index.html">Doxia Sitetools</a>
+
+ <li>
+
+ <a href="../doxia/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/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 class="expanded">
- <a href="../doxia/index.html">Doxia 1.5</a>
- <ul>
- <li class="none">
- <a href="../doxia-archives/doxia-1.5/index.html">Doxia base</a>
+
+ <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 class="expanded">
- <a href="../doxia-archives/doxia-1.4/index.html">Doxia 1.4</a>
- <ul>
- <li class="none">
- <a href="../doxia-archives/doxia-1.4/index.html">Doxia base</a>
- </li>
- <li class="none">
- <a href="../doxia-sitetools-archives/doxia-sitetools-1.4/index.html">Doxia Sitetools</a>
+
+ <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 class="expanded">
- <a href="../doxia-archives/doxia-1.3/index.html">Doxia 1.3</a>
- <ul>
- <li class="none">
- <a href="../doxia-archives/doxia-1.3/index.html">Doxia base</a>
- </li>
- <li class="none">
- <a href="../doxia-sitetools-archives/doxia-sitetools-1.3/index.html">Doxia Sitetools</a>
+
+ <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 class="expanded">
- <a href="../doxia-archives/doxia-1.2/index.html">Doxia 1.2</a>
- <ul>
- <li class="none">
- <a href="../doxia-archives/doxia-1.2/index.html">Doxia base</a>
- </li>
- <li class="none">
- <a href="../doxia-sitetools-archives/doxia-sitetools-1.2/index.html">Doxia Sitetools</a>
+
+ <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 class="none">
- <a href="../doxia-tools/index.html">Doxia Tools</a>
- </li>
- <li class="none">
- <a href="../doxia-ide.html">Doxia IDE</a>
- </li>
- </ul>
- <h5>Project Documentation</h5>
- <ul>
- <li class="collapsed">
- <a href="../project-info.html">Project Information</a>
+
+ <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>
- </ul>
- <h5>Maven Projects</h5>
- <ul>
- <li class="none">
- <a href="../../ant-tasks/index.html">Ant Tasks</a>
- </li>
- <li class="none">
- <a href="../../archetype/index.html">Archetype</a>
- </li>
- <li class="none">
- <a href="../index.html">Doxia</a>
- </li>
- <li class="none">
- <a href="../../jxr/index.html">JXR</a>
- </li>
- <li class="none">
- <a href="../../maven-1.x/index.html">Maven 1.x</a>
- </li>
- <li class="none">
- <a href="../../index.html">Maven 2 & 3</a>
- </li>
- <li class="none">
- <a href="../../pom/index.html">Parent POMs</a>
- </li>
- <li class="none">
- <a href="../../plugins/index.html">Plugins</a>
- </li>
- <li class="none">
- <a href="../../plugin-tools/index.html">Plugin Tools</a>
- </li>
- <li class="none">
- <a href="../../scm/index.html">SCM</a>
- </li>
- <li class="none">
- <a href="../../shared/index.html">Shared Components</a>
- </li>
- <li class="none">
- <a href="../../skins/index.html">Skins</a>
- </li>
- <li class="none">
- <a href="../../surefire/index.html">Surefire</a>
- </li>
- <li class="none">
- <a href="../../wagon/index.html">Wagon</a>
- </li>
- </ul>
- <h5>ASF</h5>
- <ul>
- <li class="none">
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
- </li>
- </ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
- </a>
-
- </div>
- </div>
- <div id="bodyColumn">
- <div id="contentBox">
- <!-- 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. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt-
format.html --><div class="section">
-<h2>The APT format<a name="The_APT_format"></a></h2><!-- ~~~~~~~~~~~~ -->
+ <li class="nav-header">Maven Projects</li>
+
+ <li>
+
+ <a href="../../ant-tasks/index.html" title="Ant Tasks">
+ <span class="none"></span>
+ Ant Tasks</a>
+ </li>
+
+ <li>
+
+ <a href="../../archetype/index.html" title="Archetype">
+ <span class="none"></span>
+ Archetype</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="http://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="http://www.apache.org/foundation/" class="externalLink" title="Foundation">
+ <span class="none"></span>
+ Foundation</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">
+ <span class="none"></span>
+ Sponsoring Apache</a>
+ </li>
+
+ <li>
+
+ <a href="http://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="https://maven.apache.org/doxia" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=search-form"></script>
+
+ <hr />
+
+ <div id="poweredBy">
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+
+ <div class="g-plusone" data-href="http://maven.apache.org/doxia/" data-size="tall" ></div>
+
+ <div class="clear"></div>
+ <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>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span10" >
+
+ <!-- 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. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/
apt-format.html --><div class="section">
+<h2><a name="The_APT_format"></a>The APT format</h2><!-- ~~~~~~~~~~~~ -->
<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>
<div class="section">
-<h3>Important Notice<a name="Important_Notice"></a></h3>
+<h3><a name="Important_Notice"></a>Important Notice</h3>
<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></div>
<div class="section">
@@ -264,8 +513,7 @@
<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> First line of first paragraph.
+<div class="source"><pre class="prettyprint linenums"> First line of first paragraph.
Second line of first paragraph.
Third line of first paragraph.
@@ -273,13 +521,11 @@
Line 2 of paragraph 2.</pre></div>
<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>My section title (not indented).
+<div class="source"><pre class="prettyprint linenums">My section title (not indented).
My paragraph first line (indented by 2 spaces).</pre></div>
<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> First paragraph has its first line indented by four
+<div class="source"><pre class="prettyprint linenums"> 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.
@@ -288,14 +534,13 @@ other lines of the paragraph.
the one used for the previous paragraph.</pre></div>
<p>Note that tabs are expanded with a tab width set to 8.</p></div>
<div class="section">
-<h3>Document elements<a name="Document_elements"></a></h3><!-- ~~~~~~~~~~~~~~~~~ -->
+<h3><a name="Document_elements"></a>Document elements</h3><!-- ~~~~~~~~~~~~~~~~~ -->
<div class="section">
-<h4>Block level elements<a name="Block_level_elements"></a></h4><!-- ~~~~~~~~~~~~~~~~~~~~~ -->
+<h4><a name="Block_level_elements"></a>Block level elements</h4><!-- ~~~~~~~~~~~~~~~~~~~~~ -->
<div class="section">
-<h5>Title<a name="Title"></a></h5><!-- ~~~~~~~~ -->
+<h5><a name="Title"></a>Title</h5><!-- ~~~~~~~~ -->
<p>A title is optional. If used, it must appear as the first block of the document.</p>
-<div class="source">
-<pre> ------
+<div class="source"><pre class="prettyprint linenums"> ------
Title
------
Author
@@ -306,8 +551,7 @@ other lines of the paragraph.
<p>This text may immediately be followed by another <tt>---</tt> line and one or several consecutive lines of text which specifies the author of the document.</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> ------
+<div class="source"><pre class="prettyprint linenums"> ------
Title
------
------
@@ -318,20 +562,18 @@ other lines of the paragraph.
<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></div>
<div class="section">
-<h5>Paragraph<a name="Paragraph"></a></h5><!-- ~~~~~~~~~~~ -->
+<h5><a name="Paragraph"></a>Paragraph</h5><!-- ~~~~~~~~~~~ -->
<p>Paragraphs other than the title block may appear before the first section.</p>
-<div class="source">
-<pre> Paragraph 1, line 1.
+<div class="source"><pre class="prettyprint linenums"> 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></div>
<div class="section">
-<h5>Section<a name="Section"></a></h5><!-- ~~~~~~~~~ -->
+<h5><a name="Section"></a>Section</h5><!-- ~~~~~~~~~ -->
<p>Sections are created by inserting section titles into the document. Simple documents need not contain sections.</p>
-<div class="source">
-<pre>Section title
+<div class="source"><pre class="prettyprint linenums">Section title
* Sub-section title
@@ -342,9 +584,8 @@ other lines of the paragraph.
**** Sub-sub-sub-sub-section title</pre></div>
<p>Section titles are not indented. A sub-section title begins with one asterisk (<tt>*</tt>), a sub-sub-section title begins with two asterisks (<tt>**</tt>), and so forth up to four sub-section levels.</p></div>
<div class="section">
-<h5>List<a name="List"></a></h5><!-- ~~~~~~ -->
-<div class="source">
-<pre> * List item 1.
+<h5><a name="List"></a>List</h5><!-- ~~~~~~ -->
+<div class="source"><pre class="prettyprint linenums"> * List item 1.
* List item 2.
@@ -359,8 +600,7 @@ other lines of the paragraph.
<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 <tt>[]</tt> pseudo-element may be used to force the end of a list.</p>
-<div class="source">
-<pre> * List item 3.
+<div class="source"><pre class="prettyprint linenums"> * List item 3.
Force end of list:
[]
@@ -370,8 +610,7 @@ Verbatim text not contained in list item
--------------------------------------------</pre></div>
<p>In the previous example, without the <tt>[]</tt>, the verbatim text (not indented as all displays) would have been contained in list item 3.</p>
<p>A single <tt>[]</tt> may be used to end several nested lists at the same time. The indentation of <tt>[]</tt> may be used to specify exactly which lists should be ended. Example:</p>
-<div class="source">
-<pre> * List item 1.
+<div class="source"><pre class="prettyprint linenums"> * List item 1.
* List item 2.
@@ -385,8 +624,7 @@ Verbatim text not contained in list item
Verbatim text contained in list item 2, but not in sub-list item 2
-------------------------------------------------------------------</pre></div>
<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> [[1]] Numbered item 1.
+<div class="source"><pre class="prettyprint linenums"> [[1]] Numbered item 1.
[[A]] Numbered item A.
@@ -406,15 +644,13 @@ Verbatim text contained in list item 2,
<dt><tt>[[I]]</tt></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> [Defined term 1] of definition list 2.
+<div class="source"><pre class="prettyprint linenums"> [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></div>
<div class="section">
-<h5>Verbatim text<a name="Verbatim_text"></a></h5><!-- ~~~~~~~~~~~~~~~ -->
-<div class="source">
-<pre>----------------------------------------
+<h5><a name="Verbatim_text"></a>Verbatim text</h5><!-- ~~~~~~~~~~~~~~~ -->
+<div class="source"><pre class="prettyprint linenums">----------------------------------------
Verbatim
text,
preformatted,
@@ -424,23 +660,21 @@ Verbatim
<p><tt>+--</tt> instead of <tt>---</tt> 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></div>
<div class="section">
-<h5>Figure<a name="Figure"></a></h5><!-- ~~~~~~~~ -->
-<div class="source">
-<pre>[Figure name] Figure caption</pre></div>
+<h5><a name="Figure"></a>Figure</h5><!-- ~~~~~~~~ -->
+<div class="source"><pre class="prettyprint linenums">[Figure name] Figure caption</pre></div>
<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 <tt>/home/joe/docs/mylogo.jpeg</tt>, the figure name is <tt>/home/joe/docs/mylogo</tt>. <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 <tt>/home/joe/docs/mylogo</tt>. An APT processor will first try to load <tt>/home/joe/docs/mylogo.eps</tt>. 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 <tt>/home/joe/docs/mylogo.jpeg</tt> to encapsulated PostScript.</p></div>
<div class="section">
-<h5>Table<a name="Table"></a></h5><!-- ~~~~~~~ -->
+<h5><a name="Table"></a>Table</h5><!-- ~~~~~~~ -->
<p>A table block is not indented. It begins with a non indented line containing an asterisk and at least 2 dashes (<tt>*--</tt>). 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 (<tt>*</tt>) is used to specify that column 1 is centered,</li>
<li>the plus sign (<tt>+</tt>) specifies that column 2 is left aligned,</li>
<li>the colon (<tt>:</tt>) specifies that column 3 is right aligned.</li></ul>
-<div class="source">
-<pre>*----------*--------------+----------------:
+<div class="source"><pre class="prettyprint linenums">*----------*--------------+----------------:
| Centered | Left-aligned | Right-aligned |
| cell 1,1 | cell 1,2 | cell 1,3 |
*----------*--------------+----------------:
@@ -452,35 +686,30 @@ Table caption</pre></div>
<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 (<tt>|</tt>). (<tt>|</tt> may be used in the cell text if quoted: <tt>\|</tt>.)</p>
<p>The last <tt>|</tt> is only used to make the table nicer. The first <tt>|</tt> 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>*-----*------*
+<div class="source"><pre class="prettyprint linenums">*-----*------*
cell | cell
*-----*------*
cell | cell
*-----*------*</pre></div></div>
<div class="section">
-<h5>Horizontal rule<a name="Horizontal_rule"></a></h5><!-- ~~~~~~~~~~~~~~~~~ -->
-<div class="source">
-<pre>=====================</pre></div>
+<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 (<tt>===</tt>).</p></div>
<div class="section">
-<h5>Page break<a name="Page_break"></a></h5><!-- ~~~~~~~~~~~~ -->
-<div class="source">
-<pre>^L</pre></div>
+<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></div></div>
<div class="section">
-<h4>Text level elements<a name="Text_level_elements"></a></h4><!-- ~~~~~~~~~~~~~~~~~~~~ -->
+<h4><a name="Text_level_elements"></a>Text level elements</h4><!-- ~~~~~~~~~~~~~~~~~~~~ -->
<div class="section">
-<h5>Font<a name="Font"></a></h5><!-- ~~~~~~ -->
-<div class="source">
-<pre> <Italic> font. <<Bold>> font. <<<Monospaced>>> font.</pre></div>
+<h5><a name="Font"></a>Font</h5><!-- ~~~~~~ -->
+<div class="source"><pre class="prettyprint linenums"> <Italic> font. <<Bold>> font. <<<Monospaced>>> font.</pre></div>
<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></div>
<div class="section">
-<h5>Anchor and link<a name="Anchor_and_link"></a></h5><!-- ~~~~~~~~~~~~~~~~~ -->
-<div class="source">
-<pre> {Anchor}. Link to {{anchor}}. Link to {{http://www.pixware.fr}}.
+<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}}.
Link to {{{anchor}showing alternate text}}.
Link to {{{http://www.pixware.fr}Pixware home page}}.</pre></div>
<p>Text between curly braces (<tt>{}</tt>) specifies an anchor. Text between double curly braces (<tt>{{}}</tt>) specifies a link.</p>
@@ -490,31 +719,26 @@ Table caption</pre></div>
<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></div>
<div class="section">
-<h5>Line break<a name="Line_break"></a></h5><!-- ~~~~~~~~~~~~ -->
-<div class="source">
-<pre> Force line\
+<h5><a name="Line_break"></a>Line break</h5><!-- ~~~~~~~~~~~~ -->
+<div class="source"><pre class="prettyprint linenums"> Force line\
break.</pre></div>
<p>A backslash character (<tt>\</tt>) 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></div>
<div class="section">
-<h5>Non breaking space<a name="Non_breaking_space"></a></h5><!-- ~~~~~~~~~~~~~~~~~~~~ -->
-<div class="source">
-<pre> Non\ breaking\ space.</pre></div>
+<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 (<tt>\</tt>) followed by a space character.</p></div>
<div class="section">
-<h5>Special character<a name="Special_character"></a></h5><!-- ~~~~~~~~~~~~~~~~~~~ -->
-<div class="source">
-<pre> Escaped special characters: \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\.</pre></div>
+<h5><a name="Special_character"></a>Special character</h5><!-- ~~~~~~~~~~~~~~~~~~~ -->
+<div class="source"><pre class="prettyprint linenums"> Escaped special characters: \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\.</pre></div>
<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. (<tt>*</tt> has no special meaning in the middle of a paragraph.)</p>
-<div class="source">
-<pre> Copyright symbol: \251, \xA9, \u00a9.</pre></div>
+<div class="source"><pre class="prettyprint linenums"> Copyright symbol: \251, \xA9, \u00a9.</pre></div>
<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 <tt>\x</tt><i>NN</i> notation, where <i>NN</i> are two hexadecimal digits.</p>
<p>Unicode characters may be specified by their codes using the <tt>\u</tt><i>NNNN</i> notation, where <i>NNNN</i> are four hexadecimal digits.</p></div>
<div class="section">
-<h5>Comment<a name="Comment"></a></h5><!-- ~~~~~~~~~ -->
-<div class="source">
-<pre>~~Commented out.</pre></div>
+<h5><a name="Comment"></a>Comment</h5><!-- ~~~~~~~~~ -->
+<div class="source"><pre class="prettyprint linenums">~~Commented out.</pre></div>
<p>Text found after two tildes (<tt>~~</tt>) is ignored up to the end of line.</p>
<p>A line of <tt>~</tt> is often used to ``underline'' section titles in order to make them stand out of other paragraphs.</p><!-- PB --><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<div>
@@ -623,22 +847,24 @@ Table caption
~~Commented out.
</pre></div></div></div></div></div>
- </div>
- </div>
- <div class="clear">
- <hr/>
- </div>
- <div id="footer">
- <div class="xright">
- © 2005-2014
- The Apache Software Foundation
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
- Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
- </div>
- <div class="clear">
- <hr/>
- </div>
- </div>
- </body>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p >Copyright © 2005–2015
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All rights reserved.
+
+ </p>
+ </div>
+
+
+ </div>
+ </footer>
+ </body>
</html>
Modified: websites/staging/maven-doxia/trunk/content/references/doxia-apt.html
==============================================================================
--- websites/staging/maven-doxia/trunk/content/references/doxia-apt.html (original)
+++ websites/staging/maven-doxia/trunk/content/references/doxia-apt.html Sat Nov 21 02:03:05 2015
@@ -1,256 +1,505 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia at 2014-07-01
- | Rendered using Apache Maven Stylus Skin 1.5
+ | Generated by Apache Maven Doxia 1.6 at 2015-11-21
+ | Rendered using Apache Maven Fluido Skin 1.4
-->
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
- <title>Doxia - Doxia APT Enhancements</title>
- <style type="text/css" media="all">
- @import url("../css/maven-base.css");
- @import url("../css/maven-theme.css");
- @import url("../css/site.css");
- </style>
- <link rel="stylesheet" href="../css/print.css" type="text/css" media="print" />
- <meta name="author" content="Lukas Theussl
+ <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="author" content="Lukas Theussl
Robert Scholte" />
- <meta name="Date-Creation-yyyymmdd" content="20130406" />
- <meta name="Date-Revision-yyyymmdd" content="20140701" />
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-
-<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-
+ <meta name="Date-Creation-yyyymmdd" content="20130406" />
+ <meta name="Date-Revision-yyyymmdd" content="20151121" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>Doxia – Doxia APT Enhancements</title>
+ <link rel="stylesheet" href="../css/apache-maven-fluido-1.4.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.4.min.js"></script>
+
+
+
+<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+
<script type="text/javascript">_uacct = "UA-140879-1";
urchinTracker();</script>
- </head>
- <body class="composite">
- <div id="banner">
- <a href="../../" id="bannerLeft">
- <img src="../images/apache-maven-project-2.png" alt="" />
+
+ </head>
+ <body class="topBarDisabled">
+
+
+
+
+ <div class="container-fluid">
+ <div id="banner">
+ <div class="pull-left">
+ <a href="http://www.apache.org/" id="bannerLeft">
+ <img src="../../images/apache-maven-project.png" alt="Apache Maven"/>
</a>
- <a href=".././" id="bannerRight">
- <img src="../images/maven-logo-2.gif" alt="" />
+ </div>
+ <div class="pull-right"> <a href="../../" id="bannerRight">
+ <img src="../../images/maven-logo-black-on-white.png" />
</a>
- <div class="clear">
- <hr/>
</div>
- </div>
- <div id="breadcrumbs">
+ <div class="clear"><hr/></div>
+ </div>
+
+ <div id="breadcrumbs">
+ <ul class="breadcrumb">
+
+
+ <li class="">
+ <a href="http://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="../index.html" title="Doxia">
+ Doxia</a>
+ <span class="divider">/</span>
+ </li>
+ <li class="active ">Doxia APT Enhancements</li>
+
+
+
+ <li id="publishDate" class="pull-right">Last Published: 2015-11-21</li>
- <div class="xleft">
- <a href="http://www.apache.org/" class="externalLink">Apache</a>
- >
- <a href="../../index.html">Maven</a>
- >
- <a href="../index.html">Doxia</a>
- >
- Doxia APT Enhancements
- </div>
- <div class="xright">
- Last Published: 2014-07-01
- </div>
- <div class="clear">
- <hr/>
+ </ul>
</div>
- </div>
- <div id="leftColumn">
- <div id="navcolumn">
-
- <h5>About Doxia</h5>
- <ul>
- <li class="none">
- <a href="../index.html">What is Doxia?</a>
- </li>
- <li class="none">
- <a href="../overview.html">Overview</a>
- </li>
- <li class="collapsed">
- <a href="../upgrading.html">Upgrading</a>
+
+
+ <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="none">
- <a href="../downloads.html">Downloads</a>
- </li>
- <li class="none">
- <a href="../faq.html">FAQ</a>
- </li>
- </ul>
- <h5>Documentation</h5>
- <ul>
- <li class="expanded">
- <a href="../references/index.html">Format References</a>
- <ul>
- <li class="expanded">
- <a href="../references/apt-format.html">Apt Format</a>
- <ul>
- <li class="none">
- <strong>Doxia Apt Enhancements</strong>
+
+ <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-down"></span>
+ Format References</a>
+ <ul class="nav nav-list">
+
+ <li>
+
+ <a href="../references/apt-format.html" title="Apt Format">
+ <span class="icon-chevron-down"></span>
+ Apt Format</a>
+ <ul class="nav nav-list">
+
+ <li class="active">
+
+ <a href="#"><span class="none"></span>Doxia Apt Enhancements</a>
</li>
</ul>
</li>
- <li class="none">
- <a href="../references/fml-format.html">FML Format</a>
- </li>
- <li class="none">
- <a href="../references/xdoc-format.html">Xdoc Format</a>
+
+ <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>
</ul>
</li>
- <li class="none">
- <a href="../modules/index.html">Doxia Modules Guide</a>
- </li>
- <li class="none">
- <a href="../macros/index.html">Doxia Macros Guide</a>
- </li>
- <li class="none">
- <a href="../book/index.html">Writing Books</a>
- </li>
- <li class="none">
- <a href="../issues/index.html">Issues & Gotchas</a>
- </li>
- <li class="none">
- <a href="../resources.html">External Resources</a>
- </li>
- </ul>
- <h5>Developer Docs</h5>
- <ul>
- <li class="collapsed">
- <a href="../developers/index.html">Developer Centre</a>
+
+ <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 class="expanded">
- <a href="../doxia/index.html">Doxia 1.6</a>
- <ul>
- <li class="none">
- <a href="../doxia/index.html">Doxia base</a>
- </li>
- <li class="none">
- <a href="../doxia-sitetools/index.html">Doxia Sitetools</a>
+
+ <li>
+
+ <a href="../doxia/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/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 class="expanded">
- <a href="../doxia/index.html">Doxia 1.5</a>
- <ul>
- <li class="none">
- <a href="../doxia-archives/doxia-1.5/index.html">Doxia base</a>
+
+ <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 class="expanded">
- <a href="../doxia-archives/doxia-1.4/index.html">Doxia 1.4</a>
- <ul>
- <li class="none">
- <a href="../doxia-archives/doxia-1.4/index.html">Doxia base</a>
- </li>
- <li class="none">
- <a href="../doxia-sitetools-archives/doxia-sitetools-1.4/index.html">Doxia Sitetools</a>
+
+ <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 class="expanded">
- <a href="../doxia-archives/doxia-1.3/index.html">Doxia 1.3</a>
- <ul>
- <li class="none">
- <a href="../doxia-archives/doxia-1.3/index.html">Doxia base</a>
- </li>
- <li class="none">
- <a href="../doxia-sitetools-archives/doxia-sitetools-1.3/index.html">Doxia Sitetools</a>
+
+ <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 class="expanded">
- <a href="../doxia-archives/doxia-1.2/index.html">Doxia 1.2</a>
- <ul>
- <li class="none">
- <a href="../doxia-archives/doxia-1.2/index.html">Doxia base</a>
- </li>
- <li class="none">
- <a href="../doxia-sitetools-archives/doxia-sitetools-1.2/index.html">Doxia Sitetools</a>
+
+ <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 class="none">
- <a href="../doxia-tools/index.html">Doxia Tools</a>
- </li>
- <li class="none">
- <a href="../doxia-ide.html">Doxia IDE</a>
- </li>
- </ul>
- <h5>Project Documentation</h5>
- <ul>
- <li class="collapsed">
- <a href="../project-info.html">Project Information</a>
+
+ <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>
- </ul>
- <h5>Maven Projects</h5>
- <ul>
- <li class="none">
- <a href="../../ant-tasks/index.html">Ant Tasks</a>
- </li>
- <li class="none">
- <a href="../../archetype/index.html">Archetype</a>
- </li>
- <li class="none">
- <a href="../index.html">Doxia</a>
- </li>
- <li class="none">
- <a href="../../jxr/index.html">JXR</a>
- </li>
- <li class="none">
- <a href="../../maven-1.x/index.html">Maven 1.x</a>
- </li>
- <li class="none">
- <a href="../../index.html">Maven 2 & 3</a>
- </li>
- <li class="none">
- <a href="../../pom/index.html">Parent POMs</a>
- </li>
- <li class="none">
- <a href="../../plugins/index.html">Plugins</a>
- </li>
- <li class="none">
- <a href="../../plugin-tools/index.html">Plugin Tools</a>
- </li>
- <li class="none">
- <a href="../../scm/index.html">SCM</a>
- </li>
- <li class="none">
- <a href="../../shared/index.html">Shared Components</a>
- </li>
- <li class="none">
- <a href="../../skins/index.html">Skins</a>
- </li>
- <li class="none">
- <a href="../../surefire/index.html">Surefire</a>
- </li>
- <li class="none">
- <a href="../../wagon/index.html">Wagon</a>
- </li>
- </ul>
- <h5>ASF</h5>
- <ul>
- <li class="none">
- <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
- </li>
- <li class="none">
- <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
- </li>
- </ul>
- <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
- <img alt="Built by Maven" src="../images/logos/maven-feather.png"/>
- </a>
-
- </div>
- </div>
- <div id="bodyColumn">
- <div id="contentBox">
- <!-- 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. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/apt-
format.html --><div class="section">
-<h2>Enhancements to the APT format<a name="Enhancements_to_the_APT_format"></a></h2><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
+ <li class="nav-header">Maven Projects</li>
+
+ <li>
+
+ <a href="../../ant-tasks/index.html" title="Ant Tasks">
+ <span class="none"></span>
+ Ant Tasks</a>
+ </li>
+
+ <li>
+
+ <a href="../../archetype/index.html" title="Archetype">
+ <span class="none"></span>
+ Archetype</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="http://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="http://www.apache.org/foundation/" class="externalLink" title="Foundation">
+ <span class="none"></span>
+ Foundation</a>
+ </li>
+
+ <li>
+
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink" title="Sponsoring Apache">
+ <span class="none"></span>
+ Sponsoring Apache</a>
+ </li>
+
+ <li>
+
+ <a href="http://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="https://maven.apache.org/doxia" name="sitesearch" type="hidden"/>
+ <input class="search-query" name="q" id="query" type="text" />
+</form>
+<script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=search-form"></script>
+
+ <hr />
+
+ <div id="poweredBy">
+
+ <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
+
+
+ <div class="g-plusone" data-href="http://maven.apache.org/doxia/" data-size="tall" ></div>
+
+ <div class="clear"></div>
+ <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>
+ </div>
+ </div>
+ </div>
+
+
+ <div id="bodyColumn" class="span10" >
+
+ <!-- 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. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/references/
apt-format.html --><div class="section">
+<h2><a name="Enhancements_to_the_APT_format"></a>Enhancements to the APT format</h2><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<p>In the following we provide a list of differences/enhancements to the original <a href="./apt-format.html">APT</a> format that were incorporated in Doxia. Note that the original specification still applies to <b>Doxia-1.0</b> (used e.g. by Maven-2.0.x), the changes outlined here only apply from <b>Doxia-1.1</b> (used by Maven >= 2.1.x). Apart from some exceptions, these differences are usually 'backwards-compatible', i.e. any document that gets correctly processed by Aptconvert should also be a valid Doxia input file and lead to identical results when processed by a Doxia parser.</p>
<ul>
<li><a href="#Paragraphs_in_list_items">Paragraphs in list items</a></li>
@@ -262,30 +511,25 @@ Robert Scholte" />
<div class="section">
<h3><a name="Paragraphs_in_list_items">Paragraphs in list items</a></h3><!-- ~~~~~~~~~~~~~~~~~~~~~~~~~~ -->
<p>Contrary to the original APT parser, the Doxia APT parser does not put list items within paragraphs. Eg, the example given in the APT guide:</p>
-<div class="source">
-<pre> * List item 1.</pre></div>
+<div class="source"><pre class="prettyprint linenums"> * List item 1.</pre></div>
<p>will, for instance, produce the following html:</p>
-<div class="source">
-<pre> <li>List item 1.</li></pre></div>
+<div class="source"><pre class="prettyprint linenums"> <li>List item 1.</li></pre></div>
<p>To get the same result as aptconvert, use</p>
-<div class="source">
-<pre> *
+<div class="source"><pre class="prettyprint linenums"> *
List item 1.</pre></div>
<p>which will produce:</p>
-<div class="source">
-<pre> <li><p>List item 1.</p></li></pre></div></div>
+<div class="source"><pre class="prettyprint linenums"> <li><p>List item 1.</p></li></pre></div></div>
<div class="section">
<h3><a name="Table_header_cells">Table header cells</a></h3><!-- ~~~~~~~~~~~~~~~~~~~~ -->
<p>Header cells are defined by an additional pipe character '|' at the beginning of the cell:</p>
-<div class="source">
-<pre>*-----------+-----------+
+<div class="source"><pre class="prettyprint linenums">*-----------+-----------+
|| Header 1 || Header 2 |
*-----------+-----------+
| Cell 1 | Cell 2 |
*-----------+-----------+</pre></div>
<p>produces:</p>
-<table border="1" class="bodyTable">
+<table border="1" class="table table-striped">
<tr class="a">
<th align="left">Header 1</th>
<th align="left">Header 2</th></tr>
@@ -295,15 +539,14 @@ Robert Scholte" />
<div class="section">
<h3><a name="Multi-lines_cells_in_table">Multi-lines cells in table</a></h3><!-- ~~~~~~~~~~~~~~~~~~~~ -->
<p>Since 1.1, multi-lines cells are recognized with the character '\' at the end of the cells:</p>
-<div class="source">
-<pre>*-----------+-----------+
+<div class="source"><pre class="prettyprint linenums">*-----------+-----------+
|| Header 1 || Header 2 |
*-----------+-----------+
| Cell\ | Cell 2 |
| 1 | |
*-----------+-----------+</pre></div>
<p>produces:</p>
-<table border="1" class="bodyTable">
+<table border="1" class="table table-striped">
<tr class="a">
<th align="left">Header 1</th>
<th align="left">Header 2</th></tr>
@@ -315,8 +558,7 @@ Robert Scholte" />
<div class="section">
<h4><a name="Anchors_for_section_titles">Anchors for section titles</a></h4>
<p>Contrary to the original APT format, section titles are <b>not</b> implicitly defined anchors. If you want an anchor for a section title you need to define it explicitly as such:</p>
-<div class="source">
-<pre>* {Anchors for section titles}</pre></div></div>
+<div class="source"><pre class="prettyprint linenums">* {Anchors for section titles}</pre></div></div>
<div class="section">
<h4><a name="Anchor_construction">Anchor construction</a></h4>
<p>Contrary to the original APT format, an anchor/link is <b>not</b> its text with all non alphanumeric characters stripped. Ideally, an anchor should be a valid Doxia id, ie it must begin with a letter ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods ("."). Any anchor that does not satisfy this pattern is transformed according to the following rules:</p>
@@ -352,24 +594,25 @@ Robert Scholte" />
<div class="section">
<h3><a name="Figure_extensions">Figure extensions</a></h3><!-- ~~~~~~~~~~~~~~~~~~~ -->
<p>Contrary to the original APT format, a figure name has to be given fully <b>with</b> extension. For instance:</p>
-<div class="source">
-<pre>[/home/joe/docs/mylogo.jpeg] Figure caption</pre></div></div></div>
- </div>
- </div>
- <div class="clear">
- <hr/>
- </div>
- <div id="footer">
- <div class="xright">
- © 2005-2014
- The Apache Software Foundation
-
- - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
- Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
- </div>
- <div class="clear">
- <hr/>
- </div>
- </div>
- </body>
+<div class="source"><pre class="prettyprint linenums">[/home/joe/docs/mylogo.jpeg] Figure caption</pre></div></div></div>
+ </div>
+ </div>
+ </div>
+
+ <hr/>
+
+ <footer>
+ <div class="container-fluid">
+ <div class="row-fluid">
+ <p >Copyright © 2005–2015
+ <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+ All rights reserved.
+
+ </p>
+ </div>
+
+
+ </div>
+ </footer>
+ </body>
</html>