Typographical Conventions
|
=========================
|
|
Literals, filenames and function arguments are presented using the
|
following style:
|
|
``argument1``
|
|
Warnings, which represent limitations and need-to-know information
|
related to a topic or concept are presented in the following style:
|
|
.. warning::
|
|
This is a warning.
|
|
Notes, which represent additional information related to a topic or
|
concept are presented in the following style:
|
|
.. note::
|
|
This is a note.
|
|
We present Python method names using the following style:
|
|
:meth:`pyramid.config.Configurator.add_view`
|
|
We present Python class names, module names, attributes and global
|
variables using the following style:
|
|
:class:`pyramid.config.Configurator.registry`
|
|
References to glossary terms are presented using the following style:
|
|
:term:`Pylons`
|
|
URLs are presented using the following style:
|
|
`Pylons <http://pylonsproject.org>`_
|
|
References to sections and chapters are presented using the following
|
style:
|
|
:ref:`traversal_chapter`
|
|
Code and configuration file blocks are presented in the following style:
|
|
.. code-block:: python
|
:linenos:
|
|
def foo(abc):
|
pass
|
|
When a command that should be typed on one line is too long to fit on
|
a page, the backslash ``\`` is used to indicate that the following
|
printed line should actually be part of the command:
|
|
.. code-block:: text
|
|
c:\bigfntut\tutorial> ..\Scripts\nosetests --cover-package=tutorial \
|
--cover-erase --with-coverage
|
|
A sidebar, which presents a concept tangentially related to content
|
discussed on a page, is rendered like so:
|
|
.. sidebar:: This is a sidebar
|
|
Sidebar information.
|
