João Abecasis wrote:

<snip excellent detailed analysis>


However, I'd like to propose the following specific changes in the handling of identifiers,

    - identifiers should be verified to begin with a letter, possibly
      allowing an underscore as well, although that goes against html
      rules.

I wouldn't allow identifiers that were disallowed by HTML.

    - the hyphen should be allowed inside identifiers, since it seems to
      be generally allowed.

Agree.

    - QuickBook should keep track of the identifiers it generates to
      avoid reusing identifiers when it sanitizes input. This may be
      particularly important for languages that use characters outside
      the ASCII character set (como o Português ;-) where overlapping
      IDs could appear too easily.

Agree.

Even though these changes would fix Andy's issue, I think it still is important to consider the general case: it is cumbersome to refer to sanitized references. Maybe QuickBook could provide the means to generate the same sanitized reference on the spot. For instance, the mark-up

    [link [A long winded section title]]

could be used to generate,

    <link linkend="a_long_winded_section_title">A long winded section
        title</link>

For nested sections, perhaps

    [link [Section 2][Heading 1] Heading 1 of Section 2]

?

Thoughts?

Oh wow, that would be great! I wonder if there is a way we can extend this to work also with linking to sections in external docs. First, we would need a QuickBook syntax that maps to BoostBook's <libraryname>, which is currently lacking at the moment. Something like [libraryref range]. Then linking to a section in the range documentation could be:

  [link [libraryref range][Intro] Introduction to Boost.Range]

?

--
Eric Niebler
Boost Consulting
www.boost-consulting.com


-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems?  Stop!  Download the new AJAX search engine that makes
searching your log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
http://sel.as-us.falkag.net/sel?cmd=lnk&kid3432&bid#0486&dat1642
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests: 
https://lists.sourceforge.net/lists/listinfo/boost-docs

Reply via email to