排版惯例¶
介绍¶
本章介绍Pyramid文档中使用的排版约定。
术语表¶
术语表定义了文档中使用的术语。术语表术语参考如下。
请注意，它是超链接的，单击它会将用户带到术语表中的术语并突出显示该术语。
链接¶
链接显示如下，可以点击。
参见
也见 交叉引用 文档中的其他链接。
话题¶
主题类似于带标题的块引号，或不带子章节的独立部分。主题表示独立于文档流的独立思想。主题可以发生在任何可能发生节或转换的地方。
代码¶
代码可以以块或内联的形式显示。代码块可以使用语法突出显示、行编号和强调。
语法突出显示¶
XML：
<somesnippet>Some XML</somesnippet>
unix shell命令（请参见 venv 为了…的意义 $VENV ）：
$VENV/bin/pip install -e .
Windows命令（请参见 venv 为了…的意义 %VENV% ）：
%VENV%\Scripts\pserve development.ini
CFG：
[some-part]
# A random part in the buildout
recipe = collective.recipe.foo
option = value
Iini：
[tool:pytest]
python_files = test_*.py
testpaths =
tests
addopts = -W always
交互式python：
>>> class Foo:
... bar = 100
...
>>> f = Foo()
>>> f.bar
100
>>> f.bar / 0
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
ZeroDivisionError: integer division or modulo by zero
显示长命令¶
当应在一行上键入的命令太长，无法适应页面的显示宽度时，反斜杠字符 \ 用于指示后续打印行应是命令的一部分：
$VENV/bin/pytest tutorial/tests.py --cov-report term-missing \
--cov=tutorial -q
代码块选项¶
为了强调线条，我们给出了在代码上使用突出显示笔的外观。
if "foo" == "bar":
# This is Python code
pass
带有行号的代码块。
1if "foo" == "bar":
2 # This is Python code
3 pass
有些代码块可能有标题。
if "foo" == "bar":
# This is Python code
pass
内联代码¶
内联代码显示如下，其中内联代码为“pip install-e”。 [docs] “”。
安装建筑文件要求： pip install -e ".[docs]"
功能版本控制¶
我们指定在项目中添加、更改或否决某些内容的版本。
增加版本¶
将功能添加到项目中的版本显示如下。
在 1.1 版本加入: pyramid.paster.bootstrap()
版本更改¶
在项目中更改功能的版本显示如下。
在 1.8 版本发生变更: 增加了 bootstrap 通过自动清除 with 语句。
已弃用¶
项目中不推荐使用某个功能的版本显示如下。
自 1.7 版本弃用: 使用 require_csrf 选项或读取 自动检查CSRF令牌 取而代之的是 pyramid.exceptions.BadCSRFToken 引发异常。
警告¶
警告表示与主题或概念相关的限制和建议。
警告
这是一个警告。
笔记¶
注释表示与主题或概念相关的附加信息。
备注
这是一张便条。
另见¶
“另请参阅”消息指与当前主题相关的主题，但具有叙述性语气，而不仅仅是没有解释的链接。另请参见“也是在一个块中呈现的，以便它突出显示给读者。
交叉引用¶
交叉引用是指向文档、任意位置、对象或其他项的链接。
交叉引用文档¶
此文档中的页面链接显示如下。
交叉引用任意位置¶
本文档中的节、表和带标题的图的链接显示如下。
python模块、类、方法和函数¶
以下所有内容都是指向Python模块、类、方法和函数的可单击链接。
python模块名称显示如下。
python类名显示如下。
python方法名显示如下。
pyramid.config.Configurator.add_view()
python函数名显示如下。
pyramid.renderers.render_to_response()
有时我们只显示Python对象名称的最后一段，显示如下。
应用程序“Pyramid”本身显示如下。
Pyramid