/ 
OpenOffice-OODoc-1.108
River stage one • 6 direct dependents • 6 total dependents
/ OpenOffice::OODoc

NAME

OpenOffice::OODoc - A library for direct OpenOffice.org document processing

DESCRIPTION

This toolbox allows direct read/write operations on documents, without using the OpenOffice.org software. It provides a high-level, document-oriented language, and isolates the programmer from the details of the OpenOffice.org XML dialect and file format.

DETAILS

The main module of the API, OpenOffice::OODoc, provides some code shortcuts for the programmer. So, its main function is to load the operational modules, i.e :

OpenOffice::OODoc::Document
OpenOffice::OODoc::File
OpenOffice::OODoc::Image
OpenOffice::OODoc::Meta
OpenOffice::OODoc::Styles
OpenOffice::OODoc::Text
OpenOffice::OODoc::XPath

The detailed documentation is organised on a by-module basis. There is a man page for each one in the list above. But, before using it you should read the README of the standard distribution, or the OpenOffice::OODoc::Intro man page, to get an immediate knowledge of the functionality of each one. Alternatively, you can download the original reference manual in OpenOffice.org or PDF format from the project homepage (http://www.genicorp.com/devel/oodoc)

Exported functions

Every "ooXxx" function below is only a shortcut for the constructor ("new") in a submodule of the API. See the man page of the corresponding module for details.

localEncoding

Accessor to get/set the user's local character set
(see $OpenOffice::OODoc::XPath::LOCAL_CHARSET in the
OpenOffice::OODoc::XPath man page).

Example:

	$old_charset = localEncoding();
	localEncoding('iso-8859-15');

If the given argument is an unsupported encoding, an error
message is produced and the old encoding is preserved. So
this accessor is safer than a direct update of the
$OpenOffice::OODoc::XPath::LOCAL_CHARSET variable.

The default local character set is "iso-8859-1".
Should be set to the appropriate value by the application
before processing.

See the Encode::Supported (Perl) documentation for the list
of supported encodings.

ooDecodeText($ootext)

Returns the translation of a raw OpenOffice.org (UTF-8) in
the local character set. For exceptional use; this translation
is normally done by the high level text read/write methods.

ooEncodeText($ootext)

Returns the translation of an application-provided string,
made of local characters, in OpenOffice.org (UTF-8).
For exceptional use; this translation is normally done by the
high level text read/write methods.

ooDocument

Shortcut for OpenOffice::OODoc::Document->new

ooFile

Shortcut for OpenOffice::OODoc::File->new

ooImage

Shortcut for OpenOffice::OODoc::Image->new

ooStyles

Shortcut for OpenOffice::OODoc::Styles->new

ooText

Shortcut for OpenOffice::OODoc::Text->new

ooXPath

Shortcut for OpenOffice::OODoc::XPath->new

Special variable

$XML_PARSER is a reserved variable in the space of the
main program. It contains a reusable XML Parser
(XML::XPath::XMLParser object), automatically created.
Advanced, XPath-aware applications may reuse this parser
(see the documentation of the XML::XPath Perl module) but
they must *NOT* set the variable.

AUTHOR/COPYRIGHT

Copyright 2004 by Genicorp, S.A. (http://www.genicorp.com)

Initial developer: Jean-Marie Gouarne (http://jean.marie.gouarne.online.fr)

Licensing conditions:

- Licence Publique Generale Genicorp v1.0
- GNU Lesser General Public License v2.1

Contact: oodoc@genicorp.com