outline

要素関数

要素関数

要素関数はsetルールやshowルールでカスタマイズできます。

目次や図表などのアウトライン。

この関数は、指定したdepthまでに登場する要素を文書内から抽出し、その一覧（アウトライン）を生成します。 各要素には、その見出しやキャプションとともに、その要素の番号やページ番号がアウトライン形式で表示されます。

例

#set heading(numbering: "1.")
#outline()

= Introduction
#lorem(5)

= Methods
== Setup
#lorem(10)

見出し以外のアウトライン

デフォルト設定では、この関数は目次（セクション見出しのアウトライン）を生成します。 targetパラメーターを設定することで、見出し以外の要素のアウトラインも生成できます。

下の例では、targetをfigure.where(kind: image)に設定して、画像を含む図のみをアウトライン表示しています。 同様にfigure.where(kind: table)と設定すれば、表のアウトラインを生成できます。

whereセレクターを使わずにfigureのみの指定もできますが、その場合は画像や表、またその他の素材も含む 全て の図表がアウトラインに表示されます。

#outline(
  title: [List of Figures],
  target: figure.where(kind: image),
)

#figure(
  image("tiger.jpg"),
  caption: [A nice figure!],
)

アウトラインのスタイル

基本的に、アウトライン本体やその項目に対してプロパティを設定することでスタイルを変更できます。 これにより、アウトラインのタイトル、項目のインデント、項目のテキストとページ番号の間の空白の埋め方などをカスタマイズできます。

アウトラインの項目を設定を調整することで、より高度なカスタマイズも可能です。 アウトラインは、対象となる各要素に対して1つの項目を生成します。

項目同士の間隔調整

アウトラインの各項目はブロック要素であるため、通常のブロック間隔設定を用いて、項目同士の間隔を調整できます。

#show outline.entry.where(
  level: 1
): set block(above: 1.2em)

#outline()

= About ACME Corp.
== History
=== Origins
= Products
== ACME Tools

アウトライン項目の構築

項目の外観を完全に制御するために、outline.entryを変更するshowルールも書けます。 ただし、アウトライン項目を適切に書式設定・インデントするための処理は非常に複雑であり、アウトライン項目自体が持つフィールドは「レベル」と「対象要素」の2つのみです。

そのため、必要な部分だけを組み合わせて項目を構築できるよう、さまざまな補助関数が提供されています。

アウトライン項目に対する既定のshowルールは次のようになっています¹。:

#show outline.entry: it => link(
  it.element.location(),
  it.indented(it.prefix(), it.inner()),
)

• indented関数は、任意のプレフィックスと内部コンテンツを受け取り、適切なインデントを自動的に適用します。 これにより、異なる項目同士がきれいに揃い、長い見出しも正しく折り返されます。

• prefix関数は、要素の番号（存在する場合）を整形します。 また、特定の要素には補足語も付加します。

• inner関数は、要素のbodyとpage number、およびそれらの間を埋めるフィラー（点線など）を組み合わせます。

これらの関数を個別に使うことで、アウトライン項目の書式を変更できます。 例えば、フィラーやページ番号を完全に削除したい場合は、次のようなshowルールを書くことができます。

#show outline.entry: it => link(
  it.element.location(),
  // Keep just the body, dropping
  // the fill and the page.
  it.indented(it.prefix(), it.body()),
)

#outline()

= About ACME Corp.
== History