xml::grove::asstring(3) [redhat man page]

XML::Grove::AsString(3) 				User Contributed Perl Documentation				   XML::Grove::AsString(3)

NAME

       XML::Grove::AsString - output content of XML objects as a string

SYNOPSIS

	use XML::Grove::AsString;

	# Using as_string method on XML::Grove::Document or XML::Grove::Element:
	$string = $xml_object->as_string OPTIONS;
	$string = $element->attr_as_string $attr, OPTIONS;

	# Using an XML::Grove::AsString instance:
	$writer = new XML::Grove::AsString OPTIONS;

	$string = $writer->as_string($xml_object);
	$writer->as_string($xml_object, $file_handle);

DESCRIPTION

       Calling `"as_string"' on an XML object returns the character data contents of that object as a string, including all elements below that
       object.	Calling `"attr_as_string"' on an element returns the contents of the named attribute as a string.  Comments, processing instruc-
       tions, and, by default, entities all return an empty string.

       OPTIONS may either be a key-value list or a hash containing the options described below.  OPTIONS may be modified directly in the object.
       The default options are no filtering and entities are mapped to empty strings.

OPTIONS

       Filter
	   `"Filter"' is an anonymous sub that gets called to process character data before it is appended to the string to be returned.  This can
	   be used, for example, to escape characters that are special in output formats.  The `"Filter"' sub is called like this:

	       $string = &$filter ($character_data);

       EntityMap
	   `"EntityMap"' is an object that accepts `"lookup"' methods or an anonymous sub that gets called with the entity replacement text (data)
	   and mapper options as arguments and returns the corresponding character replacements.  It is called like this if it is an object:

	       $replacement_text = $entity_map->lookup ($entity_data,
							$entity_map_options);

	   or this if it is a sub:

	       $replacement_text = &$entity_map ($entity_data,
						 $entity_map_options);

       EntityMapOptions
	   `"EntityMapOptions"' is a hash passed through to the `"lookup"' method or anonymous sub, the type of value is defined by the entity
	   mapping package or the anonymous sub.

       EntityMapFilter
	   `"EntityMapFilter"' is a flag to indicate if mapped entities should be filtered after mapping.

EXAMPLES

       Here is an example of entity mapping using the Text::EntityMap module:

	   use Text::EntityMap;
	   use XML::Grove::AsString;

	   $html_iso_dia = Text::EntityMap->load ('ISOdia.2html');
	   $html_iso_pub = Text::EntityMap->load ('ISOpub.2html');
	   $html_map = Text::EntityMap->group ($html_iso_dia,
					       $html_iso_pub);

	   $element->as_string (EntityMap => $html_map);

AUTHOR

       Ken MacLeod, ken@bitsko.slc.ut.us

SEE ALSO

       perl(1), XML::Grove(3)

       Extensible Markup Language (XML) <http://www.w3c.org/XML>

perl v5.8.0							    1999-08-25						   XML::Grove::AsString(3)

XML::Grove::PerlSAX(3pm)				User Contributed Perl Documentation				  XML::Grove::PerlSAX(3pm)

NAME

       XML::Grove::PerlSAX - an PerlSAX event interface for XML objects

SYNOPSIS

	use XML::Grove::PerlSAX;

	$parser = XML::Grove::PerlSAX->new( [OPTIONS] );
	$result = $parser->parse( [OPTIONS] );

	# or
	$result = $xml_object->parse( [OPTIONS] );

DESCRIPTION

       "XML::Grove::PerlSAX" is a PerlSAX parser that generates PerlSAX events from XML::Grove objects.  This man page summarizes the specific
       options, handlers, and properties supported by "XML::Grove::PerlSAX"; please refer to the PerlSAX standard in `"PerlSAX.pod"' for general
       usage information.

METHODS

       new Creates a new parser object.  Default options for parsing, described below, are passed as key-value pairs or as a single hash.  Options
	   may be changed directly in the parser object unless stated otherwise.  Options passed to `"parse()"' override the default options in
	   the parser object for the duration of the parse.

       parse
	   Parses a document.  Options, described below, are passed as key-value pairs or as a single hash.  Options passed to `"parse()"'
	   override default options in the parser object.

OPTIONS

       The following options are supported by "XML::Grove::PerlSAX":

	Handler 	 default handler to receive events
	DocumentHandler  handler to receive document events
	Source		 hash containing the input source for parsing

       If no handlers are provided then all events will be silently ignored.

       If a single grove argument is passed to the `"parse()"' method, it is treated as if a `"Source"' option was given with a `"Grove"'
       parameter.

       The `"Source"' hash may contain the following parameters:

	Grove		 The grove object used to generate parse events..

HANDLERS

       The following events are generated by "XML::Grove::PerlSAX".  XML::Grove::PerlSAX passes the corresponding grove object as it's parameter
       so the properties passed to the handler are those that were used to create or were assigned to the grove.  Please see the docs for the
       parser used to create the grove for a list of properties that were provided.

   DocumentHandler methods
       start_document
	   Receive notification of the beginning of a document.  This is called from the XML::Grove::Document object before processing any
	   document content.

       end_document
	   Receive notification of the end of a document.  This is called from the XML::Grove::Document object after processing all document
	   content.

       start_element
	   Receive notification of the beginning of an element.  This is called from the XML::Grove::Element object before processing any element
	   content.

       end_element
	   Receive notification of the end of an element.  This is called from the XML::Grove::Element object after processing all element
	   content.

       characters
	   Receive notification of character data.  This is called from the XML::Grove::Characters object.

       processing_instruction
	   Receive notification of a processing instruction.  This is called from the XML::Grove::PI object.

       comment
	   Receive notification of a comment.  This is called from the XML::Grove::Comment object.

AUTHOR

       Ken MacLeod, ken@bitsko.slc.ut.us

SEE ALSO

       perl(1), XML::Grove(3)

       Extensible Markup Language (XML) <http://www.w3c.org/XML>

perl v5.10.1							    1999-10-23						  XML::Grove::PerlSAX(3pm)