Shlomi Fish committed fcf430d

Apply a patch to clarify the parameter documentation.

Comments (0)

Files changed (2)

 Revision history for Perl extension XML::LibXSLT.
+    - Apply a patch from Michael Ludwig clarifying the quoting of string
+    parameters to the XSLT transformation.
+        - Thanks, Michael!
 1.76            Thu Jan 12 19:15:03 IST 2012
     - Made LibXSLT.xs compile with C compilers that don't accept declarations
     inside blocks:
 =item transform(doc, %params)
-  my $results = $stylesheet->transform($doc, foo => "value);
+  my $results = $stylesheet->transform($doc, foo => "'bar'");
   print $stylesheet->output_as_bytes($results);
 Transforms the passed in XML::LibXML::Document object, and returns a
 new XML::LibXML::Document. Extra hash entries are used as parameters.
-See output_string
+Be sure to keep in mind the caveat with regard to quotes explained in
+the section on L</"Parameters"> below.
 =item transform_file(filename, %params)
-  my $results = $stylesheet->transform_file($filename, bar => "value");
+  my $results = $stylesheet->transform_file($filename, bar => "'baz'");
+Note the string parameter caveat, detailed in the section on
+L</"Parameters"> below.
 =item output_as_bytes(result)
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.