How to design boost package web page?
Hi, I want to submit a package as well as the documentation. The existing web pages for all the packages look similar in style. I'm wondering if there are some utilities to make the web page appearance consistent. Thanks, Peng
AMDG Peng Yu wrote:
I want to submit a package as well as the documentation. The existing web pages for all the packages look similar in style. I'm wondering if there are some utilities to make the web page appearance consistent.
http://www.boost.org/tools/quickbook In Christ, Steven Watanabe
On Sat, Nov 22, 2008 at 9:57 PM, Steven Watanabe <watanabesj@gmail.com> wrote:
AMDG
Peng Yu wrote:
I want to submit a package as well as the documentation. The existing web pages for all the packages look similar in style. I'm wondering if there are some utilities to make the web page appearance consistent.
http://www.boost.org/doc/libs/1_37_0/doc/html/quickbook.html It seems that the following link on the above page is broken. Can somebody fix it? http://www.boost.org/doc/libs/1_37_0/tools/quickbook/doc/quickbook.qbk Thanks, Peng
-----Original Message----- From: boost-bounces@lists.boost.org [mailto:boost-bounces@lists.boost.org] On Behalf Of Peng Yu Sent: 23 November 2008 02:24 To: boost@lists.boost.org Subject: [boost] How to design boost package web page?
I want to submit a package as well as the documentation. The existing web pages for all the packages look similar in style. I'm wondering if there are some utilities to make the web page appearance consistent.
My personal recommendation is to use the QuickBook route, perhaps with Doxygen too. (Watch out for problems with tools file/path specification). The absurdly complicated toolchain is a pig to set up - see other peoples user-config.jam for examples, but the actual document production is painless using the wiki style formatting. It is also easy for other people to alter if you hand maintenance over to someone else - or ask someone else for help with editing. What is especially nice is to embed much of the documentation in the C++ code and include it to display fragments of code in the documentation. This greatly helps keeping the code and docs in sync. Look at other people examples: math toolkit and unit are big packages but there are other smaller ones, including the Quickbook package which may be easier to follow. Have fun! Paul --- Paul A. Bristow Prizet Farmhouse Kendal, UK LA8 8AB +44 1539 561830, mobile +44 7714330204 pbristow@hetp.u-net.com
2008/11/23 Paul A. Bristow <pbristow@hetp.u-net.com>:
The absurdly complicated toolchain is a pig to set up - see other peoples user-config.jam for examples, but the actual document production is painless using the wiki style formatting. It is also easy for other people to alter if you hand maintenance over to someone else - or ask someone else for help with editing.
It's quite easy on linux, although that's not much help if you're using windows. I've started writing some instructions at: https://svn.boost.org/trac/boost/wiki/BoostDocs/GettingStarted Daniel
-----Original Message----- From: boost-bounces@lists.boost.org [mailto:boost-bounces@lists.boost.org] On Behalf Of Daniel James Sent: 23 November 2008 11:15 To: boost@lists.boost.org Subject: Re: [boost] How to design boost package web page?
2008/11/23 Paul A. Bristow <pbristow@hetp.u-net.com>:
The absurdly complicated toolchain is a pig to set up - see other
user-config.jam for examples, but the actual document production is
peoples painless
using the wiki style formatting. It is also easy for other people to alter if you hand maintenance over to someone else - or ask someone else for help with editing.
It's quite easy on linux, although that's not much help if you're using windows. I've started writing some instructions at:
https://svn.boost.org/trac/boost/wiki/BoostDocs/GettingStarted
This is exactly what many people need in order to get writing in Quickbook without a shedload of hassle. But having done (nearly!) this recently I can add quite a few comments from the long and rocky road. I also think that this excellent page should be expanded to include the vital details from the various tools docs - it is tiresome to have to keep jumping out to each tools docs and trying to find some detail. And a 'check that this tool is working OK' step for every tool will be very helpful. And perhaps an overall check on all the tools. I also think that for many purposes, pdf format is more useful (you can use Find in the *whole* document, not just one 'page' - especially if it has an *index*. John Maddock has produced some very promising looking prototypes for the math toolkit which may need this long felt need - watch his space. Paul --- Paul A. Bristow Prizet Farmhouse Kendal, UK LA8 8AB +44 1539 561830, mobile +44 7714330204 pbristow@hetp.u-net.com
participants (4)
-
Daniel James -
Paul A. Bristow -
Peng Yu -
Steven Watanabe