William Candillon has proposed merging lp:~zorba-coders/zorba/doxygen into
lp:zorba.
Requested reviews:
Cezar Andrei (cezar-andrei)
Matthias Brantner (matthias-brantner)
For more details, see:
https://code.launchpad.net/~zorba-coders/zorba/doxygen/+merge/90249
- Fix a couple of external links
- Fix main documentation structure
- Fix a couple of typos
--
https://code.launchpad.net/~zorba-coders/zorba/doxygen/+merge/90249
Your team Zorba Coders is subscribed to branch lp:zorba.
=== modified file 'doc/c/manual/indexpage.dox'
--- doc/c/manual/indexpage.dox 2011-08-26 23:36:24 +0000
+++ doc/c/manual/indexpage.dox 2012-01-26 10:15:43 +0000
@@ -23,7 +23,7 @@
written in C.
</ul>
- To start with, this documentation provides a <a class="el" href="../examples/cexamples.c">set of examples</a> that demonstrate
+ To start with, this documentation provides a <a class="el" href="examples.html">set of examples</a> that demonstrate
some features.
*/
=== modified file 'doc/zorba/build.dox'
--- doc/zorba/build.dox 2011-09-23 10:54:01 +0000
+++ doc/zorba/build.dox 2012-01-26 10:15:43 +0000
@@ -151,7 +151,7 @@
you need a working Visual Studio (Express) installation (2008, 2010).
- If you want to compile Zorba using Visual Studio 2008,
you will need to install the
- <a href="http://www.microsoft.com/downloads/en/details.aspx?FamilyId=D466226B-8DAB-445F-A7B4-448B326C48E7&displaylang=en"; target="_blank">Visual C++ 2008 Feature Pack Release</a>.
+ <a href="http://www.microsoft.com/downloads/en/details.aspx?FamilyId=D466226B-8DAB-445F-A7B4-448B326C48E7"; target="_blank">Visual C++ 2008 Feature Pack Release</a>.
- Make sure that the libraries required for Zorba
are built with the same version of Visual Studio that you use.
- The Windows version of some required packages
@@ -233,10 +233,10 @@
a set of public keys freely available on the internet.
- On Windows,
Zorba expects this file to be called \c cacert.pem
- and searches for it in current directory and system paths.
+ and searches for it in the current directory and system paths.
- This \c cacert.pem file can be found on the curl page:
http://curl.haxx.se/docs/caextract.html .
-- In order to disable the validation of server certificate,
+- In order to disable the validation of the server certificate,
the \c ZORBA_VERIFY_PEER_SSL_CERTIFICATE can be set to \c OFF
in cmake
(and actually this is the default value).
=== modified file 'doc/zorba/build_noncore.dox'
--- doc/zorba/build_noncore.dox 2011-09-23 10:54:01 +0000
+++ doc/zorba/build_noncore.dox 2012-01-26 10:15:43 +0000
@@ -77,7 +77,7 @@
\subsubsection cclientunix Unix/Linux/Mac OS X
Notes:
- There are some known issues with the CClient packages
- that come with diffrent Linux distributions.
+ that come with different Linux distributions.
- On x32 bit OpenSuse and also on x64 bit Ubuntu,
we noticed that the CClient shared library is broken
(undefined symbol: mm_dlog).
=== modified file 'doc/zorba/commandline.dox'
--- doc/zorba/commandline.dox 2011-11-04 11:31:13 +0000
+++ doc/zorba/commandline.dox 2012-01-26 10:15:43 +0000
@@ -1,18 +1,5 @@
/** \page commandline Command Line Utility
-<ul>
- <li> Table of Contents
- <ul>
- <li> \ref commandLineUsage
- <li> \ref commandLineHelp
- <li> \ref commandlineexamples
- <ul>
- <li> \ref cmdlineExample1
- <li> \ref cmdlineExample2
- </ul>
- </ul>
-</ul>
-
\section commandLineUsage Usage
%zorba [options] [-q Inline_Query ...] or \n
%zorba [options] -f [-q Query_File ...]
=== modified file 'doc/zorba/data_lifecycle.dox'
--- doc/zorba/data_lifecycle.dox 2011-09-08 19:44:12 +0000
+++ doc/zorba/data_lifecycle.dox 2012-01-26 10:15:43 +0000
@@ -123,7 +123,7 @@
Also please note that a data container that is available in the store will be available to all XQuery programs that are being executed synchronously.
Again, please read more about the Zorba Data Stores below about data consistency details.
-\section dl_examples Examples
+\section dlexamples Examples
In the following, we show a couple of examples to demonstrate how data can be retrieved and store in various kinds of containers.
It is important to note that most of the examples uses the <a href="../../zorba/html/scripting_tutorial.html">XQuery Scripting Extension</a> for apply pending updates in order to make them visible to subsequent expressions in the same program.
@@ -284,7 +284,7 @@
The reason is simple: the XQuery processor can understand the data flow and data lifecycle in the first case, while it cannot in the second.
-\section dl_zorba_store Zorba Stores
+\section dlzorbastore Zorba Stores
Zorba defines a Store API that allows developers to seamlessly process XML data stored in different places.
Essentially, the Store API is a C++ interface for
=== modified file 'doc/zorba/external_functions.dox'
--- doc/zorba/external_functions.dox 2011-11-04 11:36:35 +0000
+++ doc/zorba/external_functions.dox 2012-01-26 10:15:43 +0000
@@ -111,7 +111,7 @@
be necessary for you to place the shared object such that Zorba can
load it at runtime.
-To locate a dynamic libary, Zorba first transforms its target
+To locate a dynamic library, Zorba first transforms its target
namespace URI to a relative file path and then uses the "Library Path"
mechanism (described in \ref libpath) to turn this relative path
to the absolute path name of the dynamic library file. The
@@ -131,7 +131,7 @@
<li>
The path component of the URI is extracted and separated into a branch name and
-a file name: (a) if the path component does not contain any "/" charcters, the
+a file name: (a) if the path component does not contain any "/" characters, the
branch name is empty and the file name is the full path component, else (b) if
the path component ends with a "/", the branch name is the full path component
and the file name is empty, else (c) the file name is set to the last step of
=== modified file 'doc/zorba/ft_intro.dox'
--- doc/zorba/ft_intro.dox 2011-10-07 08:28:43 +0000
+++ doc/zorba/ft_intro.dox 2012-01-26 10:15:43 +0000
@@ -1,7 +1,5 @@
/** \page ft_intro Full Text
-\section ft_intro Introduction
-
The Zorba XQuery engine implements the
<a href="http://www.w3.org/TR/xpath-full-text-10/";>XQuery and XPath Full Text 1.0</a>
specification.
=== modified file 'doc/zorba/indexpage.dox.in'
--- doc/zorba/indexpage.dox.in 2011-10-07 08:28:43 +0000
+++ doc/zorba/indexpage.dox.in 2012-01-26 10:15:43 +0000
@@ -1,141 +1,62 @@
-/*! \mainpage Zorba ${ZORBA_MAJOR_NUMBER}.${ZORBA_MINOR_NUMBER} Documentation
-
-
-<table>
-<tr><td class="tdDocIndexTable">
-
-
- <h2>Installation and Build</h2>
- \ref installation
-
- \ref build
- <ul>
- <li>\ref build_ubuntu </li>
- <li>\ref php_ubuntu_tutorial </li>
- <li>\ref php_windows_tutorial </li>
- <li>\ref python_windows_tutorial </li>
- </ul>
-
- \ref commandline
-
- <a href="http://xqdt.org"; target="_blank">XQuery Development Toolkit (XQDT)</a>
-
-
-</td><td class="tdDocIndexTable">
-
-
- <h2>APIs</h2>
- <a href="../../cxx/html/index.html">C++ API</a>
-
- <h3>Language Bindings</h3>
- <ul>
- <li><a class="el" href="../../c/html/index.html">C API</a></li>
- <li><a class="el" href="../../java/html/index.html">Java API</a></li>
- <li><a class="el" href="../../python/html/index.html">Python API</a></li>
- <li><a class="el" href="../../ruby/html/index.html">Ruby API</a></li>
- <li><a class="el" href="../../php/html/index.html">PHP API</a></li>
- </ul>
-
-
-</td></tr>
-<tr><td class="tdDocIndexTable">
-
-
- <h2>General Architecture</h2>
- \ref data_lifecycle
-
- <ul>
- <li>\ref dl_examples</li>
- <li>\ref dl_zorba_store</li>
- </ul>
-
- \ref schema_lifecycle
-
- \ref uriresolvers
-
- \ref data_converters
-
- \ref ft_intro
- <ul>
- <li>\ref ft_thesaurus</li>
- </ul>
-
- \ref errors_warnings
-
- \ref impl_dep_features
-
- <div style="display:none;">\ref controlling_memory</div>
- <div style="display:none;">\ref plugable_components </div>
-
-
-</td><td class="tdDocIndexTable">
-
-
- <h2>XQuery Libraries</h2>
- <a href="../xqdoc/xhtml/index.html">XQuery Module Library</a>
-
- \ref modules_top
- <ul>
- <li>\ref mod_importing</li>
- <li>\ref mod_versioning</li>
- <li>\ref modules_authoring</li>
- <li>\ref modules_authoring_2</li>
- <li>\ref modules_building_in</li>
- <li>\ref external_functions</li>
- </ul>
-
-
-</td></tr>
-<tr><td class="tdDocIndexTable">
-
-
- <h2>W3C Specifications</h2>
-
- \ref overview
-
- <a href="http://www.w3.org/TR/xquery/";>W3C XQuery 1.0</a> (\ref conformanceXQTS)
-
- <a href="http://www.w3.org/TR/xpath-functions-30/";>W3C XPath and XQuery Functions and Operators</a>
- (<a href="../xqdoc/xhtml/function_index.html">List of Supported Functions</a>)
-
- <a href="http://www.w3.org/TR/xquery-update-10/";>W3C XQuery Update Facility 1.0</a> (\ref conformanceXQUTS)
-
- <a href="http://www.w3.org/TR/xpath-full-text-10/";>W3C XQuery and XPath Full Text 1.0</a> (\ref conformanceXQFTTS)
-
- <a href="http://www.w3.org/TR/xquery-30/";>W3C XQuery 3.0</a> (\ref partial_support "Partial Support")
-
- <a href="http://www.w3.org/XML/Schema";>W3C XML Schema</a>
-
- <a href="http://www.w3.org/TR/xslt";>W3C XSL Transformations (XSLT) 1.0</a>
-
- <a href="http://www.w3.org/TR/xqueryx/";>W3C XML Syntax for XQuery 1.0 (XQueryX)</a>
-
- <a href="http://www.w3.org/TR/xslt-xquery-serialization/";>W3C XSLT 2.0 and XQuery 1.0 Serialization</a>
-
-
-</td><td class="tdDocIndexTable">
-
-
- <h2>Zorba Proprietary Specifications</h2>
-
- \ref xqddf
-
- <a href="scripting_spec.html">XQuery Scripting Extension</a> (also see our \ref scripting_tutorial "Tutorial")
-
- \ref options_and_annotations
-
- <!--li>\ref extensions_update</li-->
-
-
-</td></tr>
-<tr><td class="tdDocIndexTable">
-
-
- <h2>Tutorials</h2>
-
- \ref web_crawler_tutorial
-
-</td><tr>
-</table>
-
+/*! \mainpage Zorba ${ZORBA_MAJOR_NUMBER}.${ZORBA_MINOR_NUMBER}.${ZORBA_PATCH_NUMBER} Documentation
+
+\section installbuild Installation and Build
+ - \ref installation
+ - \ref build
+ - \ref build_ubuntu
+ - \ref php_ubuntu_tutorial
+ - \ref php_windows_tutorial
+ - \ref python_windows_tutorial
+ - \ref commandline
+ - <a href="http://xqdt.org"; target="_blank">XQuery Development Toolkit (XQDT)</a>
+
+\section apis APIs
+ - <a href="../../cxx/html/index.html">C++ API</a>
+ - <a class="el" href="../../c/html/index.html">C API</a>
+ - <a class="el" href="../../java/html/index.html">Java API</a>
+ - <a class="el" href="../../python/html/index.html">Python API</a>
+ - <a class="el" href="../../ruby/html/index.html">Ruby API</a>
+ - <a class="el" href="../../php/html/index.html">PHP API</a>
+
+\section generalarchitecture General Architecture
+ - \ref data_lifecycle
+ - \ref dlexamples
+ - \ref dlzorbastore
+ - \ref schema_lifecycle
+ - \ref uriresolvers
+ - \ref data_converters
+ - \ref ft_intro
+ - \ref ft_thesaurus
+ - \ref errors_warnings
+ - \ref impl_dep_features
+
+\section xqlib XQuery Modules
+ - <a href="../xqdoc/xhtml/index.html">XQuery Module Library</a>
+ - \ref modules_top
+ - \ref mod_importing
+ - \ref mod_versioning
+ - \ref modules_authoring
+ - \ref modules_authoring_2
+ - \ref modules_building_in
+ - \ref external_functions
+
+\section w3cspecs W3C Specifications
+ - \ref overview
+ - <a href="http://www.w3.org/TR/xquery/";>W3C XQuery 1.0</a> (\ref conformanceXQTS)
+ - <a href="http://www.w3.org/TR/xpath-functions-30/";>W3C XPath and XQuery Functions and Operators</a> (<a href="../xqdoc/xhtml/function_index.html">List of Supported Functions</a>)
+ - <a href="http://www.w3.org/TR/xquery-update-10/";>W3C XQuery Update Facility 1.0</a> (\ref conformanceXQUTS)
+ - <a href="http://www.w3.org/TR/xpath-full-text-10/";>W3C XQuery and XPath Full Text 1.0</a> (\ref conformanceXQFTTS)
+ - <a href="http://www.w3.org/TR/xquery-30/";>W3C XQuery 3.0</a> (\ref partial_support "Partial Support")
+ - <a href="http://www.w3.org/XML/Schema";>W3C XML Schema</a>
+ - <a href="http://www.w3.org/TR/xslt";>W3C XSL Transformations (XSLT) 1.0</a>
+ - <a href="http://www.w3.org/TR/xqueryx/";>W3C XML Syntax for XQuery 1.0 (XQueryX)</a>
+ - <a href="http://www.w3.org/TR/xslt-xquery-serialization/";>W3C XSLT 2.0 and XQuery 1.0 Serialization</a>
+
+\section zorbaspec Zorba Proprietary Specifications
+ - \ref xqddf
+ - <a href="scripting_spec.html">XQuery Scripting Extension</a> (also see our \ref scripting_tutorial "Tutorial")
+ - \ref options_and_annotations
+
+\section tutorials Tutorials
+ - \ref web_crawler_tutorial
*/
=== modified file 'doc/zorba/installation.dox'
--- doc/zorba/installation.dox 2011-09-23 10:54:01 +0000
+++ doc/zorba/installation.dox 2012-01-26 10:15:43 +0000
@@ -1,7 +1,6 @@
/** \page installation Installation
-\section installation Installation
-\subsection SourceInstallation Installing the Source Distribution
+\section SourceInstallation Installing the Source Distribution
The Zorba source is available as tar.gz and zip files.
The Zorba sources can be installed by extracting the compressed files
@@ -12,7 +11,7 @@
To build Zorba,
please follow the build instructions (see \ref buildingzorba).
-\subsection Installing Installing
+\section Installing Installing
Once you have successfully built Zorba using the "Unix Makefile" generator
(see \ref SourceInstallation),
@@ -82,7 +81,7 @@
we also provide graphical installers
for Windows and Mac OS X.
-\subsection UbuntuInstallation Additional notes for Ubuntu systems installations
+\section UbuntuInstallation Additional notes for Ubuntu systems installations
The recommended way of installing the Zorba library on an Ubuntu system
is to add the lib directory as a \c .conf file in \c /etc/ld.so.conf
=== modified file 'doc/zorba/modules_building_in.dox'
--- doc/zorba/modules_building_in.dox 2011-11-04 11:31:13 +0000
+++ doc/zorba/modules_building_in.dox 2012-01-26 10:15:43 +0000
@@ -17,7 +17,7 @@
directly into the Zorba installation. Simply invoking the "install"
target of the project will do this. Note that on many systems, if
Zorba is installed into a system-wide location, you may require root
-or adminstrator priviledges to install your module in this location.
+or administrator privileges to install your module in this location.
\section mod_baking_in Building Zorba With Additional Modules
=== modified file 'doc/zorba/options.dox'
--- doc/zorba/options.dox 2012-01-11 17:30:25 +0000
+++ doc/zorba/options.dox 2012-01-26 10:15:43 +0000
@@ -416,7 +416,7 @@
and it is the copied subtrees that are then connected to the newly constructed
node. However, such copying is not always necessary. If no copying is done, then
some nodes will be "shared" by multiple trees. XML trees that do not contain
-any shared nodes will be refered to as "stand-alone trees".
+any shared nodes will be referred to as "stand-alone trees".
Whether node copying is really necessary or not depends on the kind of operations
that are going to be performed on the nodes and their associated trees after the
@@ -447,8 +447,8 @@
If a number N appears in the value, then the function may return to its caller
a node n that is bound to the N-th parameter, or a node in the subtree of n. This
annotation helps the optimizer determine whether nodes consumed by an expression
-are comming from a node constructor, so that if the expression requires stand-alone
-trees, then the optimizer will make sure that the relavant node constructor does
+are coming from a node constructor, so that if the expression requires stand-alone
+trees, then the optimizer will make sure that the relevant node constructor does
copy nodes.
</li>
</ul>
=== modified file 'doc/zorba/php_ubuntu.dox'
--- doc/zorba/php_ubuntu.dox 2011-09-21 08:18:59 +0000
+++ doc/zorba/php_ubuntu.dox 2012-01-26 10:15:43 +0000
@@ -1,10 +1,8 @@
/** \page php_ubuntu_tutorial Zorba XQuery in PHP 5 - Ubuntu Installation
-by Cezar Andrei,
-May 13th, 2011
\section initial_setup Initial setup
-These steps were checked on Ubuntu 10.10. Send us email with the results you had on diffrent platforms.
+These steps were checked on Ubuntu 10.10. Send us email with the results you had on different platforms.
\section install_apache_http Install Apache HTTP Server
@@ -75,7 +73,7 @@
zorba/build$ cp swig/php/zorba_api.so swig/php/zorba_api_wrapper.php /usr/local/lib/php/
\endcode
-Add the folowing lines to /etc/php5/apache2/php.ini file.
+Add the following lines to /etc/php5/apache2/php.ini file.
\code
include_path="/usr/local/lib/php/"
=== modified file 'doc/zorba/php_windows.dox'
--- doc/zorba/php_windows.dox 2011-09-21 08:18:59 +0000
+++ doc/zorba/php_windows.dox 2012-01-26 10:15:43 +0000
@@ -1,6 +1,4 @@
/** \page php_windows_tutorial Zorba XQuery in PHP 5 - Windows Installation
-by Rodolfo Ochoa,
-May 24th, 2011
These steps were checked on Windows 7. It should work fine with any PHP 5.X version and any other W32 platform.
=== modified file 'doc/zorba/schema_lifecycle.dox'
--- doc/zorba/schema_lifecycle.dox 2011-09-01 22:25:26 +0000
+++ doc/zorba/schema_lifecycle.dox 2012-01-26 10:15:43 +0000
@@ -1,6 +1,6 @@
/** \page schema_lifecycle Schema Lifecycle
-\section intro Intro
+\section intro Introduction
This page is a quick presentation on how to use Zorba with XMLSchema type information.
\section immport How to import a schema
=== modified file 'doc/zorba/xqddf.dox'
--- doc/zorba/xqddf.dox 2011-10-30 08:04:47 +0000
+++ doc/zorba/xqddf.dox 2012-01-26 10:15:43 +0000
@@ -1,45 +1,5 @@
/** \page xqddf XQuery Data Definition Facility
-<ul>
- <li> Table of Contents </li>
- <ul>
- <li> \ref intro </li>
- <li> \ref collections </li>
- <ul>
- <li> \ref collections_in_action </li>
- <li> \ref collection_declaration </li>
- <li> \ref creating_collections </li>
- <li> \ref accessing_collections </li>
- <li> \ref updating_collections </li>
- <li> \ref destroying_collections </li>
- </ul>
- <li> \ref indexes</li>
- <ul>
- <li> \ref indexes_in_action </li>
- <li> \ref index_declaration </li>
- <li> \ref index_creation </li>
- <li> \ref index_deletion </li>
- <li> \ref index_probing </li>
- <li> \ref index_maintenance </li>
- </ul>
- <li> \ref integrity_constraints</li>
- <ul>
- <li> \ref ic_declaration</li>
- <ul>
- <li> \ref ic_entity_integrity</li>
- <li> \ref ic_domain_integrity</li>
- <li> \ref ic_referential_integrity</li>
- </ul>
- <li> \ref ic_life_cycle</li>
- </ul>
- <li> \ref extensions_xquf_updates_routines </li>
- <li> \ref error_summary </li>
- </ul>
-</ul>
-
-
-\section intro The Zorba Data Definition Facility
-
Zorba extends the XQuery language with support for collections, indexes, and
integrity constraints. This is accomplished via a combination of new prolog
declarations, new kinds of expressions or extensions to existing expressions,
@@ -1838,7 +1798,7 @@
equal to the number of keyspecs found in the index declaration.
</li>
<li>
-[err:XPTY0004], if a non-empty seach key is given, whose type does not match
+[err:XPTY0004], if a non-empty search key is given, whose type does not match
the sequence type specified in the corresponding keyspec.
</li>
</ul>
--
Mailing list: https://launchpad.net/~zorba-coders
Post to : zorba-coders@lists.launchpad.net
Unsubscribe : https://launchpad.net/~zorba-coders
More help : https://help.launchpad.net/ListHelp
