docs: Documented adding custom declaration node. Fixes issue 155.

git-svn-id: http://pugixml.googlecode.com/svn/trunk@906 99668b35-9821-0410-8761-19e4c4f06640

2 files changed, 42 insertions, 0 deletions

diff --git a/docs/manual.qbk b/docs/manual.qbk
index 5059631..6faa573 100644
--- a/docs/manual.qbk
+++ b/docs/manual.qbk
@@ -1390,6 +1390,21 @@ Also note that wide stream saving functions do not have `encoding` argument and
 
 [endsect] [/encoding]
 
+[section:declaration Customizing document declaration]
+
+When you are saving the document using `xml_document::save()` or `xml_document::save_file()`, a default XML document declaration is output, if `format_no_declaration` is not speficied and if the document does not have a declaration node. However, the default declaration is not customizable. If you want to customize the declaration output, you need to create the declaration node yourself.
+
+[note By default the declaration node is not added to the document during parsing. If you just need to preserve the original declaration node, you have to add the flag [link parse_declaration] to the parsing flags; the resulting document will contain the original declaration node, which will be output during saving.]
+
+Declaration node is a node with type [link node_declaration]; it behaves like an element node in that it has attributes with values (but it does not have child nodes). Therefore setting custom version, encoding or standalone declaration involves adding attributes and setting attribute values.
+
+This is an example that shows how to create a custom declaration node ([@samples/save_declaration.cpp]):
+
+[import samples/save_declaration.cpp]
+[code_save_declaration]
+
+[endsect] [/declaration]
+
 [endsect] [/saving]
 
 [section:xpath XPath]
diff --git a/docs/samples/save_declaration.cpp b/docs/samples/save_declaration.cpp
new file mode 100644
index 0000000..6c82061
--- /dev/null
+++ b/docs/samples/save_declaration.cpp
@@ -0,0 +1,27 @@
+#include "pugixml.hpp"

+

+#include <iostream>

+

+int main()

+{

+    //[code_save_declaration

+    // get a test document

+    pugi::xml_document doc;

+    doc.load("<foo bar='baz'><call>hey</call></foo>");

+

+    // add a custom declaration node

+    pugi::xml_node decl = doc.prepend_child(pugi::node_declaration);

+    decl.append_attribute("version") = "1.0";

+    decl.append_attribute("encoding") = "UTF-8";

+    decl.append_attribute("standalone") = "no";

+

+    // <?xml version="1.0" encoding="UTF-8" standalone="no"?> 

+    // <foo bar="baz">

+    //         <call>hey</call>

+    // </foo>

+    doc.save(std::cout);

+    std::cout << std::endl;

+    //]

+}

+

+// vim:et