Creating IDE Help/ja

LCLユニットのためのヘルプ

ユーザーが、オブジェクトインスペクタ上のプロパティや、ソースエディタの識別子上で、F1をおすと、IDEが宣言を探してfpdocアイテムのHTMLビュワーにジャンプします。 このアイテムは簡単にLazDocツールを使って編集できます。 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キーワードのためのヘルプ

This feature exists since 0.9.15 and requires the FPC docs as HTML installed locally.

This is invoked when the cursor in the source editor is above a keyword and the user pressed F1. The IDE searches in the FPC html documentation for the ref.kwd file. This file is maintained by the FPC team and contains a list to all HTML pages. At the moment no custom help is implemented.

TODO: Document, where to get/ how to create FPC Html docs.

メッセージのためのヘルプ

This feature exists since 0.9.15 and requires the FPC sources installed locally.

This is invoked when the user presses F1 or uses the Help menu item of the message window.

Normally the IDE will search the errore.msg file in the FPC sources and show the comment for the message. But some messages like unit not found need extra help. The following describes how to do that:

To add a wiki help page for a message, do the following:

• Create a wiki page under the root Build messages
• Open ide/helpfpcmessages.pas and add a AddFPCMessageHelpItem line like:

  AddFPCMessageHelpItem('Can''t find unit',
                        'FPC_message:_Can_not_find_unit',': Can''t find unit ');

The first parameter is the title shown in errors. The second parameter is the wiki URL. And the third parameter is the regular expression to match the message.