Lazarus Documentation Editor/ja

From Lazarus wiki
Jump to: navigation, search

Deutsch (de) English (en) español (es) français (fr) 日本語 (ja) slovenčina (sk)

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


Lazarus に不足している重要なもののひとつはドキュメントです。このドキュメントの製作を支援するために、ツールが開発されました。このページではツールの使い方について述べます。このドキュメントで私が[$LazDir]と使用している箇所がありますが、これは Lazarus のベースディレクトリを意味します。その箇所が出てきたら、Lazarus をインストールしたディレクトリだと読み替えてください。


このプロジェクトの最初のゴールは利用可能なオンラインヘルプを作成することです。プラットホームに依存しないヘルプファイルを作成するために、Lazarus で使用される各ユニット用の XML ファイルの作成を開始していました。今のところ、dialogs.pp と buttons.pp だけが始められています。 これらの XML ファイルはインターネット上の から情報を得られるように、HTML ページを作成するために使用されます。後の段階で、統合されたヘルプは、再び同じ XML ファイルを使用して開発されます。

The Start

上述の通り、プラットホームから独立した XML ドキュメント作成をしていくために使用されます。現在のドキュメントは [$LazDir]/docs/xml 内に見つけることが出来ます。 いまのところ、lcl ディレクトリには殆どスケルトンファイルしかありません。 The XML files you find in this directory are auto generated and need to be adapted to be usable. So now we know where to find the files, lets look at the tool to create / adapt them.

The Tool

"lazde" is a tool to edit the xml files, but can also be used to generate the basic files from source files and by means of an external tool to generate a HTML version of the documentation. An example of the results of the last tool can be seen here, a part of the documentation sofar. As there is no compiled version of lazde, you have to make one yourself. The sources for "lazde" can be found in [$LazDir]/doceditor/. When you run this program and you have opened [$LazDir]/docs/xml/lcl/dialogs.xml you will be presented with this screen


The Work


Opening the node "Packages" will show the "LCL" node which contains a "Dialogs" node. Selecting this last node will fill the lower treeview with elements. These elements depict Constants, Types and Classes defined in the Dialogs.pp unit. Used units are added as well as nodes. Other nodes are added for the properies of a class, the parameters for a function and so on.

Selecting a node in the lower left treeview will make the content of that node displayed on the right side of the window.

When you look at this page you will see an overview of classes defined in the "dialogs" unit. After each class you see a line of text. This text comes from the "short" editbox from lazde.

Below the "short" editbox, there is a memofield where you can enter a more elaborate description of the component or the property.

Note: If you want to insert a line break use <br/>

Next are "Errors", "See also" and "Example code File".

"Errors" can be used to tell about errors raised by a function if parameters have values that are out of range. For an example see this page.

Just above "See also" and "Example code File" you see three buttons. These buttons enable you to add and remove links to other pages or code examples respectively.

The Outcome

Have a look at the description of InputQuery. On the top of the page we see what the page is about, in this case the InputQuery function form the dialogs.pp. The first line of text is what is entered in the "Short" editbox in lazde.

Next is the declaration of this function in the sources. The declaration part is created by the html-builder and is taken from the sources. Because there are two versions of this function the source position says 0.

Then the arguments are given. When you open the InputQuery node in lazde you will see all arguments mentioned as child nodes. The text shown after the arguments is what has been entered in the "Short" editbox when the respective child nodes are selected.

As a fourth paragraph the Function result is shown. The text shown here has been entered in the same way as the arguments.

Finally the description is shown. This is the text entered in the description box of lazde.


There are of course other units that need to be documented. If it is for instance a unit for some package, chances are there is no xml file to start with. You have to start from scratch then, but lazde has a function to get you off to a flying start. Just go to File -> New and the following screen will appear:


You start by giving the package a name. All units you want to add to this package should have the same package name. Afterwards you enter the source file to use; you can browse to this file as well. Then enter a name for the output file. (Do not forget the xml extension!) And press OK.

lazde will then generate the basics for the documentation. The generated file will be opened and the treeview will be populated by all units, classes, types, functions and so on from your source file. Now you are ready to start documenting a new part of Lazarus.

Have a look at LCL Documentation Roadmap to see which units still need to be documented.

The Final result

What I experienced during the use of the program is that I would like to see how the information is shown in its final stage (as a browsable document). For this purpose lazde makes use of a utility to build all necessary HTML-files.

This utility can be started from the menu Extra -> Build. The following screen will be shown:


"Package" should be the same as the name you gave when you created the xml files. For "Format" choose HTML. At "Output" you enter the path where the resulting files should be placed. Press "Add all" and all documents your were working on will be added to the project. Then go to the next to tab


and enter the paths to the source files. After you have pressed build your HD will start to rattle and finally the following output will be shown on the "Build output" tab.

Building docs using command: fpdoc --package="LCL"
--output="/home/matthijs/documentatie/LCL" --format=html --content 

FPDoc - Free Pascal Documentation Tool
(c) 2000 - 2003 Areca Systems GmbH / Sebastian Guenther,

Writing 2788 pages...
Documentation successfully built.

When you go to the directory you entered at "Output" you will see a index.html file and (in this case 4) sub directories. Open index.html in your favorit browser and see the result of all your hard work on the documentation. You will be able to follow the links and read it all.

When you plan to continue working on this package of documentation, press "Save" and save the build options. You will be asked to provide a name for the file and the options will be saved. Next time you want to build the HTML-files you can just "load" them again.

The Submission

When you are satisfied with your work you certainly want to share it with the Lazarus community. All you have to do is make a patch, zip this and send it in.

A small note

Note the following: The lazde is work in progress. It is workable, but not completely finished yet. So there can be some bugs in it, but feel free to fix them.