Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
| Comment: | Updated user manual Docbook version from 4.2 to 4.4, effectively dropping CentOS 3 and 4 as build platforms, since the current Homebrew Docbook XSL stylesheets throw lots of errors if you specify 4.2 or 4.3. Updated the user manual's README.txt file accordingly. |
|---|---|
| Downloads: | Tarball | ZIP archive | SQL archive |
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA3-256: |
3b3678d64e02d53be70cbfa62a78e7cf |
| User & Date: | tangent 2018-07-27 04:34:34 |
Context
|
2018-07-27
| ||
| 04:39 | Polishing pass on the new Unicode material in the user manual. check-in: 8469cf623d user: tangent tags: trunk | |
| 04:34 | Updated user manual Docbook version from 4.2 to 4.4, effectively dropping CentOS 3 and 4 as build platforms, since the current Homebrew Docbook XSL stylesheets throw lots of errors if you specify 4.2 or 4.3. Updated the user manual's README.txt file accordingly. check-in: 3b3678d64e user: tangent tags: trunk | |
| 03:59 | Squished a few complaints from Doxygen. NFC. check-in: 57170bf853 user: tangent tags: trunk | |
Changes
Changes to doc/userman/README.txt.
1 -The user manual is written in XML DocBook format, version 4.2. 2 -It uses the official DocBook XSL stylesheets, and will build with 3 -versions as old as 1.61.2. (Why these versions? They're what comes 4 -with CentOS 3, the oldest system I still use.) 1 +The user manual is written in XML DocBook format, version 4.4. It uses 2 +the official DocBook XSL stylesheets, and will build with versions at 3 +least as far back as 1.69.1. (Why these versions? They're what comes 4 +with CentOS 5, the oldest system I still use.) 5 5 6 6 To make the HTML version of the user manual, just type 'make' in this 7 7 directory. (Or 'make html' if you want to be pedantic.) To make the 8 8 PDF version of the manual, say 'make pdf'. To make both versions, 9 9 say 'make all'. 10 10 11 11 ................................................................................ 45 45 The build system relies on a simple script in this directory -- 46 46 fo2pdf -- to find an XSL-FO formatter and run it. It looks first 47 47 for RenderX's XEP, which comes in a free-as-in-beer version for 48 48 personal use. (http://renderx.com/download/personal.html) If 49 49 you're in a commercial environment, RenderX wants you to use their 50 50 commercial trial version which will format this manual without 51 51 complaint, but it puts watermarks and blank pages into the output. 52 - They want $300 for the single-user to get clean output. It's the 53 - same as the free personal version, just with a different license. 54 - You don't need the higher-end versions of XEP; they don't do 55 - anything we need here. 52 + As of July 2018, they want $400 for the single-user to get clean 53 + output. It's the same as the free personal version, just with a 54 + different license. You don't need the higher-end versions of XEP; 55 + they don't do anything we need here. 56 56 57 57 If fo2pdf can't find XEP, it then looks for Antenna House's XSL 58 58 Formatter (http://antennahouse.com/). It's pretty much the same 59 59 deal as XEP: crippled demo version for testing, and a single-user 60 - version for $300. There is no free version for personal use, 60 + version for $400. There is no free version for personal use, 61 61 however. 62 62 63 63 Failing all that, fo2pdf falls back to the only free-as-in-speech 64 64 XSL-FO formmatter, Apache FOP (http://xmlgraphics.apache.org/fop/). 65 - FOP isn't yet available through most Unixy package download 66 - systems, so you'll have to download it directly from the source. 67 - The Debian repositories do have it, so on any Debian based distro 68 - (e.g. Ubuntu) you can just say "sudo apt-get install fop". 65 + FOP may be available through your OS's package system. For 66 + instance, with Debian tyep OSes, you can just say 67 + 68 + sudo apt-get install fop 69 + 70 + If FOP is not in your OS's package system, you can download 71 + pre-built binaries from the FOP web site that will run with the 72 + version of Java that almost certainly is available with your OS's 73 + package system. 69 74 70 75 You might be wondering why fo2pdf looks for FOP last, given that 71 76 MySQL++ is itself free software and relies on a lot of other 72 77 free software. It's just that it's a good bet that if there's 73 78 a commercial processor on the system, it was put there quite 74 79 purposefully by someone who paid (or caused money to be paid) for 75 80 it, and so wants it to be used. The commercial vendors can still ................................................................................ 77 82 them in several important areas. That said, don't feel that you 78 83 need to go and buy an XSL-FO processor just to build the manuals. 79 84 We try to always keep the manual in a state where FOP can generate 80 85 adequate output. 81 86 82 87 83 88 The third replaceable piece above is the DocBook XSL stylesheet set. 84 -The stylesheets are the XSLT processor's rules, controlling how 85 -the input XML gets transformed to the output format. The standard 86 -DocBook stylesheet set (link below) includes stylesheets for HTML and 87 -XSL-FO output. By default, xsltproc looks for these first on your 88 -local system, and failing to find them, tries to download them on 89 -the fly from the Internet. Because this slows processing quite a bit 90 -even if you have a fast Internet connection, and it obviously doesn't 91 -work when your net connection is down, we've disabled this option. 92 -Therefore, you must have the DocBook XSL stylesheets installed to 93 -build the user manual. 89 +The stylesheets are the XSLT processor's rules, controlling how the 90 +input XML gets transformed to the output format. The standard DocBook 91 +stylesheet set includes stylesheets for HTML and XSL-FO output. 92 +Normally, xsltproc looks for these first on your local system, and 93 +failing to find them, tries to download them on the fly from the 94 +Internet. Because this slows processing quite a bit even if you have a 95 +fast Internet connection, we've disabled this feature of xsltproc, so 96 +you must have the DocBook XSL stylesheets locally installed to build the 97 +user manual. 94 98 95 99 Most Unixy type systems have pre-built DocBook XSL stylesheet packages 96 100 available: 97 101 98 - Red Hat/Fedora: docbook-style-xsl RPM package 99 - Mac OS X: docbook-xsl Fink package (http://fink.sf.net) 102 + Red Hat/Fedora: docbook-style-xsl RPM package, base OS repository 103 + macOS: docbook-xsl Homebrew package (http://brew.sh/) 100 104 Cygwin: docbook-xml?? package (?? = DocBook version) 101 - Ubuntu/Debian: docbook-xsl, from the standard APT repository 105 + Ubuntu/Debian: docbook-xsl package, standard APT repository 102 106 103 -(Please send the name of the package for your system to the mailing 104 -list if it isn't listed above, and I'll add it to the list.) 107 +Please send the name of the package for your system to the mailing list 108 +if it isn't listed above, and I'll add it to the list. 105 109 106 110 If you can't find a package for your system, you can get the DocBook 107 111 stylesheets from the source: http://docbook.sourceforge.net/ They're 108 112 a bit tricky to set up correctly, so it's better to use a pre-built 109 113 package if you can. 110 114 111 115 If you are still having problems, post the details about it to the ................................................................................ 122 126 article: 123 127 124 128 http://tinyurl.com/8alb2 125 129 126 130 This is the best tutorial I've found. 127 131 128 132 129 - Walsh and Muellner's _DocBook: The Definitive Guide_ book, second 130 - edition, online version: 133 + Walsh and Muellner's _DocBook: The Definitive Guide_ book: 131 134 132 - http://www.docbook.org/tdg/en/html/docbook.html 135 + https://tdg.docbook.org/ 133 136 134 - This is the official DocBook referece. 135 - 136 - 137 - DocBook FAQ: 138 - 139 - http://www.dpawson.co.uk/docbook/ 140 - 141 - Go here when you have a question that the tutorials and 142 - references do not answer. 137 + This is the official DocBook referece. It is available both 138 + online and in dead-tree versions. 143 139 144 140 145 141 The official DocBook site: 146 142 147 143 http://docbook.org/ 148 144
Changes to doc/userman/breakages.dbx.
1 1 <?xml version="1.0" encoding='UTF-8'?> 2 -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 3 - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 3 + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 4 4 5 5 <sect1 id="breakages"> 6 6 <title>Incompatible Library Changes</title> 7 7 8 8 <para>This chapter documents those library changes since the epochal 9 9 1.7.9 release that break end-user programs. You can dig this stuff out 10 10 of the <filename>ChangeLog.md</filename> file, but the change log
Changes to doc/userman/configuration.dbx.
1 1 <?xml version="1.0" encoding='UTF-8'?> 2 -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 3 - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 3 + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 4 4 5 5 <sect1 id="configuration"> 6 6 <title>Configuring MySQL++</title> 7 7 8 8 <para>The default configuration of MySQL++ is suitable for most 9 9 purposes, but there are a few things you can change to make it meet 10 10 special needs.</para>
Changes to doc/userman/incorporating.dbx.
1 1 <?xml version="1.0" encoding='UTF-8'?> 2 -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 3 - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 3 + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 4 4 5 5 <sect1 id="incorporating"> 6 6 <title>Using MySQL++ in Your Own Project</title> 7 7 8 8 <para>Up to now, this manual has only discussed MySQL++ 9 9 in conjunction with the example programs that come with the 10 10 library. This chapter covers the steps you need to take to
Changes to doc/userman/intro.dbx.
1 1 <?xml version="1.0" encoding="UTF-8"?> 2 -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 3 - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 3 + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 4 4 5 5 <sect1 id="intro"> 6 6 <title>Introduction</title> 7 7 8 8 <para>MySQL++ is a powerful C++ wrapper for MySQL’s 9 9 C API<footnote><para>The MySQL C API is also known as <ulink 10 10 url="https://dev.mysql.com/downloads/connector/c/">Connector/C</ulink>.</para></footnote>.
Changes to doc/userman/licenses.dbx.
1 1 <?xml version="1.0" encoding='UTF-8'?> 2 -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 3 - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 3 + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 4 4 5 5 <sect1 id="licenses"> 6 6 <title>Licensing</title> 7 7 8 8 <para>The primary copyright holders on the MySQL++ library and its 9 9 documentation are Kevin Atkinson (1998), MySQL AB (1999 through 2001) 10 10 and Educational Technology Resources, Inc. (2004 through the date of
Changes to doc/userman/overview.dbx.
1 1 <?xml version="1.0" encoding='UTF-8'?> 2 -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 3 - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 3 + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 4 4 5 5 <sect1 id="overview"> 6 6 <title>Overview</title> 7 7 8 8 <para>MySQL++ has a lot of complexity and power to cope with the 9 9 variety of ways people use databases, but at bottom it doesn’t 10 10 work all that differently than other database access APIs. The usage
Changes to doc/userman/section-template.dbx.
1 1 <?xml version="1.0" encoding='UTF-8'?> 2 -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 3 - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 3 + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 4 4 5 5 <sect1 id="SOMETHING_UNIQUE"> 6 6 <title>SECTION TITLE</title> 7 7 8 8 <para>FIRST PARAGRAPH</para> 9 9 </sect1>
Changes to doc/userman/ssqls.dbx.
1 1 <?xml version="1.0" encoding='UTF-8'?> 2 -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 3 - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 3 + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 4 4 5 5 <sect1 id="ssqls"> 6 6 <title>Specialized SQL Structures</title> 7 7 8 8 <para>The Specialized SQL Structure (SSQLS) feature lets you easily 9 9 define C++ structures that match the form of your SQL tables. At the 10 10 most superficial level, an SSQLS has a member variable corresponding
Changes to doc/userman/threads.dbx.
1 1 <?xml version="1.0" encoding='UTF-8'?> 2 -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 3 - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 3 + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 4 4 5 5 <sect1 id="threads"> 6 6 <title>Using MySQL++ in a Multithreaded Program</title> 7 7 8 8 <para>MySQL++ is not “thread safe” in any 9 9 meaningful sense. MySQL++ contains very little code that 10 10 actively prevents trouble with threads, and all of it is
Changes to doc/userman/tquery.dbx.
1 1 <?xml version="1.0" encoding='UTF-8'?> 2 -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 3 - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 3 + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 4 4 5 5 <sect1 id="tquery" xreflabel="Template Queries"> 6 6 <title>Template Queries</title> 7 7 8 8 <para>Another powerful feature of MySQL++ is being able to set up 9 9 template queries. These are kind of like C’s 10 10 <function>printf()</function> facility: you give MySQL++ a string
Changes to doc/userman/tutorial.dbx.
1 1 <?xml version="1.0" encoding='UTF-8'?> 2 -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 3 - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 3 + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 4 4 5 5 <sect1 id="tutorial" xreflabel="Tutorial"> 6 6 <title>Tutorial</title> 7 7 8 8 <para>The <link linkend="overview">previous chapter</link> introduced 9 9 the major top-level mechanisms in MySQL++. Now we’ll dig down a 10 10 little deeper and get into real examples. We start off with the basics
Changes to doc/userman/unicode.dbx.
1 1 <?xml version="1.0" encoding='UTF-8'?> 2 -<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.2//EN" 3 - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> 2 +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook V4.4//EN" 3 + "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"> 4 4 5 5 <sect1 id="unicode" xreflabel="Using Unicode with MySQL++"> 6 6 <title>Using Unicode with MySQL++</title> 7 7 8 8 <sect2 id="unicode-history"> 9 9 <title>A Short History of Unicode</title> 10 10 <subtitle>...with a focus on relevance to MySQL++</subtitle>
Changes to doc/userman/userman.dbx.
1 1 <?xml version="1.0" encoding="UTF-8"?> 2 -<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" 3 - "http://www.docbook.org/xml/4.2/docbookx.dtd" 2 +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 3 + "http://www.docbook.org/xml/4.4/docbookx.dtd" 4 4 [ <!ENTITY % xinclude SYSTEM "xinclude.mod"> 5 5 %xinclude; 6 6 ]> 7 7 <article> 8 - <articleinfo> 9 - <title>MySQL++ v3.2.3 User Manual</title> 8 + <articleinfo> 9 + <title>MySQL++ v3.2.3 User Manual</title> 10 + 11 + <authorgroup> 12 + <author> 13 + <firstname>Kevin</firstname> 14 + <surname>Atkinson</surname> 15 + </author> 16 + 17 + <author> 18 + <firstname>Sinisa</firstname> 19 + <surname>Milivojevic</surname> 20 + </author> 10 21 11 - <authorgroup> 12 - <author> 13 - <firstname>Kevin</firstname> 14 - <surname>Atkinson</surname> 15 - </author> 22 + <author> 23 + <firstname>Monty</firstname> 24 + <surname>Widenius</surname> 25 + </author> 16 26 17 - <author> 18 - <firstname>Sinisa</firstname> 19 - <surname>Milivojevic</surname> 20 - </author> 27 + <author> 28 + <firstname>Warren</firstname> 29 + <surname>Young</surname> 30 + </author> 31 + </authorgroup> 21 32 22 - <author> 23 - <firstname>Monty</firstname> 24 - <surname>Widenius</surname> 25 - </author> 33 + <copyright> 34 + <year>1998-2001, 2005-2015</year> 35 + <holder>Kevin Atkinson (original author)</holder> 36 + <holder>MySQL AB</holder> 37 + <holder>Educational Technology Resources</holder> 38 + </copyright> 26 39 27 - <author> 28 - <firstname>Warren</firstname> 29 - <surname>Young</surname> 30 - </author> 31 - </authorgroup> 32 - 33 - <copyright> 34 - <year>1998-2001, 2005-2015</year> 35 - <holder>Kevin Atkinson (original author)</holder> 36 - <holder>MySQL AB</holder> 37 - <holder>Educational Technology Resources</holder> 38 - </copyright> 39 - 40 - <pubdate><?dbtimestamp format="B d, Y"?></pubdate> 41 - </articleinfo> 40 + <pubdate><?dbtimestamp format="B d, Y"?></pubdate> 41 + </articleinfo> 42 42 43 43 44 - <xi:include href="intro.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 45 - <xi:include href="overview.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 46 - <xi:include href="tutorial.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 47 - <xi:include href="tquery.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 48 - <xi:include href="ssqls.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 49 - <xi:include href="unicode.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 50 - <xi:include href="threads.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 51 - <xi:include href="configuration.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 52 - <xi:include href="incorporating.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 53 - <xi:include href="breakages.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 54 - <xi:include href="licenses.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 44 + <xi:include href="intro.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 45 + <xi:include href="overview.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 46 + <xi:include href="tutorial.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 47 + <xi:include href="tquery.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 48 + <xi:include href="ssqls.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 49 + <xi:include href="unicode.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 50 + <xi:include href="threads.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 51 + <xi:include href="configuration.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 52 + <xi:include href="incorporating.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 53 + <xi:include href="breakages.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 54 + <xi:include href="licenses.dbx" xmlns:xi="http://www.w3.org/2001/XInclude"/> 55 55 </article>