CotEditorのアウトライン機能を使うと、書類内の構造を一覧で表示して、すばやく移動できます。アウトラインメニューに表示するテキストの抽出方法や表示形式は、アウトライン抽出ルールとして定義できます。
シンタックスのアウトラインの抽出ルールを定義するには、シンタックスエディタの左のリストから「アウトライン」を選択し、右側のリストに条件を追加します。シンタックスエディタの開き方は、シンタックスを定義するを参照してください。
アウトライン設定の各項目の内容は次の通りです。
| 項目 | 説明 |
|---|---|
| IC | チェックがオンのとき、大文字/小文字を区別しません（Ignore Caseの略）。例えば、開始文字列を「abc」として「IC」にチェックを入れると、「ABC」「abc」「Abc」などに一致します。 |
| 種類 | アウトライン項目の種類を設定します。タイトルの前につくアイコンに使われます。 |
| 正規表現パターン | ここで設定した正規表現に一致する部分がアウトラインとしてリストアップされます。この項目は必須です。 |
| 表示パターン | アウトライン項目の書式を設定します。「正規表現」で一致したテキストとこのパターンからタイトルが決定されます。 |
| 説明 | 登録する語句にメモがあるときにこのフィールドを使用できます。この項目は抽出に影響せず、空でも構いません。 |
表示パターンには以下のメタ文字が使えます:
| メタ文字 | 説明 |
|---|---|
| （記述なし） | 「正規表現」で一致したすべてのテキスト |
$0 | 「正規表現」で一致したすべてのテキスト |
$1 〜 $9 | 「正規表現」で一致した部分テキストのうち、最初〜9番目に一致した部分 |
「$0」などのメタ文字をそのままメニューに表示させるには、「$」の直前に「\（半角バックスラッシュ）」を置いてください。メニュー項目では「\」は表示されません。
表示パターンを適用したあと、アウトラインのタイトル先頭のインデントや余分な空白は、見やすいように整えられます。
抽出ルールでアイコンを選択すると、アウトラインのタイトルの横にアイコンを表示できます。
| 種類 | 説明 | 例 |
|---|---|---|
| コンテナ | 他の項目を含むことができる名前付きの構造ブロック | class、struct、enum、protocol、extension、namespace |
| 値 | プロパティ、フィールド、変数、定数などの値を表すシンボル | property、enum case、const |
| 関数 | 関数やメソッドなど、呼び出し可能なシンボル | function、method、def、init |
| タイトル | 文書や図表の名前 | title、figcaption |
| 見出し | セクションの階層構造を定義する書類の見出し。見出しレベル（1〜7）を指定すると、折りたたみ可能な階層アウトラインを作成できます。 | h1–h6、section{}/subsection{} (LaTeX) |
| マーク | 正式な見出しではないものの、セクションを視覚的に区切ったり注釈を付けたりするために人が記述するマーカー | MARK:、#pragma mark、region/endregion |
| 区切り線 | アウトライン項目を見やすくグループ化するための、選択できない区切り線 | <hr>、---、MARK: - |
| なし | 意味的な種類が割り当てられていない項目 |