Lazarus Documentation Editor

From Free Pascal wiki
Revision as of 13:21, 16 May 2005 by Matthijs (talk | contribs)
Jump to navigationJump to search

Introduction

This is work in progress.

An important part of Lazarus still missing is the documentation. To aid in the making of this documentation a tool has been developed. This page will describe the workings of this tool. To denote the Lazarus base directory in this document I use [$LazDir]. So when you read this replace this with the directory lazarus is installed in.

How to start

To keep the documentation platform independent XML is used. The current documentation can be found in [$LazDir]/docs/xml/. So far there are only skeleton files in the lcl directory. 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 Lazarus Documentation Editor

The sources for "lazde" can be found in [$LazDir]/doceditor/. After you have opened, build and ran lazde.lpi, you will be presented with this screen.