diff options
author | Derek Jones <derek.jones@ellislab.com> | 2011-10-05 20:34:52 +0200 |
---|---|---|
committer | Derek Jones <derek.jones@ellislab.com> | 2011-10-05 20:34:52 +0200 |
commit | 8ede1a2ecbb62577afd32996956c5feaf7ddf9b6 (patch) | |
tree | 2e960ec3b416b477f40bb546371f2d486f4a22f0 /user_guide_src/source/helpers/xml_helper.rst | |
parent | d1ecd5cd4ae6ab5d37df9fbda14b93977b9e743c (diff) |
replacing the old HTML user guide with a Sphinx-managed user guide
Diffstat (limited to 'user_guide_src/source/helpers/xml_helper.rst')
-rw-r--r-- | user_guide_src/source/helpers/xml_helper.rst | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/user_guide_src/source/helpers/xml_helper.rst b/user_guide_src/source/helpers/xml_helper.rst new file mode 100644 index 000000000..be848bcd1 --- /dev/null +++ b/user_guide_src/source/helpers/xml_helper.rst @@ -0,0 +1,38 @@ +########## +XML Helper +########## + +The XML Helper file contains functions that assist in working with XML +data. + +.. contents:: Page Contents + +Loading this Helper +=================== + +This helper is loaded using the following code + +:: + + $this->load->helper('xml'); + +The following functions are available: + +xml_convert() +===================== + +Takes a string as input and converts the following reserved XML +characters to entities: + +- Ampersands: & +- Less then and greater than characters: < > +- Single and double quotes: ' " +- Dashes: - + +This function ignores ampersands if they are part of existing character +entities. Example + +:: + + $string = xml_convert($string); + |