Index: doc/userman/README.txt ================================================================== --- doc/userman/README.txt +++ doc/userman/README.txt @@ -1,9 +1,9 @@ -The user manual is written in XML DocBook format, version 4.2. -It uses the official DocBook XSL stylesheets, and will build with -versions as old as 1.61.2. (Why these versions? They're what comes -with CentOS 3, the oldest system I still use.) +The user manual is written in XML DocBook format, version 4.4. It uses +the official DocBook XSL stylesheets, and will build with versions at +least as far back as 1.69.1. (Why these versions? They're what comes +with CentOS 5, the oldest system I still use.) To make the HTML version of the user manual, just type 'make' in this directory. (Or 'make html' if you want to be pedantic.) To make the PDF version of the manual, say 'make pdf'. To make both versions, say 'make all'. @@ -47,27 +47,32 @@ for RenderX's XEP, which comes in a free-as-in-beer version for personal use. (http://renderx.com/download/personal.html) If you're in a commercial environment, RenderX wants you to use their commercial trial version which will format this manual without complaint, but it puts watermarks and blank pages into the output. - They want $300 for the single-user to get clean output. It's the - same as the free personal version, just with a different license. - You don't need the higher-end versions of XEP; they don't do - anything we need here. + As of July 2018, they want $400 for the single-user to get clean + output. It's the same as the free personal version, just with a + different license. You don't need the higher-end versions of XEP; + they don't do anything we need here. If fo2pdf can't find XEP, it then looks for Antenna House's XSL Formatter (http://antennahouse.com/). It's pretty much the same deal as XEP: crippled demo version for testing, and a single-user - version for $300. There is no free version for personal use, + version for $400. There is no free version for personal use, however. Failing all that, fo2pdf falls back to the only free-as-in-speech XSL-FO formmatter, Apache FOP (http://xmlgraphics.apache.org/fop/). - FOP isn't yet available through most Unixy package download - systems, so you'll have to download it directly from the source. - The Debian repositories do have it, so on any Debian based distro - (e.g. Ubuntu) you can just say "sudo apt-get install fop". + FOP may be available through your OS's package system. For + instance, with Debian tyep OSes, you can just say + + sudo apt-get install fop + + If FOP is not in your OS's package system, you can download + pre-built binaries from the FOP web site that will run with the + version of Java that almost certainly is available with your OS's + package system. You might be wondering why fo2pdf looks for FOP last, given that MySQL++ is itself free software and relies on a lot of other free software. It's just that it's a good bet that if there's a commercial processor on the system, it was put there quite @@ -79,31 +84,30 @@ We try to always keep the manual in a state where FOP can generate adequate output. The third replaceable piece above is the DocBook XSL stylesheet set. -The stylesheets are the XSLT processor's rules, controlling how -the input XML gets transformed to the output format. The standard -DocBook stylesheet set (link below) includes stylesheets for HTML and -XSL-FO output. By default, xsltproc looks for these first on your -local system, and failing to find them, tries to download them on -the fly from the Internet. Because this slows processing quite a bit -even if you have a fast Internet connection, and it obviously doesn't -work when your net connection is down, we've disabled this option. -Therefore, you must have the DocBook XSL stylesheets installed to -build the user manual. +The stylesheets are the XSLT processor's rules, controlling how the +input XML gets transformed to the output format. The standard DocBook +stylesheet set includes stylesheets for HTML and XSL-FO output. +Normally, xsltproc looks for these first on your local system, and +failing to find them, tries to download them on the fly from the +Internet. Because this slows processing quite a bit even if you have a +fast Internet connection, we've disabled this feature of xsltproc, so +you must have the DocBook XSL stylesheets locally installed to build the +user manual. Most Unixy type systems have pre-built DocBook XSL stylesheet packages available: - Red Hat/Fedora: docbook-style-xsl RPM package - Mac OS X: docbook-xsl Fink package (http://fink.sf.net) + Red Hat/Fedora: docbook-style-xsl RPM package, base OS repository + macOS: docbook-xsl Homebrew package (http://brew.sh/) Cygwin: docbook-xml?? package (?? = DocBook version) - Ubuntu/Debian: docbook-xsl, from the standard APT repository + Ubuntu/Debian: docbook-xsl package, standard APT repository -(Please send the name of the package for your system to the mailing -list if it isn't listed above, and I'll add it to the list.) +Please send the name of the package for your system to the mailing list +if it isn't listed above, and I'll add it to the list. If you can't find a package for your system, you can get the DocBook stylesheets from the source: http://docbook.sourceforge.net/ They're a bit tricky to set up correctly, so it's better to use a pre-built package if you can. @@ -124,25 +128,17 @@ http://tinyurl.com/8alb2 This is the best tutorial I've found. - Walsh and Muellner's _DocBook: The Definitive Guide_ book, second - edition, online version: + Walsh and Muellner's _DocBook: The Definitive Guide_ book: - http://www.docbook.org/tdg/en/html/docbook.html + https://tdg.docbook.org/ - This is the official DocBook referece. - - - DocBook FAQ: - - http://www.dpawson.co.uk/docbook/ - - Go here when you have a question that the tutorials and - references do not answer. + This is the official DocBook referece. It is available both + online and in dead-tree versions. The official DocBook site: http://docbook.org/ Index: doc/userman/breakages.dbx ================================================================== --- doc/userman/breakages.dbx +++ doc/userman/breakages.dbx @@ -1,8 +1,8 @@ - + Incompatible Library Changes This chapter documents those library changes since the epochal Index: doc/userman/configuration.dbx ================================================================== --- doc/userman/configuration.dbx +++ doc/userman/configuration.dbx @@ -1,8 +1,8 @@ - + Configuring MySQL++ The default configuration of MySQL++ is suitable for most Index: doc/userman/incorporating.dbx ================================================================== --- doc/userman/incorporating.dbx +++ doc/userman/incorporating.dbx @@ -1,8 +1,8 @@ - + Using MySQL++ in Your Own Project Up to now, this manual has only discussed MySQL++ Index: doc/userman/intro.dbx ================================================================== --- doc/userman/intro.dbx +++ doc/userman/intro.dbx @@ -1,8 +1,8 @@ - + Introduction MySQL++ is a powerful C++ wrapper for MySQL’s Index: doc/userman/licenses.dbx ================================================================== --- doc/userman/licenses.dbx +++ doc/userman/licenses.dbx @@ -1,8 +1,8 @@ - + Licensing The primary copyright holders on the MySQL++ library and its Index: doc/userman/overview.dbx ================================================================== --- doc/userman/overview.dbx +++ doc/userman/overview.dbx @@ -1,8 +1,8 @@ - + Overview MySQL++ has a lot of complexity and power to cope with the Index: doc/userman/section-template.dbx ================================================================== --- doc/userman/section-template.dbx +++ doc/userman/section-template.dbx @@ -1,9 +1,9 @@ - + SECTION TITLE FIRST PARAGRAPH Index: doc/userman/ssqls.dbx ================================================================== --- doc/userman/ssqls.dbx +++ doc/userman/ssqls.dbx @@ -1,8 +1,8 @@ - + Specialized SQL Structures The Specialized SQL Structure (SSQLS) feature lets you easily Index: doc/userman/threads.dbx ================================================================== --- doc/userman/threads.dbx +++ doc/userman/threads.dbx @@ -1,8 +1,8 @@ - + Using MySQL++ in a Multithreaded Program MySQL++ is not “thread safe” in any Index: doc/userman/tquery.dbx ================================================================== --- doc/userman/tquery.dbx +++ doc/userman/tquery.dbx @@ -1,8 +1,8 @@ - + Template Queries Another powerful feature of MySQL++ is being able to set up Index: doc/userman/tutorial.dbx ================================================================== --- doc/userman/tutorial.dbx +++ doc/userman/tutorial.dbx @@ -1,8 +1,8 @@ - + Tutorial The previous chapter introduced Index: doc/userman/unicode.dbx ================================================================== --- doc/userman/unicode.dbx +++ doc/userman/unicode.dbx @@ -1,8 +1,8 @@ - + Using Unicode with MySQL++ Index: doc/userman/userman.dbx ================================================================== --- doc/userman/userman.dbx +++ doc/userman/userman.dbx @@ -1,55 +1,55 @@ - %xinclude; ]>
- - MySQL++ v3.2.3 User Manual + + MySQL++ v3.2.3 User Manual + + + + Kevin + Atkinson + + + + Sinisa + Milivojevic + - - - Kevin - Atkinson - + + Monty + Widenius + - - Sinisa - Milivojevic - + + Warren + Young + + - - Monty - Widenius - + + 1998-2001, 2005-2015 + Kevin Atkinson (original author) + MySQL AB + Educational Technology Resources + - - Warren - Young - - - - - 1998-2001, 2005-2015 - Kevin Atkinson (original author) - MySQL AB - Educational Technology Resources - - - - + + - - - - - - - - - - - + + + + + + + + + + +