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 11:44:59

#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 danieljames):

 > Oh Dear not RFTM again :-(

 I wouldn't say that, it's not that easy to find. I think the quickbook
 documentation could do with a little tutorial that introduces these
 concepts. But that's for another day.

 > I get (in the log)
 >
 >    Writing plot_in_svg/howtouse.html for section(plot_in_svg.howtouse)

 It works for me... For this quickbook file:

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

 Test
 }}}

 Which produces this boostbook:

 {{{
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
 "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
 <article id="SVG_plot" name="Plot in SVG" dirname="SVG_plot" last-
 revision="$Date: 2009/01/31 10:37:36 $"
  xmlns:xi="http://www.w3.org/2001/XInclude">
   <articleinfo>
   </articleinfo>
   <title>Plot in SVG</title>
   <para>
     Test
   </para>
 </article>
 }}}

 Note that `id` and `dirname` are both `SVG_plot`.

 If you still still can't get it to work, then I guess that's a new ticket.

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

 Yes, I don't have the time to deal with it at the moment. That's why I
 didn't accept the ticket.

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