概要

Curlのドキュメントには、Curl言語を効率良く学習できるよう、リンクやインタラクティブな例題などの機能が含まれています。Curlのドキュメントビューアは、これらのドキュメント表示を目的として Curl で作成された、ブラウザに似た特別なアプリケーションです。

ドキュメントにはリンクが含まれています。たとえば「このリンク」をクリックすると、今読んでいるページの「ナビゲーションペイン」のセクションに移動することができます。さらに、docref と呼ばれる特別な目的を持つリンクからは、『API リファレンス』に直接アクセスすることができます。これらリンクは、たとえばこの HBox 項目へのリンクのように濃い青色の等幅フォントで表示されます。ハイパーテキストリンクはこのような書式だけにとどまらず、グラフィック画像を含め任意の外観を持つことができます。ポインタがハイパーリンクの上に置かれると、指さし手形のマーク

に変わります。

ドキュメントビューアは以下の方法で起動できます。

[スタート] メニューから [ドキュメント] を選択します。
Curl IDE の [ヘルプ] メニューで [言語ドキュメンテーション]、[Curl IDE のヘルプ] または [エディタのヘルプ] を選択します。
Curl IDE で F1 キーを押します。

ドキュメントビューアのウィンドウは 2 つの主な領域に分かれており、左側にはナビゲーションペイン、右側にはコンテンツペインがあります。

Curl Documentation

Curl言語、Curl IDEと関連したツールのドキュメンテーションは、 APIリファレンスとユーザードキュメンテーションからなります。ユーザードキュメンテーションは以下の章からなります。

Curl開発者ガイドは、Curl言語の高度なマニュアルです。
Curl IDEユーザーガイドは、Curl統合開発環境に含まれる様々なツールの詳細な情報を提供します。これらのツールは、Curl言語でコードを書いたり、デバッグしたり、パッケージを作成したり、アプレットのデプロイに役立ちます。
Curl VLEユーザーガイドは、Curlビジュアルレイアウトエディタに含まれる様々なツールの詳細情報を提供します。

API リファレンス

APIリファレンスには、Curl言語の基本と標準パッケージで利用可能な全てのクラスが記述されています。開発者ガイドよりも、クラス、プロシージャ、キーワードに関してより詳細に広範囲に説明されています。 APIリファレンスの多くの項目には、開発者ガイドと同じようにインタラクティブなサンプルが含まれています。

APIリファレンスにアクセスする方法は幾つかあります。

目次タブを選択して、APIリファレンスを開きます。すると、全てのCurl言語パッケージが一覧表示されます。ドキュメントを読みたいパッケージの名前を選択してください。
インデックスタブを選択してインデックスを表示してください。インデックスは、Curl言語APIの主要なコンポーネントを一覧表示します。 APIリファレンスの各項目には、ＡＰＩコンポーネントの種類を示す括弧つきの単語が末尾についています。例えば、Box(クラス)のようにです。
検索タブを選択して、APIコンポーネントを検索します。インデックスまたは、検索結果のAPIリファレンスの項目をダブルクリックしてください。インデックスと検索結果の詳細については、ナビゲーションペインを参照してください。
濃い青の等幅フォントで表されるリンクは、APIリファレンスの項目に対応しています。例えば、このリンクHBox をクリックすると、ドキュメントのHBox クラスを見ることができます。APIリファレンスは、他の項目へのリンクを含んでいます。

ナビゲーションペイン

ナビゲーションペインは、[目次] タブ、[インデックス] タブ、[検索] タブ、[ブックマーク] タブに分かれます。各タブでは、それぞれ異なる方法でドキュメントから情報を検索します。

検索範囲の制御

[インデックス] タブと [検索] タブには、[検索範囲] のドロップダウンリストがあります。このリストを使用して、表示される情報を制限できます。選択肢は次のとおりです。

[全ドキュメント]
開発者ガイドとユーザーガイド、および API リファレンス、すべてのドキュメントから情報を表示します。
[API リファレンス]
API リファレンスドキュメントだけを検索します。
[カテゴリー別の API リファレンス]
検索対象をさらに絞り込み、次のいずれかの種類のオブジェクトについてのみ、API リファレンスのドキュメントを検索します。
- プロシージャとクラスプロシージャ
- 非ローカルオプション定義
- クラス
- マクロとプリミティブ
- テキストフォーマットとテキストプロシージャ

次の 3 つの選択肢は、指定したタイトルの Curl ドキュメントに絞り込みます。

[Curl 開発者ガイド]
[Curl IDE ユーザーガイド]
[Curl VLE ユーザーガイド]

[目次] タブ

目次を表示するには [目次] タブを選択します。

この目次はツリービュー構成になっています。サブエントリのある項目は、エントリのわきに青の矢印マーク（

）が表示されます。矢印をクリックするとサブエントリが表示されます。

目次で青色の下線付き項目をクリックすると、その項目の内容がドキュメントビューアに表示されます。クリックした項目が別の章にある場合、その章がロードされて表示されます。ページにジャンプしないトップレベルのドキュメントセクションは黒字のテキストで表示されています。

項目名がペインの幅より長くて完全に見えない場合があります。項目の上にマウスポインタを移動すると、完全なテキストがポップアップ表示されます。

[インデックス] タブ

[インデックス] タブを選択するとドキュメントの索引が表示されます。検索範囲を絞り込んだ場合は、選択したドキュメントの索引項目だけが表示されます。

索引項目はアルファベット順に表示されています。索引の入力フィールドに入力すると、入力した文字に一致する索引一覧の最初の項目にジャンプしてそれが選択されます。文字を削除すると、残った文字列に一致するように画面の位置も変わります。ナビゲーションペインで索引項目をクリックするとその項目が選択され、ダブルクリックするとコンテンツペインにその内容が表示されます。

API リファレンス内の情報の索引項目の後には、そのリンク先の API オブジェクトタイプを示す用語がカッコ内に示されています。例 :

索引項目「after (マクロ)」は、API マニュアルの after マクロにリンクされています。
索引項目 「after マクロ」は開発者ガイドの after マクロにリンクされています。

API クラスメンバは、Class.member 形式を使用すると、それ自体が一覧表示されます。たとえば、Canvas.add メソッドは add (メソッド) および Canvas.add (メソッド) の両方で一覧表示されます。add のように、メンバが複数のクラスで定義されている場合、メンバ項目 (add (メソッド)) をダブルクリックすると、ダイアログボックスが表示されクラスを選択するよう求められます。

索引項目には、メインの項目と 1 つ以上の下位項目で構成されるものがあります。メインの項目部分がドキュメントの内容にリンクされていないものもあり、これらは索引リストでは淡色で表示されます。

[検索] タブ

[検索] タブを選択すると、ドキュメントの検索機能にアクセスできます。検索範囲を絞り込んだ場合は、検索対象は選択したドキュメントだけです。

検索機能を使用して、ドキュメントを検索できます。検索範囲を絞り込んだ場合は、選択したドキュメントだけを検索します。検索する文字列を検索の入力フィールドに入力し、Enter キーを押すか、[検索] ボタンをクリックして、検索を開始します。

[全文検索] チェックボックスをオンにすると、ドキュメント内のすべてのテキストが検索対象になります。このチェックボックスがオフの場合は、検索リスト内の項目だけが検索対象になります。どちらの場合も、次の 2 つのチェックボックスを使って検索対象を変更できます。

[大文字と小文字を区別] をオンにすると、大文字と小文字を区別して検索を行います。このチェックボックスがオフの場合、検索では大文字と小文字が区別されません。
[正規表現] は、検索文字列を正規表現として解釈します。「正規表現」を参照してください。

索引用語の検索を実行すると、検索文字列を含む検索リスト内のすべての項目がアルファベット順で返されます。結果に下位項目が含まれる場合、検索結果では対応するメインの項目がその上に表示され、このメインの項目が他の項目と共にアルファベット順でソートされます。

全文検索を実行する場合、検索文字列はスペースで区切られた一連の単語として解釈されます。検索文字列に指定されたすべての単語を含むドキュメントページが検索結果として返されます。

[ブックマーク] タブ

[ブックマーク] タブを選択すると、今後の参照のためにブックマークされたページのリストを表示できます。[移動] メニューの [このページをブックマークする] コマンドとコンテキストペインのコンテキストメニューで、ブックマークのリストに追加できます。

ペイン下部の次のボタンで、リストにあるブックマークを管理することができます。

また、ブックマークをドラッグしてリスト内の位置を移動することもできます。

ブックマークはセッション間で持続します。複数のドキュメントビューアウィンドウすべてで、同じブックマークリストを共有します。ある1つのウィンドウで行われた変更は、他のすべてのウィンドウに反映されます。

コンテンツペイン

インタラクティブなサンプル

Curlドキュメントの強力な機能の 1 つとして、開発者ガイドと API リファレンスの両方にインタラクティブな例題が掲載されています。

「playpen」と呼ばれるインタラクティブなサンプルボックスに、ソースコードとコード評価の結果が表示されています。スタティックな例とは異なり、サンプルボックスでコードを変更し、その結果をポップアップウィンドウに表示することができます。playpen の例を次に示します。

例: インタラクティブなサンプルウィンドウの例

{value 3 + 4}

playpen の中央のペインには元のソースコードが表示され、コードの評価結果は上のペインに表示されます。

ソースコードの編集は中央のペインで行います。[実行] ボタンをクリックすると、修正した Curl 言語ソースコードの評価結果がポップアップウィンドウに表示されます。コードを元の状態に戻すには、[元に戻す] をクリックします。playpen 内の作業を保存するには、[アプレットとして保存する...] ボタンをクリックしてソースコードを独自のファイルに保存します。

注意: playpen の結果ペインと [実行] ボタンを押したときに表示されるポップアップウィンドウ内の結果は、ソースコードの評価結果を表示するグラフィック環境が多少異なるために、境界のスタイルやウィンドウ幅などが異なって表示される場合があります。また、[アプレットとして保存する...] でソースコードをアプレットとしてファイルに保存すると、ブラウザウィンドウで同じソースコードを実行した結果とは異なって見える場合があります。

拡張したサンプル

Curlドキュメンテーションは、幾つかの拡張したサンプルを提供します。これらのサンプルは、圧縮ファイル(.zip)として d:\automated-build-temp\build\win32-atom\docs\default\examplesにあります。この圧縮ファイルを便利な場所に解凍してください。この圧縮ファイルには、CurlソースファイルやIDEにロードできるプロジェクトが含まれています。サンプルファイルを実行したり編集したりすることで、IDEの理解を深めることができます。

このサンプルファイルをCurlインストールディレクトリ(d:\automated-build-temp\build\win32-atom\) に解凍しないでください。このディレクトリ下のファイルは、Curlを再インストールしたり、アップグレードした時に削除または更新されることがあります。

ドキュメントビューアメニュー

[ファイル] メニュー

[ソースの編集] は、現在のページのソースコードをソースエディタで開きます。
[新規ドキュメンテーションビューア] のサブメニューには、インストールされているすべての Curl ドキュメンテーションが一覧表示されます。他の言語またはリリースのドキュメントをインストールすると、このリストに追加されます。サブメニューの項目をクリックすると、新しいブラウザが開いて指定ドキュメントを表示します。
[印刷] または ctrl+P は、コンテンツペインで現在表示されているセクションの内容を印刷用にフォーマットして、プリンタの選択を求める画面を表示します。ナビゲーションペインは印刷されません。
[閉じる] または ctrl+W は、ドキュメントビューアの現在のインスタンスを終了します。

[編集] メニュー

[切り取り] または ctrl+x は、テキストフィールドで選択したテキストをシステムのクリップボードにコピーし、選択したテキストをフィールドから削除します。このコマンドは、Curl 言語で作成されたアプレットのテキストフィールドでテキストを選択したときにだけ使用できます。
[コピー] または ctrl+c は、選択したテキストをドキュメントビューアからシステムのクリップボードにコピーします。通常、ページに表示されるテキストはどれでも選択できます。
[貼り付け] または ctrl+v は、テキストをシステムのクリップボードから Curl アプレットのテキストフィールドに挿入します。
[すべて選択] または ctrl+a は、コンテンツペインのコンテンツをすべて選択します。
[検索] または ctrl+f は、指定したテキストの検索用ダイアログボックスを現在のページに表示します。

[ツール] メニュー

[再ロード] と [停止] を除き、このメニューのすべての項目は API ドキュメントを参照する場合のみ使用できます。「API リファレンスマニュアル」を参照してください。

[再ロード] はドキュメントビューアで現在のページを再度読み込んで表示します。
[停止] はページのロードを停止します。
[メンバを隠す] はすべてのセクションを閉じ、メンバ情報が表示されないようにします。
[メンバを表示] はすべてのセクションを開き、すべてのメンバが一覧表示されるようにします。各メンバの詳細な説明部分は非表示のままです。詳細を表示する[メンバの説明を表示] を選択後に、このメニューコマンドを選択すると一覧表示されたすべてのメンバの詳細説明が閉じます。
[メンバの説明を表示] は、一覧表示されたすべてのメンバの詳細説明を開きます。
[クラスの使用者向けの表示] は既存のクラスを使いたい場合に、もっとも便利な形式でクラスのドキュメントを表示します。アクセス属性が protected のメンバは表示せず、メンバは以下のように分類されます。
- [プロパティ] には、アクセッサ と、ローカルオプション、非ローカルオプション が含まれます。
- [コンストラクタ] には、コンストラクタ と ファクトリ が含まれます。
[サブクラスの作成者向けの表示] は、新しいサブクラスを作成したい場合に、もっとも便利な形式でクラスのドキュメントを表示します。それぞれの型のクラスメンバを個別の見出しの下に表示します。protected のメンバも表示します。
[継承メンバ] は、クラスが継承したメンバが含まれているかどうか、および含まれている場合はそれらをグループ化する方法を選択できるサブメニューを表示します。サブメニューには次の項目があります。
- [なし] は、一覧表示するメンバをこのクラスで定義されたメンバに制限します。このため、継承されたメンバはリストに表示されません。
- [アルファベット順にソート] は、このクラスで定義されたメンバに加え、継承されたメンバも一覧表示し、アルファベット順にソートします。
- [クラスでソート] は、このクラスで定義されたメンバに加え、継承されたメンバも一覧表示し、クラスの継承順にソートします。

[移動] メニュー

開発者ガイドの参照中、ドキュメントビューアはその履歴を保存していきます。[移動] メニューを使用し、既に参照したセクションに移動することができます。

[進む] または alt+rightキーは、履歴リストを一度に 1 セクションずつ前方に移動します。履歴リストからページを表示している場合は、[進む] をクリックしてドキュメント履歴内を移動し、その次に参照したセクションを表示することができます。[進む] ボタンは、履歴リストで現在のセクションの後にセクションがある場合のみ有効になります。
[戻る] または alt+leftキーは、履歴リストを一度に 1 セクションずつ後方に移動します。[戻る] ボタンを押すと、現在の表示ページの前のページがロードされます。[戻る] を複数回クリックすると、履歴内のさらに前のページが表示されます。[戻る] ボタンは、履歴リストで現在のセクションの前にセクションがある場合のみ有効になります。
[このページをブックマークする] は、現在表示されているページをブックマークリストに追加します。このリストは [ブックマーク] タブに表示されます。
[履歴] は、以前に見たエントリを一覧表示したウィンドウを表示します。[履歴] ウィンドウ内のページに移動するには、ページを選択して [OK] をクリックします。
[履歴リスト]は [履歴] コマンドにより表示され、[戻る] や [進む] で辿り付けるページを一覧表示します。

ヘルプメニュー

新しいビューアで言語ドキュメンテーションを開く または shift+f1は、Curl IDEドキュメンテーションビューアを新しいウィンドウで開きます。
言語ドキュメンテーション または f1 は、Curl IDEドキュメンテーションビューアを開きます。
Curl IDEのヘルプ は、Curl IDEドキュメンテーションビューアで Curl統合開発環境(IDE)のイントロダクションを開きます。
エディタのヘルプ は、Curl IDEドキュメンテーションビューアで Curl言語ソースの編集を開きます。
デバッガのヘルプは、Curl IDEドキュメンテーションビューアで アプレットのデバッグを開きます。
プロジェクトのディプロイメントは、Curl IDEドキュメンテーションビューアで プロジェクトのディプロイメントを開きます。
Curl Pro/IDE の購入 では、60日間無料トライアル版 Curl Pro/IDE を始めることができ、購入したCurl Pro/IDE ライセンスをアクティベートすることが出来ます。
Curl IDEについては、Curl IDEのバージョン情報を表示します。

ドキュメントビューアのツールバー

ドキュメントビューアのツールバーから、メニューコマンドのサブセットにすばやくアクセスできます。次の表は、ツールバーのボタンと関連コマンドの概要を示しています。

アイコン	メニュー	選択
	移動	戻る
	移動	進む
	ツール	再ロード
	ファイル	印刷
	ツール	メンバを隠す
	ツール	メンバを表示
	ツール	メンバの説明を表示
	ツール / 継承メンバ	なし
	ツール / 継承メンバ	アルファベット順にソート
	ツール / 継承メンバ	クラスでソート
	ツール	クラスの使用者向けの表示
	ツール	サブクラス作成者向けの表示

Copyright © 1998-2019 SCSK Corporation. All rights reserved.
Curl, the Curl logo, Surge, and the Surge logo are trademarks of SCSK Corporation. that are registered in the United States. Surge Lab, the Surge Lab logo, and the Surge Lab Visual Layout Editor (VLE) logo are trademarks of SCSK Corporation.