Added: maven/doxia/website/content/references/apt-format.html URL: http://svn.apache.org/viewvc/maven/doxia/website/content/references/apt-format.html?rev=1829011&view=auto ============================================================================== --- maven/doxia/website/content/references/apt-format.html (added) +++ maven/doxia/website/content/references/apt-format.html Thu Apr 12 21:22:02 2018 @@ -0,0 +1,528 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from content/apt/references/apt-format.apt at 2018-04-12 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="author" content="Jason van Zyl" /> + <meta name="Date-Creation-yyyymmdd" content="20090302" /> + <meta name="Date-Revision-yyyymmdd" content="20180412" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Doxia – The APT format</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + <script type="text/javascript" src="../js/apache-maven-fluido-1.7.min.js"></script> + <!-- Google Analytics --> + <script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-140879-1']); + _gaq.push(['_trackPageview']); + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Doxia Site"/></a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/doxia-logo.png" alt="Doxia"/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> + <li class=""><a href="http://maven.apache.org/doxia/index.html"; class="externalLink" title="Doxia">Doxia</a><span class="divider">/</span></li> + <li class="active ">The APT format</li> + <li id="publishDate" class="pull-right">Last Published: 2018-04-12</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">About Doxia</li> + <li><a href="../index.html" title="What is Doxia?"><span class="none"></span>What is Doxia?</a></li> + <li><a href="../overview.html" title="Overview"><span class="none"></span>Overview</a></li> + <li><a href="../upgrading.html" title="Upgrading"><span class="icon-chevron-right"></span>Upgrading</a></li> + <li><a href="../downloads.html" title="Downloads"><span class="none"></span>Downloads</a></li> + <li><a href="../faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> + <li class="nav-header">Documentation</li> + <li><a href="../references/index.html" title="Format References"><span class="icon-chevron-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><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><a href="../modules/index.html" title="Doxia Modules Guide"><span class="none"></span>Doxia Modules Guide</a></li> + <li><a href="../macros/index.html" title="Doxia Macros Guide"><span class="none"></span>Doxia Macros Guide</a></li> + <li><a href="../book/index.html" title="Writing Books"><span class="none"></span>Writing Books</a></li> + <li><a href="../issues/index.html" title="Issues & Gotchas"><span class="none"></span>Issues & Gotchas</a></li> + <li><a href="../resources.html" title="External Resources"><span class="none"></span>External Resources</a></li> + <li class="nav-header">Developer Docs</li> + <li><a href="../developers/index.html" title="Developer Centre"><span class="icon-chevron-right"></span>Developer Centre</a></li> + <li><a href="../doxia/index.html" title="Doxia 1.8"><span class="icon-chevron-down"></span>Doxia 1.8</a> + <ul class="nav nav-list"> + <li><a href="../doxia/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.7/index.html" title="Doxia 1.7"><span class="icon-chevron-down"></span>Doxia 1.7</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.7/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.7.5/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.6/index.html" title="Doxia 1.6"><span class="icon-chevron-down"></span>Doxia 1.6</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.6/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.6/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia/index.html" title="Doxia 1.5"><span class="icon-chevron-down"></span>Doxia 1.5</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.5/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.4/index.html" title="Doxia 1.4"><span class="icon-chevron-down"></span>Doxia 1.4</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.4/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.4/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.3/index.html" title="Doxia 1.3"><span class="icon-chevron-down"></span>Doxia 1.3</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.3/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.3/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.2/index.html" title="Doxia 1.2"><span class="icon-chevron-down"></span>Doxia 1.2</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.2/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.2/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-tools/index.html" title="Doxia Tools"><span class="none"></span>Doxia Tools</a></li> + <li><a href="../doxia-ide.html" title="Doxia IDE"><span class="none"></span>Doxia IDE</a></li> + <li class="nav-header">Project Documentation</li> + <li><a href="../project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li> + <li class="nav-header">Maven Projects</li> + <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> + <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> + <li><a href="../index.html" title="Doxia"><span class="none"></span>Doxia</a></li> + <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> + <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> + <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> + <li><a href="../../plugins/index.html" title="Plugins"><span class="none"></span>Plugins</a></li> + <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> + <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> + <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> + <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> + <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> + <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> + <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> + <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> + <li class="nav-header">ASF</li> + <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> + <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> +</ul> +<form id="search-form" action="https://www.google.com/search"; method="get" > + <input value="$sitesearchValue" name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div id="twitter"> + <a href="https://twitter.com/ASFMavenProject"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a> + <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> + </div> + <div class="clear"></div> + <div class="clear"></div> +<a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > +<div class="section"> +<h2><a name="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><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"> +<h3><a name="Document_structure">Document structure</a></h3> +<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. + 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> +<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). + + 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 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. + + 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></div> +<div class="section"> +<h3><a name="Document_elements"></a>Document elements</h3> +<div class="section"> +<h4><a name="Block_level_elements"></a>Block level elements</h4> +<div class="section"> +<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 class="prettyprint linenums"> ------ + Title + ------ + Author + ------ + Date</pre></div> +<p>A title block is indented (centering it is nicer). It begins with a line containing at least 3 dashes (<tt>---</tt>).</p> +<p>After the first <tt>---</tt> 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 <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 class="prettyprint linenums"> ------ + Title + ------ + ------ + Date + ------</pre></div> +<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></div> +<div class="section"> +<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 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><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 class="prettyprint linenums">Section title + +* Sub-section title + +** Sub-sub-section title + +*** 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 (<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><a name="List"></a>List</h5> +<div class="source"><pre class="prettyprint linenums"> * List item 1. + + * List item 2. + + Paragraph contained in list item 2. + + * Sub-list item 1. + + * Sub-list item 2. + + * List item 3.</pre></div> +<p>List items are indented and begin with a asterisk (<tt>*</tt>).</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 <tt>[]</tt> pseudo-element may be used to force the end of a list.</p> +<div class="source"><pre class="prettyprint linenums"> * List item 3. + Force end of list: + + [] + +-------------------------------------------- +Verbatim text not contained in list item 3 +--------------------------------------------</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 class="prettyprint linenums"> * List item 1. + + * List item 2. + + * Sub-list item 1. + + * Sub-list item 2. + + [] + +------------------------------------------------------------------- +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 class="prettyprint linenums"> [[1]] Numbered item 1. + + [[A]] Numbered item A. + + [[B]] Numbered item B. + + [[2]] Numbered item 2.</pre></div> +<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><tt>[[1]]</tt></dt> +<dd>Decimal numbering: 1, 2, 3, 4, etc.</dd> +<dt><tt>[[a]]</tt></dt> +<dd>Lower-alpha numbering: a, b, c, d, etc.</dd> +<dt><tt>[[A]]</tt></dt> +<dd>Upper-alpha numbering: A, B, C, D, etc.</dd> +<dt><tt>[[i]]</tt></dt> +<dd>Lower-roman numbering: i, ii, iii, iv, etc.</dd> +<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 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><a name="Verbatim_text"></a>Verbatim text</h5> +<div class="source"><pre class="prettyprint linenums">---------------------------------------- +Verbatim + text, + preformatted, + escaped. +----------------------------------------</pre></div> +<p>A verbatim block is not indented. It begins with a non indented line containing at least 3 dashes (<tt>---</tt>). It ends with a similar line.</p> +<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><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><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 class="prettyprint linenums">*----------*--------------+----------------: +| 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> +<p>Rows are separated by a non indented line beginning with <tt>*--</tt>.</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 (<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 class="prettyprint linenums">*-----*------* + cell | cell +*-----*------* + cell | cell +*-----*------*</pre></div></div> +<div class="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 (<tt>===</tt>).</p></div> +<div class="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></div></div> +<div class="section"> +<h4><a name="Text_level_elements"></a>Text level elements</h4> +<div class="section"> +<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><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> +<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 <tt>http:/</tt>, <tt>https:/</tt>, <tt>ftp:/</tt>, <tt>file:/</tt>, <tt>mailto:</tt>, <tt>../</tt>, <tt>./</tt> (<tt>..\</tt> and <tt>.\</tt> 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></div> +<div class="section"> +<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><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><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 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><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> +<pre> ------ + Title + ------ + Author + ------ + Date + + Paragraph 1, line 1. + Paragraph 1, line 2. + + Paragraph 2, line 1. + Paragraph 2, line 2. + +Section title + +* Sub-section title + +** Sub-sub-section title + +*** Sub-sub-sub-section title + +**** Sub-sub-sub-sub-section title + + * List item 1. + + * List item 2. + + Paragraph contained in list item 2. + + * Sub-list item 1. + + * Sub-list item 2. + + * List item 3. + Force end of list: + + [] + ++------------------------------------------+ +Verbatim text not contained in list item 3 ++------------------------------------------+ + + [[1]] Numbered item 1. + + [[A]] Numbered item A. + + [[B]] Numbered item B. + + [[2]] Numbered item 2. + + List numbering schemes: [[1]], [[a]], [[A]], [[i]], [[I]]. + + [Defined term 1] of definition list. + + [Defined term 2] of definition list. + ++-------------------------------+ +Verbatim text + in a box ++-------------------------------+ + + --- instead of +-- suppresses the box around verbatim text. + +[Figure name] Figure caption + +*----------*--------------+----------------: +| 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 + + No grid, no caption: + +*-----*------* + cell | cell +*-----*------* + cell | cell +*-----*------* + + Horizontal line: + +======================================================================= + +^L + New page. + + <Italic> font. <<Bold>> font. <<<Monospaced>>> font. + + {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}}. + + Force line\ + break. + + Non\ breaking\ space. + + Escaped special characters: \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\. + + Copyright symbol: \251, \xA9, \u00a9. + +~~Commented out. +</pre></div></div></div></div></div> + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>Copyright ©2005–2018 +<a href="https://www.apache.org/";>The Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html> \ No newline at end of file
Added: maven/doxia/website/content/references/doxia-apt.html URL: http://svn.apache.org/viewvc/maven/doxia/website/content/references/doxia-apt.html?rev=1829011&view=auto ============================================================================== --- maven/doxia/website/content/references/doxia-apt.html (added) +++ maven/doxia/website/content/references/doxia-apt.html Thu Apr 12 21:22:02 2018 @@ -0,0 +1,276 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from content/apt/references/doxia-apt.apt at 2018-04-12 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="author" content="Lukas Theussl +Robert Scholte" /> + <meta name="Date-Creation-yyyymmdd" content="20130406" /> + <meta name="Date-Revision-yyyymmdd" content="20180412" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Doxia – Doxia APT Enhancements</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + <script type="text/javascript" src="../js/apache-maven-fluido-1.7.min.js"></script> + <!-- Google Analytics --> + <script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-140879-1']); + _gaq.push(['_trackPageview']); + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Doxia Site"/></a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/doxia-logo.png" alt="Doxia"/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> + <li class=""><a href="http://maven.apache.org/doxia/index.html"; class="externalLink" title="Doxia">Doxia</a><span class="divider">/</span></li> + <li class="active ">Doxia APT Enhancements</li> + <li id="publishDate" class="pull-right">Last Published: 2018-04-12</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">About Doxia</li> + <li><a href="../index.html" title="What is Doxia?"><span class="none"></span>What is Doxia?</a></li> + <li><a href="../overview.html" title="Overview"><span class="none"></span>Overview</a></li> + <li><a href="../upgrading.html" title="Upgrading"><span class="icon-chevron-right"></span>Upgrading</a></li> + <li><a href="../downloads.html" title="Downloads"><span class="none"></span>Downloads</a></li> + <li><a href="../faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> + <li class="nav-header">Documentation</li> + <li><a href="../references/index.html" title="Format References"><span class="icon-chevron-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><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><a href="../modules/index.html" title="Doxia Modules Guide"><span class="none"></span>Doxia Modules Guide</a></li> + <li><a href="../macros/index.html" title="Doxia Macros Guide"><span class="none"></span>Doxia Macros Guide</a></li> + <li><a href="../book/index.html" title="Writing Books"><span class="none"></span>Writing Books</a></li> + <li><a href="../issues/index.html" title="Issues & Gotchas"><span class="none"></span>Issues & Gotchas</a></li> + <li><a href="../resources.html" title="External Resources"><span class="none"></span>External Resources</a></li> + <li class="nav-header">Developer Docs</li> + <li><a href="../developers/index.html" title="Developer Centre"><span class="icon-chevron-right"></span>Developer Centre</a></li> + <li><a href="../doxia/index.html" title="Doxia 1.8"><span class="icon-chevron-down"></span>Doxia 1.8</a> + <ul class="nav nav-list"> + <li><a href="../doxia/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.7/index.html" title="Doxia 1.7"><span class="icon-chevron-down"></span>Doxia 1.7</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.7/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.7.5/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.6/index.html" title="Doxia 1.6"><span class="icon-chevron-down"></span>Doxia 1.6</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.6/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.6/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia/index.html" title="Doxia 1.5"><span class="icon-chevron-down"></span>Doxia 1.5</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.5/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.4/index.html" title="Doxia 1.4"><span class="icon-chevron-down"></span>Doxia 1.4</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.4/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.4/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.3/index.html" title="Doxia 1.3"><span class="icon-chevron-down"></span>Doxia 1.3</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.3/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.3/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.2/index.html" title="Doxia 1.2"><span class="icon-chevron-down"></span>Doxia 1.2</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.2/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.2/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-tools/index.html" title="Doxia Tools"><span class="none"></span>Doxia Tools</a></li> + <li><a href="../doxia-ide.html" title="Doxia IDE"><span class="none"></span>Doxia IDE</a></li> + <li class="nav-header">Project Documentation</li> + <li><a href="../project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li> + <li class="nav-header">Maven Projects</li> + <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> + <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> + <li><a href="../index.html" title="Doxia"><span class="none"></span>Doxia</a></li> + <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> + <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> + <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> + <li><a href="../../plugins/index.html" title="Plugins"><span class="none"></span>Plugins</a></li> + <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> + <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> + <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> + <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> + <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> + <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> + <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> + <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> + <li class="nav-header">ASF</li> + <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> + <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> +</ul> +<form id="search-form" action="https://www.google.com/search"; method="get" > + <input value="$sitesearchValue" name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div id="twitter"> + <a href="https://twitter.com/ASFMavenProject"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a> + <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> + </div> + <div class="clear"></div> + <div class="clear"></div> +<a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > +<div class="section"> +<h2><a name="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> +<li><a href="#Table_header_cells">Table header cells</a></li> +<li><a href="#Multi-lines_cells_in_table">Multi-lines cells in table</a></li> +<li><a href="#Anchors">Anchors</a></li> +<li><a href="#Links">Links</a></li> +<li><a href="#Figure_extensions">Figure extensions</a></li></ul> +<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 class="prettyprint linenums"> * List item 1.</pre></div> +<p>will, for instance, produce the following html:</p> +<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 class="prettyprint linenums"> * + + List item 1.</pre></div> +<p>which will produce:</p> +<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 class="prettyprint linenums">*-----------+-----------+ +|| Header 1 || Header 2 | +*-----------+-----------+ +| Cell 1 | Cell 2 | +*-----------+-----------+</pre></div> +<p>produces:</p> +<table border="1" class="table table-striped"> +<tr class="a"> +<th align="left">Header 1</th> +<th align="left">Header 2</th></tr> +<tr class="b"> +<td align="left">Cell 1</td> +<td align="left">Cell 2</td></tr></table></div> +<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 class="prettyprint linenums">*-----------+-----------+ +|| Header 1 || Header 2 | +*-----------+-----------+ +| Cell\ | Cell 2 | +| 1 | | +*-----------+-----------+</pre></div> +<p>produces:</p> +<table border="1" class="table table-striped"> +<tr class="a"> +<th align="left">Header 1</th> +<th align="left">Header 2</th></tr> +<tr class="b"> +<td align="left">Cell <br />1</td> +<td align="left">Cell 2</td></tr></table></div> +<div class="section"> +<h3><a name="Anchors">Anchors</a></h3> +<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 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> +<ul> +<li>Any whitespace at the start and end is removed</li> +<li>If the first character is not a letter, prepend the letter 'a'</li> +<li>Any spaces are replaced with an underscore '_'</li> +<li>Any characters not matching the above pattern are stripped.</li></ul> +<p>Note in particular that case is preserved in this conversation and that APT anchors and links are case-sensitive. So the anchor for the section title in the previous example would be <tt>Anchors_for_section_titles</tt>.</p></div></div> +<div class="section"> +<h3><a name="Links">Links</a></h3> +<p>In <b>Doxia-1.1</b> the notion of a '<i>local</i>' link was introduced in addition to <i>internal</i> links and <i>external</i> links.</p> +<ul> +<li>An <b>internal</b> link is a link to an anchor within the same source document. +<p>In the APT format used by <b>Doxia-1.1</b>, internal links have to be valid Doxia ids, as specified in the anchors section above.</p> +<p>Note in particular that internal links in APT do <b>not</b> start with '#'.</p></li> +<li>A <b>local</b> link is a link to another document within the same site. +<p>In the APT format used by <b>Doxia-1.1</b>, local links <b>have to</b> start with either <tt>./</tt> or <tt>../</tt> to distinguish them from internal links. E.g.,</p> +<div> +<pre> {{{doc/standalone.html}Standalone}}</pre></div> +<p>is not valid, it should be</p> +<div> +<pre> {{{./doc/standalone.html}Standalone}}</pre></div> +<p>Note in particular that the following link</p> +<div> +<pre> {{{standalone.html}Standalone}}</pre></div> +<p>will be interpreted as an internal link (dots are valid characters in anchor names). Since you most likely meant to link to another source document, you should again prepend a "./".</p></li> +<li>An <b>external</b> link is a link that is neither local nor internal. +<p>An external link should be a valid <a class="externalLink" href="http://www.ietf.org/rfc/rfc2396.txt";>URI</a>.</p></li></ul> +<p>Anchors are always translated to a valid id, including escaping. In some situation this can cause issues, especially when referring to a javadoc-link.<br />Since Doxia 1.4 there is support for literal anchors, by using 2 hashed (##) instead of 1. This implies that the writer is responsible for using the right URL encoding!</p> +<div> +<pre> {{{../apidocs/groovyx/net/http/ParserRegistry.html##parseText(org.apache.http.HttpResponse)}ParserRegistry}}</pre></div></div> +<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 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–2018 +<a href="https://www.apache.org/";>The Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html> \ No newline at end of file Added: maven/doxia/website/content/references/fml-format.html URL: http://svn.apache.org/viewvc/maven/doxia/website/content/references/fml-format.html?rev=1829011&view=auto ============================================================================== --- maven/doxia/website/content/references/fml-format.html (added) +++ maven/doxia/website/content/references/fml-format.html Thu Apr 12 21:22:02 2018 @@ -0,0 +1,272 @@ +<!DOCTYPE html> +<!-- + | Generated by Apache Maven Doxia Site Renderer 1.8 from content/xdoc/references/fml-format.xml at 2018-04-12 + | Rendered using Apache Maven Fluido Skin 1.7 +--> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta charset="UTF-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /> + <meta name="author" content="Lukas Theussl" /> + <meta name="Date-Revision-yyyymmdd" content="20180412" /> + <meta http-equiv="Content-Language" content="en" /> + <title>Doxia – The FML (FAQ Markup Language) format</title> + <link rel="stylesheet" href="../css/apache-maven-fluido-1.7.min.css" /> + <link rel="stylesheet" href="../css/site.css" /> + <link rel="stylesheet" href="../css/print.css" media="print" /> + <script type="text/javascript" src="../js/apache-maven-fluido-1.7.min.js"></script> + <!-- Google Analytics --> + <script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-140879-1']); + _gaq.push(['_trackPageview']); + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script> + </head> + <body class="topBarDisabled"> + <div class="container-fluid"> + <div id="banner"> + <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" alt="Doxia Site"/></a></div> + <div class="pull-right"><a href=".././" id="bannerRight"><img src="../images/doxia-logo.png" alt="Doxia"/></a></div> + <div class="clear"><hr/></div> + </div> + + <div id="breadcrumbs"> + <ul class="breadcrumb"> + <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> + <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> + <li class=""><a href="http://maven.apache.org/doxia/index.html"; class="externalLink" title="Doxia">Doxia</a><span class="divider">/</span></li> + <li class="active ">The FML (FAQ Markup Language) format</li> + <li id="publishDate" class="pull-right">Last Published: 2018-04-12</li> + </ul> + </div> + <div class="row-fluid"> + <div id="leftColumn" class="span2"> + <div class="well sidebar-nav"> + <ul class="nav nav-list"> + <li class="nav-header">About Doxia</li> + <li><a href="../index.html" title="What is Doxia?"><span class="none"></span>What is Doxia?</a></li> + <li><a href="../overview.html" title="Overview"><span class="none"></span>Overview</a></li> + <li><a href="../upgrading.html" title="Upgrading"><span class="icon-chevron-right"></span>Upgrading</a></li> + <li><a href="../downloads.html" title="Downloads"><span class="none"></span>Downloads</a></li> + <li><a href="../faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> + <li class="nav-header">Documentation</li> + <li><a href="../references/index.html" title="Format References"><span class="icon-chevron-down"></span>Format References</a> + <ul class="nav nav-list"> + <li><a href="../references/apt-format.html" title="Apt Format"><span class="icon-chevron-right"></span>Apt Format</a></li> + <li class="active"><a href="#"><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><a href="../modules/index.html" title="Doxia Modules Guide"><span class="none"></span>Doxia Modules Guide</a></li> + <li><a href="../macros/index.html" title="Doxia Macros Guide"><span class="none"></span>Doxia Macros Guide</a></li> + <li><a href="../book/index.html" title="Writing Books"><span class="none"></span>Writing Books</a></li> + <li><a href="../issues/index.html" title="Issues & Gotchas"><span class="none"></span>Issues & Gotchas</a></li> + <li><a href="../resources.html" title="External Resources"><span class="none"></span>External Resources</a></li> + <li class="nav-header">Developer Docs</li> + <li><a href="../developers/index.html" title="Developer Centre"><span class="icon-chevron-right"></span>Developer Centre</a></li> + <li><a href="../doxia/index.html" title="Doxia 1.8"><span class="icon-chevron-down"></span>Doxia 1.8</a> + <ul class="nav nav-list"> + <li><a href="../doxia/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.7/index.html" title="Doxia 1.7"><span class="icon-chevron-down"></span>Doxia 1.7</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.7/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.7.5/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.6/index.html" title="Doxia 1.6"><span class="icon-chevron-down"></span>Doxia 1.6</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.6/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.6/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia/index.html" title="Doxia 1.5"><span class="icon-chevron-down"></span>Doxia 1.5</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.5/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.4/index.html" title="Doxia 1.4"><span class="icon-chevron-down"></span>Doxia 1.4</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.4/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.4/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.3/index.html" title="Doxia 1.3"><span class="icon-chevron-down"></span>Doxia 1.3</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.3/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.3/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-archives/doxia-1.2/index.html" title="Doxia 1.2"><span class="icon-chevron-down"></span>Doxia 1.2</a> + <ul class="nav nav-list"> + <li><a href="../doxia-archives/doxia-1.2/index.html" title="Doxia base"><span class="none"></span>Doxia base</a></li> + <li><a href="../doxia-sitetools-archives/doxia-sitetools-1.2/index.html" title="Doxia Sitetools"><span class="none"></span>Doxia Sitetools</a></li> + </ul> +</li> + <li><a href="../doxia-tools/index.html" title="Doxia Tools"><span class="none"></span>Doxia Tools</a></li> + <li><a href="../doxia-ide.html" title="Doxia IDE"><span class="none"></span>Doxia IDE</a></li> + <li class="nav-header">Project Documentation</li> + <li><a href="../project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li> + <li class="nav-header">Maven Projects</li> + <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> + <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> + <li><a href="../index.html" title="Doxia"><span class="none"></span>Doxia</a></li> + <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> + <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> + <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> + <li><a href="../../plugins/index.html" title="Plugins"><span class="none"></span>Plugins</a></li> + <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> + <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> + <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> + <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> + <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> + <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> + <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> + <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> + <li class="nav-header">ASF</li> + <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> + <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> +</ul> +<form id="search-form" action="https://www.google.com/search"; method="get" > + <input value="$sitesearchValue" name="sitesearch" type="hidden"/> + <input class="search-query" name="q" id="query" type="text" /> +</form> +<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script> + <hr /> + <div id="poweredBy"> + <div class="clear"></div> + <div class="clear"></div> + <div id="twitter"> + <a href="https://twitter.com/ASFMavenProject"; class="twitter-follow-button" data-show-count="false" data-align="left" data-size="medium" data-show-screen-name="true" data-lang="en">Follow ASFMavenProject</a> + <script type="text/javascript">!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script> + </div> + <div class="clear"></div> + <div class="clear"></div> +<a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a> + </div> + </div> + </div> + <div id="bodyColumn" class="span10" > + + + + <div class="section"> +<h2><a name="The_FML_format"></a>The FML format</h2> + +<div class="section"> +<h3><a name="Overview"></a>Overview</h3> + +<p> + An 'fml' (FAQ Markup Language) is an XML document conforming to a small and simple set of tags. + The format was first used in the <a class="externalLink" href="http://maven.apache.org/maven-1.x/";>Maven 1</a>, + version of the <a class="externalLink" href="http://maven.apache.org/maven-1.x/plugins/faq/";>FAQ plugin</a>. + </p> + </div> + + +<div class="section"> +<h3><a name="The_FML_format"></a>The FML format</h3> + +<p> + The full documentation is available at <a href="../doxia/doxia-modules/doxia-module-fml/xsddoc/index.html">here</a>. + </p> + </div> + + +<div class="section"> +<h3><a name="FML_Sample"></a>FML Sample</h3> + +<p> + The following is a sample FML document: + </p> + +<div class="source"><pre class="prettyprint linenums"><?xml version="1.0" encoding="UTF-8"?> +<faqs xmlns="http://maven.apache.org/FML/1.0.1" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd" + title="Frequently Asked Questions" + toplink="false"> + + <part id="general"> + <title>General</title> + + <faq id="whats-foo"> + <question> + What is Foo? + </question> + <answer> + <p>some markup goes here</p> + + <source>some source code</source> + + <p>some markup goes here</p> + </answer> + </faq> + + <faq id="whats-bar"> + <question> + What is Bar? + </question> + <answer> + <p>some markup goes here</p> + </answer> + </faq> + </part> + + <part id="install"> + + <title>Installation</title> + + <faq id="how-install"> + <question> + How do I install Foo? + </question> + <answer> + <p>some markup goes here</p> + </answer> + </faq> + + </part> + +</faqs> +</pre></div> + + </div> + </div> + + +<div class="section"> +<h2><a name="Validation"></a>Validation</h2> + +<p> + Doxia is able to validate your fml files as described + <a href="../doxia/doxia-modules/doxia-module-fml/using-fml-xsd.html">here</a>. + </p> + </div> + + + + </div> + </div> + </div> + <hr/> + <footer> + <div class="container-fluid"> + <div class="row-fluid"> + <p>Copyright ©2005–2018 +<a href="https://www.apache.org/";>The Apache Software Foundation</a>. +All rights reserved.</p> + </div> + </div> + </footer> + </body> +</html> \ No newline at end of file
