From 101184f00f6c8cf8487cab10f05af7ec6914222e Mon Sep 17 00:00:00 2001 From: gggeek Date: Mon, 27 Apr 2015 21:49:08 +0100 Subject: [PATCH] Restructure the documentation folder; add more options to makefile --- README.md | 5 +- doc/{ => build}/custom.fo.xsl | 204 +++++++++--------- doc/{ => build}/custom.xsl | 2 +- doc/custom.dsl | 25 --- .../css-docbook}/COPYING | 34 +-- .../css-docbook}/CREDITS | 20 +- .../css-docbook}/core.css | 0 .../css-docbook}/db-bindings.xml | 62 +++--- .../css-docbook}/driver.css | 0 .../css-docbook}/l10n.css | 0 .../css-docbook}/l10n/de.css | 0 .../css-docbook}/l10n/en.css | 0 .../css-docbook}/l10n/es.css | 0 .../css-docbook}/l10n/pl.css | 0 .../css-docbook}/mozilla.css | 0 .../css-docbook}/opera.css | 0 .../css-docbook}/styles.css | 0 .../css-docbook}/tables.css | 0 .../css-docbook}/xmlrpc.css | 0 doc/{ => manual/images}/debugger.gif | Bin doc/{ => manual/images}/progxmlrpc.s.gif | Bin .../phpxmlrpc_manual.xml} | 6 +- pakefile.php | 75 ++++--- 23 files changed, 216 insertions(+), 217 deletions(-) rename doc/{ => build}/custom.fo.xsl (93%) rename doc/{ => build}/custom.xsl (97%) delete mode 100644 doc/custom.dsl rename doc/{docbook-css => manual/css-docbook}/COPYING (98%) rename doc/{docbook-css => manual/css-docbook}/CREDITS (95%) rename doc/{docbook-css => manual/css-docbook}/core.css (100%) rename doc/{docbook-css => manual/css-docbook}/db-bindings.xml (96%) rename doc/{docbook-css => manual/css-docbook}/driver.css (100%) rename doc/{docbook-css => manual/css-docbook}/l10n.css (100%) rename doc/{docbook-css => manual/css-docbook}/l10n/de.css (100%) rename doc/{docbook-css => manual/css-docbook}/l10n/en.css (100%) rename doc/{docbook-css => manual/css-docbook}/l10n/es.css (100%) rename doc/{docbook-css => manual/css-docbook}/l10n/pl.css (100%) rename doc/{docbook-css => manual/css-docbook}/mozilla.css (100%) rename doc/{docbook-css => manual/css-docbook}/opera.css (100%) rename doc/{docbook-css => manual/css-docbook}/styles.css (100%) rename doc/{docbook-css => manual/css-docbook}/tables.css (100%) rename doc/{docbook-css => manual/css-docbook}/xmlrpc.css (100%) rename doc/{ => manual/images}/debugger.gif (100%) rename doc/{ => manual/images}/progxmlrpc.s.gif (100%) rename doc/{xmlrpc_php.xml => manual/phpxmlrpc_manual.xml} (99%) diff --git a/README.md b/README.md index b0d323b..dfc9631 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,9 @@ Installation instructions are in the [INSTALL.md](INSTALL.md) file. Docs ---- -The manual, in HTML and pdf versions, can be found in the doc/ directory. -Use of this software is subject to the terms in doc/index.html +The manual can be found in the doc/manual directory, in HTML and PDF versions for release tarballs and Docbook always. + +Use of this software is subject to the terms in the [license.txt](license.txt) file SSL-certificate --------------- diff --git a/doc/custom.fo.xsl b/doc/build/custom.fo.xsl similarity index 93% rename from doc/custom.fo.xsl rename to doc/build/custom.fo.xsl index 1ba937c..b1964c0 100644 --- a/doc/custom.fo.xsl +++ b/doc/build/custom.fo.xsl @@ -1,103 +1,103 @@ - - - - - - - - - - -1 -no -ansi -0 -1 -php -A4 -1 - - - 80% - - - - - - - - - - - - - - - - - - - - - - - - - - - ( void ) - - - ( ) - - - - - - ( ... ) - - - - - - - ( - - - - - - - - - - - , - - - ) - - - - - - - - - - - - = - - - - + + + + + + + + + + +1 +no +ansi +0 +1 +php +A4 +1 + + + 80% + + + + + + + + + + + + + + + + + + + + + + + + + + + ( void ) + + + ( ) + + + + + + ( ... ) + + + + + + + ( + + + + + + + + + + + , + + + ) + + + + + + + + + + + + = + + + + \ No newline at end of file diff --git a/doc/custom.xsl b/doc/build/custom.xsl similarity index 97% rename from doc/custom.xsl rename to doc/build/custom.xsl index f648887..aed8d5e 100644 --- a/doc/custom.xsl +++ b/doc/build/custom.xsl @@ -15,7 +15,7 @@ - + diff --git a/doc/custom.dsl b/doc/custom.dsl deleted file mode 100644 index b3b35ce..0000000 --- a/doc/custom.dsl +++ /dev/null @@ -1,25 +0,0 @@ - -]> - - - - - -(define %link-mailto-url% - "edd@usefulinc.com") - -(define %html-ext% - ".html") - -(define %use-id-as-filename% - #t) - -(define %root-filename% - "index") - - - - - - diff --git a/doc/docbook-css/COPYING b/doc/manual/css-docbook/COPYING similarity index 98% rename from doc/docbook-css/COPYING rename to doc/manual/css-docbook/COPYING index d199ddc..735dca1 100644 --- a/doc/docbook-css/COPYING +++ b/doc/manual/css-docbook/COPYING @@ -1,17 +1,17 @@ -Copyright (c) 2004 David Holroyd, and contributors. - -Permission to use, copy, modify and distribute this software and its -documentation for any purpose and without fee is hereby granted in -perpetuity, provided that the above copyright notice appear in all -copies, and that both the copyright notice and this permission notice -appear in supporting documentation. The contributors make no -representations about the suitability of this software for any -purpose. It is provided "as is" without express or implied warranty. - -THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS -SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND -FITNESS. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY -SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER -RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF -CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN -CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +Copyright (c) 2004 David Holroyd, and contributors. + +Permission to use, copy, modify and distribute this software and its +documentation for any purpose and without fee is hereby granted in +perpetuity, provided that the above copyright notice appear in all +copies, and that both the copyright notice and this permission notice +appear in supporting documentation. The contributors make no +representations about the suitability of this software for any +purpose. It is provided "as is" without express or implied warranty. + +THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS +SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND +FITNESS. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY +SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER +RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF +CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN +CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. diff --git a/doc/docbook-css/CREDITS b/doc/manual/css-docbook/CREDITS similarity index 95% rename from doc/docbook-css/CREDITS rename to doc/manual/css-docbook/CREDITS index 08d96c5..cbc51ee 100644 --- a/doc/docbook-css/CREDITS +++ b/doc/manual/css-docbook/CREDITS @@ -1,10 +1,10 @@ -This stylesheet was writen by David Holroyd, with patches, suggestions, -translations, and other help from these people: - - David Leppik - Martin Gautier - Asia Magiera - Federico Koessler - Katie McSweenie - -Many thanks to all of them! +This stylesheet was writen by David Holroyd, with patches, suggestions, +translations, and other help from these people: + + David Leppik + Martin Gautier + Asia Magiera + Federico Koessler + Katie McSweenie + +Many thanks to all of them! diff --git a/doc/docbook-css/core.css b/doc/manual/css-docbook/core.css similarity index 100% rename from doc/docbook-css/core.css rename to doc/manual/css-docbook/core.css diff --git a/doc/docbook-css/db-bindings.xml b/doc/manual/css-docbook/db-bindings.xml similarity index 96% rename from doc/docbook-css/db-bindings.xml rename to doc/manual/css-docbook/db-bindings.xml index cb575fd..f3c0059 100644 --- a/doc/docbook-css/db-bindings.xml +++ b/doc/manual/css-docbook/db-bindings.xml @@ -1,31 +1,31 @@ - - - - - - - - - - - - - - - - - - var img = document.getAnonymousNodes(this)[0]; - var file = this.getAttribute("fileref"); - // HACK: using img.src=file 'inline' doesn't seem to work - // but it does when called from a setTimeout() - var f = function() { img.src = file; } - setTimeout(f, 0); - - - - + + + + + + + + + + + + + + + + + + var img = document.getAnonymousNodes(this)[0]; + var file = this.getAttribute("fileref"); + // HACK: using img.src=file 'inline' doesn't seem to work + // but it does when called from a setTimeout() + var f = function() { img.src = file; } + setTimeout(f, 0); + + + + diff --git a/doc/docbook-css/driver.css b/doc/manual/css-docbook/driver.css similarity index 100% rename from doc/docbook-css/driver.css rename to doc/manual/css-docbook/driver.css diff --git a/doc/docbook-css/l10n.css b/doc/manual/css-docbook/l10n.css similarity index 100% rename from doc/docbook-css/l10n.css rename to doc/manual/css-docbook/l10n.css diff --git a/doc/docbook-css/l10n/de.css b/doc/manual/css-docbook/l10n/de.css similarity index 100% rename from doc/docbook-css/l10n/de.css rename to doc/manual/css-docbook/l10n/de.css diff --git a/doc/docbook-css/l10n/en.css b/doc/manual/css-docbook/l10n/en.css similarity index 100% rename from doc/docbook-css/l10n/en.css rename to doc/manual/css-docbook/l10n/en.css diff --git a/doc/docbook-css/l10n/es.css b/doc/manual/css-docbook/l10n/es.css similarity index 100% rename from doc/docbook-css/l10n/es.css rename to doc/manual/css-docbook/l10n/es.css diff --git a/doc/docbook-css/l10n/pl.css b/doc/manual/css-docbook/l10n/pl.css similarity index 100% rename from doc/docbook-css/l10n/pl.css rename to doc/manual/css-docbook/l10n/pl.css diff --git a/doc/docbook-css/mozilla.css b/doc/manual/css-docbook/mozilla.css similarity index 100% rename from doc/docbook-css/mozilla.css rename to doc/manual/css-docbook/mozilla.css diff --git a/doc/docbook-css/opera.css b/doc/manual/css-docbook/opera.css similarity index 100% rename from doc/docbook-css/opera.css rename to doc/manual/css-docbook/opera.css diff --git a/doc/docbook-css/styles.css b/doc/manual/css-docbook/styles.css similarity index 100% rename from doc/docbook-css/styles.css rename to doc/manual/css-docbook/styles.css diff --git a/doc/docbook-css/tables.css b/doc/manual/css-docbook/tables.css similarity index 100% rename from doc/docbook-css/tables.css rename to doc/manual/css-docbook/tables.css diff --git a/doc/docbook-css/xmlrpc.css b/doc/manual/css-docbook/xmlrpc.css similarity index 100% rename from doc/docbook-css/xmlrpc.css rename to doc/manual/css-docbook/xmlrpc.css diff --git a/doc/debugger.gif b/doc/manual/images/debugger.gif similarity index 100% rename from doc/debugger.gif rename to doc/manual/images/debugger.gif diff --git a/doc/progxmlrpc.s.gif b/doc/manual/images/progxmlrpc.s.gif similarity index 100% rename from doc/progxmlrpc.s.gif rename to doc/manual/images/progxmlrpc.s.gif diff --git a/doc/xmlrpc_php.xml b/doc/manual/phpxmlrpc_manual.xml similarity index 99% rename from doc/xmlrpc_php.xml rename to doc/manual/phpxmlrpc_manual.xml index 363f8a7..5c69ba7 100644 --- a/doc/xmlrpc_php.xml +++ b/doc/manual/phpxmlrpc_manual.xml @@ -1,5 +1,5 @@ - +