Difference between revisions of "Creating IDE Help/ja"

From Lazarus wiki
Jump to navigationJump to search
m (Added categories)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
{{Creating IDE Help}}
+
{{LanguageBar|Creating IDE Help}}
  
 
{{Japanese Menu}}
 
{{Japanese Menu}}
Line 7: Line 7:
  
 
ユーザーが、オブジェクトインスペクタ上のプロパティや、ソースエディタの識別子上で、F1をおすと、IDEが宣言を探してfpdocアイテムのHTMLビュワーにジャンプします。
 
ユーザーが、オブジェクトインスペクタ上のプロパティや、ソースエディタの識別子上で、F1をおすと、IDEが宣言を探してfpdocアイテムのHTMLビュワーにジャンプします。
−
このアイテムは簡単に[[LazDoc]]ツールを使って編集できます。
+
このアイテムは簡単に[[FPDoc Editor]]ツールを使って編集できます。
 
LCLのドキュメントの状態は、[[LCL Documentation Roadmap]]をみてください。
 
LCLのドキュメントの状態は、[[LCL Documentation Roadmap]]をみてください。
  
 
== IDEウインドウのためのヘルプ ==
 
== IDEウインドウのためのヘルプ ==
−
 
+
0.9.15以降にこの機能があります。
−
この機能は、0.9.15以降で実現されています。
 
  
 
IDEウインドウのヘルプ（例えば、'Object Inspector' や、 'Compiler Options'など)は、このWikiで文書化されています。
 
IDEウインドウのヘルプ（例えば、'Object Inspector' や、 'Compiler Options'など)は、このWikiで文書化されています。
Line 39: Line 38:
 
== メッセージのためのヘルプ ==
 
== メッセージのためのヘルプ ==
  
−
This feature exists since 0.9.15 and requires the FPC sources installed locally.
+
0.9.15以降にこの機能があります。また、FPCソースがローカルにインストールされている必要があります。
  
−
This is invoked when the user presses F1 or uses the Help menu item of the message window.
+
この機能は、ユーザーがF1キーを押すか、メッセージウインドウのヘルプメニューを使うと呼び出されます。
  
−
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:
+
通常、IDEはFPCソースのerror.msgファイルを探して、メッセージのコメントを表示します。
 +
しかし、''unit not found'' のようないくつかのメッセージは、他のヘルプが必要です。以下に、それを記述する方法を示します。
  
−
To add a wiki help page for a message, do the following:
+
メッセージのためのwikiヘルプページを追加する方法：
−
* Create a wiki page under the root [[Build messages]]
+
* [[Build messages]]の下にWikiページを作ります。
−
* Open ide/helpfpcmessages.pas and add a ''AddFPCMessageHelpItem'' line like:
+
* ide/helpfpcmessages.pasを開いて、''AddFPCMessageHelpItem''行を次のように追加します。:
 
<pre>
 
<pre>
 
   AddFPCMessageHelpItem('Can''t find unit',
 
   AddFPCMessageHelpItem('Can''t find unit',
 
                         'FPC_message:_Can_not_find_unit',': Can''t find unit ');
 
                         'FPC_message:_Can_not_find_unit',': Can''t find unit ');
 
</pre>
 
</pre>
−
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.
+
 
 +
最初のパラメータは、エラーの時に表示されるタイトルです。２番目のパラメータはWikiのURLです。3番目のパラメータはメッセージにマッチする正規表現です。
 +
 
 +
 
 +
訳注）ここでいうメッセージというのは、コンパイルするときに表示されるコンパイラメッセージです。
 +
 
 +
[[Category:Help and Docs/ja]]
 +
{{AutoCategory}}

Latest revision as of 09:16, 26 January 2020

│ Deutsch (de) │ English (en) │ 日本語 (ja) │ русский (ru) │

日本語版メニュー
メインページ - Lazarus Documentation日本語版 - 翻訳ノート - 日本語障害情報


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 ');

最初のパラメータは、エラーの時に表示されるタイトルです。２番目のパラメータはWikiのURLです。3番目のパラメータはメッセージにマッチする正規表現です。


訳注）ここでいうメッセージというのは、コンパイルするときに表示されるコンパイラメッセージです。

Retrieved from "http://wiki.freepascal.org/index.php?title=Creating_IDE_Help/ja&oldid=131038"