wiki:ImprovingBoostDocs

Version 25 (modified by Matias Capeletto, 15 years ago) ( diff )

--

Improving Boost Docs project


News


Open positions for "Improving Boost Docs" projects

These are small projects waiting for one or two folks to jump into them.


Docs Translations

The translated docs will be located in: SVN: snadbox/doc_test/libs/xxx/doc

Once they are stable, the lib author will be invited to see the results and commit them to the correct location CVS: boost/libs/xxx/doc

Volunteers looking for something to do

Add yourself here!

Volunteers sweating

  • Stjepan Rajko (translating smart_ptr)
  • Glyn Matthews (translating bind and mem_fun)
  • Darren Garvey (lists.drrngrvy@… : translating tribool and range)
  • Andrew Sutton (translating and improving graph docs)

HTML to Quickbook translations

Ongoing

  • smart_ptr (assigned to Stjepan Rajko)
  • bind (assigned to Glyn Matthews)
  • mem_fun (assigned to Glyn Matthews)
  • graph (assigned to Andrew Sutton)

Pending

  • wave (translator wanted)
  • serialization (translators wanted... it may be too big for one person)
  • spirit (translators wanted)

Authozarization from author needed

  • compatibility
  • crc
  • dynamic_bitset
  • integer
  • pool
  • random
  • rational
  • timer
  • tokenizer

Boostbook to Quickbook translations

  • tribool (assigned to Darren Garvey)
  • range (assigned to Darren Garvey)

This translations are low priority for now.

  • string_algo (translator wanted)
  • function (translator wanted)
  • signals (translator wanted)
  • assign (translator wanted)
  • ptr_container (translator wanted)

Unified look & feel

You can see the last iteration of the new style here.

Some of the new features:

  • Validated XHTML 1.1 output (better than strict XHTML)
  • New header and footer based on beta.boost.org.
  • GroupedLinks select boxes for Boost Libraries and Section quick jumping.
  • Google Search box over our docs.
  • Box-wrapper based blurbs that allow us to include rounded corners, drop shadows, etc.
  • Alternatives syntax highlighthing that simulates your own IDE (move the mouse to the upper-right corner of a code block)
  • Chapter logo support
  • Modular css design
  • css based admonitions and navigation graphics
  • PDF stylesheet matches the HTML style.

You are welcome to join boost-docs list to help us improve it even further.

The project is hosted in boost sandbox at boost/sandbox/doc_test

Last version of Boosbook: boost/sandbox/doc_test/box_wrapper/xsl

Attachments (5)

Download all attachments as: .zip

Note: See TracWiki for help on using the wiki.