This book uses the following typographic conventions:
File names and directories
inline code or, better:
Substituted text here... is used to have certain code part automatically replaced.
This stands for a general advice or hint.
This stands for a tip or a suggestion.
With this symbol, certain special behavior is explained, which could lead to problems or impose a risk.
Each and every reST file of
*.rst should include
at the very beginning. Specify the relative path.
Headlines in the reST source look nicer when the punctuation lines are of the same length as the text.
To switch the default highlighting use the 'highlight' directive:
To start a code-block with the default highlighting write:
.. highlight:: php And this is the PHP code:: <- renders as a single ':' $result = 1 + 2;
.. highlight:: php What may be the problem here? :: <- no ':' is in the output $result = 091;
.. highlight:: php What may be the problem here? :: <- no ':' is in the output <- this line is ignored $result = 091;