maven-doxia-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Dennis Lundberg <denn...@apache.org>
Subject Re: Review Link Handling in APT
Date Sat, 12 Apr 2008 11:41:57 GMT
Vincent Siveton wrote:
> Hi Benjamin,
> 
> 2008/4/12, Benjamin Bentmann <benjamin.bentmann@udo.edu>:
>> Hi,
>>
>>  According to the APT Reference [0] and the output delivered by the Maven
>> Site Plugin 2.0-beta-6, the construct
>>
>>   {{{foo}baa}}
>>
>>  denotes an internal link to the anchor "foo" in the current document. I
>> believe this kind of linking is inconsistent/unintuitive and hence
>> error-prone.
>>
>>  For example, {{{dir/doc.pdf}baa}} will render an external link as expected.
>> Now let's move doc.pdf up one directory. The appealing snippet
>> {{{doc.pdf}baa}} will not give you the desired external link but out of a
>> sudden an internal link. To get the desired link, users need to write
>> {{{./doc.pdf}baa}}.
> 
> Not sure. Take a look to the renderer [1] and the source [2]. Link are
> external for {{{guide-testing-releases.html} test releases}}

IIRC there is some special handling if the href part of a link ends with 
".html". In such cases they are always treated as an external link.

> 
> Cheers,
> 
> Vincent
> 
> [1] http://maven.apache.org/guides/development/guide-helping.html
> [2] https://svn.apache.org/repos/asf/maven/site/trunk/src/site/apt/guides/development/guide-helping.apt
> 
> 
>>  Wouldn't it be easier, both for users and the parser, if APT would handle
>> links just like the well-known HTML format? I.e. a link is internal if and
>> only if it starts with '#'.
>>
>>  What do you think?
>>
>>
>>  Benjamin
>>
>>
>>  [0]
>> http://maven.apache.org/doxia/references/apt-format.html
>>
> 


-- 
Dennis Lundberg

Mime
View raw message