文書ツール
文書の分析
LaTeX、Typst、Markdown の文書にある見出し、図、表、数式、ラベル、引用、ToDo を一覧し、投稿用のメタデータをコピーします。
投稿する前に、文書に実際に何が入っているかを確認しておくと役に立ちます。すべての図にキャプションはあるか。引用されたキーはすべて参考文献にあるか。 文書の分析は、これらをひとつのダイアログにまとめて表示し、各項目をソースの該当行にリンクします。
エディタのツールバー右端の文書の分析ボタンで開くか、⌘K パレットから文書の分析を実行します。LaTeX、Typst、Markdown のプロジェクトで使え、メインファイルからたどって文書を読み取るため、\input で取り込んだ LaTeX の章や、#include で取り込んだ Typst のファイルも対象になります。
各タブの内容
「各タブの内容」セクション概要には、以下の各リストの件数が表示されます。件数をクリックすると、そのタブが開きます。
- 見出し。階層に応じてインデントされます。
- 図と表。それぞれにキャプション(なければキャプションなし)、ラベル、番号がなければ番号なしが表示されます。
- 数式:ディスプレイ数式のみで、インライン数式は含みません。
- ラベル:すべてのラベルと、それが何に付いているか(見出し、図、表、数式、その他)。
- 引用:引用されたキーすべてと、その引用回数。参考文献にないキーには参考文献にありませんと表示され、概要にその件数が表示されます。
- ToDo:ソース中の
TODO、FIXME、XXXのメモ。LaTeX では、\todo、\missingfigure、fixme パッケージのメモも数えられます。
行をクリックすると、ダイアログが閉じてその行に移動します。灰色の行は、ソースまでたどれなかったものです。
番号とページ
「番号とページ」セクション番号の取得元は、エンジンによって異なります。
- LaTeX:図、表、数式、見出しの番号とそのページは、ラベルが付いている項目について、前回のコンパイルから取得します。フッターに、それが最新かどうかが表示されます。その後に編集した場合は、もう一度コンパイルして更新してください。
- Typst:ダイアログを開くとき、プロジェクトの Typst のバージョンと選択中のビルドバリアントで Typst に文書を読み取らせるため、番号とページは現在のソースと一致します。Typst が文書をコンパイルできない場合は、概要に代わりにエラーが一覧され、それぞれの行へのリンクが付きます。一覧されるのは最初の 5,000 個の要素だけです。フッターに、使用した Typst のバージョンが表示されます。
- Markdown:項目はソースの順に並び、番号やページはありません。
更新を押すと、ダイアログを閉じずに文書を読み直します。
投稿用メタデータ
「投稿用メタデータ」セクション概要には、Oleafly が見つけたタイトル / 著者 / キーワード / 日付 / 要旨も表示されます。見つからないものには未設定と表示されます。
- LaTeX では、
\title、\author、\date、abstract環境、および\keywordsコマンドまたはkeywordsかIEEEkeywords環境から取得します。 - Typst では、文書が適用しているテンプレートの引数、または
#set document(...)から取得します。要旨は、「Abstract」という名前の見出しから取得することもあります。 - Markdown では、フロントマターの
title、authorまたはauthors、date、keywords、abstractから取得します。
投稿用メタデータをコピーを押すと、タイトル、著者、キーワード、要旨がラベル付きの行としてクリップボードにコピーされ、投稿フォームにそのまま貼り付けられます。どれも設定されていない場合、このボタンは無効です。
関連ページ
「関連ページ」セクション- プリフライトチェック:投稿前の、ソース、ログ、PDF に対するより詳しいチェック
- 引用と参考文献:文書の分析が不足していると報告したキーを追加する
- 文書の設定:エディタのツールバーにあるもう 1 つの文書ツール