Update of /cvsroot/po4a/po4a/lib/Locale/Po4a In directory haydn:/tmp/cvs-serv881 Modified Files: Html.pm Xml.pm Log Message: Fix the pod syntax; add a big fat warning that the module is not ready for distribution yet Index: Html.pm =================================================================== RCS file: /cvsroot/po4a/po4a/lib/Locale/Po4a/Html.pm,v retrieving revision 1.6 retrieving revision 1.7 diff -u -d -r1.6 -r1.7 --- Html.pm 19 Jul 2004 10:21:12 -0000 1.6 +++ Html.pm 29 Jul 2004 01:26:27 -0000 1.7 @@ -38,6 +38,10 @@ Locale::Po4a::Html is a module to help the translation of documentation in the HTML format into other [human] languages. +Please note that this module is not distributed with the main po4a archive +because we don't feel it mature enough for that. If you insist on using it +anyway, check it from the CVS out. + =cut package Locale::Po4a::Html; Index: Xml.pm =================================================================== RCS file: /cvsroot/po4a/po4a/lib/Locale/Po4a/Xml.pm,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- Xml.pm 25 Jul 2004 09:07:10 -0000 1.4 +++ Xml.pm 29 Jul 2004 01:26:27 -0000 1.5 @@ -40,6 +40,10 @@ other [human] languages. It can also be used as a base to build modules for XML-based documents. +Please note that this module is still under heavy developement, and not +distributed in official po4a release since we don't feel it to be mature +enough. If you insist on trying, check the CVS out. + =cut package Locale::Po4a::Xml; @@ -160,6 +164,8 @@ Space-separated list of the tags you want to treat as inline. By default, all tags break the sequence. This follows the same syntax as the tags option. +=back + =cut sub initialize { @@ -304,6 +310,8 @@ This function returns the translated tag (translated attributes or all needed transformations) as a single string. +=back + =cut ##### Generic XML tag types ##### @@ -494,6 +502,8 @@ =head2 WORKING WITH TAGS +=over 4 + =item get_path This function returns the path to the current tag from the document's root, @@ -657,6 +667,8 @@ matched tag options (the characters in front of the tag) or 1 (if that tag doesn't have options). +=back + =cut sub tag_in_list { @@ -700,10 +712,14 @@ =head2 WORKING WITH ATTRIBUTES +=over 4 + =item treat_attributes TODO +=back + =cut sub treat_attributes { @@ -851,12 +867,16 @@ =head2 WORKING WITH THE MODULE OPTIONS +=over 4 + =item treat_options This function fills the internal structures that contain the tags, attributes and inline data with the options of the module (specified in the command-line or in the initialize function). +=back + =cut sub treat_options { @@ -875,6 +895,8 @@ =head2 GETTING TEXT FROM THE INPUT STREAM +=over + =item get_string_until This function returns an array with the lines (and references) from the input @@ -967,6 +989,8 @@ This function returns a simple string with the text from the argument array (discarding the references). + +=back =cut