added PDF documentation

This commit is contained in:
Roland Gruber 2005-09-15 20:10:38 +00:00
parent ed571cfdd8
commit d0f8af8885
3 changed files with 42 additions and 7 deletions

View File

@ -9,9 +9,4 @@
- Samba 3: support kickoff time
- InetOrgPerson: jpgPhoto
0.5.0
- document missing parts
- add Samba display name

View File

@ -47,7 +47,7 @@ lists</a></li>
<li><a href="account_modules_lib.htm">Account modules
(modules.inc)</a><br>
</li>
<li>PDF (pdf.inc, pdfstruct.inc)<br>
<li><a href="pdf_libs.htm">PDF (pdf.inc, pdfstruct.inc)</a><br>
</li>
<li><a href="profiles.htm">Account profiles (profiles.inc)</a><br>
</li>

View File

@ -0,0 +1,40 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html; charset=ISO-8859-15"
http-equiv="content-type">
<title>PDF (pdf.inc, pdfstruct.inc)</title>
<link rel="stylesheet" type="text/css" href="style/layout.css">
</head>
<body>
<h1 style="text-align: center;">PDF (pdf.inc, pdfstruct.inc)<br>
</h1>
<br>
These files control the management of PDF structures and creation of
PDF files.<br>
<br>
<br>
<h2>pdfstruct.inc</h2>
This file includes all functions which are needed to manage the PDF
structures. You can load/save/delete structures, get a list of
available structures and logos.<br>
<br>
<br>
<h2>pdf.inc</h2>
The pdf.inc library is used to create a PDF file. <br>
<br>
<span style="font-weight: bold;">createModulePDF()</span> takes a list
of <span style="font-style: italic;">accountContainer</span> objects
and a PDF structure as parameters. The function then creates a PDF
file, saves it to the <span style="font-style: italic;">tmp</span>
folder and returns the file name.<br>
<br>
<br>
The <span style="font-weight: bold;">lamPDF</span> class extends the <span
style="font-style: italic;">UFPDF</span> class and adds the LAM
specific header and footer.<br>
It also defines the used font. Currently only Bitstream-Vera is
supported.<br>
<br>
</body>
</html>