Then enter a name for the output file - do not forget the xml extension! - and click OK. Afterwards you enter the source file to use. All units you want to add to this package should be given the same package name. Just go to File -> New and the following screen appears: You will then have to start from scratch, and lazde has a function to get you off to a flying start. If the unit is part of a package, it is likely that there is no xml file for you to start from. There are of course many other units waiting to be documented. This is the text entered in the description box of lazde. The text shown here has been entered in the same way as for the function's arguments. The function result is shown as a fourth paragraph. The text shown after each argument corresponds to whatever was entered in the "Short" editbox when the respective child node was selected. When you open the InputQuery node in lazde you will see each argument separately as a child node.
Because there are two versions of this function the source position says 0. The declaration part is created by the html-builder and is parsed directly from the sources. Next is the declaration of this function taken from the source file dialogs.pp. The first line of text is what has been entered in the "Short" editbox in lazde. Have a look at the description of InputQuery.Īt the top of the page you can see what the page is about (in this case the InputQuery function from dialogs.pp).
#FREE PASCAL WIN 8 CODE#
These buttons enable you to add and remove links to other pages or code examples respectively. The "See also" and "Example code File" fields are each provided with three buttons (,, ). "Errors" is used to give information about any errors raised by a function if parameters have values that are out of range. Note: If you want to insert a line break use īelow the main description field are further fields labelled "Errors", "See also" and "Example code File". When you build and run this program, if you open /docs/xml/lcl/dialogs.xml you will be presented with this screen The sources for "lazde" can be found in /doceditor/. Since compiled executable versions of lazde are not provided, you have to build one for yourself. An example of FPDoc output can be seen here, a part of the documentation so far. It can also be used to generate the basic XML file skeleton derived from a Pascal unit source file and (by means of the external tool FPDoc) to generate an HTML version of the documentation. "Lazde" is a tool designed to edit the XML documentation files. So now we know where to find the files, let's look at the tool we're developing to create and adapt the documentation data files. The XML files you will find in this directory are auto-generated and need to be adapted to be useful. So far the /lcl/ directory contains mainly empty skeleton files, which contain little (or no) useful documentation. The current documentation can be found in /docs/xml/. The task of documenting Lazarus is underwayĪs mentioned above, XML was chosen as the documentation data format since this is platform-independent.
#FREE PASCAL WIN 8 OFFLINE#
to create CHM files that you can browse offline (once placed in a correctly registered local directory) as help for Lazarus that is available even when you have no internet access.to create HTML pages you can access at.Each Lazarus unit has its own XML documentation data file.Ī large number of such XML files have already been written, and they can be used: To make the help file platform-independent we use XML files to record and store documentation data. The primary goal of this documentation project is to make available an online help file. So when you read simply replace it with the directory appropriate for your Lazarus installation. In this wiki document I use to denote the Lazarus base directory. This page describes the use of this tool to edit existing documentation or to create new documentation files. To help produce the needed documentation a tool called LazDE has been developed.
Good, comprehensive documentation is an important missing part of Lazarus.
0 kommentar(er)
