Author: ltheussl
Date: Thu May 7 11:10:37 2009
New Revision: 772607
URL: http://svn.apache.org/viewvc?rev=772607&view=rev
Log:
Additional notes about links
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=772607&r1=772606&r2=772607&view=diff
==============================================================================
--- maven/doxia/site/src/site/apt/references/doxia-apt.apt (original)
+++ maven/doxia/site/src/site/apt/references/doxia-apt.apt Thu May 7 11:10:37
2009
@@ -87,7 +87,7 @@
*-----------+-----------+
+---------------------------------------------------------------------------+
-* {Anchors and links}
+* {Anchors}
~~~~~~~~~~~~~~~~~~~~~
** {Anchors for section titles}
@@ -121,7 +121,8 @@
anchors and links are case-sensitive. So the anchor for the section
title in the previous example would be <<<Anchors_for_section_titles>>>.
-** {Links}
+* {Links}
+~~~~~~~~~~~~~~~~~~~~~
In <<Doxia-1.1>> the notion of a '<local>' link was introduced in addition to
<internal> links and <external> links.
@@ -131,6 +132,8 @@
In the APT format used by <<Doxia-1.1>>, internal links have to be valid
Doxia ids, as specified in the anchors section above.
+ Note in particular that internal links in APT do <<not>> start with '#'.
+
* 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
@@ -146,6 +149,15 @@
{{{./doc/standalone.html}Standalone}}
---
+ Note in particular that the following link
+
+---
+ {{{standalone.html}Standalone}}
+---
+
+ will be interpreted as an internal link. Since you most likely meant to
+ link to another source document, you should again prepend a "./".
+
* 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}}.
