diff --git a/readme.txt b/readme.txt index 1291a70..62a1972 100755 --- a/readme.txt +++ b/readme.txt @@ -71,7 +71,7 @@ Both parsers: Advantages of TinyXML-2
  1. The focus of all future dev.
    2. -
  2. Many fewer memory allocation (about 1/100th), uses less memory (about 40% of TinyXML-1), and faster.
    3. +
  3. Many fewer memory allocation (1/10th to 1/100th), uses less memory (about 40% of TinyXML-1), and faster.
  4. No STL requirement.
  5. More modern C++, including a proper namespace.
  6. Proper and useful handling of whitespace
    7. @@ -107,52 +107,41 @@ As a first step, all newlines / carriage-returns / line-feeds are normalized to line-feed character, as required by the XML spec. White space in text is preserved. For example: -@verbatim + Hello, World -@endverbatim The leading space before the "Hello" and the double space after the comma are preserved. Line-feeds are preserved, as in this example: -@verbatim Hello again, World -@endverbatim However, white space between elements is *not* preserved. Although not strictly compliant, tracking and reporting inta-element space is awkward, and not normally valuable. TinyXML-2 sees these as the same XML: -@verbatim - -1 -2 -3 - -@endverbatim + + 1 + 2 + 3 + -@verbatim -123 -@endverbatim + 123

    Entities

    TinyXML-2 recognizes the pre-defined "character entities", meaning special characters. Namely: -@verbatim & & < < > > " " ' ' -@endverbatim These are recognized when the XML document is read, and translated to there UTF-8 equivalents. For instance, text with the XML of: -@verbatim Far & Away -@endverbatim will have the Value() of "Far & Away" when queried from the XMLText object, and will be written back to the XML stream/file as an ampersand. @@ -167,42 +156,37 @@ regular code point. The output is correct, but the entity syntax isn't preserved

    Print to file

    You can directly use the convenience function: -@verbatim + XMLDocument doc; ... doc.Save( "foo.xml" ); -@endverbatim Or the XMLPrinter class: -@verbatim + XMLPrinter printer( fp ); doc.Print( &printer ); -@endverbatim

    Print to memory

    Printing to memory is supported by the XMLPrinter. -@verbatim + XMLPrinter printer; doc->Print( &printer ); // printer.CStr() has a const char* to the XML -@endverbatim

    Print without an XMLDocument

    - When loading, an XML parser is very useful. However, sometimes - when saving, it just gets in the way. The code is often set up - for streaming, and constructing the DOM is just overhead. +When loading, an XML parser is very useful. However, sometimes +when saving, it just gets in the way. The code is often set up +for streaming, and constructing the DOM is just overhead. - The Printer supports the streaming case. The following code - prints out a trivially simple XML file without ever creating - an XML document. +The Printer supports the streaming case. The following code +prints out a trivially simple XML file without ever creating +an XML document. -@verbatim XMLPrinter printer( fp ); printer.OpenElement( "foo" ); printer.PushAttribute( "foo", "bar" ); printer.CloseElement(); -@endverbatim

    Using and Installing