2001-05-14
0.08.00
KDEヘルプシステム ユーザーマニュアル
KDE ヘルプシステム
&kde;ヘルプシステムは、&kde;本来のドキュメント(&XML;)だけでなく、標準的な&UNIX;のヘルプシステム(man 及び info)にもアクセスできるようデザインされています。
全ての&kde;アプリケーションには、ドキュメンテーションチームの努力により、完全なドキュメントが付けられています。もし、ドキュメンテーションチームをお手伝い頂けるなら、Lauri Wattslauri@kde.org宛てにメールを下さい。熱意と根気以外さえあれば、経験の有無は問いません。
また、あなたの使用している言語への&kde;ドキュメントの翻訳でもお手伝い頂けます。翻訳に関するコーディネータはThomas Diehlthd@kde.orgで、彼に連絡下されば、彼はあなたの参加を歓迎するでしょう。各国語のチームのコーディネータ等、詳細な情報はInternationalisation web siteを参照して下さい。このドキュメントの連絡先セクションにも若干の情報があります。
インストール
&khelpcenter; は&kde;の基本インストールの一部に含まれていますので、全ての&kde;環境にインストールされています。これはkdebaseパッケージ内にありますので、KDE &FTP; siteから入手できます。また、あなたのlinuxディストリビューションにもkdebaseパッケージが含まれているでしょう。
ヘルプの起動
&khelpcenter;は複数の方法で起動出来ます:
ヘルプメニューから もっとも一般的な方法は、アプリケーションのヘルプ目次を選択して、そのアプリケーションのヘルプファイルの目次を開くというものでしょう。 Kメニューから パネル上の大きなKを選び、ここでヘルプを選択して&khelpcenter;を開きます。標準の挨拶のページが開きます。 パネルから &kicker;パネルには標準で&khelpcenter;を起動するアイコンが含まれています。そして再び標準の挨拶ページが表示されます。 コマンドラインから &khelpcenter;は、表示したいファイルのURLを指定して起動出来ます。URLとしてはInfoや、manのページの為の指定も可能です。下記のように使用して下さい: アプリケーションのヘルプファイルの場合 khelpcenter &kedit;のヘルプファイルの目次ページを開きます。 ローカルURLの場合 khelpcenter MANページの場合 khelpcenter Infoページの場合 khelpcenter khelpcenterをパラメータ無しで実行すると、標準の挨拶のページが表示されます。
&khelpcenter;のユーザーインターフェース
&khelpcenter;のユーザーインターフェースは2つの画面領域に分かれています。
ツールバー、メニューについての説明はにあります。
殆んどのドキュメントが参照を案内するツールを備えているので、次のページ、前のページ、上、ホームのリンクを使って順に読んで行くことも、ハイパーリンクを辿って行くことも出来ます。
リンクによってドキュメント内の他の場所に飛べるだけでなく、他のドキュメンにも行くことが出来ます。またツールバー上の戻る (左向きの矢印)または、進む (右向き矢印)アイコンを使って、今回のセッションで参照した範囲を見て回ることが出来ます。
2つの領域の内、左側にはヘルプシステムの目次が、反対側にはヘルプファイルそれ自身が表示されます。
目次領域
&khelpcenter;の目次領域はウィンドウの左側に表示されます。スプリッタバーを使って、2つの領域サイズを、読みやすいように変更することが出来ます。
検索タブ
検索にはht://Digアプリケーションがインストールされている必要があります。検索インデックスのインストール及び設定の仕方が説明されています。検索インデックスの設定は&kcontrol;で行います。ヘルプ目次を選択して、このモジュールの詳細なヘルプを見ることが出来ます。
このドキュメントでは、既にこれらのインストールと設定が済んでいる事を前提としています。
ヘルプファイルの検索は、全く対話的に行います。テキストボックスで、検索したい言葉を入力し、更にオプションを(必要があれば)指定して、検索ボタンを押します。結果は右側のビューア領域に表示されます。
指定可能なオプション:
方法 複数の検索語をどう扱うかを指定します。かつを選択すると、結果は、指定した語を全て含んだものだけが表示されます。またはの場合には、指定した語のいずれかが含まれているものが結果として返されます。そして、ブーリアンを選択すると、複合した条件を指定出来ます。 ブーリアンシンタックスでは、AND,OR 及び NOTと言った論理演算子を使って。複雑な検索式を指定できます。例を上げましょう: 猫 AND 犬 猫と犬の2つの語を両方とも含んでいるページを検索します。片方しか含んでいないものは結果には含まれません。 猫 NOT 犬 猫は含んでいるけれど、犬は含まないページを検索します。 猫 OR (犬 NOT 鼻) 猫を含むページと、犬は含むが鼻は含まないページを検索します。猫と鼻を含むページは結果に含まれますが、3つの語を全て含むページは結果には含まれません。 もし思ったように検索結果が返されない時は、注意深く検索条件を調べ、誤ってNOTにより必要な検索語を除外していたり、括弧の付け方が誤っていたりしていないかを確認して下さい。 最大結果 検索結果として返されるべき最大の件数を指定します。 フォーマット 対象ページへのリンクのみ(ショート)か、簡単な要約付き(ロング)かを決めます。 ソート 結果を、スコア(どのくらい検索条件に適合しているか)順にソートするか、タイトルの順にソートするか、日付順にソートするかを指定します。順番を逆にチェックボックスをチェックすると結果のソート順を逆順にします。 インデックスを更新 検索インデックスを更新します。新規のドキュメントを組み込んだり、データベースが不完全だったり破損していた場合などに使います。これは多少時間がかかるかもしれません。
ManとInfoセクション
Manページはunixの標準のマニュアルページですが、何年もの間、多くのOSで使われて来ました。それらは非常に徹底していて、殆んどのlinuxコマンドとアプリケーションの情報を得るに最適の場所です。RTFM
と言う時、対象としているのは大抵はmanページなのです。
しかし、manページは完璧ではありません。詳しくはありますが、余りに技術的に過ぎますし、しばしば開発者によって、開発者の為に書かれています。この結果、あまりユーザーフレンドリーとは言えず、書き直されなければ一般のユーザーには理解できないようなものさえあります。しかしながら、多くのコマンドやアプリケーションの最も充実した情報ソースであり、また場合よっては唯一の情報ソースでもあります。
例えば、man(1)などと書かれている、この番号はなんだろうと思ったことがおありだと思います。これは、その項目がマニュアルのどのセクションに含まれているかを示しています。&khelpcenter;でも、この番号がmanページをそれらのセクションに分割するのに使われています。この分類を見るだけで、探したい項目が容易に見付けられるでしょう。
Infoページも利用出来ます。infoページはmanページを置き換えることを目論んで作られました。アプリケーションのメンテナーによっては、最早manページは更新しなくなっています。もし、manページとinfoページが両方ともにあるなら、infoページの内容の方が恐らくは最新のものになっているでしょう。殆んどのアプリケーションはどちらか、あるいは両方を提供しています。もしあなたが、ヘルプ情報を探しているアプリケーションが&GNU;ユーティリティの一つなら、それは、恐らくはmanページではなくinfoページの中に見つかるでしょう。
Infoページ内を移動する
Infoドキュメントでは各ページをノードと呼び、それらが階層的に配置されています。全てのinfoドキュメントはTopノードを持っていて、これが開始ページにあたります。infoドキュメント内ではTopノードには、Topを押して戻ることが出来ます。
Prev & Nextは、現在のレベルの中で、前の/次のページに移動するのに使います。
ドキュメントの中のメニュー項目をクリックすると、階層の1つ下のレベルに移動することになります。Upを押すと上の階層に行くことが出来ます。
manの場合もinfoと同様に扱われます。この場合、セクションのインデックスがTopノードになり、各manページが下のレベルになります。manの各項目は1つのページとなります。
&kde;用語集
メニューとツールバー
ツールバーアイコン 印刷 検索 フォントを拡大 フォントを縮小
ファイル ファイル(F) フレームを印刷 &Ctrl;W ファイル(F) 閉じる(C) 編集 表示
クレジットとライセンス
&khelpcenter;
最初の開発者はMatthias Elter me@kde.orgです
現在のメンテナーはMatthias Hoelzer-Kluepfelmhk@kde.orgです
&underFDL;
&underGPL;