Merge branch 'release/v0.7.4'

Author: tomschr

.github/ISSUE_TEMPLATE/Bug_report.md

@@ -0,0 +1,22 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+## Problem Description
+A clear and concise description of what the bug is.
+
+## To Reproduce
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## Expected Behavior
+A clear and concise description of what you expected to happen.
+
+
+## Additional context
+Add any other context about the problem here like OS, version, etc.

.github/ISSUE_TEMPLATE/Feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/issue_template.md

@@ -2,11 +2,13 @@ syntax: glob
 # Temporary files used by the oXygen editor
 *.~
 *~
+*.bak
 
 # Temporary directories and files by Python
 __pycache__
 *.pyc
 *.pyo
+.tmp/
 
 
 # Temporary files used by the vim editor.

.gitignore

@@ -16,12 +16,13 @@ before_install:
 install:
     - sudo apt-get update -q
     - sudo apt-get install xsltproc
-    - sudo apt-get install libsaxon-java libxml-commons-resolver1.1-java libsaxon-java libxerces2-java
+    - sudo apt-get install libsaxon-java libxml-commons-resolver1.1-java libsaxon-java libxerces2-java fop
     - sudo apt-get install trang jing
     - sudo apt-get install python3 python3-lxml
 
 script:
-    - ./bin/buildbook.py -v --archive
+    - ./bin/buildbook.py -v html --archive
+    - ./bin/buildbook.py -v pdf && mv -vi build/fo/*.pdf .
 
 before_deploy:
     - git config --local user.name "Travis CI"
@@ -34,6 +35,7 @@ deploy:
   file:
     - DBCookBook-$VERSION-html.tar.bz2
     - DBCookBook-$VERSION-html.zip
+    - DBCookBook-$VERSION.pdf
   skip_cleanup: true
   on:
     branch: master

.travis.yml

@@ -0,0 +1,3 @@
+# Contributing to this Book
+
+See http://doccookbook.sf.net/html/en/dbc.preface.contrib.html for more details.

CONTRIBUTING.md

@@ -1,3 +1,16 @@
+-------------------------------------------------------------------
+Mon May 14 08:40:00 UTC 2018 - tom_schr@web.de
+
+Version 0.7.4 Small fixes here and there:
+
+* Update issue template (issue #31)
+* Implement subcommands for pdf and html for building the books (commit
+  88ef68a)
+* Use dbtimestamp PI in pubdate (commit 2208bd4)
+* Corrected old link from code.google.com (issue #26)
+* Update to DocBook 5.1 (commit 6d2c8e8b)
+* Update DocBook XSLT2 stylesheet to v2.3.2 (commit c5e95165)
+
 -------------------------------------------------------------------
 Sat Mar 10 23:25:00 UTC 2018 - tom_schr@web.de
 

Changelog

@@ -4,41 +4,8 @@
 import sys
 import os
 
-from dbcookbook.config import config,  __version__
-from dbcookbook import internaltest
-from dbcookbook.cli import parsecommandline
-from dbcookbook.log import logger, trace, createlogger
-from dbcookbook.env import initenv
-from dbcookbook.formats import html
-from dbcookbook.categories import resolvecategories
-from dbcookbook.zip import createzip
-
-_abspath=os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))+"/"
-
-
-def main():
-    parserobj=parsecommandline()
-    args=parserobj[1]
-    createlogger(args.verbose)
-    
-    logger.debug("CLI arguments: {args}".format(args=args))
-    logger.debug("Found these sections in INI: {sects}".format(sects=config.sections()))
-
-    # Set the absolute path, so we always resolve correctly:
-    config.set('Common', 'abspath', _abspath)
-
-    logger.debug("""Environment:
-    absolute path={path}
-    xhtmldir={xhtmldir}
-    fodir={fodir}
-    """.format(path=_abspath, **dict(config["XSLT1"].items()) ))
-    
-    initenv(*parserobj)
-    resolvecategories(*parserobj)
-    html(*parserobj)
-    createzip(*parserobj)
-    
-    return parserobj
+from dbcookbook.log import logger
+from dbcookbook.main import main
 
 
 def __test():
@@ -48,25 +15,33 @@ def __test():
 
 if __name__=="__main__":
     from configparser import InterpolationMissingOptionError
-    from lxml.etree import XSLTApplyError
+    from lxml.etree import XSLTApplyError, XSLTParseError
+    from subprocess import CalledProcessError
     line="-"*10
 
     try:
         logger.debug("{line} START {line}".format(**locals()))
-        obj = main()
+        result = main()
 
     except (InterpolationMissingOptionError, 
-            NameError, 
-            XSLTApplyError, 
-            FileNotFoundError
+            # NameError, 
+            XSLTApplyError,
+            XSLTParseError,
+            FileNotFoundError,
+            CalledProcessError
            ) as error:
-        logger.critical("{classname}: {error}".format(classname=error.__class__.__name__, error=error))
+        logger.critical("{cls}: {error}".format(cls=error.__class__.__name__,
+                                                error=error))
         sys.exit(10)
 
-    if obj[1].test:
-        internaltest()
+    #if obj[1].test:
+    #    from dbcookbook import internaltest
+    #    internaltest()
 
     logger.info("Success!")
+    # logger.info("Find the result at: ")
     logger.debug("{line} END {line}".format(**locals()))
 
-# EOF
+    sys.exit(result)
+
+# EOF

DocBook-Cookbook.xpr

@@ -1,5 +1,30 @@
 # -*- coding: UTF-8 -*-
 
+from dbcookbook.categories import resolvecategories
+from dbcookbook.env import initenv
+from dbcookbook.formats import html, fo
+from dbcookbook.log import logger
+from dbcookbook.zip import createzip
+
+
+def func_html(parserobj, args):
+    logger.debug("-- Create HTML with %s --" % args)
+    initenv(parserobj, args)
+    resolvecategories(parserobj, args)
+    result = html(parserobj, args)
+    if args.archive:
+        result = createzip(parserobj, args)
+    else:
+        logger.info("Skipping compressed archive creation")
+    return result
+
+
+def func_pdf(parserobj, args):
+    logger.debug("-- Create PDF with %s --", args)
+    initenv(parserobj, args)
+    resolvecategories(parserobj, args)
+    return fo(parserobj, args)
+
 
 def parsecommandline():
     """Parses commandline and returns parser and parsed arguments
@@ -9,9 +34,15 @@ def parsecommandline():
     import argparse
     from .config import __version__, __author__, LOGFILE, MAINFILE
 
+    mainfile = dict(help="Use main XML file  (default: %(default)r)",
+                     default=MAINFILE,
+                     nargs='?',
+                     )
     parser = argparse.ArgumentParser(
         description='Transforms an DocBook XML file into a target format',
     )
+    # Subparsers
+    sp = parser.add_subparsers(dest='subcmd', help='sub-command help')
 
     parser.add_argument('--version',
         action='version',
@@ -60,27 +91,51 @@ def parsecommandline():
         type=int,
         default=1,
         )
-    parser.add_argument('-A', '--archive',
-        help="Create compressed files of the HTML build (default: %(default)s)",
-        action='store_true',
-        default=False,
-        )
-    parser.add_argument('mainfile',
-        help="Use main XML file  (default: %(default)s)",
-        default=MAINFILE,
-        nargs='?',
-        )
+
     # Should go away as soon as the script is stable
     parser.add_argument('--test',
         help="Just for testing",
         action='store_true',
         default=False,
         )
-    
+
+    # HTML Subparser
+    htmlsub = sp.add_parser('html',
+                            help='Generate HTML')
+    # sp.set_defaults(subcommand=None)
+    htmlsub.set_defaults(func=func_html)
+    htmlsub.add_argument('-A', '--archive',
+                         help=("Create compressed files of the HTML build "
+                               "(default: %(default)s)"),
+                         action='store_true',
+                         default=False,
+                         )
+    htmlsub.add_argument('mainfile', **mainfile)
+
+    # FO Subparser
+    fosub = sp.add_parser('pdf',
+                          help='Generate PDF from FO')
+    fosub.set_defaults(func=func_pdf)
+    fosub.add_argument('-f', '--formatter',
+                       choices=('fop', 'xep'),  # axf
+                       default='fop',
+                       help='Format the FO with formatter (default %(default)r)',
+                       )
+    fosub.add_argument('-o', '--output',
+                       # required=False,
+                       help="Save result PDF in OUTPUT"
+                       )
+    fosub.add_argument('--opts',
+                       help=("Pass special options to formatter; "
+                             "keep in mind to quote it correctly")
+                       )
+    fosub.add_argument('mainfile', **mainfile)
+
+
     args=parser.parse_args()
-    
+
     if args.jobs < 0:
         parser.error("argument -j/--job: negative int value: {}. "
                      "Job values have to be positive.".format(args.jobs))
-        
+
     return parser, args