aboutsummaryrefslogtreecommitdiff
path: root/misc/Publican
diff options
context:
space:
mode:
authorNikos Giotis <nikos.giotis@gmail.com>2018-02-12 11:13:04 +0000
committerWilly Sudiarto Raharjo <willysr@slackbuilds.org>2018-02-17 07:42:54 +0700
commit35ac55945d62be5b3e3e086826e2b3a023702e66 (patch)
treea2d9f20d77f15d5914b6e38bd5b739a9bd1f4578 /misc/Publican
parent0475d55c77de2d9ed3d388a53804f7f20075fcd3 (diff)
misc/Publican: Added (Tool for publishing DocBook XML).
Signed-off-by: David Spencer <idlemoor@slackbuilds.org>
Diffstat (limited to 'misc/Publican')
-rw-r--r--misc/Publican/Publican.SlackBuild135
-rw-r--r--misc/Publican/Publican.info22
-rw-r--r--misc/Publican/README28
-rw-r--r--misc/Publican/catalog27
-rw-r--r--misc/Publican/doinst.sh14
-rw-r--r--misc/Publican/slack-desc19
6 files changed, 245 insertions, 0 deletions
diff --git a/misc/Publican/Publican.SlackBuild b/misc/Publican/Publican.SlackBuild
new file mode 100644
index 0000000000000..c765e2a19befd
--- /dev/null
+++ b/misc/Publican/Publican.SlackBuild
@@ -0,0 +1,135 @@
+#!/bin/sh
+
+# Slackware build script for Publican
+
+# Copyright 2018 Nikos Giotis <nikos.giotis@gmail.com>, Athens, GR
+# All rights reserved.
+#
+# Redistribution and use of this script, with or without modification, is
+# permitted provided that the following conditions are met:
+#
+# 1. Redistributions of this script must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+#
+# THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
+# WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+# EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+# OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+# OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+# ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+PRGNAM=Publican
+VERSION=${VERSION:-4.3.2}
+BUILD=${BUILD:-1}
+TAG=${TAG:-_SBo}
+
+SRCNAM="$(printf $PRGNAM | cut -d- -f2-)"
+
+if [ -z "$ARCH" ]; then
+ case "$( uname -m )" in
+ i?86) ARCH=i586 ;;
+ arm*) ARCH=arm ;;
+ *) ARCH=$( uname -m ) ;;
+ esac
+fi
+
+CWD=$(pwd)
+TMP=${TMP:-/tmp/SBo}
+PKG=$TMP/package-$PRGNAM
+OUTPUT=${OUTPUT:-/tmp}
+
+if [ "$ARCH" = "i586" ]; then
+ SLKCFLAGS="-O2 -march=i586 -mtune=i686"
+ LIBDIRSUFFIX=""
+elif [ "$ARCH" = "i686" ]; then
+ SLKCFLAGS="-O2 -march=i686 -mtune=i686"
+ LIBDIRSUFFIX=""
+elif [ "$ARCH" = "x86_64" ]; then
+ SLKCFLAGS="-O2 -fPIC"
+ LIBDIRSUFFIX="64"
+else
+ SLKCFLAGS="-O2"
+ LIBDIRSUFFIX=""
+fi
+
+set -e
+
+rm -rf $PKG
+mkdir -p $TMP $PKG $OUTPUT
+cd $TMP
+rm -rf $SRCNAM-v$VERSION
+tar xvf $CWD/$SRCNAM-v$VERSION.tar.gz
+cd $SRCNAM-v$VERSION
+chown -R root:root .
+find -L . \
+ \( -perm 777 -o -perm 775 -o -perm 750 -o -perm 711 -o -perm 555 \
+ -o -perm 511 \) -exec chmod 755 {} \; -o \
+ \( -perm 666 -o -perm 664 -o -perm 640 -o -perm 600 -o -perm 444 \
+ -o -perm 440 -o -perm 400 \) -exec chmod 644 {} \;
+
+######################################################################################################
+# The following can be used to patch Publican to work around docbook validation issues
+# Don't use this, unless you know what you are doing!!!
+# This method produces documents that are depended upon the system's path
+#for i in $(find . -name '*.xml' -o -name '*.xmlt' -o -name '*.pm' -o -name '*.po' -o -name '*.xsl'); do
+# echo "patching $i"
+# sed -i 's|http://www.oasis-open.org/docbook/xml/4.5/dbcentx.mod|/usr/share/xml/docbook/xml-dtd-4.5/dbcentx.mod|g' $i
+# sed -i 's|http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd|/usr/share/xml/docbook/xml-dtd-4.5/docbookx.dtd|g' $i
+# sed -i 's|http://www.oasis-open.org/docbook/xml/$dtdver/docbookx.dtd|/usr/share/xml/docbook/xml-dtd-$dtdver/docbookx.dtd|g' $i
+#done
+#sed -i 's|PATH|file://usr/share/xml/docbook/xml-dtd-4.5/dbcentx.mod|g' catalog
+#sed -i 's|/usr/share/sgml/docbook|/usr/share/xml/docbook/xml|g' publican.spec
+######################################################################################################
+
+# Don't build regression tests in the user's guide
+sed -i 's|#condition: prod|condition: prod|g' Users_Guide/publican.cfg
+
+# Use the provided docbook xml catalog for building - some validation requires network to work
+sed -i "s|use warnings;|\$ENV{XML_CATALOG_FILES} = '$CWD/catalog';\nuse warnings;|1" bin/publican
+export XML_CATALOG_FILES=$CWD/catalog
+
+perl Build.PL --installdirs vendor \
+ --config installvendorman1dir=/usr/man/man1 \
+ --config installvendorman3dir=/usr/man/man3 \
+
+./Build
+./Build test verbose=1
+./Build install \
+ --destdir $PKG
+
+# Fix xml validation errors for docbook 4.5 for the resulting package
+# by using the provided docbook 4.5 catalog
+cp $CWD/catalog $PKG/usr/share/publican/catalog
+sed -i "s|$CWD/catalog|/usr/share/publican/catalog|1" $PKG/usr/bin/publican
+
+find $PKG -print0 | xargs -0 file | grep -e "executable" -e "shared object" | grep ELF \
+ | cut -f 1 -d : | xargs strip --strip-unneeded 2> /dev/null || true
+
+find $PKG/usr/man -type f -exec gzip -9 {} \;
+for i in $( find $PKG/usr/man -type l ) ; do ln -s $( readlink $i ).gz $i.gz ; rm $i ; done
+
+find $PKG -name perllocal.pod -o -name ".packlist" -o -name "*.bs" | xargs rm -f || true
+
+find $PKG -depth -type d -empty -delete || true
+
+mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION
+cp -a \
+ COPYING LICENSE README TODO \
+ $PKG/usr/doc/$PRGNAM-$VERSION
+mkdir -p $PKG/usr/doc/$PRGNAM-$VERSION/Users_Guide
+cp -a Users_Guide/build/en-US/html-desktop/* $PKG/usr/doc/$PRGNAM-$VERSION/Users_Guide
+cat $CWD/$PRGNAM.SlackBuild > $PKG/usr/doc/$PRGNAM-$VERSION/$PRGNAM.SlackBuild
+
+mv $PKG/etc/publican-website.cfg $PKG/etc/publican-website.cfg.new
+
+mkdir -p $PKG/install
+cat $CWD/slack-desc > $PKG/install/slack-desc
+cat $CWD/doinst.sh > $PKG/install/doinst.sh
+
+cd $PKG
+/sbin/makepkg -l y -c n $OUTPUT/$PRGNAM-$VERSION-$ARCH-$BUILD$TAG.${PKGTYPE:-tgz}
diff --git a/misc/Publican/Publican.info b/misc/Publican/Publican.info
new file mode 100644
index 0000000000000..9f414d627bcac
--- /dev/null
+++ b/misc/Publican/Publican.info
@@ -0,0 +1,22 @@
+PRGNAM="Publican"
+VERSION="4.3.2"
+HOMEPAGE="https://sourceware.org/publican/en-US/index.html"
+DOWNLOAD="https://sourceware.org/publican/releases/Publican-v4.3.2.tar.gz"
+MD5SUM="7f9726fe568b6b686f4bbe1fe2dd5439"
+DOWNLOAD_x86_64=""
+MD5SUM_x86_64=""
+REQUIRES="perl-Archive-Zip perl-Config-Simple \
+ perl-DateTime-Format-DateParse perl-File-Copy-Recursive \
+ perl-File-Find-Rule perl-File-HomeDir perl-File-Inplace \
+ perl-File-Slurp perl-File-Which perl-File-pushd perl-HTML-Formatter \
+ perl-HTML-FormatText-WithLinks \
+ perl-HTML-FormatText-WithLinks-AndTables perl-HTML-Tree \
+ perl-HTML-WikiConverter-Markdown perl-IO-String perl-Lingua-EN-Fathom \
+ perl-List-MoreUtils perl-Locale-Maketext-Lexicon \
+ perl-Locale-Maketext-Gettext perl-Locale-Msgfmt perl-Locale-PO \
+ perl-Module-Build perl-Sort-Versions perl-String-Similarity \
+ perl-Syntax-Highlight-Engine-Kate perl-Template-Toolkit \
+ perl-Text-CSV_XS perl-xml-libxml perl-XML-LibXSLT \
+ perl-XML-TreeBuilder perl-DBD-SQLite perl-yaml wkhtmltox"
+MAINTAINER="Nikos Giotis"
+EMAIL="nikos.giotis@gmail.com"
diff --git a/misc/Publican/README b/misc/Publican/README
new file mode 100644
index 0000000000000..01189cdb172af
--- /dev/null
+++ b/misc/Publican/README
@@ -0,0 +1,28 @@
+Publican is a single source publishing tool based on DocBook XML.
+
+Important notes:
+
+While building the package an active network connection is required for
+both 4.5 and 5.0 document validation to work correctly.
+
+This package provides a fixed docbook catalog located at
+/usr/share/publican/catalog. Publican is patched to always use this
+catalog. There are some problems with docbook validation with the
+original slackware dockbook catalog and Publican's dependencies that
+result in validation problems and failures for docbook 4.5 documents.
+
+For more details see
+https://www.linuxquestions.org/questions/slackware-14/linuxdoc-tools-problem-when-validating-docbook-4-5-documents-4175623483/
+
+The resulting package picks the appropriate slackware's docbook 4.5
+xml's using the provided fixed catalog for docbook 4.5 documents. For
+documents that are written in docbook 5.0 an active network connection
+is required since docbook 5.0 is not included in slackware-14.2.
+
+fop is an alternative dependency to wkhtmltox for producing pdf
+documents. fop use is deprecated upstream and Publican is not
+compatible with fop version 2.0, an older fop version is required.
+The recommended dependency for correct pdf's is wkhtmltox.
+
+For more information on how to use publican, see the user's guide in
+/usr/doc/Publican-4.3.2/Users_Guide
diff --git a/misc/Publican/catalog b/misc/Publican/catalog
new file mode 100644
index 0000000000000..4b1ffc954acc7
--- /dev/null
+++ b/misc/Publican/catalog
@@ -0,0 +1,27 @@
+<?xml version="1.0"?>
+<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">
+<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
+ <public publicId="-//OASIS//DTD DocBook XML V4.5//EN" uri="file:///usr/share/xml/docbook/xml-dtd-4.5/docbookx.dtd"/>
+ <public publicId="-//OASIS//DTD DocBook CALS Table Model V4.5//EN" uri="file:///usr/share/xml/docbook/xml-dtd-4.5/calstblx.dtd"/>
+ <public publicId="-//OASIS//DTD XML Exchange Table Model 19990315//EN" uri="file:///usr/share/xml/docbook/xml-dtd-4.5/soextblx.dtd"/>
+ <public publicId="-//OASIS//ELEMENTS DocBook Information Pool V4.5//EN" uri="file:///usr/share/xml/docbook/xml-dtd-4.5/dbpoolx.mod"/>
+ <public publicId="-//OASIS//ELEMENTS DocBook Document Hierarchy V4.5//EN" uri="file:///usr/share/xml/docbook/xml-dtd-4.5/dbhierx.mod"/>
+ <public publicId="-//OASIS//ELEMENTS DocBook XML HTML Tables V4.5//EN" uri="file:///usr/share/xml/docbook/xml-dtd-4.5/htmltblx.mod"/>
+ <public publicId="-//OASIS//ENTITIES DocBook Notations V4.5//EN" uri="file:///usr/share/xml/docbook/xml-dtd-4.5/dbnotnx.mod"/>
+ <public publicId="-//OASIS//ENTITIES DocBook Character Entities V4.5//EN" uri="file:///usr/share/xml/docbook/xml-dtd-4.5/dbcentx.mod"/>
+ <public publicId="-//OASIS//ENTITIES DocBook Additional General Entities V4.5//EN" uri="file:///usr/share/xml/docbook/xml-dtd-4.5/dbgenent.mod"/>
+ <rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/xml/4.5" rewritePrefix="file:///usr/share/xml/docbook/xml-dtd-4.5"/>
+ <rewriteURI uriStartString="http://www.oasis-open.org/docbook/xml/4.5" rewritePrefix="file:///usr/share/xml/docbook/xml-dtd-4.5"/>
+ <public publicId="-//OASIS//DTD DocBook XML V4.1.2//EN" uri="http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"/>
+ <rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/xml/4.1.2" rewritePrefix="file:///usr/share/xml/docbook/xml-dtd-4.5"/>
+ <rewriteURI uriStartString="http://www.oasis-open.org/docbook/xml/4.1.2" rewritePrefix="file:///usr/share/xml/docbook/xml-dtd-4.5"/>
+ <public publicId="-//OASIS//DTD DocBook XML V4.2//EN" uri="http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"/>
+ <rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/xml/4.2" rewritePrefix="file:///usr/share/xml/docbook/xml-dtd-4.5"/>
+ <rewriteURI uriStartString="http://www.oasis-open.org/docbook/xml/4.2" rewritePrefix="file:///usr/share/xml/docbook/xml-dtd-4.5"/>
+ <public publicId="-//OASIS//DTD DocBook XML V4.3//EN" uri="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"/>
+ <rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/xml/4.3" rewritePrefix="file:///usr/share/xml/docbook/xml-dtd-4.5"/>
+ <rewriteURI uriStartString="http://www.oasis-open.org/docbook/xml/4.3" rewritePrefix="file:///usr/share/xml/docbook/xml-dtd-4.5"/>
+ <public publicId="-//OASIS//DTD DocBook XML V4.4//EN" uri="http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"/>
+ <rewriteSystem systemIdStartString="http://www.oasis-open.org/docbook/xml/4.4" rewritePrefix="file:///usr/share/xml/docbook/xml-dtd-4.5"/>
+ <rewriteURI uriStartString="http://www.oasis-open.org/docbook/xml/4.4" rewritePrefix="file:///usr/share/xml/docbook/xml-dtd-4.5"/>
+</catalog>
diff --git a/misc/Publican/doinst.sh b/misc/Publican/doinst.sh
new file mode 100644
index 0000000000000..c899c943f9bed
--- /dev/null
+++ b/misc/Publican/doinst.sh
@@ -0,0 +1,14 @@
+config() {
+ NEW="$1"
+ OLD="$(dirname $NEW)/$(basename $NEW .new)"
+ # If there's no config file by that name, mv it over:
+ if [ ! -r $OLD ]; then
+ mv $NEW $OLD
+ elif [ "$(cat $OLD | md5sum)" = "$(cat $NEW | md5sum)" ]; then
+ # toss the redundant copy
+ rm $NEW
+ fi
+ # Otherwise, we leave the .new copy for the admin to consider...
+}
+
+config etc/publican-website.cfg.new
diff --git a/misc/Publican/slack-desc b/misc/Publican/slack-desc
new file mode 100644
index 0000000000000..eca1b7965eff8
--- /dev/null
+++ b/misc/Publican/slack-desc
@@ -0,0 +1,19 @@
+# HOW TO EDIT THIS FILE:
+# The "handy ruler" below makes it easier to edit a package description.
+# Line up the first '|' above the ':' following the base package name, and
+# the '|' on the right side marks the last column you can put a character in.
+# You must make exactly 11 lines for the formatting to be correct. It's also
+# customary to leave one space after the ':' except on otherwise blank lines.
+
+ |-----handy-ruler------------------------------------------------------|
+Publican: Publican (Tool for publishing material authored in DocBook XML)
+Publican:
+Publican: Publican is a publication system, not just a DocBook processing tool.
+Publican: As well as ensuring your DocBook XML is valid, Publican works to
+Publican: ensure your XML is up to publishable standard.
+Publican:
+Publican: NOTE: Building Publican requires an active network connection!
+Publican: Resulting package requires network for docbook 5.0 documents,
+Publican: since only docbook 4.5 is included in slackware. See README.
+Publican:
+Publican: Homepage: https://sourceware.org/publican/en-US/index.html