[ 
http://jira.codehaus.org/browse/DOXIA-138?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_104917
 ] 

Lukas Theussl commented on DOXIA-138:
-------------------------------------

I really don't like section titles as anchors. IMO, if you want to reference a 
section, you should explicitly provide an anchor.

The use of automatically constructed anchors from section titles was 
discouraged in one of the last versions of the m1 xdoc plugin [1] as it only 
led to trouble (see MPXDOC-158 and MPPDF-40 for related discussions). We will 
have the same sort of problems in doxia if we implement that, so my preference 
would be to remove this statement from the user guide.

[1] 
http://maven.apache.org/maven-1.x/plugins/xdoc/reference/xdocs.html#Referencing_sections_and_subsections

> Review and clarify the APT guide
> --------------------------------
>
>                 Key: DOXIA-138
>                 URL: http://jira.codehaus.org/browse/DOXIA-138
>             Project: Maven Doxia
>          Issue Type: Task
>          Components: Documentation, Module - Apt
>    Affects Versions: 1.0-alpha-8
>            Reporter: Lukas Theussl
>             Fix For: 1.0
>
>
> Our current apt guide is a copy of 
> http://www.xmlmind.com/_aptconvert/docs/userguide2.html, but there are 
> several issues that need clarification, eg
> * case sensitivity and white space handling in anchors
> * anchors for section titles
> * figure handling, esp extensions
> * tables: is the first line always a header row?
> Some of these depend on how things are going to be implemented.
> We also decided to remove the apt guide at 
> http://maven.apache.org/guides/mini/guide-apt-format.html and only keep the 
> one on the doxia site.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: 
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Reply via email to