Difference between revisions of "Creating IDE Help/ja"
(New page: {{Creating IDE Help}} {{Japanese Menu}} == LCLユニットのためのヘルプ == Whenever the user presses F1 for an Object Inspector property or on an identifier in the source edito...) |
|||
Line 6: | Line 6: | ||
== LCLユニットのためのヘルプ == | == LCLユニットのためのヘルプ == | ||
− | + | ユーザーが、オブジェクトインスペクタ上のプロパティや、ソースエディタの識別子上で、F1をおすと、IDEが宣言を探してfpdocアイテムのHTMLビュワーにジャンプします。 | |
− | + | このアイテムは簡単に[[LazDoc]]ツールを使って編集できます。 | |
− | + | LCLのドキュメントの状態は、[[LCL Documentation Roadmap]]をみてください。 | |
− | |||
== IDEウインドウのためのヘルプ == | == IDEウインドウのためのヘルプ == |
Revision as of 16:29, 13 February 2008
LCLユニットのためのヘルプ
ユーザーが、オブジェクトインスペクタ上のプロパティや、ソースエディタの識別子上で、F1をおすと、IDEが宣言を探してfpdocアイテムのHTMLビュワーにジャンプします。 このアイテムは簡単にLazDocツールを使って編集できます。 LCLのドキュメントの状態は、LCL Documentation Roadmapをみてください。
IDEウインドウのためのヘルプ
This feature exists since 0.9.15.
The help for the IDE windows (i.e. 'Object Inspector' or the 'Compiler Options') are documented in this wiki. The IDE has a mapping file docs/IDEWindowHelpTree.xml, which contains the paths from the various IDE forms/controls to wiki pages. This mapping file is edited via an editor that is shown at any place in the IDE via Ctrl+Shift+F1, except for controls, that catches all keys, like synedit. You can set the short cut in the editor options -> key mapping.
The root page of the IDE window docs is Lazarus IDE.
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.