Typographic conventions

This book uses the following typographic conventions:

File names and directories

emphasized content

class names,

method names,

inline code or, better: inline code

Substituted text here… is used to have certain code part automatically replaced.

Note

This stands for a general advice or hint.

Tip

This stands for a tip or a suggestion.

Warning

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 Includes.txt 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:

.. highlight:: php
.. highlight:: javascript
.. highlight:: typoscript

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;

Or:

.. highlight:: php

What may be the problem here? ::  <- no ':' is in the output

   $result = 091;

Or:

.. highlight:: php

What may be the problem here?

::          <- no ':' is in the output
            <- this line is ignored
      $result = 091;