| commit | author | age | ||
| 878328 | 1 | Typographical Conventions |
| CM | 2 | ========================= |
| 3 | ||
| 4 | Literals, filenames and function arguments are presented using the | |
| 5 | following style: | |
| 6 | ||
| 7 | ``argument1`` | |
| 8 | ||
| 9 | Warnings, which represent limitations and need-to-know information | |
| 10 | related to a topic or concept are presented in the following style: | |
| 11 | ||
| 12 | .. warning:: | |
| 13 | ||
| 14 | This is a warning. | |
| 15 | ||
| 16 | Notes, which represent additional information related to a topic or | |
| 17 | concept are presented in the following style: | |
| 18 | ||
| e4e3aa | 19 | .. note:: |
| 878328 | 20 | |
| e4e3aa | 21 | This is a note. |
| 878328 | 22 | |
| CM | 23 | We present Python method names using the following style: |
| 24 | ||
| d7f259 | 25 | :meth:`pyramid.config.Configurator.add_view` |
| 878328 | 26 | |
| e4e3aa | 27 | We present Python class names, module names, attributes and global |
| CM | 28 | variables using the following style: |
| 878328 | 29 | |
| d7f259 | 30 | :class:`pyramid.config.Configurator.registry` |
| 878328 | 31 | |
| e4e3aa | 32 | References to glossary terms are presented using the following style: |
| CM | 33 | |
| 093628 | 34 | :term:`Pylons` |
| e4e3aa | 35 | |
| CM | 36 | URLs are presented using the following style: |
| 37 | ||
| e7b5fe | 38 | `Pylons <http://pylonsproject.org>`_ |
| e4e3aa | 39 | |
| CM | 40 | References to sections and chapters are presented using the following |
| 878328 | 41 | style: |
| CM | 42 | |
| e4e3aa | 43 | :ref:`traversal_chapter` |
| 878328 | 44 | |
| 12205f | 45 | Code and configuration file blocks are presented in the following style: |
| 878328 | 46 | |
| CM | 47 | .. code-block:: python |
| 48 | :linenos: | |
| 49 | ||
| 50 | def foo(abc): | |
| 51 | pass | |
| 52 | ||
| 44f1df | 53 | When a command that should be typed on one line is too long to fit on |
| CM | 54 | a page, the backslash ``\`` is used to indicate that the following |
| 55 | printed line should actually be part of the command: | |
| 56 | ||
| 57 | .. code-block:: text | |
| 58 | ||
| 59 | c:\bigfntut\tutorial> ..\Scripts\nosetests --cover-package=tutorial \ | |
| 60 | --cover-erase --with-coverage | |
| 016a1f | 61 | |
| 793425 | 62 | A sidebar, which presents a concept tangentially related to content |
| CM | 63 | discussed on a page, is rendered like so: |
| 64 | ||
| 65 | .. sidebar:: This is a sidebar | |
| 66 | ||
| 67 | Sidebar information. | |
| 68 | ||
