Re: [Boost-bugs] [Boost C++ Libraries] #2701: Quickbook docs on internal link may be misleading

Subject: Re: [Boost-bugs] [Boost C++ Libraries] #2701: Quickbook docs on internal link may be misleading
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2009-01-31 10:35:21

#2701: Quickbook docs on internal link may be misleading
-------------------------------+--------------------------------------------
  Reporter:  pbristow          |       Owner:  eric_niebler          
      Type:  Feature Requests  |      Status:  new                   
 Milestone:  Boost 1.39.0      |   Component:  quickbook             
   Version:  Boost 1.37.0      |    Severity:  Cosmetic              
Resolution:                    |    Keywords:  Quickbook link article
-------------------------------+--------------------------------------------

Comment(by pbristow):

 Replying to [comment:1 danieljames]:
 > FWIW, you can can give an article id by writing something like:
 >
 > {{{
 > [article My Book One - The Big Picture Manual
 >     [quickbook 1.4]
 >     [id mybook1]
 >     [dirname mybook1]
 > ]
 > }}}
 >
 > This is documented in the
 [http://www.boost.org/doc/libs/1_37_0/doc/html/quickbook/syntax.html#quickbook.syntax.block.document

 Document section].

 Oh Dear not RFTM again :-(

 But I'm not sure things are quite right.

 If I create an article ID thus

 [article Plot in SVG
     [quickbook 1.4]
     [id SVG_plot]
 ...

 I get (in the log)

   Writing plot_in_svg/howtouse.html for section(plot_in_svg.howtouse)

 so it is using the title, Plot in SVG converted using the rules to
 "plot_in_svg"

 that than the expected "svg_plot" from the id.

 Am I still doing something silly?

 (And my 1st 'complaint' about documenting the use of this in links
 stands).

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/2701#comment:2>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.