ドキュメントツールを使ってガイドページを作成する

ガイドページは1つのトピックに焦点を当て,機能を共有する関数へのリンクを提供する.他の関連するドキュメントへのリンクはセクションで提供する.
以下では,ドキュメントツールを使ってドキュメントを保存したり,使用したりするために,適切なパクレットディレクトリ構造がすでに設定されているものと想定して説明を行う.パクレットの作成の詳細については,パクレットの作成のチュートリアルを参考にされたい.
ここでは,PublisherIDがJohnDoeであるExampleという名のパクレットを例として使う.
DocumentationToolsを設定する
システムメニューバーから,パレット ドキュメントツールを選択する.スクリーンの右にパレットが表示される.ガイドページ作成ツールを使うために,パレットの上にあるGタブを選択する.

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

名前を指定してOKをクリックすると,新しいガイドページが構築される.タイトルとメタデータはすでに記入されている.さらに,このガイドページはパクレットのGuidesディレクトリに保存される.

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

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

ガイドで取り上げる内容を説明するテキストを記入する.

ドキュメントツールパレットの上の方にある1行の関数リストボタンを使って,強調したい関数へのリンクとその説明を追加する.4連続のXが description (説明)の左にあるセルの部分にカーソルを置いて,Xを関数名で置き換える.その右の description に上書きして短い説明を加える.

1行の関数リストをクリックすると,自動的にリンクが作成される.

あまり重要ではない関数は,関数のインラインリストとしてリストにすることができる.

Xの代りに関数名を入力する. ボタンを使ってさらに関数名を追加する.

カーソルをセルの内部かセルブラケットに置いて, 関数のリストをクリックする.後でリストにもっと関数を追加したい場合には,セルブラケットを選択して,関数のリストをクリックする.関数のリストはプレーンテキストに戻る.関数名を追加してから,もう一度関数のリストをクリックする.

関連する関数は,カーソルをセルとセルの間に置き,ドキュメントツールパレットのデリミタをクリックして,グループにまとめることができる.
クロスリンクの追加
Tech Notes(テクニカルノート)セクションには関連するテクニカルノート, More About(関連項目)セクションにはガイドページへのリンク, Related Links(関連リンク)セクションにはその他の関連ページ(Webページを含む)を追加する.

どのセクションもテキストを追加するにはタイプすればよい.それからそのテキストを選択する.

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

TechNoteにリンクをクリックすると,テクニカルノートへのリンクが作成される.

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

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

4連続のXを残す
セル内のコンテンツとして4連続のXが残されていると,それはビルドの過程で省略される.そのため,作成者は,それらのセルに対しては何も行う必要がない.
プレビューボタン
作成中のノートブックの一番上にプレビューボタンがある.

プレビューボタンをクリックすると,作成中のノートブックのビルドバージョンが生成される.