Creating IDE Help/ja: what changed
Revision 0 to 1. Removed lines have a minus sign; added lines have a plus sign.
Title: Creating IDE Help/ja
| Old | New | Line | |
|---|---|---|---|
| 1 | + | ## LCLユニットのためのヘルプ | |
| 2 | + | ||
| 3 | + | ユーザーが、オブジェクトインスペクタ上のプロパティや、ソースエディタの識別子上で、F1をおすと、IDEが宣言を探してfpdocアイテムのHTMLビュワーにジャンプします。 このアイテムは簡単に[[FPDoc Editor|FPDoc Editorツールを]]使って編集できます。 LCLのドキュメントの状態は、[[LCL Documentation Roadmap|LCL Documentation Roadmapをみてください]]。 | |
| 4 | + | ||
| 5 | + | ## IDEウインドウのためのヘルプ | |
| 6 | + | ||
| 7 | + | 0.9.15以降にこの機能があります。 | |
| 8 | + | ||
| 9 | + | IDEウインドウのヘルプ（例えば、'Object Inspector' や、 'Compiler Options'など)は、このWikiで文書化されています。 | |
| 10 | + | ||
| 11 | + | IDEには、マッピングファイル*docs/IDEWindowHelpTree.xml*があり、その中にIDEフォームやコントロールから、ヘルプ用のWikiページへジャンプするための情報が書かれています。 | |
| 12 | + | ||
| 13 | + | このマッピングファイルは、IDEのどこにあっても、Ctrl+Shift+F1を押して表示され、エディタで編集できます。 （syneditのような全てのキーを取り込むコントロールは除きます） | |
| 14 | + | ||
| 15 | + | このショートカットは、options -\> key mappingで設定することができます。 | |
| 16 | + | ||
| 17 | + | IDEウインドウのルートページのドキュメントは、[[Lazarus IDE/ja]] です。 | |
| 18 | + | ||
| 19 | + | (訳注：Lazarusの日本語環境において、この機能は非常に多くの部分が未完成です。） | |
| 20 | + | ||
| 21 | + | ## FPCキーワードのためのヘルプ | |
| 22 | + | ||
| 23 | + | 0.9.15以降にこの機能があります。また、ローカルにFPC docsがHTMLとしてインストールされていることが必要です。 | |
| 24 | + | ||
| 25 | + | この機能は、ソースエディタのキーワード上にカーソルがあり、ユーザーがF1キーを押したときに、呼び出されます。 IDEはFPCのHTML文書の中から、ref.kwdファイルを元に検索します。このファイルはFPCチームでメンテナンスされており、全てのHTMLページのリストを含んでいます。現在は、カスタムヘルプは実装されていません。 | |
| 26 | + | ||
| 27 | + | TODO: Document, where to get/ how to create FPC Html docs. | |
| 28 | + | ||
| 29 | + | ## メッセージのためのヘルプ | |
| 30 | + | ||
| 31 | + | 0.9.15以降にこの機能があります。また、FPCソースがローカルにインストールされている必要があります。 | |
| 32 | + | ||
| 33 | + | この機能は、ユーザーがF1キーを押すか、メッセージウインドウのヘルプメニューを使うと呼び出されます。 | |
| 34 | + | ||
| 35 | + | 通常、IDEはFPCソースのerror.msgファイルを探して、メッセージのコメントを表示します。 しかし、*unit not found* のようないくつかのメッセージは、他のヘルプが必要です。以下に、それを記述する方法を示します。 | |
| 36 | + | ||
| 37 | + | メッセージのためのwikiヘルプページを追加する方法： | |
| 38 | + | ||
| 39 | + | - [[Build messages|Build messagesの]]下にWikiページを作ります。 | |
| 40 | + | - ide/helpfpcmessages.pasを開いて、*AddFPCMessageHelpItem*行を次のように追加します。: | |
| 41 | + | ||
| 42 | + | AddFPCMessageHelpItem('Can''t find unit', | |
| 43 | + | 'FPC_message:_Can_not_find_unit',': Can''t find unit '); | |
| 44 | + | ||
| 45 | + | 最初のパラメータは、エラーの時に表示されるタイトルです。２番目のパラメータはWikiのURLです。3番目のパラメータはメッセージにマッチする正規表現です。 | |
| 46 | + | ||
| 47 | + | 訳注）ここでいうメッセージというのは、コンパイルするときに表示されるコンパイラメッセージです。 | |
| 48 | + | ||
| 49 | + | --- | |
| 50 | + | *From the Free Pascal wiki, page "Creating IDE Help/ja", as it stood on 2020-01-26 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* | |
| 51 | + | Category: Help and Docs/ja | |
| 52 | + | Category: Japanese |