paweld/lazarus
1
0
Fork 0
mirror of https://gitlab.com/freepascal.org/lazarus/lazarus.git synced 2025-09-01 22:00:20 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: xmlread/write, issue #35342, from Don Siders

Browse Source 
git-svn-id: trunk@60896 -
This commit is contained in:
mattias 2019-04-08 14:27:04 +00:00
parent f37e4f2ce4
commit 4a5a1e4634
5 changed files with 1170 additions and 1237 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1847
docs/xml/lazutils/laz2_xmlread.xml
View File

File diff suppressed because it is too large Load Diff

237
docs/xml/lazutils/laz2_xmlwrite.xml
View File

@ -1,109 +1,168 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<package name="lazutils">
<!--
====================================================================
laz2_XMLWrite
====================================================================
-->
<module name="laz2_XMLWrite">
<short>
Provides routines used to write XML content to a file, text file, or stream
</short>
<descr>
<p>
<var>laz2_xmlwrite.pas</var> provides procedures and types used to write XML content to a file, text file, or stream. laz2_xmlwrite.pas has classes in its implementation section that are used to perform serialization of XML content to the storage destination.
</p>
<p>
Copyright (c) 1999-2000 by Sebastian Guenther, sg@freepascal.org <br/>
Modified in 2006 by Sergei Gorelkin, sergei_gorelkin@mail.ru <br/>
Converted to use UTF-8 instead of widestrings by Mattias Gaertner.
</p>
</descr>
<!--
====================================================================
laz2_XMLWrite
====================================================================
-->
<!-- unresolved externals -->
<element name="Classes"/>
<element name="SysUtils"/>
<element name="LazUTF8"/>
<element name="lazUTF8Classes"/>
<element name="laz2_DOM"/>
<element name="laz2_XMLUtils"/>
<module name="laz2_XMLWrite">
<short></short>
<descr>
</descr>
<!-- enumeration type Visibility: default -->
<element name="TXMLWriterFlag">
<short>
Represent options enabled when writing XML content
</short>
<descr>
<var>TXMLWriterFlag</var> is an enumerated type with values that represent options enabled when writing XML content. Values in TXMLWriterFlag are stored in the <var>TXMLWriterFlags</var> set type, and passed as an argument to the WriteXMLFile and WriteXML routines.
</descr>
<seealso>
<link id="TXMLWriterFlags"/>
<ink id="WriteXMLFile"/>
<ink id="WriteXML"/>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TXMLWriterFlag.xwfSpecialCharsInAttributeValue">
<short>
Enables writing Carriage Return (Decimal 13) characters in attribute values instead of the numeric character entity &amp;xD;
</short>
</element>
<element name="TXMLWriterFlag.xwfPreserveWhiteSpace">
<short>Preserves whitespace in DOM Text nodes</short>
</element>
<!-- enumeration type Visibility: default -->
<element name="TXMLWriterFlag">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- set type Visibility: default -->
<element name="TXMLWriterFlags">
<short>Set type used to store TXMLWriterFlag values</short>
<descr>
<p>
<var>TXMLWriterFlags</var> is a set type used to store 0 or more values from the <var>TXMLWriterFlag</var> enumeration. TXMLWriterFlags indicates the options enabled when writing XML content. TXMLWriterFlags is the type passed as an argument to the <var>WriteXMLFile</var> procedure.
</p>
</descr>
<seealso>
<link id="TXMLWriterFlag"/>
<link id="WriteXMLFile"/>
</seealso>
</element>
<!-- enumeration value Visibility: default -->
<element name="TXMLWriterFlag.xwfSpecialCharsInAttributeValue">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="WriteXMLFile">
<short>
Writes an XML document to a file, text file, or stream
</short>
<descr>
<p>
<var>WriteXMLFile</var> is an overloaded procedure used to write an XML document to a file, text file, or stream. Overloaded variants provide the implementation details for each of the destinations, and create either TTextXMLWriter or TStreamXMLWriter class instances to store the XML document.
</p>
<p>
AFileName indicates the file name on the local file system where the XML content is stored. AFileName can contain UTF-8 encoded values, and must represent a valid file name. If the file in AFileName already exists, an exception will be raised.
</p>
<p>
Flags contains values from the TXMLWriterFlag enumeration. Use Flags to enable XML writing options in the routine. The default value for the argument is an empty set (<b>[]</b>), and indicates that no options are enabled in the routine.
</p>
</descr>
<seealso>
<link id="WriteXML"/>
</seealso>
</element>
<!-- set type Visibility: default -->
<element name="TXMLWriterFlags">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.doc">
<short>XML document written in the routine</short>
</element>
<!-- procedure Visibility: default -->
<element name="WriteXMLFile">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.AFileName">
<short>File name where the XML content is stored</short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.doc">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.AFile">
<short>Text file type where the content is written</short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.AFileName">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.AStream">
<short>Stream where the XML document is stored</short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.Flags">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.Flags">
<short>Options enabled when writing the XML content</short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.AFile">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="WriteXML">
<short>
Writes a DOM Node to a file, text file, or stream
</short>
<descr>
<p>
<var>WriteXML</var> is an overloaded procedure used to write a DOM Node to a file, text file, or stream. WriteXML calls one of the overloaded WriteXMLFile routines for a specific destination.
</p>
<p>
Element is a TDOMNode parameter that represents the DOM Document Node with the XML content written in the method. WriteXML ensures that Element is cast to a TXMLDocument type when calling the WriteXMLFile routine.
</p>
<p>
AFileName indicates the file name on the local file system where the XML content is stored. AFileName can contain UTF-8 encoded values, and must represent a valid file name. If the file in AFileName already exists, an exception will be raised.
</p>
<p>
Flags contains values from the TXMLWriterFlag enumeration. Use Flags to enable XML writing options in the routine. The default value for the argument is an empty set (<b>[]</b>), and indicates that no options are enabled in the routine.
</p>
</descr>
<seealso>
<link id="WriteXMLFile"/>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.AStream">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXML.Element">
<short>DOM Node with the XML content written in the method</short>
</element>
<!-- procedure Visibility: default -->
<element name="WriteXML">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="WriteXML.AFileName">
<short>File name where the XML content is stored</short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXML.Element">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXML.AFile">
<short>Text file type where the content is written</short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXML.AFileName">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXML.AStream">
<short>Stream where the XML document is stored</short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXML.AFile">
<short></short>
</element>
<element name="WriteXML.Flags">
<short>Options enabled when writing the XML content</short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXML.AStream">
<short></short>
</element>
</module>
<!-- laz2_XMLWrite -->
</module> <!-- laz2_XMLWrite -->
</package>
</package>
</fpdoc-descriptions>

155
docs/xml/lazutils/laz_xmlread.xml
View File

@ -1,135 +1,38 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<package name="lazutils">
<!--
====================================================================
Laz_XMLRead
====================================================================
-->
<module name="Laz_XMLRead">
<short></short>
<descr></descr>
<!--
====================================================================
Laz_XMLRead
====================================================================
-->
<!-- unresolved externals -->
<element name="Classes"/>
<element name="laz2_DOM"/>
<element name="laz2_XMLRead"/>
<module name="Laz_XMLRead">
<short></short>
<descr>
</descr>
<element name="EXMLReadError" link="laz2_XMLRead.EXMLReadError"/>
<element name="ReadXMLFile" link="laz2_XMLRead.ReadXMLFile"/>
<element name="ReadXMLFile.ADoc" link="laz2_XMLRead.ReadXMLFile.ADoc"/>
<element name="ReadXMLFile.AFilename" link="laz2_XMLRead.ReadXMLFile.AFileName"/>
<element name="ReadXMLFile.f" link="laz2_XMLRead.ReadXMLFile.f"/>
<!-- class Visibility: default -->
<element name="EXMLReadError">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="ReadXMLFragment" link="laz2_XMLRead.ReadXMLFragment"/>
<element name="ReadXMLFragment.AParentNode" link="laz2_XMLRead.ReadXMLFragment.AParentNode"/>
<element name="ReadXMLFragment.AFilename" link="laz2_XMLRead.ReadXMLFragment.AFileName"/>
<element name="ReadXMLFragment.f" link="laz2_XMLRead.ReadXMLFragment.f"/>
<!-- variable Visibility: public -->
<element name="EXMLReadError.Position">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<element name="ReadDTDFile" link="laz2_XMLRead.ReadDTDFile"/>
<element name="ReadDTDFile.ADoc" link="laz2_XMLRead.ReadDTDFile.ADoc"/>
<element name="ReadDTDFile.AFilename" link="laz2_XMLRead.ReadDTDFile.AFileName"/>
<element name="ReadDTDFile.f" link="laz2_XMLRead.ReadDTDFile.f"/>
<!-- variable Visibility: public -->
<element name="EXMLReadError.LineCol">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
</module>
<!-- Laz_XMLRead -->
<!-- variable Visibility: public -->
<element name="EXMLReadError.Descr">
<short></short>
<descr>
</descr>
<seealso>
</seealso>
</element>
<!-- procedure Visibility: default -->
<element name="ReadXMLFile">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="ReadXMLFile.ADoc">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="ReadXMLFile.AFilename">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="ReadXMLFile.f">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="ReadXMLFragment">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="ReadXMLFragment.AParentNode">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="ReadXMLFragment.AFilename">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="ReadXMLFragment.f">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="ReadDTDFile">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="ReadDTDFile.ADoc">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="ReadDTDFile.AFilename">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="ReadDTDFile.f">
<short></short>
</element>
</module> <!-- Laz_XMLRead -->
</package>
</package>
</fpdoc-descriptions>

97
docs/xml/lazutils/laz_xmlwrite.xml
View File

@ -1,81 +1,32 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<package name="lazutils">
<!--
====================================================================
Laz_XMLWrite
====================================================================
-->
<module name="Laz_XMLWrite">
<short></short>
<descr></descr>
<!--
====================================================================
Laz_XMLWrite
====================================================================
-->
<element name="Classes"/>
<element name="laz2_DOM"/>
<element name="laz2_XMLWrite"/>
<module name="Laz_XMLWrite">
<short></short>
<descr>
</descr>
<element name="WriteXML" link="laz2_XMLWrite.WriteXML"/>
<element name="WriteXML.Element" link="laz2_XMLWrite.WriteXML.Element"/>
<element name="WriteXML.AFileName" link="laz2_XMLWrite.WriteXML.AFileName"/>
<element name="WriteXML.AStream" link="laz2_XMLWrite.WriteXML.AStream"/>
<!-- procedure Visibility: default -->
<element name="WriteXMLFile">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<element name="WriteXMLFile" link="laz2_XMLWrite.WriteXMLFile"/>
<element name="WriteXMLFile.doc" link="laz2_XMLWrite.WriteXMLFile.doc"/>
<element name="WriteXMLFile.AFileName" link="laz2_XMLWrite.WriteXMLFile.AFileName"/>
<element name="WriteXMLFile.AFile" link="laz2_XMLWrite.WriteXMLFile.AFile"/>
<element name="WriteXMLFile.AStream" link="laz2_XMLWrite.WriteXMLFile.AStream"/>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.doc">
<short></short>
</element>
</module>
<!-- Laz_XMLWrite -->
<!-- argument Visibility: default -->
<element name="WriteXMLFile.AFileName">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.AFile">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXMLFile.AStream">
<short></short>
</element>
<!-- procedure Visibility: default -->
<element name="WriteXML">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- argument Visibility: default -->
<element name="WriteXML.Element">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXML.AFileName">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXML.AFile">
<short></short>
</element>
<!-- argument Visibility: default -->
<element name="WriteXML.AStream">
<short></short>
</element>
</module> <!-- Laz_XMLWrite -->
</package>
</package>
</fpdoc-descriptions>

71
docs/xml/lazutils/lazutf8sysutils.xml
View File

@ -1,51 +1,36 @@
<?xml version="1.0" encoding="UTF-8"?>
<fpdoc-descriptions>
<package name="lazutils">
<package name="lazutils">
<!--
====================================================================
lazutf8sysutils
====================================================================
-->
<module name="lazutf8sysutils">
<short></short>
<descr></descr>
<!--
====================================================================
lazutf8sysutils
====================================================================
-->
<!-- function Visibility: default -->
<element name="NowUTC">
<short>Deprecated; use the function from the LazSysUtils unit</short>
</element>
<module name="lazutf8sysutils">
<short></short>
<descr>
</descr>
<!-- function result Visibility: default -->
<element name="NowUTC.Result">
<short></short>
</element>
<!-- function Visibility: default -->
<element name="NowUTC">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function Visibility: default -->
<element name="GetTickCount64">
<short>Deprecated; use the function from the LazSysUtils unit</short>
</element>
<!-- function result Visibility: default -->
<element name="NowUTC.Result">
<short></short>
</element>
<!-- function result Visibility: default -->
<element name="GetTickCount64.Result">
<short></short>
</element>
<!-- function Visibility: default -->
<element name="GetTickCount64">
<short></short>
<descr>
</descr>
<errors>
</errors>
<seealso>
</seealso>
</element>
<!-- function result Visibility: default -->
<element name="GetTickCount64.Result">
<short></short>
</element>
</module> <!-- lazutf8sysutils -->
</package>
</module>
<!-- lazutf8sysutils -->
</package>
</fpdoc-descriptions>