Author: ltheussl
Date: Mon Mar 2 15:10:56 2009
New Revision: 749329
URL: http://svn.apache.org/viewvc?rev=749329&view=rev
Log:
Add section on new link handling in apt
Modified:
maven/doxia/site/src/site/apt/references/doxia-apt.apt
Modified: maven/doxia/site/src/site/apt/references/doxia-apt.apt
URL:
http://svn.apache.org/viewvc/maven/doxia/site/src/site/apt/references/doxia-apt.apt?rev=749329&r1=749328&r2=749329&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/references/doxia-apt.apt (original)
+++ maven/doxia/site/src/site/apt/references/doxia-apt.apt Mon Mar 2 15:10:56
2009
@@ -121,6 +121,35 @@
anchors and links are case-sensitive. So the anchor for the section
title in the previous example would be <<<Anchors_for_section_titles>>>.
+** {Links}
+
+ In <<Doxia-1.1>> the notion of a '<local>' link was introduced in addition to
+ <internal> links and <external> links.
+
+ * An <<internal>> link is a link to an anchor within the same source
document.
+
+ In the APT format used by <<Doxia-1.1>>, internal links have to be valid
+ Doxia ids, as specified in the anchors section above.
+
+ * A <<local>> link is a link to another document within the same site.
+
+ In the APT format used by <<Doxia-1.1>>, local links <<have to>> start with
+ either <<<./>>> or <<<../>>> to distinguish them from internal links. E.g.,
+
+---
+ {{{doc/standalone.html}Standalone}}
+---
+
+ is not valid, it should be
+
+---
+ {{{./doc/standalone.html}Standalone}}
+---
+
+ * An <<external>> link is a link that is neither local nor internal.
+
+ An external link should be a valid
{{{http://www.ietf.org/rfc/rfc2396.txt}URI}}.
+
* {Figure extensions}
~~~~~~~~~~~~~~~~~~~~~
