Creating IDE Help/ja
│ Deutsch (de) │ English (en) │ 日本語 (ja) │ русский (ru) │
LCLユニットのためのヘルプ
ユーザーが、オブジェクトインスペクタ上のプロパティや、ソースエディタの識別子上で、F1をおすと、IDEが宣言を探してfpdocアイテムのHTMLビュワーにジャンプします。 このアイテムは簡単にFPDoc Editorツールを使って編集できます。 LCLのドキュメントの状態は、LCL Documentation Roadmapをみてください。
IDEウインドウのためのヘルプ
0.9.15以降にこの機能があります。
IDEウインドウのヘルプ(例えば、'Object Inspector' や、 'Compiler Options'など)は、このWikiで文書化されています。
IDEには、マッピングファイルdocs/IDEWindowHelpTree.xmlがあり、その中にIDEフォームやコントロールから、ヘルプ用のWikiページへジャンプするための情報が書かれています。
このマッピングファイルは、IDEのどこにあっても、Ctrl+Shift+F1を押して表示され、エディタで編集できます。 (syneditのような全てのキーを取り込むコントロールは除きます)
このショートカットは、options -> key mappingで設定することができます。
IDEウインドウのルートページのドキュメントは、Lazarus IDE/ja です。
(訳注:Lazarusの日本語環境において、この機能は非常に多くの部分が未完成です。)
FPCキーワードのためのヘルプ
0.9.15以降にこの機能があります。また、ローカルにFPC docsがHTMLとしてインストールされていることが必要です。
この機能は、ソースエディタのキーワード上にカーソルがあり、ユーザーがF1キーを押したときに、呼び出されます。 IDEはFPCのHTML文書の中から、ref.kwdファイルを元に検索します。このファイルはFPCチームでメンテナンスされており、全てのHTMLページのリストを含んでいます。現在は、カスタムヘルプは実装されていません。
TODO: Document, where to get/ how to create FPC Html docs.
メッセージのためのヘルプ
0.9.15以降にこの機能があります。また、FPCソースがローカルにインストールされている必要があります。
この機能は、ユーザーがF1キーを押すか、メッセージウインドウのヘルプメニューを使うと呼び出されます。
通常、IDEはFPCソースのerror.msgファイルを探して、メッセージのコメントを表示します。 しかし、unit not found のようないくつかのメッセージは、他のヘルプが必要です。以下に、それを記述する方法を示します。
メッセージのためのwikiヘルプページを追加する方法:
- Build messagesの下にWikiページを作ります。
- ide/helpfpcmessages.pasを開いて、AddFPCMessageHelpItem行を次のように追加します。:
AddFPCMessageHelpItem('Can''t find unit', 'FPC_message:_Can_not_find_unit',': Can''t find unit ');
最初のパラメータは、エラーの時に表示されるタイトルです。2番目のパラメータはWikiのURLです。3番目のパラメータはメッセージにマッチする正規表現です。
訳注)ここでいうメッセージというのは、コンパイルするときに表示されるコンパイラメッセージです。