Lire Developer's Manual

Joost van Baal

Egon L. Willighagen

Francis J. Lacoste

This manual is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this manual (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html or write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.

Revision History
Revision 20020214 $Date: 2002/02/10 23:03:49 $
$Id: dev-manual.dbx,v 1.27 2002/02/10 23:03:49 flacoste Exp $

Table of Contents

Preface
What This Book Contains
How Is This Book Organized?
Conventions Used
If You Don't Find Something In This Manual
I. Lire Architecture
1. Architecture Overview
Definitions
2. Logs Abstraction into DLF
3. Report Generation
4. Report Formatting
XSLT Transformation
Perl Text Formatting
Chart Generation
5. Responder Architecture
6. Source Tree Layout
II. Extending Lire
7. Writing a New Superservice
DLF Design
The DLF Schema
8. Writing New Service
Writing a Log File to DLF Converter
API for 2DLF Scripts
9. Writing a New Report
Report Informations
Report's Display Specification
Filter Specification
Calculation Specification
10. Writing Advanced Reports
Using a Derived Schema
Writing Extension Reports
III. Lire Developers' Conventions
11. Developers' Toolbox
Required Tools To Build From CVS
Accessing Lire's CVS
CVS primer
SourceForge
Mailing Lists
12. Coding Standards
Shell Coding Standards
Perl Coding Standards
13. Commit Policy
CVS Branches
Hands-on example
Naming, what it looks like
Creating a Branch
Accessing a Branch
Merging Branches on the Trunk
14. Testing
15. Making a Release
Setting version in NEWS file
Tagging the CVS
Building The "Standard" Tarball
Building The "Full" Tarball
Building The Debian Package
Building The RPM Package
Uploading The Release
The LogReport Webserver
Advertising The Release
SourceForge
Freshmeat.net
16. Website Maintenance
Documentation on the LogReport Website
Publishing the DTD's
17. Writing Documentation
UML Diagrams
UML Editing
Diagram Types
IV. Developer's Reference
18. Lire DLF Schema Markup Language
19. Lire Report Specification Markup Language
20. Lire Report Markup Language
21. The Lire::Program API
22. The DLF Schema API
23. The Report Specification API