ドキュメントツールを使ってテクニカルノートを作成する

テクニカルノートは,特定の機能に焦点を当て,例題,役に立つ関数へのリンクとその説明を含む表,数学の教科書のような情報を含む.他の関連するドキュメントへのリンクはセクションで提供する.
以下では,ドキュメントツールを使ってドキュメントを保存したり,使用したりするために,適切なパクレットディレクトリ構造がすでに設定されているものと想定して説明を行う.パクレットの作成の詳細については,パクレットの作成のチュートリアルを参考にされたい.
ここでは,PublisherIDがJohnDoeであるExampleという名のパクレットを例として使う.
DocumentationToolsを設定する
Mathematicaのメニューバーから,パレット ドキュメントツールを選択する.スクリーンの右にパレットが表示される.テクニカルノート作成ツールを使うために,パレットの上にあるTタブを選択する.

ドキュメントツールを初めて使ってパクレットドキュメントを作成する場合には,パクレットを置く場所を設定しなければならない.パレットの一番上のプルダウンメニューのパクレットの追加...をクリックし,作成するパクレットのトップディレクトリを選択する.こうすると,テストのための作成ノートブック内のリンクがアクティベートされる.
まだパクレットのドキュメントディレクトリ構造が作成されていない場合には,新しいパクレットが追加されると,ドキュメントツールディレクトリ「パクレット名」 > Documentation > 「言語」を,そして「言語」ディレクトリの中にGuides,ReferencePages,Tutorialsのディレクトリを自動的に作成する.さらにReferencePagesディレクトリ内にSymbolsディレクトリが作成される.デフォルトで「言語」ディレクトリはWolfram System言語で選択されている言語の英語名となり,通常これは$Languageと一致する.
作成
新規TechNoteをクリックすると,新しいチュートリアルの名前を指定するためのダイアログが表示される.

名前を指定してOKをクリックすると,新しいテクニカルノートが構築される.タイトルとメタデータはすでに記入されている.さらに,このテクニカルノートはプロジェクトのTutorialsディレクトリに保存される.

注: 作成するノートブックには,明示的に編集しない限りビルドに含まれない,一連のプレースホルダが含まれている.これらのプレースホルダには通常4連続のXが含まれる.

注:チュートリアルページのサンプルは,ドキュメントツールパレットの上の方にある?をクリックすると表示される.

チュートリアルで取り上げる内容を説明するテキストを記入する.

関数のテンプレートが左の列,短い説明が右の列になるように,表に関数を記入する.ドキュメントツールを使ってシンボルページを作成するに記載される手順に従い,テンプレート入力を使ってテンプレートと関数の入力を書式設定する.

以下は,テンプレート入力を使う前の表である.

以下は,テンプレート入力を使うと表がどのように表示されるかを示す.

行の最後にカーソルを置き,ドキュメントツールパレットの定義ボックスセクションにある行の追加ボタンをクリックすると,定義ボックスに行を追加することができる.

各例題の説明テキストは,例題キャプションをクリックして入力することができる.

注: テクニカルノートには最も重要な概念について例題を少し加えるだけでよい.もしユーザが関数について特定の疑問点がある場合には,対応するシンボルページを参照すればよいからである.

表を追加する場合は,追加したいノートブックの位置にセル挿入バーを置き,2列あるいは3列ボタンをクリックする.

新しいテキストセルは,ドキュメントツールパレットのTextをクリックして加えることができる.

必要に応じてSectionとSubsectionのセルを追加する.

クロスリンクの追加
More About(関連項目)セクションにはガイドページへのリンク, Related Tutorials(関連するチュートリアル)には関連するチュートリアルへのリンクが含まれる.

どのセクションもテキストを追加するにはタイプすればよい.そしてそのテキストを選択し,ドキュメントツールパレットのリンクをクリックし,追加したいリンクのタイプを選ぶ(その他のツールを開くと,さらに多くのオプションから選択できる.).

検索インデックス情報の追加
作成中のノートブックの一番下にスクロールダウンして,Keywordsセルグループを開く.

"Keyword"セルは,作成中のノートブックを分類する際にMathematicaの検索インデックスが使用するものであり,大文字小文字は区別しない.
キーワードは,ユーザがWolframのドキュメント内でその単語を検索した場合に,検索結果のリストにそのページが含まれるように設定されている.

4連続のXを残す
セル内のコンテンツとして4連続のXが残されていると,それはビルドの過程で省略される.そのため,作成者は,それらのセルに対しては何も行う必要がない.表の行で要素がすべて4連続のXである場合には,それらの行はビルドの過程で省略される.さらに,要素がすべて4連続のXである表も同じように省略される.