diff options
Diffstat (limited to 'docs/quickstart.adoc')
| -rw-r--r-- | docs/quickstart.adoc | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/quickstart.adoc b/docs/quickstart.adoc index 41a169b..3fe29b1 100644 --- a/docs/quickstart.adoc +++ b/docs/quickstart.adoc @@ -24,7 +24,7 @@ https://github.com/zeux/pugixml/releases/download/v{version}/pugixml-{version}.t The distribution contains library source, documentation (the guide you're reading now and the manual) and some code examples. After downloading the distribution, install pugixml by extracting all files from the compressed archive. The complete pugixml source consists of three files - one source file, `pugixml.cpp`, and two header files, `pugixml.hpp` and `pugiconfig.hpp`. `pugixml.hpp` is the primary header which you need to include in order to use pugixml classes/functions. The rest of this guide assumes that `pugixml.hpp` is either in the current directory or in one of include directories of your projects, so that `#include "pugixml.hpp"` can find the header; however you can also use relative path (i.e. `#include "../libs/pugixml/src/pugixml.hpp"`) or include directory-relative path (i.e. `#include <xml/thirdparty/pugixml/src/pugixml.hpp>`). - + The easiest way to build pugixml is to compile the source file, `pugixml.cpp`, along with the existing library/executable. This process depends on the method of building your application; for example, if you're using Microsoft Visual Studio footnote:[All trademarks used are properties of their respective owners.], Apple Xcode, Code::Blocks or any other IDE, just add `pugixml.cpp` to one of your projects. There are other building methods available, including building pugixml as a standalone static/shared library; link:manual/install.html#install.building[read the manual] for further information. [[dom]] @@ -67,7 +67,7 @@ This is an example of loading XML document from file (link:samples/load_file.cpp [source,indent=0] ---- -include::samples/load_file.cpp[tags=code] +include::samples/load_file.cpp[tags=code] ---- `load_file`, as well as other loading functions, destroys the existing document tree and then tries to load the new tree from the specified file. The result of the operation is returned in an `xml_parse_result` object; this object contains the operation status, and the related information (i.e. last successfully parsed position in the input file, if parsing fails). @@ -78,7 +78,7 @@ This is an example of handling loading errors (link:samples/load_error_handling. [source,indent=0] ---- -include::samples/load_error_handling.cpp[tags=code] +include::samples/load_error_handling.cpp[tags=code] ---- Sometimes XML data should be loaded from some other source than file, i.e. HTTP URL; also you may want to load XML data from file using non-standard functions, i.e. to use your virtual file system facilities or to load XML from gzip-compressed files. These scenarios either require loading document from memory, in which case you should prepare a contiguous memory block with all XML data and to pass it to one of buffer loading functions, or loading document from C{plus}{plus} IOstream, in which case you should provide an object which implements `std::istream` or `std::wistream` interface. @@ -280,7 +280,7 @@ OTHER DEALINGS IN THE SOFTWARE. .... This means that you can freely use pugixml in your applications, both open-source and proprietary. If you use pugixml in a product, it is sufficient to add an acknowledgment like this to the product distribution: - + .... This software is based on pugixml library (http://pugixml.org). pugixml is Copyright (C) 2006-2016 Arseny Kapoulkine. |