(機械翻訳)印刷慣習¶
前書き¶
この章では、Pyramidのドキュメントで使用される表記規則について説明します。
用語集¶
用語集は、ドキュメント全体で使用される用語を定義します。用語集の参照は次のようになります。
：term： 要求
ハイパーリンクされていることに注意してください。クリックすると、ユーザーは用語集の用語に移動し、用語を強調表示します。
リンク¶
リンクは以下のように表示され、クリック可能です。
`TryPyramid <https://trypyramid.com> `_
参考
ドキュメント内の他のリンクについては：ref： `typographical-convention-cross-references`も参照してください。
トピック¶
トピックは、タイトル付きのブロック見積もり、またはサブセクションのない自己完結型のセクションに似ています。トピックとは、ドキュメントの流れとは別の自己完結型のアイデアを示します。トピックは、セクションまたは遷移が発生する可能性がある場所で発生することがあります。
トピックタイトル
後続のインデントされた行は、トピックの本文を構成し、本文要素として解釈されます。
コード¶
コードはブロックまたはインラインで表示されます。コードブロックでは、構文の強調表示、行番号付け、および強調を使用できます。
シンタックスハイライト¶
XML：
<somesnippet>Some XML</somesnippet>
Unixのシェルコマンドには接頭辞 `` $ ``が付きます。 （ `` $ VENV``の意味についてはterm： `venv`を参照してください。）
$ $VENV/bin/pip install -e .
Windowsコマンドの先頭には、オプションのディレクトリ名を持つドライブ文字が付いています。 （ ``％VENV％ ``の意味についてはterm： `venv`を参照してください。）
c:\> %VENV%\Scripts\pserve development.ini
CFG：
[some-part]
# A random part in the buildout
recipe = collective.recipe.foo
option = value
これは：
[nosetests]
match=^test
where=pyramid
nocapture=1
インタラクティブな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
長いコマンドの表示¶
1行に入力するコマンドが長すぎてページの表示幅に収まらない場合は、後続の印刷行がコマンドの一部であることを示すために、バックスラッシュ文字 `` ``を使用します。
$ $VENV/bin/py.test tutorial/tests.py --cov-report term-missing \
--cov=tutorial -q
コードブロックオプション¶
行を強調するために、強調表示ペンがコード上で使用されているように見えます。
if "foo" == "bar":
# This is Python code
pass
行番号を持つコードブロック。
1 2 3 | if "foo" == "bar":
# This is Python code
pass
|
一部のコードブロックにはキャプションが付いている場合があります。
if "foo" == "bar":
# This is Python code
pass
インラインコード¶
インラインコードは次のように表示されます。インラインコードは 'pip install -e "です。[docs] "
ドキュメント構築のためのインストール要件： `` pip install -e "。[docs] " ``
機能のバージョン管理¶
プロジェクトで何かが追加、変更、または廃止されたバージョンを指定します。
バージョン変更¶
プロジェクトでフィーチャが変更されたバージョンは、次のように表示されます。
バージョン 1.8 で変更: `` boot```を `` with``文で自動的にクリーンアップする機能を追加しました。
廃止予定¶
プロジェクトでフィーチャが廃止予定のバージョンは、次のように表示されます。
バージョン 1.7 で撤廃: `` require_csrf``オプションを使うか、：ref： auto_csrf_checking`を読んで：class： pyramid.exceptions.BadCSRFToken`例外を発生させてください。
も参照してください¶
"メッセージは、現在のトピックに関連するトピックを指しますが、説明のない単なるリンクではなく、それらに物語りをしています。 "も参照するとブロック内にレンダリングされるので、読者の注意を引くことができます。
クロスリファレンス¶
相互参照は、文書、任意の場所、オブジェクト、または他のアイテムにリンクするリンクです。
Pythonモジュール、クラス、メソッド、関数¶
以下はすべて、Pythonのモジュール、クラス、メソッド、関数へのクリック可能なリンクです。
Pythonモジュール名は次のように表示されます。
：mod： pyramid.config
Pythonのクラス名は次のように表示されます。
：クラス： pyramid.config.Configurator
Pythonのメソッド名は次のように表示されます。
：meth： pyramid.config.Configurator.add_view
Pythonの関数名は次のように表示されます。
：func： pyramid.renderers.render_to_response
時には、Pythonオブジェクトの名前の最後の部分だけを表示することもあります。これは、次のように表示されます。
：func： 〜pyramid.renderers.render_to_response
アプリケーション"Pyramid "自体が次のように表示されます。
：アプリ： ピラミッド