リテラルブロック
- 公開日: 2019/10/26
- 更新日: 2019/10/26
テキストをそのまま整形済みテキストとして処理したい場合(HTMLのPRE要素のように)は、リテラルブロックを使用します。リテラルブロックは、直前の段落の行末にコロンを2つ入れ、空白行を置いて整形済みテキストとして処理したいテキストを字下げして入力します。
整形されないテキストです。:: この行から整形済みの テキストとなります。 段落分けを行うこともできます。 ここから整形されない段落がはじまります。
上記のソースは以下のHTMLに変換されます。
<p>整形されないテキストです。:</p>
<pre class="literal-block">
この行から整形済みの
テキストとなります。
段落わけを行うこともできます。
</pre>
<p>ここから整形されない段落がはじまります。</p>
上記のように、前段落の行末にコロンが追加されます。コロンを追加したくない時は、以下の例のように、コロン2つのみの行を作り、一行開けて字下げを行います。
前の段落です。 :: 前の段落の行末にコロンをつけたくない時は、 コロン2つのみの行を作ります。
テキストがプログラム等のコードであることを明示的に示したい場合は、codeディレクティブを使っても良いでしょう。codeディレクティブを使った場合、HTML変換した時にPRE要素になるのは変わりませんが、PRE要素の内側にCODE要素が入れ子になり、さらにclass属性に"code"が追加されます。また、ディレクティブなのでnameやclass属性を追加することも可能です。:number-lines: 開始行番号オプションで行番号を表示させることも可能です(開始行番号を省略した場合は1から)。codeディレクティブの一例を示します。
.. code:: :class: Python :name: helloworld :number-lines: text = 'Hello, world!' print (text)