「ドキュメントツール」クイックスタート

1.gif

パクレットの追加 ドキュメントを開発しているパクレットのディレクトリを選ぶ.指定されたディレクトリには,何も入っていなくても,PacletInfo.mかPacletInfo.wlファイルだけ入っていても,または呼び出せる関数を含むロード可能なパクレットを形成する追加のファイルやディレクトリが入っていてもよい.詳細は,「ドキュメントツール」を使えるようにパクレットを設定するを参照されたい.
パクレットインスペクタ PrivateFrontEndOptions/"InterfaceSettings"/"Documentation Tools"で参照されているパクレット名の表を表示する.パクレットインスペクタは,現行パクレット,参照されたパクレットのディレクトリパス,そのロード状況とドキュメントディレクトリの存在状況,パクレットディレクトリを開いてその場所を変更するボタンだけでなく,参照されたパクレットをロードして,ドキュメントディレクトリを持たない参照パクレットのためにドキュメントディレクトリを作成するボタンも表示する.
関数(F)タブ
新規関数ページ(?) 新しい関数ページを開始する.?ボタンを使って,関数ページのサンプルを開く.
関数ページを開く 名前が指定の部分文字列で始まる,または指定の部分文字列を含む,(現在選択されているパクレット内の)関数ページすべてへのリンクを表示するダイアログを開く.
テンプレート入力 関数テンプレートを選択する.関数テンプレート内の小文字の単語(1文字以上)は,テンプレート入力ボタンが使われた後,斜体字になる.xxx$yyy は,yyyxxx の下付き文字にする.$$は, (\[Ellipsis])を返す.適切な場合には,関数名がリンクになる.テンプレート入力のショートカットについては,書式メニューを参照されたい(「ドキュメントツール」のカスタムメニュー項目は,角カッコで囲まれている).
使用法の追加 関数ページの使用法のセル内で,カーソル位置の下に,新しい使用法メッセージテンプレートと説明のテキストのプレースホルダを挿入する.
インラインリスト プレーンテキストと,選択部分が含まれるセルに適切なリンクや書式設定されたデリミタを含むインラインリストとの間で,書式を切り換える.セルとセルの間が選択されている場合は,「関連項目」のリストのテンプレートが作成される..を使って,関数名と関数名の間のデリミタを表す.
関数ページの作成についての詳細は,関数ページを生成するを参照されたい.

詳細とオプション

追加情報 Notesセルを挿入,またはNotesスタイルを選択セルに適用する.
オプションの表ダイアログ: 関数ページの名前に対応するオプションを選択し,関数ページの詳細セクションに表として挿入する.

表ツール

1列/テキスト1列 1列の表を挿入する.
2列/テキスト2列 2列の表を挿入する.
3列/テキスト3列 3列の表を挿入する.
行の追加
表のソート 表の第1列をソートする.
表の結合
第1列に広げる
表のカスタム挿入 (2列か3列)

例題

デリミタの挿入 例題グループを分割し,入力の履歴をリセットする.
テキストの挿入
Section/Subsec/Subsub
関数のオプション 関数ページの「オプション」セクションに現在リストされているオプションを,そのドキュメント作成中の関数についてOptionsで返されるオプションと比べる.欠けているオプションは,ダイアログで選んで追加することができる.

リンク

ガイドにリンク () 選択部分をガイドページへのリンクにする.ボタンでファイルブラウザを開き,選択部分をガイドページへのリンクとしてファイルにリンクする.
TechNoteにリンク () 選択部分をテクニカルノートへのリンクにする.ボタンでファイルブラウザを開き,選択部分をテクニカルノートへのリンクとしてファイルにリンクする.
関数にリンク () 選択部分を関数ページへのリンクにする.ボタンでファイルブラウザを開き,選択部分を関数ページへのリンクとしてファイルにリンクする.
URLにリンク 選択部分からリンクするURLを挿入するダイアログ.
リンクの編集 インラインで編集できないリンクのコンテンツを編集するためのダイアログ.適用する前に,カーソルをリンクの後ろに置く.

その他のリンクツール

セル選択/リンク作成 現行パクレットのドキュメントレイアウトで,保存したノートブック内のセルブラケットを選び,「セル選択」ボタンをクリックする.その後,現行パクレットのドキュメントレイアウトで,同じまたは別のノートブック内のテキストを選択して「リンク作成」ボタンをクリックし,取得したデータを使って,選択したテキストをリンクにする.
Systemのガイド 選択部分をSystemのガイドページのリンクにする.
SystemのTechNote 選択部分をSystemのテクニカルノートのリンクにする.
カスタムURI インタラクティブに与えられたパクレットURIに基づいてリンクを作成する.

書式設定

特殊な書式 その他の入力形式のパレット.
デフォルトの書式 タイプ中に現行セルのデフォルト書式に戻す.または選択部分に設定した書式を削除する.
文字入力 Wolfram言語のテキストによる文字入力形式にこれを使う.+9(インラインセル)を使うことに等しい.
コードインライン テキスト内のインラインのコードまたはその他のコンピュータボイス要素にこれを使う.
斜体字入力 関数のテンプレートで斜体字を使う場合にのみこれを使う(例:関数の引数).
プレーンテキスト 関数のテンプレートでプレーンテキストを使う場合にのみこれを使う(例:関数の引数).
慣用形の数式 数学の慣用表記に近い形で入力,または近い形に変換する場合にこれを使う.
注釈 (, , D) セルに注釈を加える,またはセルの注釈を編集するためのダイアログ. は,入力ノートブックの次の注釈セルを検索する. は,入力ノートブックの前の注釈セルを検索する.Dは,セルの注釈を削除する.

Futureフラグ

選択 選択したセルがドキュメントビルドから除外されるように設定する.ボタンで設定のオンとオフを切り換えることができる.
ページ全体 入力ノートブックがドキュメントビルドから除外されるように設定する.ボタンで設定のオンとオフを切り換えることができる.

ツール

関数ページの生成 現行パクレット内で使用法メッセージを含むシンボルすべてについて関数ページを生成する.既存のノートブックはどれも,ReferencePages/Symbolsディレクトリ内のOriginalReferencePagesディレクトリに置かれる.
ベースの変更 パクレットのドキュメントディレクトリ内の全ノートブックにおいて,メタデータ内のパクレット名,コンテキスト,URIだけでなく,ボタンデータで使われるリンクベースも変更する.

その他

設定 作成者のユーザ名を設定し,新しいドキュメントページを開始したときに,メタデータの記入を促すメッセージを表示するかどうか,そしてページへのリンクがクリックされたときに,「ページを開く」ダイアログが閉じられるかどうかを指定するための,「ドキュメントツール」の設定ダイアログを開く.
ヘルプ
ガイド(G)タブ
新規ガイドページ(?) 新しいガイドページを開始する.?ボタンを使って,ガイドページのサンプルを開く.
ガイドページを開く 指定の部分文字列で始まる,または指定の部分文字列を含む名前を持つ,(現在選択されているパクレット内の)ガイドページすべてへのリンクを表示するダイアログを開く.
1行の関数リスト セルとセルの間を選択し,1行の関数テンプレートを挿入する.既存の1行の関数セルのテキストに使われた場合には,書式を設定した状態と解除した状態の間で切り換わる.
関数のリスト .を使って,要素間にデリミタを入れる.関数名は自動的にリンクされる.簡単に編集できるように,書式のオン・オフを切り換えることができる.複数のセルブラケットを選択することもできる.
Subsection
デリミタ 関数リストのセクションで項目と項目の間に入れるもの.
Text

リンク

書式設定

Futureフラグ

ツール

その他

テクニカルノート(T) タブ
新規TechNote (?) 新しいテクニカルノートページを開始する.?ボタンを使って,テクニカルノートページのサンプルを開く.
TechNoteを開く 指定の部分文字列で始まる,または指定の部分文字列を含む名前を持つ,(現在選択されているパクレット内の)テクニカルノートすべてへのリンクを表示するダイアログを開く.
Section
Subsection
Text
例題グループ 例題グループを挿入する.
例題キャプション 例題キャプションを挿入する.

定義ボックス

2列 2列の定義ボックスを挿入する.
3列 3列の定義ボックスを挿入する.
行の追加 定義ボックスに行を追加する.
結合 選択した2つの定義ボックスを1つのセルに結合する.

リンク

書式設定

Futureフラグ

概要ページツール

概要ページの生成 選んだテクニカルノートファイルのリストについて概要ページを作成する.
新しい概要ページ
TOCChapter TOCChapter(目次の章)セルを挿入する.または,セルにスタイルを適用する.
TOCSection TOCSection(目次のセクション)セルを挿入する.または,セルにスタイルを適用する.
TOCSubsection TOCSubsection(目次のサブセクション)セルを挿入する.または,セルにスタイルを適用する.
TOCSubsubsection TOCSubsubsection(目次のサブサブセクション)セルを挿入する.または,セルにスタイルを適用する.

目次リンクツール

(1) ブラウズ 見出しにリンクするテクニカルノートをブラウズする.
(2) セルの選択 ブラウズしたテクニカルのセルブラケットを選択し,このボタンをクリックする.
(3) ペースト 構築中の概要ページのセルブラケットかセルとセルの間をクリックしてから,このボタンをクリックする.

ツール

その他