From 134502223e9edb51690672f108b29777e3b66f2c Mon Sep 17 00:00:00 2001 From: Francis Lachapelle Date: Thu, 17 Jun 2021 12:20:20 -0400 Subject: [PATCH] refactor(doc): replace xsltproc/fop by asciidoctor-pdf --- Documentation/Makefile | 32 ++- Documentation/SOGoDevelopersGuide.asciidoc | 7 +- Documentation/SOGoInstallationGuide.asciidoc | 58 ++--- ...GoMobileDevicesConfigurationGuide.asciidoc | 8 +- ...illaThunderbirdConfigurationGuide.asciidoc | 8 +- ...utlookConnectorConfigurationGuide.asciidoc | 7 +- Documentation/docbook/fop-centos6.patch | 16 -- .../docbook/xmlgraphics-fop-centos5.patch | 17 -- Documentation/docbook/xsl/headerfooter-fo.xsl | 107 --------- Documentation/docbook/xsl/sogo-fo.xsl | 182 --------------- Documentation/docbook/xsl/titlepage-fo.xml | 96 -------- Documentation/docbook/xsl/titlepage-fo.xsl | 208 ------------------ Documentation/docinfo.xml | 24 -- Documentation/fonts/fop-config.xml | 32 --- Documentation/fonts/inconsolata.xml | 1 - .../includes/commercial-support.asciidoc | 14 +- Documentation/includes/docinfo.asciidoc | 13 ++ .../includes/global-attributes.asciidoc | 22 +- 18 files changed, 96 insertions(+), 756 deletions(-) delete mode 100644 Documentation/docbook/fop-centos6.patch delete mode 100644 Documentation/docbook/xmlgraphics-fop-centos5.patch delete mode 100644 Documentation/docbook/xsl/headerfooter-fo.xsl delete mode 100644 Documentation/docbook/xsl/sogo-fo.xsl delete mode 100644 Documentation/docbook/xsl/titlepage-fo.xml delete mode 100644 Documentation/docbook/xsl/titlepage-fo.xsl delete mode 100644 Documentation/docinfo.xml delete mode 100644 Documentation/fonts/fop-config.xml delete mode 100644 Documentation/fonts/inconsolata.xml create mode 100644 Documentation/includes/docinfo.asciidoc diff --git a/Documentation/Makefile b/Documentation/Makefile index 03a484995..56c0c9d82 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -1,9 +1,29 @@ -all: $(patsubst %.asciidoc,%.pdf,$(wildcard *.asciidoc)) +all: pdf html -%.pdf : %.asciidoc - asciidoc -a docinfo1 -b docbook -d book -o $<.docbook $< - xsltproc -o $<.fo docbook/xsl/sogo-fo.xsl $<.docbook - fop -c fonts/fop-config.xml $<.fo -pdf $@ +ASCIIDOCS = $(wildcard SOGo*.asciidoc) +PDFS = $(patsubst %.asciidoc,%.pdf, $(ASCIIDOCS)) +HTML = $(patsubst %.asciidoc,%.html, $(ASCIIDOCS)) + +%.pdf: %.asciidoc asciidoctor-pdf-theme.yml $(wildcard includes/*.asciidoc) + asciidoctor-pdf \ + -a pdf-fontsdir=fonts \ + -a release_version=`git describe --abbrev=0 --tags | cut -d'-' -f 2` \ + -a release_month=`date +%B` \ + -a pdf-theme=asciidoctor-pdf-theme.yml \ + --trace \ + $< + +%.html: %.asciidoc $(wildcard includes/*.asciidoc) + asciidoctor \ + -D . \ + -a release_version=`git describe --abbrev=0 --tags | cut -d'-' -f 2` \ + -a release_month=`date +%B` \ + -n \ + $< + +pdf: $(PDFS) + +html: $(HTML) clean: - rm -f *.asciidoc.fo *.asciidoc.docbook *.pdf + rm -f *.pdf *.html diff --git a/Documentation/SOGoDevelopersGuide.asciidoc b/Documentation/SOGoDevelopersGuide.asciidoc index 5f320c608..97d86dd8a 100644 --- a/Documentation/SOGoDevelopersGuide.asciidoc +++ b/Documentation/SOGoDevelopersGuide.asciidoc @@ -1,16 +1,13 @@ Developer's Guide ================= -:toc: left -:icons: font - //// This file is part of the SOGo project. - See docinfo.xml for authors, copyright and license information. + See includes/global-attributes.asciidoc + for authors, copyright and license information. //// - include::includes/global-attributes.asciidoc[] UI and UX diff --git a/Documentation/SOGoInstallationGuide.asciidoc b/Documentation/SOGoInstallationGuide.asciidoc index 1ad6e79a6..ce740f673 100644 --- a/Documentation/SOGoInstallationGuide.asciidoc +++ b/Documentation/SOGoInstallationGuide.asciidoc @@ -1,16 +1,13 @@ Installation and Configuration Guide ==================================== -:toc: left -:icons: font - //// This file is part of the SOGo project. - See docinfo.xml for authors, copyright and license information. + See includes/global-attributes.asciidoc + for authors, copyright and license information. //// - include::includes/global-attributes.asciidoc[] About this Guide @@ -334,7 +331,7 @@ by the user and stored in SOGo's database. To identify the level in which each parameter can be defined, we use the following abbreviations in the tables of this document: -[cols="^3,97"] +[cols="^5,95"] |==================================================================== |S |Parameter exclusive to the system and not configurable per domain |D |Parameter exclusive to a domain and not configurable per user @@ -349,7 +346,7 @@ General Preferences The following table describes the general parameters that can be set: -[cols="^3,47,50a"] +[cols="^4,46,50a"] |======================================================================= |S |WOWorkersCount |The amount of instances of SOGo that will be spawned @@ -776,10 +773,15 @@ any requests being made. Default value is 0, or disabled |Number of seconds, defaults to 300 (or 5 minutes). Note that _SOGoCacheCleanupInterval_ must be set to a value equal or higher than _SOGoRequestBlockInterval_. -|D |SOGoXSRFValidationEnabled +|S |SOGoXSRFValidationEnabled |Parameter used to enable or not XSRF (also known as CSRF) protection in SOGo. Default value is `YES`, or enabled. +|D |SOGoUserSources +|Parameter used to set the LDAP and/or SQL sources used for +authentication and global address books. Multiple sources can be +specified as an array of dictionaries. + |======================================================================= Authentication using LDAP @@ -918,16 +920,10 @@ would be: ---- The following table describes the possible parameters related to a LDAP -source: +source defined as a dictionary entry of the _SOGoUserSources_ parameter: -[cols="3,47a,50"] +[cols="1,2a"] |======================================================================= -.36+^|D |SOGoUserSources -|Parameter used to set the LDAP and/or SQL sources used for -authentication and global address books. Multiple sources can be -specified as an array of dictionaries. A dictionary that defines an LDAP -source can contain the following values: - |type |The type of this user source, set to ldap` for an LDAP source. @@ -1112,8 +1108,8 @@ Defaults to `NO` when unset. (with read-only access). Note that if set to `NO`, autocompletion will not work for entries in this source and thus, freebusy lookups. -|displayName (optional) -|If set as an address book, the human identification name of the LDAP +!displayName (optional) +!If set as an address book, the human identification name of the LDAP repository |listRequiresDot (optional) @@ -1167,7 +1163,7 @@ The following parameters can be defined along the other keys of each entry of the SOGoUserSources, but can also defined at the domain and/or system levels: -[cols="3,47,50a"] +[cols="^4,46,50a"] |======================================================================= |D |SOGoLDAPContactInfoAttribute |Parameter used to specify an attribute that should appear in @@ -1474,7 +1470,7 @@ OCSSessionsFolderURL = The following table describes the parameters that were set: -[cols="3,47,50a"] +[cols="^4,46,50a"] |======================================================================= |S |SOGoProfileURL |Parameter used to set the database URL so that SOGo can retrieve user @@ -1632,17 +1628,11 @@ Authentication using SQL SOGo can use a SQL-based database server for authentication. The configuration is very similar to LDAP-based authentication. -The following table describes all the possible parameters related to a -SQL source: +The following table describes the possible parameters related to a SQL +source defined as a dictionary entry of the _SOGoUserSources_ parameter: -[cols="3,47a,50"] +[cols="1,2a"] |======================================================================= -.21+^|D |SOGoUserSources -|Parameter used to set the SQL and/or LDAP sources used for -authentication and global address books. Multiple sources can be -specified as an array of dictionaries. A dictionary that defines a SQL -source can contain the following values: - |type |The type of this user source, set to `sql` for a SQL source. @@ -1816,7 +1806,7 @@ iMIP/iTIP messages and various notifications. The following table describes the related parameters. -[cols="3,47,50a"] +[cols="^4,46,50a"] |======================================================================= |D |SOGoMailingMechanism |Parameter used to set how SOGo sends mail messages. Possible values @@ -1868,7 +1858,7 @@ messages, manage their folders and more. The following table describes the related parameters. -[cols="3,47,50a"] +[cols="^4,46,50a"] |======================================================================= |U |SOGoDraftsFolderName |Parameter used to set the IMAP folder name used to store drafts @@ -2031,7 +2021,7 @@ Web Interface Configuration The following additional parameters only affect the Web interface behaviour of SOGo. -[cols="3,47,50a"] +[cols="^4,46,50a"] |======================================================================= |S |SOGoPageTitle |Parameter used to define the Web page title. @@ -2591,7 +2581,7 @@ coyote.com): The following additional parameters only affect SOGo when using multiple domains. -[cols="3,47,50a"] +[cols="^4,46,50a"] |======================================================================= |S |SOGoEnableDomainBasedUID |Parameter used to enable user identification by domain. Users will be @@ -2812,7 +2802,7 @@ Restart Apache afterwards. The following additional parameters only affect SOGo when using ActiveSync: -[cols="3,47,50a"] +[cols="^4,46,50a"] |======================================================================= |S |SOGoMaximumPingInterval |Parameter used to set the maximum amount of time, in seconds, SOGo will diff --git a/Documentation/SOGoMobileDevicesConfigurationGuide.asciidoc b/Documentation/SOGoMobileDevicesConfigurationGuide.asciidoc index e12338aec..5353e1994 100644 --- a/Documentation/SOGoMobileDevicesConfigurationGuide.asciidoc +++ b/Documentation/SOGoMobileDevicesConfigurationGuide.asciidoc @@ -1,17 +1,13 @@ Mobile Devices Configuration Guide ================================== -:toc: left -:icons: font - //// This file is part of the SOGo project. - See SOGo Mobile Devices Configuration-docinfo.xml for authors, - copyright and license information. + See includes/global-attributes.asciidoc + for authors, copyright and license information. //// - include::includes/global-attributes.asciidoc[] About this Guide diff --git a/Documentation/SOGoMozillaThunderbirdConfigurationGuide.asciidoc b/Documentation/SOGoMozillaThunderbirdConfigurationGuide.asciidoc index 6eacbbdd3..081c37795 100644 --- a/Documentation/SOGoMozillaThunderbirdConfigurationGuide.asciidoc +++ b/Documentation/SOGoMozillaThunderbirdConfigurationGuide.asciidoc @@ -1,17 +1,13 @@ Mozilla Thunderbird Configuration Guide ======================================= -:toc: left -:icons: font - //// This file is part of the SOGo project. - See SOGo Mozilla Thunderbird Configuration Guide-docinfo.xml for - authors, copyright and license information. + See includes/global-attributes.asciidoc + for authors, copyright and license information. //// - include::includes/global-attributes.asciidoc[] About this Guide diff --git a/Documentation/SOGoOutlookConnectorConfigurationGuide.asciidoc b/Documentation/SOGoOutlookConnectorConfigurationGuide.asciidoc index f757a76b8..7a730cf51 100644 --- a/Documentation/SOGoOutlookConnectorConfigurationGuide.asciidoc +++ b/Documentation/SOGoOutlookConnectorConfigurationGuide.asciidoc @@ -1,16 +1,13 @@ Microsoft Outlook CalDAVSynchronizer Configuration Guide ======================================================== -:toc: left -:icons: font - //// This file is part of the SOGo project. - See docinfo.xml for authors, copyright and license information. + See includes/global-attributes.asciidoc + for authors, copyright and license information. //// - include::includes/global-attributes.asciidoc[] About this Guide diff --git a/Documentation/docbook/fop-centos6.patch b/Documentation/docbook/fop-centos6.patch deleted file mode 100644 index 630628898..000000000 --- a/Documentation/docbook/fop-centos6.patch +++ /dev/null @@ -1,16 +0,0 @@ -# -# fop fix to build our documentation on CentOS 6 -# -# Inverse inc. -# ---- /usr/bin/fop.orig 2012-01-17 21:25:50.000000000 -0500 -+++ /usr/bin/fop 2012-01-17 21:26:04.000000000 -0500 -@@ -26,7 +26,7 @@ - # Set parameters - set_jvm - set_classpath commons-io batik-all avalon-framework xmlgraphics-commons \ -- commons-logging fop -+ commons-logging fop xalan-j2 - set_flags $BASE_FLAGS - set_options $BASE_OPTIONS - diff --git a/Documentation/docbook/xmlgraphics-fop-centos5.patch b/Documentation/docbook/xmlgraphics-fop-centos5.patch deleted file mode 100644 index 932c494cf..000000000 --- a/Documentation/docbook/xmlgraphics-fop-centos5.patch +++ /dev/null @@ -1,17 +0,0 @@ -# -# xmlgraphics-fop fix to build our documentation on CentOS 5 -# taken from https://build.opensuse.org/request/show/68994 -# -# Inverse inc. -# ---- /usr/bin/xmlgraphics-fop.orig 2012-01-17 18:42:08.000000000 -0500 -+++ /usr/bin/xmlgraphics-fop 2012-01-17 18:42:18.000000000 -0500 -@@ -24,7 +24,7 @@ - - # Rest of the configuration - MAIN_CLASS=org.apache.fop.cli.Main --BASE_JARS="xmlgraphics-fop xmlgraphics-batik/util xml-commons-jaxp-1.3-apis excalibur/avalon-framework-api xerces-j2 xalan-j2 xalan-j2-serializer" -+BASE_JARS="xmlgraphics-fop batik-all xml-commons-jaxp-1.3-apis excalibur/avalon-framework-impl excalibur/avalon-framework-api xerces-j2 xalan-j2 xalan-j2-serializer" - - # Set parameters - set_jvm diff --git a/Documentation/docbook/xsl/headerfooter-fo.xsl b/Documentation/docbook/xsl/headerfooter-fo.xsl deleted file mode 100644 index 3e5fb6d41..000000000 --- a/Documentation/docbook/xsl/headerfooter-fo.xsl +++ /dev/null @@ -1,107 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/Documentation/docbook/xsl/sogo-fo.xsl b/Documentation/docbook/xsl/sogo-fo.xsl deleted file mode 100644 index c074efffe..000000000 --- a/Documentation/docbook/xsl/sogo-fo.xsl +++ /dev/null @@ -1,182 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Lato-Medium - - - 2.5em - solid 2px - 1em - - - solid 1px - 2em - 1em - - - - - 1em - - - - Lato-Light - 10 - Incosolata - - - - 12pt - bold - center - - - page - - - 1px solid - - - - - - - - - - - - - - - - ▪ - - - - - - square - - - - - - images/ - .png - - 1px solid - 1px solid - 0.5em - 0.5em - 2em - - - - - - - #E0E0E0 - thin #9F9F9F solid - 0pt - 0.5em - - always - - - - - wrap - - - - - - - - blue - underline - - - - - - - - - - - - - - - - - diff --git a/Documentation/docbook/xsl/titlepage-fo.xml b/Documentation/docbook/xsl/titlepage-fo.xml deleted file mode 100644 index 8fc51f01b..000000000 --- a/Documentation/docbook/xsl/titlepage-fo.xml +++ /dev/null @@ -1,96 +0,0 @@ - - - - - - - - - - - - -]> - - - - - - - - - - - <subtitle - text-align="right" - font-size="&hsize4;" - space-before="&hsize4space;" - font-family="{$title.fontset}" - border-bottom="solid"/> - </t:titlepage-content> - - <t:titlepage-content t:side="verso"> - <title - font-size="&hsize2;" - font-weight="bold" - font-family="{$title.fontset}"/> - <corpauthor/> - <authorgroup t:named-template="verso.authorgroup"/> - <author/> - <othercredit/> - <releaseinfo space-before="0.5em"/> - <pubdate space-before="1em"/> - <copyright/> - <abstract/> - <legalnotice font-size="8pt"/> - </t:titlepage-content> - - <t:titlepage-separator> - <fo:block break-after="page"/> - </t:titlepage-separator> - - <t:titlepage-before t:side="recto"> - </t:titlepage-before> - - <t:titlepage-before t:side="verso"> - <fo:block break-after="page"/> - </t:titlepage-before> -</t:titlepage> - -</t:templates> diff --git a/Documentation/docbook/xsl/titlepage-fo.xsl b/Documentation/docbook/xsl/titlepage-fo.xsl deleted file mode 100644 index aa120ecf6..000000000 --- a/Documentation/docbook/xsl/titlepage-fo.xsl +++ /dev/null @@ -1,208 +0,0 @@ -<?xml version="1.0"?> - -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:exsl="http://exslt.org/common" version="1.0" exclude-result-prefixes="exsl"> - -<!-- This stylesheet was created by template/titlepage.xsl--> - -<xsl:template name="book.titlepage.recto"> - <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/mediaobject"/> - <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/mediaobject"/> - <xsl:choose> - <xsl:when test="bookinfo/title"> - <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/title"/> - </xsl:when> - <xsl:when test="info/title"> - <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/title"/> - </xsl:when> - <xsl:when test="title"> - <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="title"/> - </xsl:when> - </xsl:choose> - - <xsl:choose> - <xsl:when test="bookinfo/subtitle"> - <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="bookinfo/subtitle"/> - </xsl:when> - <xsl:when test="info/subtitle"> - <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="info/subtitle"/> - </xsl:when> - <xsl:when test="subtitle"> - <xsl:apply-templates mode="book.titlepage.recto.auto.mode" select="subtitle"/> - </xsl:when> - </xsl:choose> - -</xsl:template> - -<xsl:template name="book.titlepage.verso"> - <xsl:choose> - <xsl:when test="bookinfo/title"> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="bookinfo/title"/> - </xsl:when> - <xsl:when test="info/title"> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="info/title"/> - </xsl:when> - <xsl:when test="title"> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="title"/> - </xsl:when> - </xsl:choose> - - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="bookinfo/corpauthor"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="info/corpauthor"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="bookinfo/authorgroup"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="info/authorgroup"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="bookinfo/author"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="info/author"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="bookinfo/othercredit"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="info/othercredit"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="bookinfo/releaseinfo"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="info/releaseinfo"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="bookinfo/pubdate"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="info/pubdate"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="bookinfo/copyright"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="info/copyright"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="bookinfo/abstract"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="info/abstract"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="bookinfo/legalnotice"/> - <xsl:apply-templates mode="book.titlepage.verso.auto.mode" select="info/legalnotice"/> -</xsl:template> - -<xsl:template name="book.titlepage.separator"><fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" break-after="page"/> -</xsl:template> - -<xsl:template name="book.titlepage.before.recto"> -</xsl:template> - -<xsl:template name="book.titlepage.before.verso"><fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" break-after="page"/> -</xsl:template> - -<xsl:template name="book.titlepage"> - <fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format"> - <xsl:variable name="recto.content"> - <xsl:call-template name="book.titlepage.before.recto"/> - <xsl:call-template name="book.titlepage.recto"/> - </xsl:variable> - <xsl:variable name="recto.elements.count"> - <xsl:choose> - <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when> - <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')"> - <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($recto.content)/*)"/></xsl:when> - <xsl:otherwise>1</xsl:otherwise> - </xsl:choose> - </xsl:variable> - <xsl:if test="(normalize-space($recto.content) != '') or ($recto.elements.count > 0)"> - <fo:block><xsl:copy-of select="$recto.content"/></fo:block> - </xsl:if> - <xsl:variable name="verso.content"> - <xsl:call-template name="book.titlepage.before.verso"/> - <xsl:call-template name="book.titlepage.verso"/> - </xsl:variable> - <xsl:variable name="verso.elements.count"> - <xsl:choose> - <xsl:when test="function-available('exsl:node-set')"><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when> - <xsl:when test="contains(system-property('xsl:vendor'), 'Apache Software Foundation')"> - <!--Xalan quirk--><xsl:value-of select="count(exsl:node-set($verso.content)/*)"/></xsl:when> - <xsl:otherwise>1</xsl:otherwise> - </xsl:choose> - </xsl:variable> - <xsl:if test="(normalize-space($verso.content) != '') or ($verso.elements.count > 0)"> - <fo:block><xsl:copy-of select="$verso.content"/></fo:block> - </xsl:if> - <xsl:call-template name="book.titlepage.separator"/> - </fo:block> -</xsl:template> - -<xsl:template match="*" mode="book.titlepage.recto.mode"> - <!-- if an element isn't found in this mode, --> - <!-- try the generic titlepage.mode --> - <xsl:apply-templates select="." mode="titlepage.mode"/> -</xsl:template> - -<xsl:template match="*" mode="book.titlepage.verso.mode"> - <!-- if an element isn't found in this mode, --> - <!-- try the generic titlepage.mode --> - <xsl:apply-templates select="." mode="titlepage.mode"/> -</xsl:template> - -<xsl:template match="mediaobject" mode="book.titlepage.recto.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.recto.style"> -<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/> -</fo:block> -</xsl:template> - -<xsl:template match="title" mode="book.titlepage.recto.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.recto.style" text-align="right" font-size="24.8832pt" space-before="18.6624pt" font-weight="bold" font-family="{$title.fontset}" margin-top="8em"> -<xsl:call-template name="division.title"> -<xsl:with-param name="node" select="ancestor-or-self::book[1]"/> -</xsl:call-template> -</fo:block> -</xsl:template> - -<xsl:template match="subtitle" mode="book.titlepage.recto.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.recto.style" text-align="right" font-size="20.736pt" space-before="15.552pt" font-family="{$title.fontset}" border-bottom="solid"> -<xsl:apply-templates select="." mode="book.titlepage.recto.mode"/> -</fo:block> -</xsl:template> - -<xsl:template match="title" mode="book.titlepage.verso.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.verso.style" font-size="14.4pt" font-weight="bold" font-family="{$title.fontset}"> -<xsl:apply-templates select="." mode="book.titlepage.verso.mode"/> -</fo:block> -</xsl:template> - -<xsl:template match="corpauthor" mode="book.titlepage.verso.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.verso.style"> -<xsl:apply-templates select="." mode="book.titlepage.verso.mode"/> -</fo:block> -</xsl:template> - -<xsl:template match="authorgroup" mode="book.titlepage.verso.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.verso.style"> -<xsl:call-template name="verso.authorgroup"> -</xsl:call-template> -</fo:block> -</xsl:template> - -<xsl:template match="author" mode="book.titlepage.verso.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.verso.style"> -<xsl:apply-templates select="." mode="book.titlepage.verso.mode"/> -</fo:block> -</xsl:template> - -<xsl:template match="othercredit" mode="book.titlepage.verso.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.verso.style"> -<xsl:apply-templates select="." mode="book.titlepage.verso.mode"/> -</fo:block> -</xsl:template> - -<xsl:template match="releaseinfo" mode="book.titlepage.verso.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.verso.style" space-before="0.5em"> -<xsl:apply-templates select="." mode="book.titlepage.verso.mode"/> -</fo:block> -</xsl:template> - -<xsl:template match="pubdate" mode="book.titlepage.verso.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.verso.style" space-before="1em"> -<xsl:apply-templates select="." mode="book.titlepage.verso.mode"/> -</fo:block> -</xsl:template> - -<xsl:template match="copyright" mode="book.titlepage.verso.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.verso.style"> -<xsl:apply-templates select="." mode="book.titlepage.verso.mode"/> -</fo:block> -</xsl:template> - -<xsl:template match="abstract" mode="book.titlepage.verso.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.verso.style"> -<xsl:apply-templates select="." mode="book.titlepage.verso.mode"/> -</fo:block> -</xsl:template> - -<xsl:template match="legalnotice" mode="book.titlepage.verso.auto.mode"> -<fo:block xmlns:fo="http://www.w3.org/1999/XSL/Format" xsl:use-attribute-sets="book.titlepage.verso.style" font-size="8pt"> -<xsl:apply-templates select="." mode="book.titlepage.verso.mode"/> -</fo:block> -</xsl:template> - -</xsl:stylesheet> - diff --git a/Documentation/docinfo.xml b/Documentation/docinfo.xml deleted file mode 100644 index 37842e7d7..000000000 --- a/Documentation/docinfo.xml +++ /dev/null @@ -1,24 +0,0 @@ -<!-- TODO have the build system take care of this --> -<releaseinfo>Version 5.1.1 - June 2021</releaseinfo> -<subtitle>for version 5.1.1</subtitle> -<date>2021-06-01</date> - -<legalnotice> - <para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".</para> - - <!-- font licenses --> - <para>The fonts used in this guide are licensed under the SIL Open Font License, Version 1.1. This license is available with a FAQ at: <ulink url="http://scripts.sil.org/OFL">http://scripts.sil.org/OFL</ulink></para> - <para>Copyright © Łukasz Dziedzic, <ulink url="http://www.latofonts.com/">http://www.latofonts.com</ulink>, with Reserved Font Name: "Lato".</para> - <para>Copyright © Raph Levien, <ulink url="http://levien.com/">http://levien.com/</ulink>, with Reserved Font Name: "Inconsolata".</para> -</legalnotice> -<mediaobject> - <objectinfo> - <corpname>Inverse inc.</corpname> - </objectinfo> - <textobject> - <phrase>SOGo logo</phrase> - </textobject> - <imageobject> - <imagedata align="left" width="4in" format="PNG" fileref="images/sogo-logo.png" /> - </imageobject> -</mediaobject> diff --git a/Documentation/fonts/fop-config.xml b/Documentation/fonts/fop-config.xml deleted file mode 100644 index 1a65b7a07..000000000 --- a/Documentation/fonts/fop-config.xml +++ /dev/null @@ -1,32 +0,0 @@ -<fop version="1.0"> - <renderers> - <renderer mime="application/pdf"> - <fonts> - <font metrics-url="fonts/inconsolata.xml" kerning="yes" embed-url="fonts/inconsolata.ttf"> - <font-triplet name="Incosolata" style="normal" weight="normal"/> - </font> - <font metrics-url="fonts/lato/Lato-Regular.xml" kerning="yes" embed-url="fonts/lato/Lato-Regular.ttf"> - <font-triplet name="Lato" style="normal" weight="normal"/> - </font> - <font metrics-url="fonts/lato/Lato-Italic.xml" kerning="yes" embed-url="fonts/lato/Lato-Italic.ttf"> - <font-triplet name="Lato" style="italic" weight="normal"/> - </font> - <font metrics-url="fonts/lato/Lato-Light.xml" kerning="yes" embed-url="fonts/lato/Lato-Light.ttf"> - <font-triplet name="Lato-Light" style="normal" weight="normal"/> - </font> - <font metrics-url="fonts/lato/Lato-LightItalic.xml" kerning="yes" embed-url="fonts/lato/Lato-LightItalic.ttf"> - <font-triplet name="Lato-Light" style="italic" weight="normal"/> - </font> - <font metrics-url="fonts/lato/Lato-Medium.xml" kerning="yes" embed-url="fonts/lato/Lato-Medium.ttf"> - <font-triplet name="Lato-Medium" style="normal" weight="normal"/> - </font> - <font metrics-url="fonts/lato/Lato-MediumItalic.xml" kerning="yes" embed-url="fonts/lato/Lato-MediumItalic.ttf"> - <font-triplet name="Lato-Medium" style="italic" weight="normal"/> - </font> - <font metrics-url="fonts/lato/Lato-Semibold.xml" kerning="yes" embed-url="fonts/lato/Lato-Semibold.ttf"> - <font-triplet name="Lato-Semibold" style="normal" weight="normal"/> - </font> - </fonts> - </renderer> - </renderers> -</fop> diff --git a/Documentation/fonts/inconsolata.xml b/Documentation/fonts/inconsolata.xml deleted file mode 100644 index 20eb2d898..000000000 --- a/Documentation/fonts/inconsolata.xml +++ /dev/null @@ -1 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?><font-metrics metrics-version="2" type="TYPE0"><font-name>Inconsolata</font-name><full-name>Inconsolata</full-name><family-name>Inconsolata</family-name><embed/><cap-height>624</cap-height><x-height>458</x-height><ascender>820</ascender><descender>-180</descender><bbox><left>-1</left><bottom>-177</bottom><right>510</right><top>835</top></bbox><flags>33</flags><stemv>0</stemv><italicangle>0</italicangle><subtype>TYPE0</subtype><multibyte-extras><cid-type>CIDFontType2</cid-type><default-width>0</default-width><bfranges><bf gi="3" ue="126" us="32"/><bf gi="98" ue="255" us="160"/><bf gi="194" ue="263" us="258"/><bf gi="200" ue="273" us="268"/><bf gi="206" ue="283" us="280"/><bf gi="210" ue="287" us="286"/><bf gi="212" ue="305" us="304"/><bf gi="214" ue="314" us="312"/><bf gi="217" ue="318" us="317"/><bf gi="219" ue="324" us="321"/><bf gi="223" ue="328" us="327"/><bf gi="225" ue="331" us="330"/><bf gi="227" ue="333" us="333"/><bf gi="228" ue="341" us="336"/><bf gi="234" ue="347" us="344"/><bf gi="238" ue="357" us="350"/><bf gi="246" ue="369" us="366"/><bf gi="250" ue="382" us="376"/><bf gi="257" ue="402" us="402"/><bf gi="258" ue="567" us="567"/><bf gi="259" ue="711" us="710"/><bf gi="261" ue="713" us="713"/><bf gi="262" ue="715" us="715"/><bf gi="263" ue="733" us="728"/><bf gi="269" ue="8218" us="8216"/><bf gi="272" ue="8222" us="8220"/><bf gi="275" ue="8226" us="8224"/><bf gi="278" ue="8230" us="8230"/><bf gi="279" ue="8250" us="8249"/><bf gi="281" ue="8260" us="8260"/><bf gi="282" ue="8308" us="8308"/><bf gi="283" ue="8364" us="8364"/><bf gi="284" ue="8482" us="8482"/><bf gi="285" ue="8593" us="8593"/><bf gi="286" ue="8595" us="8595"/><bf gi="287" ue="8722" us="8722"/><bf gi="288" ue="9251" us="9251"/><bf gi="0" ue="65535" us="65535"/></bfranges><cid-widths start-index="0"><wx w="500"/><wx w="0"/><wx w="333"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="491"/><wx w="483"/><wx w="474"/><wx w="466"/><wx w="457"/><wx w="448"/><wx w="440"/><wx w="431"/><wx w="422"/><wx w="414"/><wx w="405"/><wx w="396"/><wx w="388"/><wx w="379"/><wx w="371"/><wx w="362"/><wx w="353"/><wx w="345"/><wx w="336"/><wx w="327"/><wx w="319"/><wx w="310"/><wx w="302"/><wx w="293"/><wx w="284"/><wx w="276"/><wx w="267"/><wx w="258"/><wx w="250"/><wx w="241"/><wx w="233"/><wx w="224"/><wx w="215"/><wx w="207"/><wx w="198"/><wx w="189"/><wx w="181"/><wx w="172"/><wx w="163"/><wx w="155"/><wx w="146"/><wx w="138"/><wx w="129"/><wx w="120"/><wx w="112"/><wx w="103"/><wx w="94"/><wx w="86"/><wx w="77"/><wx w="69"/><wx w="60"/><wx w="51"/><wx w="43"/><wx w="34"/><wx w="25"/><wx w="17"/><wx w="8"/><wx w="0"/><wx w="0"/><wx w="0"/><wx w="0"/><wx w="0"/><wx w="0"/><wx w="0"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="500"/><wx w="0"/><wx w="500"/><wx w="500"/><wx w="500"/></cid-widths></multibyte-extras></font-metrics> \ No newline at end of file diff --git a/Documentation/includes/commercial-support.asciidoc b/Documentation/includes/commercial-support.asciidoc index 4fbc81194..b317ed799 100644 --- a/Documentation/includes/commercial-support.asciidoc +++ b/Documentation/includes/commercial-support.asciidoc @@ -6,7 +6,7 @@ Authors: - Inverse inc. <info@inverse.ca> - Copyright (C) 2008-2014 Inverse inc. + Copyright (C) 2008-2021 Inverse inc. License: GFDL 1.2 or later. http://www.gnu.org/licenses/fdl.html //// @@ -15,12 +15,14 @@ Commercial Support and Contact Information ------------------------------------------ For any questions or comments, do not hesitate to contact us by writing -an email to : +an email to support@inverse.ca. -mailto:support@inverse.ca[support@inverse.ca] +Inverse (https://inverse.ca/) offers professional services around SOGo +to help organizations deploy the solution, customize, migrate versions or +from another system, performance tuning or aligning with best practices. -Inverse (http://inverse.ca/[http://inverse.ca]) offers professional -services around SOGo to help organizations deploy the solution and -migrate from their legacy systems. +Hourly rates or support packages are offered to best suit your needs. + +Please visit https://inverse.ca/ for details. // vim: set syntax=asciidoc tabstop=2 shiftwidth=2 expandtab: diff --git a/Documentation/includes/docinfo.asciidoc b/Documentation/includes/docinfo.asciidoc new file mode 100644 index 000000000..6f6d64533 --- /dev/null +++ b/Documentation/includes/docinfo.asciidoc @@ -0,0 +1,13 @@ +Version {release_version} - {release_month} {docyear} + +Copyright © {docyear} Inverse inc. + +Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". + +The fonts used in this guide are licensed under the SIL Open Font License, Version 1.1. This license is available with a FAQ at: http://scripts.sil.org/OFL + +Copyright © Łukasz Dziedzic, http://www.latofonts.com, with Reserved Font Name: "Lato". + +Copyright © Raph Levien, http://levien.com/, with Reserved Font Name: "Inconsolata". + +image::images/inverse-logo.jpg[width="25%",pdfwidth="50%",align="right"] diff --git a/Documentation/includes/global-attributes.asciidoc b/Documentation/includes/global-attributes.asciidoc index 0aefdefcf..0886003ea 100644 --- a/Documentation/includes/global-attributes.asciidoc +++ b/Documentation/includes/global-attributes.asciidoc @@ -6,13 +6,25 @@ Authors: - Inverse inc. <info@inverse.ca> - Copyright (C) 2008-2020 Inverse inc. + Copyright (C) 2008-2021 Inverse inc. License: GFDL 1.2 or later. http://www.gnu.org/licenses/fdl.html //// +:encoding: UTF-8 +:lang: en +:doctype: book +SOGo v{release_version} +:toc: left +:sectanchors: +:sectlinks: +// Add numbers to each section +:sectnums: +// Remove chapter prefix +:chapter-signifier: +:front-cover-image: image:images/sogo-logo.png[fit=none,pdfwidth=50%,position=center] +:source-highlighter: rouge +:rouge-style: github -// TODO have the build system take care of this - -:release_version: 5.1.1 - +// Above empty line will insert page brake +include::docinfo.asciidoc[] // vim: set syntax=asciidoc tabstop=2 shiftwidth=2 expandtab: