From 2094a4fd3da85c1972f215cb5977f6157590ff79 Mon Sep 17 00:00:00 2001 From: Arseny Kapoulkine Date: Fri, 28 Feb 2014 06:01:16 +0000 Subject: docs: Regenerate HTML documentation git-svn-id: https://pugixml.googlecode.com/svn/trunk@993 99668b35-9821-0410-8761-19e4c4f06640 --- docs/manual/install.html | 123 +++++++++++++++++++++++++++-------------------- 1 file changed, 72 insertions(+), 51 deletions(-) (limited to 'docs/manual/install.html') diff --git a/docs/manual/install.html b/docs/manual/install.html index df7b322..5675651 100644 --- a/docs/manual/install.html +++ b/docs/manual/install.html @@ -3,16 +3,16 @@ Installation - - - - + + + +
-pugixml 1.2 manual | +pugixml 1.4 manual | Overview | Installation | Document: @@ -28,32 +28,33 @@
-
-
Getting pugixml
+
+
Getting pugixml
-
Source distributions
-
Subversion repository
+
Source distributions
+
Subversion repository
+
Git repository
-
Building pugixml
+
Building pugixml
-
Building pugixml as +
Building pugixml as a part of another static library/executable
-
Building pugixml as +
Building pugixml as a standalone static library
-
Building pugixml as +
Building pugixml as a standalone shared library
-
Using pugixml in header-only - mode
-
Additional configuration +
Using + pugixml in header-only mode
+
Additional configuration options
-
Portability
+
Portability

pugixml is distributed in source form. You can either download a source distribution @@ -61,14 +62,14 @@

You can download the latest source distribution via one of the following links:

-
http://pugixml.googlecode.com/files/pugixml-1.2.zip
-http://pugixml.googlecode.com/files/pugixml-1.2.tar.gz
+
https://github.com/zeux/pugixml/releases/download/v1.4/pugixml-1.4.zip
+https://github.com/zeux/pugixml/releases/download/v1.4/pugixml-1.4.tar.gz
 

 

           The distribution contains library source, documentation (the manual you're
@@ -85,7 +86,7 @@

The Subversion repository is located at http://pugixml.googlecode.com/svn/. @@ -96,7 +97,7 @@

For example, to checkout the current version, you can use this command:

-
svn checkout http://pugixml.googlecode.com/svn/tags/release-1.2 pugixml
+
svn checkout http://pugixml.googlecode.com/svn/tags/release-1.4 pugixml

To checkout the latest version, you can use this command:

@@ -115,10 +116,20 @@ that occasionally the code can be broken in some configurations.

+
+
+

+ The Subversion repository is mirrored by a Git repository at https://github.com/zeux/pugixml. + The mirror is frequently updated and has the same structure in terms of + tags and contents as Subversion repository. +

+

pugixml is distributed in source form without any pre-built binaries; you @@ -128,7 +139,7 @@ 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; - pugiconfig.hpp is a supplementary configuration file (see Additional configuration + pugiconfig.hpp is a supplementary configuration file (see Additional configuration options). 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" @@ -138,14 +149,14 @@

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[1], Apple Xcode, Code::Blocks or any other IDE, just add pugixml.cpp to + Visual Studio[1], Apple Xcode, Code::Blocks or any other IDE, just add pugixml.cpp to one of your projects.

@@ -173,7 +184,7 @@

@@ -183,7 +194,7 @@ are project files for Apple XCode3, Code::Blocks, Codelite, Microsoft Visual Studio 2005, 2008, 2010, and configuration scripts for CMake and premake4. You're welcome to submit project files/build scripts for other software; - see Feedback. + see Feedback.

There are two projects for each version of Microsoft Visual Studio: one @@ -236,7 +247,7 @@

@@ -271,10 +282,10 @@

-
+

It's possible to use pugixml in header-only mode. This means that all source @@ -313,7 +324,7 @@

Note that it is safe to compile pugixml.cpp if PUGIXML_HEADER_ONLY is defined - so if you want to i.e. use header-only mode only in Release - configuration, you can include pugixml.cpp in your project (see Building pugixml as + configuration, you can include pugixml.cpp in your project (see Building pugixml as a part of another static library/executable), and conditionally enable header-only mode in pugiconfig.hpp, i.e.:

@@ -325,7 +336,7 @@

@@ -347,7 +358,7 @@ as character type) and UTF-16/32 style interface (the in-memory text encoding is assumed to be UTF-16/32, depending on wchar_t size, most functions use wchar_t - as character type). See Unicode interface for more details. + as character type). See Unicode interface for more details.

PUGIXML_NO_XPATH define disables XPath. @@ -377,7 +388,7 @@ is used instead. For example, to specify fixed calling convention, you can define PUGIXML_FUNCTION to i.e. __fastcall. Another - example is DLL import/export attributes in MSVC (see Building pugixml as + example is DLL import/export attributes in MSVC (see Building pugixml as a standalone shared library).

@@ -395,24 +406,34 @@ PUGIXML_MEMORY_PAGE_SIZE, PUGIXML_MEMORY_OUTPUT_STACK and PUGIXML_MEMORY_XPATH_PAGE_SIZE can be used to customize certain important sizes to optimize memory usage - for the application-specific patterns. For details see Memory consumption tuning. + for the application-specific patterns. For details see Memory consumption tuning. +

+

+ PUGIXML_HAS_LONG_LONG define enables + support for long long + type in pugixml. This define is automatically enabled if your platform + is known to have long long + support (i.e. has C++-11 support or uses a reasonably modern version of + a known compiler); if pugixml does not recognize that your platform supports + long long + but in fact it does, you can enable the define manually.

pugixml is written in standard-compliant C++ with some compiler-specific - workarounds where appropriate. pugixml is compatible with the upcoming C++0x - standard (verified using GCC 4.5). Each version is tested with a unit test + workarounds where appropriate. pugixml is compatible with the C++11 standard, + but does not require C++11 support. Each version is tested with a unit test suite (with code coverage about 99%) on the following platforms:

-
    +
    • Microsoft Windows: -
        +
        • Borland C++ Compiler 5.82
          • @@ -427,8 +448,8 @@
        • Microsoft Visual C++ 6.0, 7.0 (2002), 7.1 (2003), 8.0 (2005) x86/x64, - 9.0 (2008) x86/x64, 10.0 (2010) x86/x64, 11.0 x86/x64/ARM and some - CLR versions + 9.0 (2008) x86/x64, 10.0 (2010) x86/x64, 11.0 (2011) x86/x64/ARM, + 12.0 (2013) x86/x64/ARM and some CLR versions
        • MinGW (GCC) 3.4, 4.4, 4.5, 4.6 x64 @@ -436,7 +457,7 @@
      • - Linux (GCC 4.4.3 x86/x64) + Linux (GCC 4.4.3 x86/x64, GCC 4.8.1 x64, Clang 3.2 x64)
      • FreeBSD (GCC 4.2.1 x86/x64) @@ -466,14 +487,14 @@
    -
    -

    [1] All trademarks used are properties of their respective +

    +

    [1] All trademarks used are properties of their respective owners.

- @@ -481,7 +502,7 @@
Copyright © 2012 Arseny Kapoulkine

+

Copyright © 2014 Arseny Kapoulkine

Distributed under the MIT License

-pugixml 1.2 manual | +pugixml 1.4 manual | Overview | Installation | Document: -- cgit v1.2.3