amorfo77/sogo
1
0
Fork 0
mirror of https://github.com/inverse-inc/sogo.git synced 2026-02-17 07:33:57 +00:00
Code Issues Projects Releases Wiki Activity

refactor(doc): replace xsltproc/fop by asciidoctor-pdf

Browse Source
This commit is contained in:
Francis Lachapelle
2021-06-17 12:20:20 -04:00
parent 4a32a5e11c
commit 134502223e
18 changed files with 96 additions and 756 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
Documentation/Makefile
View File

@@ -1,9 +1,29 @@
all: $(patsubst %.asciidoc,%.pdf,$(wildcard *.asciidoc)) all: pdf html
%.pdf : %.asciidoc ASCIIDOCS = $(wildcard SOGo*.asciidoc)
asciidoc -a docinfo1 -b docbook -d book -o $<.docbook $< PDFS = $(patsubst %.asciidoc,%.pdf, $(ASCIIDOCS))
xsltproc -o $<.fo docbook/xsl/sogo-fo.xsl $<.docbook HTML = $(patsubst %.asciidoc,%.html, $(ASCIIDOCS))
fop -c fonts/fop-config.xml $<.fo -pdf $@
%.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: clean:
rm -f *.asciidoc.fo *.asciidoc.docbook *.pdf rm -f *.pdf *.html

7
Documentation/SOGoDevelopersGuide.asciidoc
View File

@@ -1,16 +1,13 @@
Developer's Guide Developer's Guide
================= =================
:toc: left
:icons: font
//// ////
This file is part of the SOGo project. 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[] include::includes/global-attributes.asciidoc[]
UI and UX UI and UX

58
Documentation/SOGoInstallationGuide.asciidoc
View File

@@ -1,16 +1,13 @@
Installation and Configuration Guide Installation and Configuration Guide
==================================== ====================================
:toc: left
:icons: font
//// ////
This file is part of the SOGo project. 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[] include::includes/global-attributes.asciidoc[]
About this Guide 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 To identify the level in which each parameter can be defined, we use the
following abbreviations in the tables of this document: 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 |S |Parameter exclusive to the system and not configurable per domain
|D |Parameter exclusive to a domain and not configurable per user |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: The following table describes the general parameters that can be set:
[cols="^3,47,50a"] [cols="^4,46,50a"]
|======================================================================= |=======================================================================
|S |WOWorkersCount |S |WOWorkersCount
|The amount of instances of SOGo that will be spawned |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_ |Number of seconds, defaults to 300 (or 5 minutes). Note that _SOGoCacheCleanupInterval_
must be set to a value equal or higher than _SOGoRequestBlockInterval_. 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. |Parameter used to enable or not XSRF (also known as CSRF) protection in SOGo.
Default value is `YES`, or enabled. 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 Authentication using LDAP
@@ -918,16 +920,10 @@ would be:
---- ----
The following table describes the possible parameters related to a LDAP 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 |type
|The type of this user source, set to ldap` for an LDAP source. |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 (with read-only access). Note that if set to `NO`, autocompletion will
not work for entries in this source and thus, freebusy lookups. not work for entries in this source and thus, freebusy lookups.
|displayName (optional) !displayName (optional)
|If set as an address book, the human identification name of the LDAP !If set as an address book, the human identification name of the LDAP
repository repository
|listRequiresDot (optional) |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 entry of the SOGoUserSources, but can also defined at the domain and/or
system levels: system levels:
[cols="3,47,50a"] [cols="^4,46,50a"]
|======================================================================= |=======================================================================
|D |SOGoLDAPContactInfoAttribute |D |SOGoLDAPContactInfoAttribute
|Parameter used to specify an attribute that should appear in |Parameter used to specify an attribute that should appear in
@@ -1474,7 +1470,7 @@ OCSSessionsFolderURL =
The following table describes the parameters that were set: The following table describes the parameters that were set:
[cols="3,47,50a"] [cols="^4,46,50a"]
|======================================================================= |=======================================================================
|S |SOGoProfileURL |S |SOGoProfileURL
|Parameter used to set the database URL so that SOGo can retrieve user |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 SOGo can use a SQL-based database server for authentication. The
configuration is very similar to LDAP-based authentication. configuration is very similar to LDAP-based authentication.
The following table describes all the possible parameters related to a The following table describes the possible parameters related to a SQL
SQL source: 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 |type
|The type of this user source, set to `sql` for a SQL source. |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. The following table describes the related parameters.
[cols="3,47,50a"] [cols="^4,46,50a"]
|======================================================================= |=======================================================================
|D |SOGoMailingMechanism |D |SOGoMailingMechanism
|Parameter used to set how SOGo sends mail messages. Possible values |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. The following table describes the related parameters.
[cols="3,47,50a"] [cols="^4,46,50a"]
|======================================================================= |=======================================================================
|U |SOGoDraftsFolderName |U |SOGoDraftsFolderName
|Parameter used to set the IMAP folder name used to store drafts |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 The following additional parameters only affect the Web interface
behaviour of SOGo. behaviour of SOGo.
[cols="3,47,50a"] [cols="^4,46,50a"]
|======================================================================= |=======================================================================
|S |SOGoPageTitle |S |SOGoPageTitle
|Parameter used to define the Web page title. |Parameter used to define the Web page title.
@@ -2591,7 +2581,7 @@ coyote.com):
The following additional parameters only affect SOGo when using multiple The following additional parameters only affect SOGo when using multiple
domains. domains.
[cols="3,47,50a"] [cols="^4,46,50a"]
|======================================================================= |=======================================================================
|S |SOGoEnableDomainBasedUID |S |SOGoEnableDomainBasedUID
|Parameter used to enable user identification by domain. Users will be |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 The following additional parameters only affect SOGo when using
ActiveSync: ActiveSync:
[cols="3,47,50a"] [cols="^4,46,50a"]
|======================================================================= |=======================================================================
|S |SOGoMaximumPingInterval |S |SOGoMaximumPingInterval
|Parameter used to set the maximum amount of time, in seconds, SOGo will |Parameter used to set the maximum amount of time, in seconds, SOGo will

8
Documentation/SOGoMobileDevicesConfigurationGuide.asciidoc
View File

@@ -1,17 +1,13 @@
Mobile Devices Configuration Guide Mobile Devices Configuration Guide
================================== ==================================
:toc: left
:icons: font
//// ////
This file is part of the SOGo project. This file is part of the SOGo project.
See SOGo Mobile Devices Configuration-docinfo.xml for authors, See includes/global-attributes.asciidoc
copyright and license information. for authors, copyright and license information.
//// ////
include::includes/global-attributes.asciidoc[] include::includes/global-attributes.asciidoc[]
About this Guide About this Guide

8
Documentation/SOGoMozillaThunderbirdConfigurationGuide.asciidoc
View File

@@ -1,17 +1,13 @@
Mozilla Thunderbird Configuration Guide Mozilla Thunderbird Configuration Guide
======================================= =======================================
:toc: left
:icons: font
//// ////
This file is part of the SOGo project. This file is part of the SOGo project.
See SOGo Mozilla Thunderbird Configuration Guide-docinfo.xml for See includes/global-attributes.asciidoc
authors, copyright and license information. for authors, copyright and license information.
//// ////
include::includes/global-attributes.asciidoc[] include::includes/global-attributes.asciidoc[]
About this Guide About this Guide

7
Documentation/SOGoOutlookConnectorConfigurationGuide.asciidoc
View File

@@ -1,16 +1,13 @@
Microsoft Outlook CalDAVSynchronizer Configuration Guide Microsoft Outlook CalDAVSynchronizer Configuration Guide
======================================================== ========================================================
:toc: left
:icons: font
//// ////
This file is part of the SOGo project. 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[] include::includes/global-attributes.asciidoc[]
About this Guide About this Guide

16
Documentation/docbook/fop-centos6.patch
View File

@@ -1,16 +0,0 @@
#
# fop fix to build our documentation on CentOS 6
#
# Inverse inc. <info@inverse.ca>
#
--- /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

17
Documentation/docbook/xmlgraphics-fop-centos5.patch
View File

@@ -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. <info@inverse.ca>
#
--- /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

107
Documentation/docbook/xsl/headerfooter-fo.xsl
View File

@@ -1,107 +0,0 @@
<?xml version='1.0'?>
<xsl:stylesheet
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:fo="http://www.w3.org/1999/XSL/Format"
version="1.0">
<!-- ********************************************************************
Header / Footer customizations
This file is part of the SOGo project.
Authors:
- Inverse inc. <info@inverse.ca>
Copyright (C) 2011-2014 Inverse inc.
License: GFDL 1.2 or later. http://www.gnu.org/licenses/fdl.html
******************************************************************** -->
<!--
Here we are re-defining docbook-xsl/fo/pagesetup.xsl to fit our needs.
- top: chapter number on the left
- bottom: copyright, chapter name, page
-->
<xsl:param name="header.rule" select="0"/>
<xsl:template name="header.content">
<xsl:param name="pageclass" select="''"/>
<xsl:param name="sequence" select="''"/>
<xsl:param name="position" select="''"/>
<xsl:param name="gentext-key" select="''"/>
<fo:block>
<!-- sequence can be odd, even, first, blank -->
<!-- position can be left, center, right -->
<xsl:choose>
<xsl:when test="$sequence = 'blank'">
<!-- nothing -->
</xsl:when>
<xsl:when test="($sequence='first' or $sequence='odd' or $sequence='even') and $position='left'">
<xsl:if test="$pageclass != 'titlepage' and $pageclass != 'lot'">
<xsl:call-template name="gentext">
<xsl:with-param name="key" select="'chapter'"/>
</xsl:call-template>
<xsl:call-template name="gentext.space"/>
<xsl:number count="chapter" from="book" level="any"/>
</xsl:if>
</xsl:when>
<!-- draft -->
<xsl:when test="$position='right'">
<xsl:call-template name="draft.text"/>
</xsl:when>
<xsl:otherwise>
<!-- nop -->
</xsl:otherwise>
</xsl:choose>
</fo:block>
</xsl:template>
<xsl:param name="footer.rule" select="0"/>
<xsl:template name="footer.content">
<xsl:param name="pageclass" select="''"/>
<xsl:param name="sequence" select="''"/>
<xsl:param name="position" select="''"/>
<xsl:param name="gentext-key" select="''"/>
<fo:block>
<!-- pageclass can be front, body, back -->
<!-- sequence can be odd, even, first, blank -->
<!-- position can be left, center, right -->
<xsl:choose>
<xsl:when test="$pageclass = 'titlepage'">
<!-- nop; no footer on title pages -->
</xsl:when>
<xsl:when test="$double.sided = 0 and $position='left'">
<xsl:apply-templates select="//copyright[1]" mode="titlepage.mode"/>
</xsl:when>
<xsl:when test="($sequence='first' or $sequence='odd' or $sequence='even') and $position='center'">
<xsl:if test="$pageclass != 'titlepage' and $pageclass != 'lot'">
<xsl:apply-templates select="." mode="titleabbrev.markup"/>
</xsl:if>
</xsl:when>
<xsl:when test="$double.sided = 0 and $position='right'">
<fo:page-number/>
</xsl:when>
<xsl:when test="$sequence='blank'">
<!-- nop -->
</xsl:when>
<xsl:otherwise>
<!-- nop -->
</xsl:otherwise>
</xsl:choose>
</fo:block>
</xsl:template>
</xsl:stylesheet>
<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

182
Documentation/docbook/xsl/sogo-fo.xsl
View File

@@ -1,182 +0,0 @@
<?xml version='1.0'?>
<xsl:stylesheet
xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:fo="http://www.w3.org/1999/XSL/Format"
version="1.0">
<!-- ********************************************************************
SOGo Documentation Docbook FO Parameters
This file is part of the SOGo project.
Authors:
- Inverse inc. <info@inverse.ca>
Copyright (C) 2011-2014 Inverse inc.
License: GFDL 1.2 or later. http://www.gnu.org/licenses/fdl.html
******************************************************************** -->
<!--
Global Tasks
TODO prettier revhistory
TODO prettier Table of Contents
TODO generate PDF table of contents (like OSX's Preview shows on the right hand side)
TODO title 2
- align with text?
- more above whitespace
TODO change the bullet for a prettier one
TODO title 3 and 4
- align with text?
- should be easier to differentiate (check network guide)
TODO icon on line wrap in monospace boxes
TODO caution, notes, warnings, etc.
- box around it
- sexy icon
TODO -> is converted into an arrow but it's not pretty (is it font or docbook-thingy?)
-->
<!--
Load default values
Real upstream schema is at:
<xsl:import href="http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl"/>
but we decided to load all sensible local xsd since it only produce a warning on missing imports.
-->
<!-- CentOS / RHEL -->
<!-- <xsl:import href="/usr/share/sgml/docbook/xsl-stylesheets/fo/docbook.xsl"/> -->
<!-- Debian / Ubuntu -->
<xsl:import href="/usr/share/xml/docbook/stylesheet/docbook-xsl/fo/docbook.xsl"/>
<!-- OSX through mac ports -->
<!-- <xsl:import href="/opt/local/share/xsl/docbook-xsl/fo/docbook.xsl"/> -->
<!-- title page extra styling -->
<xsl:import href="titlepage-fo.xsl"/>
<!-- header / footer extra styling -->
<xsl:import href="headerfooter-fo.xsl"/>
<!-- attaching an image to the verso legalnotice component -->
<xsl:template match="legalnotice" mode="book.titlepage.verso.mode">
<xsl:apply-templates mode="titlepage.mode"/>
<fo:block text-align="right">
<fo:external-graphic src="url('images/inverse-logo.jpg')" width="3in" content-width="scale-to-fit"/>
</fo:block>
</xsl:template>
<!-- stylesheet options -->
<xsl:param name="title.font.family">Lato-Medium</xsl:param>
<xsl:param name="chapter.autolabel" select="0"/>
<xsl:attribute-set name="component.title.properties">
<xsl:attribute name="padding-bottom">2.5em</xsl:attribute>
<xsl:attribute name="border-bottom">solid 2px</xsl:attribute>
<xsl:attribute name="margin-bottom">1em</xsl:attribute>
</xsl:attribute-set>
<xsl:attribute-set name="section.title.level1.properties">
<xsl:attribute name="border-bottom">solid 1px</xsl:attribute>
<xsl:attribute name="margin-top">2em</xsl:attribute>
<xsl:attribute name="margin-bottom">1em</xsl:attribute>
</xsl:attribute-set>
<!-- titles spacing -->
<xsl:attribute-set name="section.title.level2.properties">
<xsl:attribute name="margin-top">1em</xsl:attribute>
</xsl:attribute-set>
<!-- default fonts -->
<xsl:param name="body.font.family">Lato-Light</xsl:param>
<xsl:param name="body.font.master">10</xsl:param>
<xsl:param name="monospace.font.family">Incosolata</xsl:param>
<!-- revision table layout -->
<xsl:attribute-set name="revhistory.title.properties">
<xsl:attribute name="font-size">12pt</xsl:attribute>
<xsl:attribute name="font-weight">bold</xsl:attribute>
<xsl:attribute name="text-align">center</xsl:attribute>
</xsl:attribute-set>
<xsl:attribute-set name="revhistory.table.properties">
<xsl:attribute name="break-before">page</xsl:attribute>
</xsl:attribute-set>
<xsl:attribute-set name="revhistory.table.cell.properties">
<xsl:attribute name="border-bottom">1px solid</xsl:attribute>
</xsl:attribute-set>
<!-- Table Of Contents (TOC) options -->
<!-- We only want 2 level of ToC depth -->
<xsl:param name="toc.section.depth" select="1"/>
<!-- titles left margin -->
<xsl:attribute-set name="section.title.properties">
<xsl:attribute name="start-indent"><xsl:value-of select="$body.start.indent"/></xsl:attribute>
</xsl:attribute-set>
<!-- lists type -->
<xsl:template name="itemizedlist.label.markup">
<xsl:param name="itemsymbol" select="'square'"/>
<xsl:choose>
<xsl:when test="$itemsymbol='square'"><fo:inline font-family="Lato-Light">&#x25aa;</fo:inline></xsl:when>
</xsl:choose>
</xsl:template>
<xsl:template name="next.itemsymbol">
<xsl:param name="itemsymbol" select="'square'"/>
<xsl:choose>
<xsl:when test="$itemsymbol='square'">square</xsl:when>
</xsl:choose>
</xsl:template>
<!-- admonition -->
<xsl:param name="admon.graphics" select="1"></xsl:param>
<xsl:param name="admon.graphics.path">images/</xsl:param>
<xsl:param name="admon.graphics.extension">.png</xsl:param>
<xsl:attribute-set name="graphical.admonition.properties">
<xsl:attribute name="border-top">1px solid</xsl:attribute>
<xsl:attribute name="border-bottom">1px solid</xsl:attribute>
<xsl:attribute name="padding-top">0.5em</xsl:attribute>
<xsl:attribute name="padding-bottom">0.5em</xsl:attribute>
<xsl:attribute name="margin-left">2em</xsl:attribute>
</xsl:attribute-set>
<!-- grey boxes around code (screen, programlisting) -->
<xsl:param name="shade.verbatim" select="1"/>
<xsl:attribute-set name="shade.verbatim.style">
<xsl:attribute name="background-color">#E0E0E0</xsl:attribute>
<xsl:attribute name="border">thin #9F9F9F solid</xsl:attribute>
<xsl:attribute name="margin">0pt</xsl:attribute>
<xsl:attribute name="padding">0.5em</xsl:attribute>
<!-- prevent page breaks in screen and programlisting tags -->
<xsl:attribute name="keep-together.within-column">always</xsl:attribute>
</xsl:attribute-set>
<!-- breaking long lines in code (screen, programlisting) -->
<xsl:attribute-set name="monospace.verbatim.properties">
<xsl:attribute name="wrap-option">wrap</xsl:attribute>
</xsl:attribute-set>
<!-- don't show raw links in [ .. ] after a link -->
<xsl:param name="ulink.show" select="0"/>
<!-- blue underlined hyperlink -->
<xsl:attribute-set name="xref.properties">
<xsl:attribute name="color">blue</xsl:attribute>
<xsl:attribute name="text-decoration">underline</xsl:attribute>
</xsl:attribute-set>
<!-- strong emphasis in bold -->
<xsl:template match="emphasis[@role='strong']">
<fo:inline font-family="Lato" font-weight="normal">
<xsl:apply-templates/>
</fo:inline>
</xsl:template>
<!-- copyright in range instead of seperated years -->
<xsl:param name="make.year.ranges" select="1" />
<!-- variablelist behavior (asciidoc's term:: lists) -->
<!-- <xsl:param name="variablelist.term.break.after" select="1" /> -->
</xsl:stylesheet>
<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

96
Documentation/docbook/xsl/titlepage-fo.xml
View File

@@ -1,96 +0,0 @@
<!DOCTYPE t:templates [
<!ENTITY hsize0 "10pt">
<!ENTITY hsize1 "12pt">
<!ENTITY hsize2 "14.4pt">
<!ENTITY hsize3 "17.28pt">
<!ENTITY hsize4 "20.736pt">
<!ENTITY hsize5 "24.8832pt">
<!ENTITY hsize0space "7.5pt"> <!-- 0.75 * hsize0 -->
<!ENTITY hsize1space "9pt"> <!-- 0.75 * hsize1 -->
<!ENTITY hsize2space "10.8pt"> <!-- 0.75 * hsize2 -->
<!ENTITY hsize3space "12.96pt"> <!-- 0.75 * hsize3 -->
<!ENTITY hsize4space "15.552pt"> <!-- 0.75 * hsize4 -->
<!ENTITY hsize5space "18.6624pt"> <!-- 0.75 * hsize5 -->
]>
<t:templates xmlns:t="http://nwalsh.com/docbook/xsl/template/1.0"
xmlns:param="http://nwalsh.com/docbook/xsl/template/1.0/param"
xmlns:fo="http://www.w3.org/1999/XSL/Format"
xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<!-- ********************************************************************
SOGo title page
This file is part of the SOGo project.
Authors:
- Inverse inc. <info@inverse.ca>
Copyright (C) 2011-2014 Inverse inc.
License: GFDL 1.2 or later. http://www.gnu.org/licenses/fdl.html
******************************************************************** -->
<!--
If you make changes you need to rebuild XSL:
xsltproc -o docs/docbook/xsl/titlepage-fo.xsl \
/usr/share/xml/docbook/stylesheet/docbook-xsl/template/titlepage.xsl \
docs/docbook/xsl/titlepage-fo.xml
On some platforms the titlepage.xsl is located elsewhere:
* OSX: /opt/local/share/xsl/docbook-xsl/template/titlepage.xsl
This is a customized version of docbook-xsl/fo/titlepage.templates.xml.
I removed every section except the book one. Feel free to add more if more
customization are required.
-->
<t:titlepage t:element="book" t:wrapper="fo:block">
<t:titlepage-content t:side="recto">
<mediaobject/>
<title
t:named-template="division.title"
param:node="ancestor-or-self::book[1]"
text-align="right"
font-size="&hsize5;"
space-before="&hsize5space;"
font-weight="bold"
font-family="{$title.fontset}"
margin-top="8em"/>
<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>

208
Documentation/docbook/xsl/titlepage-fo.xsl
View File

@@ -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 &gt; 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 &gt; 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>

24
Documentation/docinfo.xml
View File

@@ -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>

32
Documentation/fonts/fop-config.xml
View File

@@ -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>

1
Documentation/fonts/inconsolata.xml
View File

File diff suppressed because one or more lines are too long

14
Documentation/includes/commercial-support.asciidoc
View File

@@ -6,7 +6,7 @@
Authors: Authors:
- Inverse inc. <info@inverse.ca> - 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 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 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 Hourly rates or support packages are offered to best suit your needs.
services around SOGo to help organizations deploy the solution and
migrate from their legacy systems. Please visit https://inverse.ca/ for details.
// vim: set syntax=asciidoc tabstop=2 shiftwidth=2 expandtab: // vim: set syntax=asciidoc tabstop=2 shiftwidth=2 expandtab:

13
Documentation/includes/docinfo.asciidoc Normal file
View File

@@ -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"]

22
Documentation/includes/global-attributes.asciidoc
View File

@@ -6,13 +6,25 @@
Authors: Authors:
- Inverse inc. <info@inverse.ca> - 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 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 // Above empty line will insert page brake
include::docinfo.asciidoc[]
:release_version: 5.1.1
// vim: set syntax=asciidoc tabstop=2 shiftwidth=2 expandtab: // vim: set syntax=asciidoc tabstop=2 shiftwidth=2 expandtab: