← Back to branch summary

~ubuntu-branches/debian/lenny/fpc/lenny

« back to all changes in this revision

Viewing changes to fpcsrc/packages/fcl-xml/src/README

  • Committer: Bazaar Package Importer
  • Author(s): Mazen Neifer, Torsten Werner, Mazen Neifer
  • Date: 2008-05-17 17:12:11 UTC
  • mfrom: (3.1.9 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080517171211-9qi33xhd9evfa0kg
Tags: 2.2.0-dfsg1-9
http://bugs.debian.org/477743
[ Torsten Werner ]
* Add Mazen Neifer to Uploaders field.

[ Mazen Neifer ]
* Moved FPC sources into a version dependent directory from /usr/share/fpcsrc
  to /usr/share/fpcsrc/${FPCVERSION}. This allow installing more than on FPC
  release.
* Fixed far call issue in compiler preventing building huge binearies.
  (closes: #477743)
* Updated building dependencies, recomennded and suggested packages.
* Moved fppkg to fp-utils as it is just a helper tool and is not required by
  compiler.

Show diffs side-by-side

added added

removed removed

Lines of Context:
fpcsrc/packages/fcl-xml/src/README
 
1
Free Pascal XML units
 
2
=====================
 
3
 
 
4
DOM
 
5
---
 
6
Implements most of the DOM level 1 specification and supports some of the
 
7
DOM level 2 extensions.
 
8
 
 
9
 
 
10
XMLRead
 
11
-------
 
12
Provides a simple XML reader, which can read XML data from a file or stream.
 
13
This simple parser will be replaced by a much improved one soon, which will be
 
14
able to handle different character encodings, namespaces and entity references.
 
15
(This parser reads the file directly, i.e. it doesn't support Unicode or
 
16
different charsets yet.)
 
17
Regarding entity references: The pre-defined entities "lt", "gt", "amp", "apos"
 
18
and "quot" are replaced by their normal value during reading. Other entity
 
19
references are stored as TDOMEntityReference nodes in the DOM tree.
 
20
Regarding whitespace handling: Whitespace directly after the beginning of a
 
21
tag is discarded, and sections of the XML file which contain only whitespace and
 
22
no other text content are discarded as well.
 
23
 
 
24
 
 
25
XMLWrite
 
26
--------
 
27
Writes a DOM structure as XML data into a file or stream. It can deal both with
 
28
XML files and XML fragments.
 
29
At the moment it supports only the node types which can be read by XMLRead.
 
30
Please note that the writer replaces some characters by entity references
 
31
automatically:
 
32
For normal text nodes, the following replacements will be done:
 
33
'<' => '&lt;'
 
34
'>' => '&gt;'
 
35
'&' => '&amp;'
 
36
For attribute values, additionally '"' gets replaced by '&quot;'. Single
 
37
apostrophes (') don't need to get converted, as values are already written using
 
38
"" quotes.
 
39
The XML reader (in xmlread.pp) will convert these entity references back to
 
40
their original characters.
 
41
 
 
42
 
 
43
XPath
 
44
-----
 
45
Just a XPath implementation. Should be fairly completed, but there hasn't been
 
46
further development recently.
 
47
 
 
48
 
 
49
HTMLDefs
 
50
--------
 
51
Contains basic HTML declarations.
 
52
 
 
53
 
 
54
HTMLElements
 
55
------------
 
56
Implements a DOM for HTML content. Contains a TDOMElement descendent for
 
57
all valid HTML 4.1 tags.
 
58
 
 
59
THtmlCustomElement:
 
60
  Basis for all HTML tag elements.
 
61
THTMLDocument:
 
62
  TDOMDocument descendent
 
63
THTMLIDElement:
 
64
  element representing <ID> tag 
 
65
 
 
66
All tags are in tagsintf.inc.
 
67
 
 
68
 
 
69
HTMLWriter
 
70
----------
 
71
Implements a verified HTML producer.
 
72
 
 
73
THTMLwriter:
 
74
  This is a class which allows to write certified correct HTML.
 
75
  It works using the DOM for HTML.
 
76
  It also has forms support.
 
77
 
 
78
Writing HTML is done as follows:
 
79
 
 
80
  StartBold;
 
81
  Write('This text is bold');
 
82
  EndBold;
 
83
or
 
84
  Bold('This text is bold');
 
85
 
 
86
But the following is also possible
 
87
  Bold(Center('Bold centered text'));
 
88
 
 
89
Open tags will be closed automatically.
 
90
 
 
91
wtagsintf.inc contains all possible tags.