![]() |
Home | Libraries | People | FAQ | More |
To do this... | Use this... |
---|---|
comment | [/ some comment] |
italics | ['italics] or /italics/ |
bold | [*bold] or *bold* |
underline | [_underline] or _underline_ |
teletype | [^teletype] or =teletype= |
source mode | [c++] or [python] |
inline code | `int main();` |
line break | [br] |
line break | \n |
anchor | [#anchor] |
link | [@http://www.boost.org Boost] |
anchor link | [link section.anchor Link text] |
refentry link | [link xml.refentry Link text] |
function link | [funcref fully::qualified::function_name Link text] |
class link | [classref fully::qualified::class_name Link text] |
member link | [memberref fully::qualified::member_name Link text] |
enum link | [enumref fully::qualified::enum_name Link text] |
header link | [headerref path/to/header.hpp Link text] |
escape | '''escaped text (no processing/formatting)''' |
single char escape | \c |
images | [$image.jpg] |
begin section | [section The Section Title] |
end section | [endsect] |
paragraph | No markup. Paragraphs start left-flushed and are terminated by two or more newlines. |
ordered list | # one # two # three |
unordered list | * one * two * three |
code | No markup. Preformatted code starts with a space or a tab. |
preformatted | [pre preformatted] |
block quote | [:sometext...] |
heading 1 | [h1 Heading 1] |
heading 2 | [h2 Heading 2] |
heading 3 | [h3 Heading 3] |
heading 4 | [h4 Heading 4] |
heading 5 | [h5 Heading 5] |
heading 6 | [h6 Heading 6] |
macro | [def macro_identifier some text] |
blurb | [blurb advertisement or note...] |
table | [table Title [[a][b][c]] [[a][b][c]] ] |
variablelist | [variablelist Title [[a][b]] [[a][b]] ] |
Copyright © 2002, 2004 Joel de Guzman, Eric Niebler |