33 | | In construction! |
| 33 | === Introduction === |
| 34 | |
| 35 | It will be excellent if I could write directly in Quickbook syntax |
| 36 | in the Trac Wiki. This would allow us to have an uniform syntax in |
| 37 | our Wiki and docs sources, allowing to copy and paste, share stylesheets, etc. |
| 38 | |
| 39 | An example of the use will be: |
| 40 | |
| 41 | {{{ |
| 42 | #!quickbook |
| 43 | |
| 44 | [heading Quickbook Rocks!] |
| 45 | |
| 46 | [table |
| 47 | |
| 48 | [[Feature ][Purpose ]] |
| 49 | |
| 50 | [[Templates ][Extensibility and constants ]] |
| 51 | [[Code import ][Code consistency, callouts and reuse ]] |
| 52 | [[Wiki style formatting ][High signal to noise ratio in source code ]] |
| 53 | [[Internal links ][Easy to use inter-doc anchors ]] |
| 54 | [[Syntax Highlighting ][Both in code blocks and in `inline code` ]] |
| 55 | |
| 56 | ] |
| 57 | }}} |
| 58 | |
| 59 | From some initial research we need two things: |
| 60 | |
| 61 | (1) The completion of Rene Rivera's [QuickbookHtmlBackend quickbook HTML backend]. |
| 62 | (2) A [WikiProcessors Trac WikiProcessor] written in Python that integrates Rene |
| 63 | works in the Trac Wiki. |
| 64 | |
| 65 | === Objectives === |
| 66 | |
| 67 | Complete the second point from the above list. Rene could then use it to test |
| 68 | his work and we will have a *very* good reason to finished the backend. |
| 69 | |
| 70 | A second task will be to look into the |
| 71 | [http://trac.edgewall.org/wiki/ProcessorBazaar Trac Processor Bazaar] to |
| 72 | investigate what things may be useful for us ( Take a look at |
| 73 | [http://trac.edgewall.org/wiki/ProcessorBazaar#docbook docbook], |
| 74 | [http://trac.edgewall.org/wiki/ProcessorBazaar#graphviz graphviz] |
| 75 | and http://trac.edgewall.org/wiki/ProcessorBazaar#latex-math latex-math] ). |
| 76 | |
| 77 | === Help wanted === |
| 78 | |
| 79 | If you are interested, please send a mail to the |
| 80 | [https://lists.sourceforge.net/lists/listinfo/boost-docs boost-docs list] |
| 81 | telling us you want to help. |
| 82 | |
| 83 | [[Image(http://matias.capeletto.googlepages.com/help_wanted.png,nolink)]] |