Documentation

Revision as of 21:10, 8 April 2006 by Manus (Talk | contribs) (Added page about documentation.)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Introduction

The documentation included in EiffelStudio for both EiffelStudio and its libraries is usually given in HTML format, however the documentation is actually written in XML using a very simple schema. We provide a tool Doc Builder to edit the XML file, and on Windows we can even display the generated HTML result.

Doc Builder

For the moment, we only provide a Windows binary that requires the Microsoft .NET 1.1 Framework to be installed and that can only run on 32-bit machine. Contact the developer mailing list if you absolutely need a 64-bit version.

You can find the Doc Builder package in our Downloads area.

Once you start Doc Builder, open the project file located in trunk/Delivery/xml/projects directory of the svn repository. After, you can choose which xml file to edit in the tree view on the left-hand side of the tool.

Limitations

The Doc Builder tool was originally an internal tool used at Eiffel Software for putting together the documentation of EiffelStudio. Because it was an internal tool, not much time has been devoted at fixing things which are not working properly. If you would like to improve the quality of this tool, please contact us at the developer mailing list.

Retrieved from "https://dev.eiffel.com/index.php?title=Documentation&oldid=1795"