docbook-xsl-update #1

  • //
  • guest/
  • perforce_software/
  • p4convert/
  • main/
  • docs/
  • docbook-xsl-ns-1.78.1/
  • tools/
  • bin/
  • docbook-xsl-update
  • View
  • Commits
  • Open Download .zip Download (1 KB)
#!/bin/bash
# vim: number

# docbook-xsl-update - Update environment to latest docbook-xsl snapshot
# $Id: docbook-xsl-update 9628 2012-10-20 23:52:01Z dcramer $

if [ -z $DOCBOOK_MIRROR ]; then
  myhost=docbook.xml-doc.org:5873;
else
  myhost=$DOCBOOK_MIRROR;
fi

mydir=$(readlink -f $(dirname $0))
mydocbook_xsl_base=$(readlink -f $(dirname $0)/../..)

if [ ! -f $mydocbook_xsl_base/VERSION.xsl ]; then 
  cat <<- EOF
$(basename $0): error: not in snapshot directory. Stopping.

The $(basename $0) script must be installed within its original
location in the tools/bin directory in the docbook-xsl distribution.
EOF
  exit 1
fi

usage="Usage:

  $(basename $0) [-h HOST[:PORT]]

  -h HOST[:PORT]  Specifies the rsync host and port number to use.
                  If not specified, uses the value of the
                  \$DOCBOOK_MIRROR environment variable. If that
                  environment variable is not specified, defaults
                  to a hard-coded value.

"

while getopts "h:" opt; do
  case $opt in
    h  ) myhost=$OPTARG ;;
    \? ) printf "$usage"
         printf "$opts_admon"
         exit 1 ;;
  esac
done

shift $(($OPTIND - 1))

if [ -z $myhost ]; then
  myhost=$DOCBOOK_MIRROR
fi

rsync -auv rsync://$myhost/xsl $mydocbook_xsl_base
# Change User Description Committed
#1 26953 Paul Allen Move //guest/perforce_software/p4convert to //guest/perforce_software/p4convert/main
//guest/perforce_software/p4convert/docs/docbook-xsl-ns-1.78.1/tools/bin/docbook-xsl-update
#2 14806 Paul Allen Update docs and add +w.
#1 13920 Paul Allen copy part 2 (no errors)
//guest/paul_allen/p4convert-maven/docs/docbook-xsl-ns-1.78.1/tools/bin/docbook-xsl-update
#1 13895 Paul Allen Copying using p4convert-docbook
//guest/perforce_software/doc_build/main/docbook-xsl-ns-1.78.1/tools/bin/docbook-xsl-update
#1 12728 eedwards Upgrade ANT doc build infrastructure to assemble PDFs:

- remove non-namespaced DocBook source and add
  namespaced DocBook source.

- add Apache FOP 1.1

- copy fonts, images, XSL into _build, establishing new
  asset structure. The original structure remains until
  all guides using it can be upgraded, and several other
  issues can be resolved.

- updated build.xml to allow for per-target build properties.

- upgraded the P4SAG to use the new infrastructure.

- tweaked admonition presentation in PDFs to remove
  admonition graphics, and resemble closely the
  presentation used in the new HTML layout, including
  the same colors.

With these changes, building PDFs involves using a
shell, navigating into the guide's directory (just P4SAG
for now), and executing "ant pdf".

Issues still to be resolved:

- PDF generation encounters several warnings about
  missing fonts (bold versions of Symbol and ZapfDingbats),
  and a couple of locations where the page content
  exceeds the defined content area.

- Due to issues within Apache FOP, PDF generation emits
  a substantial amount of output that is not easily suppressed
  without losing important warning information.

- Apache FOP's interface to ANT does not expose a way
  to set the font base directory. The current configuration does
  work under Mac OSX, but further testing on Windows will
  need to be done to determine if the relative paths defined
  continue to work. The workaround is for Windows users to
  customize the fop-config.xml to provide absolute system
  paths to the required fonts.

- HTML generation needs further browser testing, and
  exhibits broken navigation on iOS browsers within the
  TOC sidebar.

- A number of PDF and HTML presentation tweaks still
  need to be made, for example: sidebars, gui* DocBook
  tags, whitespace, section separation, etc.