There's something I've noticed that we ought to make very explicit in
some documentation guidelines somewhere (where? ;->)
I tend to print out docs and read them offline. Authors who embed
links like
You can find a flibber <link
linkend="bbv2.tutorial.conditions">here</link>
Are making docs that are useless when printed. You have to say
You can find a flibber in <xref
linkend="bbv2.tutorial.conditions"/>
If you want the reference to make any sense to a user of physical
paper. <link>s have their place, but any crucial cross-reference
information has to use something like <xref>.
--
Dave Abrahams
Boost Consulting
www.boost-consulting.com
-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://ads.osdn.com/?ad_id=6595&alloc_id=14396&op=click
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
