wiki:BoostSpecificWikiMacros

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

--

Improving Boost Docs Project

Boost Trac Wiki macros

Introduction

Trac Wiki allows the use of macros to help with common needs like a TOC or the insertion of a n image. They work similarly to Quickbook templates. There are only a bunch of them in the official Trac release, and it will be very helpful to have a set of boost specific macros that makes common things like referring to a particular section of boost docs very easy. Something like: 

   [[BoostDocSection(regex,introduction)]]

Objectives

  • Write a not too clutter proposal for new Boost specific WikiMacros, including the rationale behind each decision.

Initial Ideas

Link to boost libraries documentation

[[BoostDocLink(regex,introduction)]]

Toc generator

A macro that generates something similar to the naviagtion TOCs used by this Wiki page.

People info

[[PeopleInfo(Joel de Guzman)]]

This will render: 

[[Br]][[Image(People:joel_de_guzman.png,nolink)]]
[[Br]]'''[http://www.ohloh.net/projects/3/contributors/92 Joel de Guzman]'''
[[Br]]''joel at somewhere dot com''

This look in the wiki page like this:


Joel de Guzman
​Joel de Guzman
joel at somewhere dot com

Help wanted

If you are interested, please send a mail to the ​boost-docs list telling us you want to help.

Help wanted

Note: See TracWiki for help on using the wiki.