FPDoc Editor/ja

From Free Pascal wiki
Jump to: navigation, search

Deutsch (de) English (en) français (fr) 日本語 (ja) português (pt) русский (ru)

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


始めに

LazDoc は Lazarus に統合されたエディタ・ビューアです。ここに表記されている項目や LazDoc を使うには、 FPDoc に精通しておく必要があります。これ以上の情報はここ Free Pascal documentation tool manual を参照して下さい。

LazDocはどこにありますか??

LazDoc は Lazarus IDE に統合されています。View メニューで確認できます。

使い方

LazDoc の使い方はとてもシンプルです。

1. Set the search path for LazDoc in the Environment | Environment options dialog, under the LazDoc tabpage.

2. Open or select a file for which documentation exists.

3. Open the LazDoc editor. You can find it under the menu View.

4. Place and move the cursor. After placing the cursor on the source editor, you will notice that the caption of the LazDoc form changes. The caption shows the source element selected and the filename of the documentation file. By selecting the appropriate page in LazDoc you can edit a specific documentation tag. Of course it is also possible to use LazDoc only as a viewer.

Future plans

Todo リストは今のところ次の項目があります。特に決まった順はありません:

  • Make LazDoc create new elements in documentation
  • Make LazDoc create new documentation files
  • Add documentation tags "topic" to LazDoc
  • Add more source elements to be interpreted by LazDoc using exisiting codetools (now procedure/function/constructor/destructor are supported)
  • Add LazDoc to IDE settings (showing and position in IDE)
  • Use IPC for communication
  • Make LazDoc work on keydown in sourceeditor (broken)
  • Make LazDoc a WYSIWYG editor, comparable to a richtext editor.
  • Add a HTML viewer; LazDoc will generate the documentation automatically

DONE

  • Adding a small toolbar makes it possible to use the available makeup tags.
  • Add documentation tags "seealso" to LazDoc
  • Make it work for fpc sources (rtl files already exist)
  • Add settings to environment menu
  • Make it work on project files also
  • Propose to expand documentation tags with: "todo" and "notes" (no need for that, as there are alternatives)
  • Reduce overhead even further