docgen-tool 2.1.3 → 3.0.1

package/{source → dist/source}/docgen.js

@@ -1,172 +1,160 @@
-
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 var rsvp = require('rsvp');
 var fs = require('fs-extra');
 var path = require('path');
 var cheerio = require('cheerio');
-var markdown = require('markdown-it')('commonmark').enable('table');;
+var markdown = require('markdown-it')('commonmark').enable('table');
 var moment = require('moment');
-var childProcess = require("child_process");
-var schemaValidator = require("z-schema");
+var child_process_1 = require("child_process");
+var schemaValidator = require('z-schema');
 var chalk = require('chalk');
 var spawnArgs = require('spawn-args');
 var cliSpinner = require('cli-spinner').Spinner;
 var imageSizeOf = require('image-size');
-
 //Allow CommonMark links that use other protocols, such as file:///
 //The markdown-it implementation is more restrictive than the CommonMark spec
 //See https://github.com/markdown-it/markdown-it/issues/108
-markdown.validateLink = function () { return true; } 
-
+markdown.validateLink = function () {
+    return true;
+};
 /**
-* DocGen class
-*/
-
-function DocGen (process)
-{
+ * DocGen class
+ */
+function DocGen(process) {
     var mainProcess = process;
-    var version = '2.1.3';
-    var wkhtmltopdfVersion = 'wkhtmltopdf 0.12.2.1 (with patched qt)'; //output from wkhtmltopdf -V
+    var version = '3.0.1';
+    var wkhtmltopdfVersion = 'wkhtmltopdf 0.12.6 (with patched qt)'; //output from wkhtmltopdf -V
     var options;
     var templates = {};
     var meta = {};
     var pages = {};
     var sortedPages = {};
-
     this.getVersion = function () {
         return version;
-    }
-
+    };
     this.setOptions = function (userOptions) {
         options = userOptions;
         //all user-specified paths must be normalized
         if (options.input) {
-            options.input = path.normalize(options.input+'/');
+            options.input = path.normalize(options.input + '/');
         }
         if (options.output) {
-            options.output = path.normalize(options.output+'/');
+            options.output = path.normalize(options.output + '/');
         }
-
         //wkhtmltopdf path does not need a trailing slash
         if (options.wkhtmltopdfPath && options.wkhtmltopdfPath !== '') {
             options.wkhtmltopdfPath = path.normalize(options.wkhtmltopdfPath);
         }
-    }
-
+    };
     /*
-        copy the example source files (template) to any directory, when scaffold command is invoked
+      copy the example source files (template) to any directory, when scaffold command is invoked
     */
-
     this.scaffold = function () {
         console.log(chalk.green('Creating scaffold template directory'));
-        copyDirSync(__dirname+'/example', options.output);
-    }
-
+        copyDirSync(__dirname + '/example', options.output);
+    };
     this.run = function () {
-        console.log(chalk.green.bold('DocGen version '+version));
+        console.log(chalk.green.bold('DocGen version ' + version));
         //delete and recreate the output directory
         remakeDirSync(options.output);
         loadTemplates();
-    }
-
+    };
     /*
-        read any file (async)
-    */
-
+          read any file (async)
+      */
     var readFile = function (path) {
         return new rsvp.Promise(function (resolve, reject) {
-            fs.readFile (path, 'utf8', function (error, data) {
+            fs.readFile(path, 'utf8', function (error, data) {
                 if (error) {
-                    console.log(chalk.red('Error reading file: '+path));
+                    console.log(chalk.red('Error reading file: ' + path));
                     reject(error);
-                } else {
+                }
+                else {
                     data = data.replace(/^\uFEFF/, ''); //remove the BOM (byte-order-mark) from UTF-8 files, if present
                     resolve(data);
                 }
             });
         });
-    }
-
+    };
     /*
-        write any file (async)
-    */
-
+          write any file (async)
+      */
     var writeFile = function (path, data) {
         return new rsvp.Promise(function (resolve, reject) {
             fs.writeFile(path, data, function (error) {
                 if (error) {
-                    console.log(chalk.red('Error writing file: '+path));
+                    console.log(chalk.red('Error writing file: ' + path));
                     reject(error);
-                } else {
+                }
+                else {
                     resolve(true);
                 }
             });
         });
-    }
-
+    };
     /*
-        copy any directory (sync)
-    */
-
+          copy any directory (sync)
+      */
     var copyDirSync = function (source, destination) {
         try {
             fs.copySync(source, destination);
-        } catch (error) {
-            console.log(chalk.red('Error copying directory: '+source+' to '+destination));
+        }
+        catch (error) {
+            console.log(chalk.red('Error copying directory: ' + source + ' to ' + destination));
             if (options.verbose === true) {
                 console.log(chalk.red(error));
                 mainProcess.exit(1);
             }
         }
-    }
-
+    };
     /*
-        remake a directory (sync) ... remove and then mkdir in one operation
-    */
-
+          remake a directory (sync) ... remove and then mkdir in one operation
+      */
     var remakeDirSync = function (path) {
         try {
             fs.removeSync(path);
             fs.mkdirpSync(path);
-        } catch (error) {
-            console.log(chalk.red('Error recreating directory: '+path));
+        }
+        catch (error) {
+            console.log(chalk.red('Error recreating directory: ' + path));
             if (options.verbose === true) {
                 console.log(chalk.red(error));
                 mainProcess.exit(1);
             }
         }
-    }
-
+    };
     /*
-        remove any directory (sync)
-    */
-
+          remove any directory (sync)
+      */
     var removeDirSync = function (path) {
         try {
             fs.removeSync(path);
-        } catch (error) {
-            console.log(chalk.red('Error removing directory: '+path));
+        }
+        catch (error) {
+            console.log(chalk.red('Error removing directory: ' + path));
             if (options.verbose === true) {
                 console.log(chalk.red(error));
                 mainProcess.exit(1);
             }
         }
-    }
-
+    };
     /*
-        load all HTML template files
-    */
-
+          load all HTML template files
+      */
     var loadTemplates = function () {
         console.log(chalk.green('Loading templates'));
         var files = {
-            main: readFile(__dirname+'/templates/main.html'),
-            redirect: readFile(__dirname+'/templates/redirect.html'),
-            webCover: readFile(__dirname+'/templates/webCover.html'),
-            pdfCover: readFile(__dirname+'/templates/pdfCover.html'),
-            pdfHeader: readFile(__dirname+'/templates/pdfHeader.html'),
-            pdfFooter: readFile(__dirname+'/templates/pdfFooter.html'),
+            main: readFile(__dirname + '/templates/main.html'),
+            redirect: readFile(__dirname + '/templates/redirect.html'),
+            webCover: readFile(__dirname + '/templates/webCover.html'),
+            pdfCover: readFile(__dirname + '/templates/pdfCover.html'),
+            pdfHeader: readFile(__dirname + '/templates/pdfHeader.html'),
+            pdfFooter: readFile(__dirname + '/templates/pdfFooter.html'),
         };
-        rsvp.hash(files).then(function(files) {
+        rsvp
+            .hash(files)
+            .then(function (files) {
             for (var key in files) {
                 if (files.hasOwnProperty(key)) {
                     var file = files[key];
@@ -175,163 +163,180 @@ function DocGen (process)
                 }
             }
             loadMeta();
-        }).catch(function(error) {
+        })
+            .catch(function (error) {
             console.log(chalk.red('Error loading templates'));
             if (options.verbose === true) {
                 console.log(chalk.red(error));
             }
             mainProcess.exit(1);
         });
-    }
-
+    };
     /*
-        JSON schema validation
+      JSON schema validation
     */
-
     var schemas = {
-        "parameters" : {
-            title: "DocGen Parameters Schema",
-            type: "object",
+        parameters: {
+            title: 'DocGen Parameters Schema',
+            type: 'object',
             required: [
-                "title",
-                "name",
-                "version",
-                "date",
-                "organization",
-                "author",
-                "owner",
-                "contributors",
-                "website",
-                "module",
-                "id",
-                "summary",
-                "marking",
-                "legalese"
+                'title',
+                'name',
+                'version',
+                'date',
+                'organization',
+                'author',
+                'owner',
+                'contributors',
+                'website',
+                'module',
+                'id',
+                'summary',
+                'marking',
+                'legalese',
             ],
             properties: {
-                title: { type: "string" },
-                name: { type: "string" },
-                version: { type: "string" },
-                date: { type: "string" },
+                title: { type: 'string' },
+                name: { type: 'string' },
+                version: { type: 'string' },
+                date: { type: 'string' },
                 organization: {
-                    type : "object",
-                    required: [ "name", "url"],
+                    type: 'object',
+                    required: ['name', 'url'],
                     properties: {
-                        name: { type: "string" },
-                        url: { type: "string" },
-                    }
+                        name: { type: 'string' },
+                        url: { type: 'string' },
+                    },
                 },
                 author: {
-                    type : "object",
-                    required: [ "name", "url"],
+                    type: 'object',
+                    required: ['name', 'url'],
                     properties: {
-                        name: { type: "string" },
-                        url: { type: "string" },
-                    }
+                        name: { type: 'string' },
+                        url: { type: 'string' },
+                    },
                 },
                 owner: {
-                    type : "object",
-                    required: [ "name", "url"],
+                    type: 'object',
+                    required: ['name', 'url'],
                     properties: {
-                        name: { type: "string" },
-                        url: { type: "string" },
-                    }
+                        name: { type: 'string' },
+                        url: { type: 'string' },
+                    },
                 },
                 contributors: {
-                    type : "array",
-                    items: { oneOf: [ { 
-                        type: "object",
-                        required: [ "name", "url"],
-                        properties: {
-                            name: { type: "string" },
-                            url: { type: "string" },
-                        }
-                    }]}
+                    type: 'array',
+                    items: {
+                        oneOf: [
+                            {
+                                type: 'object',
+                                required: ['name', 'url'],
+                                properties: {
+                                    name: { type: 'string' },
+                                    url: { type: 'string' },
+                                },
+                            },
+                        ],
+                    },
                 },
                 website: {
-                    type : "object",
-                    required: [ "name", "url"],
+                    type: 'object',
+                    required: ['name', 'url'],
                     properties: {
-                        name: { type: "string" },
-                        url: { type: "string" },
-                    }
+                        name: { type: 'string' },
+                        url: { type: 'string' },
+                    },
                 },
                 backlink: {
-                    type : "object",
-                    required: [ "name", "url"],
+                    type: 'object',
+                    required: ['name', 'url'],
                     properties: {
-                        name: { type: "string" },
-                        url: { type: "string" },
-                    }
+                        name: { type: 'string' },
+                        url: { type: 'string' },
+                    },
                 },
-                module: { type: "string" },
-                id: { type: "string" },
-                summary: { type: "string" },
-                marking: { type: "string" },
-                legalese: { type: "string" },
-            }
+                module: { type: 'string' },
+                id: { type: 'string' },
+                summary: { type: 'string' },
+                marking: { type: 'string' },
+                legalese: { type: 'string' },
+            },
         },
-        "contents" : {
-            title: "DocGen Table of Contents Schema",
-            type : "array",
-            items: { oneOf: [ { 
-                type: "object",
-                required: [ "heading", "column", "pages"],
-                properties: {
-                    name: { type: "string" },
-                    column: { type: "integer", minimum: 1, maximum: 4 },
-                    pages: {
-                        type : "array",
-                        items: { oneOf: [ { 
-                            type: "object",
-                            required: [ "title", "source"],
-                            properties: {
-                                title: { type: "string" },
-                                source: { type: "string" },
-                                html: { type: "boolean" },
-                            }
-                        }]}
+        contents: {
+            title: 'DocGen Table of Contents Schema',
+            type: 'array',
+            items: {
+                oneOf: [
+                    {
+                        type: 'object',
+                        required: ['heading', 'column', 'pages'],
+                        properties: {
+                            name: { type: 'string' },
+                            column: { type: 'integer', minimum: 1, maximum: 4 },
+                            pages: {
+                                type: 'array',
+                                items: {
+                                    oneOf: [
+                                        {
+                                            type: 'object',
+                                            required: ['title', 'source'],
+                                            properties: {
+                                                title: { type: 'string' },
+                                                source: { type: 'string' },
+                                                html: { type: 'boolean' },
+                                            },
+                                        },
+                                    ],
+                                },
+                            },
+                        },
                     },
-                }
-            }]}
-        }
+                ],
+            },
+        },
     };
-
     var validateJSON = function (key, data) {
         var schema = schemas[key];
         var validator = new schemaValidator();
         var valid = validator.validate(data, schema);
         if (!valid) {
-            console.log(chalk.red('Error parsing required file: '+key+'.json (failed schema validation)'));
+            console.log(chalk.red('Error parsing required file: ' +
+                key +
+                '.json (failed schema validation)'));
             if (options.verbose === true) {
                 console.log(chalk.red(validator.getLastError()));
             }
         }
         return valid;
-    }
-
+    };
     /*
-        load all metadata files (JSON)
+      load all metadata files (JSON)
     */
-
     var loadMeta = function () {
         console.log(chalk.green('Loading required JSON metadata files'));
         var files = {
-            parameters: readFile(options.input+'/parameters.json'),
-            contents: readFile(options.input+'/contents.json'),
+            parameters: readFile(options.input + '/parameters.json'),
+            contents: readFile(options.input + '/contents.json'),
         };
-        rsvp.hash(files).then(function(files) {
-            for(var key in files) {
-                if (files.hasOwnProperty(key)) { //ignore prototype
+        rsvp
+            .hash(files)
+            .then(function (files) {
+            for (var key in files) {
+                if (files.hasOwnProperty(key)) {
+                    //ignore prototype
                     try {
                         var file = JSON.parse(files[key]);
                         if (validateJSON(key, file)) {
                             meta[key] = file;
-                        } else {
+                        }
+                        else {
                             mainProcess.exit(1);
                         }
-                    } catch (error) {
-                        console.log(chalk.red('Error parsing required file: '+key+'.json (invalid JSON)'));
+                    }
+                    catch (error) {
+                        console.log(chalk.red('Error parsing required file: ' +
+                            key +
+                            '.json (invalid JSON)'));
                         if (options.verbose === true) {
                             console.log(chalk.red(error));
                         }
@@ -340,102 +345,106 @@ function DocGen (process)
                 }
             }
             //add the release notes to the contents list
-            var extra = { 
-                heading: 'Extra', 
+            var extra = {
+                heading: 'Extra',
                 column: 5,
-                pages: [
-                    { title: 'Release notes', source: 'release-notes.txt' }
-                ]
+                pages: [{ title: 'Release notes', source: 'release-notes.txt' }],
             };
             meta.contents.push(extra);
             loadMarkdown();
-        }).catch(function(error) {
+        })
+            .catch(function (error) {
             console.log(chalk.red('Error loading required JSON metadata files'));
             if (options.verbose === true) {
                 console.log(chalk.red(error));
             }
             mainProcess.exit(1);
         });
-    }
-
+    };
     /*
-        load all markdown files (source)
+      load all markdown files (source)
     */
-
     var loadMarkdown = function () {
         console.log(chalk.green('Loading source files'));
         var keys = [];
         var files = [];
-        meta.contents.forEach( function (section) {
-            section.pages.forEach( function (page) {
+        meta.contents.forEach(function (section) {
+            section.pages.forEach(function (page) {
                 keys.push(page);
-                files.push(options.input+'/'+page.source);
+                files.push(options.input + '/' + page.source);
             });
         });
         //add the release notes page
         keys.push('ownership');
-        files.push(options.input+'/release-notes.txt');
-        rsvp.all(files.map(readFile)).then(function (files) {
-            files.forEach( function (page, index) {
-                try{
+        files.push(options.input + '/release-notes.txt');
+        rsvp
+            .all(files.map(readFile))
+            .then(function (files) {
+            files.forEach(function (page, index) {
+                try {
                     var key = keys[index];
-                    if (key.html === true) {   //allow raw HTML input pages
+                    if (key.html === true) {
+                        //allow raw HTML input pages
                         pages[key.source] = page;
-                    } else {                    //otherwise parse input from Markdown into HTML
+                    }
+                    else {
+                        //otherwise parse input from Markdown into HTML
                         var html = markdown.render(page);
                         pages[key.source] = html;
                     }
-                } catch (error) {
-                    console.log(chalk.red('Error parsing Markdown file: '+file.source));
+                }
+                catch (error) {
+                    console.log(chalk.red('Error parsing Markdown file: ' + file.source));
                     if (options.verbose === true) {
                         console.log(chalk.red(error));
                     }
                     mainProcess.exit(1);
                 }
             });
-            process(); 
-        }).catch(function(error) {
+            processContent();
+        })
+            .catch(function (error) {
+            console.log(error);
             console.log(chalk.red('Error loading source files'));
             if (options.verbose === true) {
                 console.log(chalk.red(error));
             }
             mainProcess.exit(1);
         });
-    }
-
+    };
     var sortPages = function () {
         //sort the contents by heading
-        var headings = {1: [], 2: [], 3: [], 4: [], 5: []};
-        meta.contents.forEach( function (section) {
+        var headings = { 1: [], 2: [], 3: [], 4: [], 5: [] };
+        meta.contents.forEach(function (section) {
             if (headings.hasOwnProperty(section.column)) {
                 headings[section.column].push(section);
             }
-
         });
         sortedPages = headings;
-    }
-
+    };
     /*
-        build the HTML for the table of contents
+      build the HTML for the table of contents
     */
-
     var webToc = function () {
         sortPages();
-        var pdfName = meta.parameters.name.toLowerCase()+'.pdf';
+        var pdfName = meta.parameters.name.toLowerCase() + '.pdf';
         var $ = templates.main;
         var html = [], i = -1;
         html[++i] = '<div><table class="unstyled"><tr>';
         //build the contents HTML
         for (var key in sortedPages) {
             if (sortedPages.hasOwnProperty(key)) {
-                if (key != 5) { //skip the extra column
+                if (key != 5) {
+                    //skip the extra column
                     html[++i] = '<td class="dg-tocGroup">';
-                    sortedPages[key].forEach( function (section) {
-                        html[++i] = '<ul><li class="dg-tocHeading">'+section.heading+'</li>';
-                        section.pages.forEach( function (page) {
+                    sortedPages[key].forEach(function (section) {
+                        html[++i] =
+                            '<ul><li class="dg-tocHeading">' + section.heading + '</li>';
+                        section.pages.forEach(function (page) {
                             var name = page.source.substr(0, page.source.lastIndexOf('.'));
-                            var path = name+'.html';
-                            html[++i] = '<li><a href="'+path+'">'+page.title+'</a></li>';
+                            var path = name + '.html';
+                            html[++i] =
+                                '<li><a href="' + path + '">' + page.title + '</a></li>';
                         });
                         html[++i] = '</li></ul>';
                     });
@@ -443,14 +452,18 @@ function DocGen (process)
                 }
             }
         }
-
         //fixed-width column at end
         html[++i] = '<td class="dg-tocGroup" id="dg-tocFixedColumn"><ul>';
-        html[++i] = '<li><span class="w-icon dg-tocIcon" data-name="person_group" title="archive"></span><a href="ownership.html">Ownership</a></li>';
-        html[++i] = '<li><span class="w-icon dg-tocIcon" data-name="refresh" title="archive"></span><a href="release-notes.html">Release Notes</a></li>';
+        html[++i] =
+            '<li><span class="w-icon dg-tocIcon" data-name="person_group" title="archive"></span><a href="ownership.html">Ownership</a></li>';
+        html[++i] =
+            '<li><span class="w-icon dg-tocIcon" data-name="refresh" title="archive"></span><a href="release-notes.html">Release Notes</a></li>';
         html[++i] = '</ul><div>';
         if (options.pdf) {
-            html[++i] = '<button class="w-icon-button" onclick="window.location=\''+pdfName+'\';">';
+            html[++i] =
+                '<button class="w-icon-button" onclick="window.location=\'' +
+                    pdfName +
+                    '\';">';
             html[++i] = '<span class="w-icon" data-name="document"></span>';
             html[++i] = '<span>PDF copy</span>';
             html[++i] = '</button>';
@@ -459,39 +472,34 @@ function DocGen (process)
         html[++i] = '</tr></table></div>';
         $('#dg-toc').html(html.join(''));
         templates.main = $;
-    }
-
+    };
     /*
-        insert the parameters into all templates
+      insert the parameters into all templates
     */
-
     var insertParameters = function () {
-
         //------------------------------------------------------------------------------------------------------
         //logo dimensions
         var hasLogo = false;
         var logoWidth = 0;
         var logoHeight = 0;
         try {
-            var logo = imageSizeOf(options.input+'/files/images/logo.png');
+            var logo = imageSizeOf(options.input + '/files/images/logo.png');
             logoWidth = logo.width;
             logoHeight = logo.height;
             hasLogo = true;
-        } catch (error) {
+        }
+        catch (error) {
             //do nothing. If logo file cannot be read, logo is simply not shown
         }
-
         //------------------------------------------------------------------------------------------------------
-
         //the homepage is the first link in the first heading
         var homelink = meta.contents[0].pages[0];
-        var homelink = homelink.source.substr(0, homelink.source.lastIndexOf('.'))+'.html';
-
+        homelink =
+            homelink.source.substr(0, homelink.source.lastIndexOf('.')) + '.html';
         var date = moment().format('DD/MM/YYYY');
         var time = moment().format('HH:mm:ss');
         var year = moment().format('YYYY');
-        var attribution = 'Created by DocGen '+version+' on '+date+' at '+time+'.';
-
+        var attribution = 'Created by DocGen ' + version + ' on ' + date + ' at ' + time + '.';
         var releaseVersion = meta.parameters.version;
         if (options.setVersion !== false) {
             releaseVersion = options.setVersion;
@@ -500,70 +508,93 @@ function DocGen (process)
         if (options.setReleaseDate !== false) {
             releaseDate = options.setReleaseDate;
         }
-
         var author = '';
         if (meta.parameters.author.url !== '') {
-            author += '<a href="'+meta.parameters.author.url+'">'+meta.parameters.author.name+'</a>';
-        } else {
+            author +=
+                '<a href="' +
+                    meta.parameters.author.url +
+                    '">' +
+                    meta.parameters.author.name +
+                    '</a>';
+        }
+        else {
             author += meta.parameters.author.name;
         }
-
         var owner = '';
         if (meta.parameters.owner.url !== '') {
-            owner += '<a href="'+meta.parameters.owner.url+'">'+meta.parameters.owner.name+'</a>';
-        } else {
+            owner +=
+                '<a href="' +
+                    meta.parameters.owner.url +
+                    '">' +
+                    meta.parameters.owner.name +
+                    '</a>';
+        }
+        else {
             owner += meta.parameters.owner.name;
         }
-
         var organization = '';
         if (meta.parameters.organization.url !== '') {
-            organization += '<a href="'+meta.parameters.organization.url+'">'+meta.parameters.organization.name+'</a>';
-        } else {
+            organization +=
+                '<a href="' +
+                    meta.parameters.organization.url +
+                    '">' +
+                    meta.parameters.organization.name +
+                    '</a>';
+        }
+        else {
             organization += meta.parameters.organization.name;
         }
-
         var website = '';
         if (meta.parameters.website.url !== '') {
-            website += '<a href="'+meta.parameters.website.url+'">'+meta.parameters.website.name+'</a>';
-        } else {
+            website +=
+                '<a href="' +
+                    meta.parameters.website.url +
+                    '">' +
+                    meta.parameters.website.name +
+                    '</a>';
+        }
+        else {
             website += meta.parameters.website.name;
         }
-
         var backlink = '';
         if (meta.parameters.backlink.url !== '') {
-            backlink += '<a href="'+meta.parameters.backlink.url+'">'+meta.parameters.backlink.name+'</a>';
-        } else {
+            backlink +=
+                '<a href="' +
+                    meta.parameters.backlink.url +
+                    '">' +
+                    meta.parameters.backlink.name +
+                    '</a>';
+        }
+        else {
             backlink += meta.parameters.backlink.name;
         }
-
         var contributors = '';
-        meta.parameters.contributors.forEach (function (contributor) {
+        meta.parameters.contributors.forEach(function (contributor) {
             if (contributor.url !== '') {
-                contributors += '<a href="'+contributor.url+'">'+contributor.name+'</a>, ';
-            } else {
-                contributors += contributor.name+', ';
+                contributors +=
+                    '<a href="' + contributor.url + '">' + contributor.name + '</a>, ';
+            }
+            else {
+                contributors += contributor.name + ', ';
             }
         });
-        contributors = contributors.replace(/,\s*$/, ""); //remove trailing commas
-
-        var copyright = '&copy; '+year+' '+organization;
-
-        var webTitle = meta.parameters.title
-
-        var webFooter = 'Version '+releaseVersion+' released on '+releaseDate+'.';
-
+        contributors = contributors.replace(/,\s*$/, ''); //remove trailing commas
+        var copyright = '&copy; ' + year + ' ' + organization;
+        var webTitle = meta.parameters.title;
+        var webFooter = 'Version ' + releaseVersion + ' released on ' + releaseDate + '.';
         for (var key in templates) {
             if (templates.hasOwnProperty(key)) {
-                $ = templates[key];
+                var $ = templates[key];
                 //logo
                 if (hasLogo === true) {
                     var logoUrl = 'files/images/logo.png';
                     $('#dg-logo').css('background-image', 'url(' + logoUrl + ')');
-                    $('#dg-logo').css('height', logoHeight+'px');
-                    $('#dg-logo').css('line-height', logoHeight+'px');
-                    $('#dg-logo').css('padding-left', (logoWidth+25)+'px'); 
-                } else {
-                    $('#dg-logo').css('padding-left', '0'); 
+                    $('#dg-logo').css('height', logoHeight + 'px');
+                    $('#dg-logo').css('line-height', logoHeight + 'px');
+                    $('#dg-logo').css('padding-left', logoWidth + 25 + 'px');
+                }
+                else {
+                    $('#dg-logo').css('padding-left', '0');
                 }
                 //parameters
                 $('title').text(meta.parameters.title);
@@ -571,7 +602,7 @@ function DocGen (process)
                 $('#dg-title').text(meta.parameters.title);
                 $('#dg-owner').html(owner);
                 $('#dg-version').text(releaseVersion);
-                $('#dg-web-title-version').text('('+releaseVersion+')');  
+                $('#dg-web-title-version').text('(' + releaseVersion + ')');
                 $('#dg-release-date').text(releaseDate);
                 $('#dg-web-footer').text(webFooter);
                 $('#dg-author').html(author);
@@ -588,38 +619,38 @@ function DocGen (process)
             }
         }
         if (options.mathKatex === true) {
-            $ = templates.main;
+            var $ = templates.main;
             //support for KaTeX (bundled with DocGen)
             $('head').append('<link rel="stylesheet" href="require/katex/katex.min.css" type="text/css">');
             $('head').append('<script type="text/javascript" src="require/katex/katex.min.js"></script>');
             $('head').append('<script type="text/javascript" src="require/katexInjector.js"></script>');
-
         }
         if (options.mathMathjax === true) {
             //support for MathJax (only supported via CDN due to very large size)
             //MathJax configuration is the same as used by math.stackexchange.com
-                //Note - wkhtmlpdf //cdn urls - see https://github.com/wkhtmltopdf/wkhtmltopdf/issues/1634
+            //Note - wkhtmlpdf //cdn urls - see https://github.com/wkhtmltopdf/wkhtmltopdf/issues/1634
             $('head').append('<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML-full"></script>');
         }
-    }
-
+    };
     /*
-        process each input into an output
+      process each input into an output
     */
-
-    var process = function () {
+    var processContent = function () {
         console.log(chalk.green('Generating the static web content'));
         webToc();
         insertParameters();
-        meta.contents.forEach( function (section) {
-            section.pages.forEach( function (page) {
+        meta.contents.forEach(function (section) {
+            section.pages.forEach(function (page) {
                 var $ = cheerio.load(templates.main.html()); //clone
                 var key = page.source;
                 var content = pages[key];
                 //add relevant container
-                if (page.html === true) { //raw HTML pages should not be confined to the fixed width
+                if (page.html === true) {
+                    //raw HTML pages should not be confined to the fixed width
                     $('#dg-content').html('<div id="dg-innerContent"></div>');
-                } else { //Markdown pages should be confined to the fixed width
+                }
+                else {
+                    //Markdown pages should be confined to the fixed width
                     $('#dg-content').html('<div class="w-fixed-width"><div id="dg-innerContent"></div></div>');
                 }
                 $('#dg-innerContent').html(content);
@@ -631,11 +662,11 @@ function DocGen (process)
                 if (headings.length > 0) {
                     html[++i] = '<ul class="dg-pageToc">';
                 }
-                headings.each(function( index ) {
+                headings.each(function () {
                     var label = $(this).text();
-                    var anchor = label.toLowerCase().replace(/\s+/g, "-");
+                    var anchor = label.toLowerCase().replace(/\s+/g, '-');
                     $(this).attr('id', anchor);
-                    html[++i] = '<li><a href="#'+anchor+'">'+label+'</a></li>';
+                    html[++i] = '<li><a href="#' + anchor + '">' + label + '</a></li>';
                 });
                 if (headings.length > 0) {
                     html[++i] = '</ul>';
@@ -645,7 +676,7 @@ function DocGen (process)
                 }
                 //------------------------------------------------------------------------------------------------------
                 //prepend the auto heading (which makes the PDF table of contents match the web TOC)
-                $('#dg-innerContent').prepend('<h1 id="dg-autoTitle">'+page.title+'</h1>');
+                $('#dg-innerContent').prepend('<h1 id="dg-autoTitle">' + page.title + '</h1>');
                 if (page.html === true) {
                     $('#dg-autoTitle').addClass('dg-hiddenTitle');
                 }
@@ -662,53 +693,52 @@ function DocGen (process)
         $('#dg-innerContent').html(templates.webCover.html());
         templates.webCover = $;
         writePages();
-    }
-
+    };
     /*
-        write each html page
+      write each html page
     */
-
     var writePages = function () {
         console.log(chalk.green('Writing the web page files'));
         var promises = {};
-        meta.contents.forEach( function (section) {
-            section.pages.forEach( function (page) {
+        meta.contents.forEach(function (section) {
+            section.pages.forEach(function (page) {
                 var key = page.source;
                 var name = key.substr(0, page.source.lastIndexOf('.'));
-                var path = options.output+name+'.html';
+                var path = options.output + name + '.html';
                 var html = pages[key].html();
                 promises[key] = writeFile(path, html);
             });
         });
         //add extra files
-        promises['ownership'] = writeFile(options.output+'ownership.html', templates.webCover.html());
+        promises['ownership'] = writeFile(options.output + 'ownership.html', templates.webCover.html());
         if (options.pdf === true) {
-            var pdfTempDir = options.output+'temp/';
+            var pdfTempDir = options.output + 'temp/';
             fs.mkdirsSync(pdfTempDir);
-            promises['docgenPdfCover'] = writeFile(pdfTempDir+'pdfCover.html', templates.pdfCover.html());
-            promises['docgenPdfHeader'] = writeFile(pdfTempDir+'pdfHeader.html', templates.pdfHeader.html());
-            promises['docgenPdfFooter'] = writeFile(pdfTempDir+'pdfFooter.html', templates.pdfFooter.html());
+            promises['docgenPdfCover'] = writeFile(pdfTempDir + 'pdfCover.html', templates.pdfCover.html());
+            promises['docgenPdfHeader'] = writeFile(pdfTempDir + 'pdfHeader.html', templates.pdfHeader.html());
+            promises['docgenPdfFooter'] = writeFile(pdfTempDir + 'pdfFooter.html', templates.pdfFooter.html());
         }
-        rsvp.hash(promises).then(function (files) {
-            copyDirSync(__dirname+'/require', options.output+'require'); //CSS, JavaScript
-            copyDirSync(options.input+'/files', options.output+'files'); //user-attached files and images
+        rsvp
+            .hash(promises)
+            .then(function () {
+            copyDirSync(__dirname + '/require', options.output + 'require'); //CSS, JavaScript
+            copyDirSync(options.input + '/files', options.output + 'files'); //user-attached files and images
             if (options.mathKatex === true) {
-                copyDirSync(__dirname+'/optional/katex', options.output+'require/katex');
+                copyDirSync(__dirname + '/optional/katex', options.output + 'require/katex');
             }
             checkPdfVersion();
-        }).catch(function(error) {
+        })
+            .catch(function (error) {
             console.log(chalk.red('Error writing the web page files'));
             if (options.verbose === true) {
                 console.log(chalk.red(error));
             }
             mainProcess.exit(1);
         });
-    }
-
+    };
     /*
-        wkthmltopdf options
+      wkthmltopdf options
     */
-
     var pdfOptions = [
         ' --zoom 1.0',
         ' --image-quality 100',
@@ -723,51 +753,51 @@ function DocGen (process)
         ' --footer-spacing 5',
         ' --no-stop-slow-scripts',
     ];
-
     var getPdfArguments = function () {
-        var pdfName = meta.parameters.name.toLowerCase()+'.pdf';
-        pdfOptions.push(' --javascript-delay '+options.pdfDelay);  //code syntax highlight in wkhtmltopdf 0.12.2.1 fails without a delay (but why doesn't --no-stop-slow-scripts work?)
-        pdfOptions.push(' --user-style-sheet '+__dirname+'/pdf-stylesheet.css');
-        pdfOptions.push(' --header-html '+options.output+'temp/pdfHeader.html');
-        pdfOptions.push(' --footer-html '+options.output+'temp/pdfFooter.html');
-        pdfOptions.push(' cover '+options.output+'temp/pdfCover.html');
-        pdfOptions.push(' toc --xsl-style-sheet '+__dirname+'/pdf-contents.xsl');
+        var pdfName = meta.parameters.name.toLowerCase() + '.pdf';
+        pdfOptions.push(' --enable-local-file-access');
+        pdfOptions.push(' --javascript-delay ' + options.pdfDelay); //code syntax highlight in wkhtmltopdf 0.12.2.1 fails without a delay (but why doesn't --no-stop-slow-scripts work?)
+        pdfOptions.push(' --user-style-sheet ' + __dirname + '/pdf-stylesheet.css');
+        pdfOptions.push(' --header-html ' + options.output + 'temp/pdfHeader.html');
+        pdfOptions.push(' --footer-html ' + options.output + 'temp/pdfFooter.html');
+        pdfOptions.push(' cover ' + options.output + 'temp/pdfCover.html');
+        pdfOptions.push(' toc --xsl-style-sheet ' + __dirname + '/pdf-contents.xsl');
         var allPages = '';
         for (var key in sortedPages) {
             if (sortedPages.hasOwnProperty(key)) {
-                sortedPages[key].forEach( function (section) {
-                    section.pages.forEach( function (page) {
+                sortedPages[key].forEach(function (section) {
+                    section.pages.forEach(function (page) {
                         var key = page.source;
                         var name = key.substr(0, page.source.lastIndexOf('.'));
-                        var path = options.output+name+'.html';
-                        allPages += ' '+path;
+                        var path = options.output + name + '.html';
+                        allPages += ' ' + path;
                     });
                 });
             }
         }
         var args = pdfOptions.join('');
         args += allPages;
-        args += ' '+options.output+pdfName;
+        args += ' ' + options.output + pdfName;
         return spawnArgs(args);
-    }
-
+    };
     var checkPdfVersion = function () {
         if (options.pdf === true) {
-            //first check that wkhtmltopdf is installed           
-            childProcess.exec(options.wkhtmltopdfPath+' -V', function (error, stdout, stderr) {
+            //first check that wkhtmltopdf is installed
+            (0, child_process_1.exec)(options.wkhtmltopdfPath + ' -V', function (error, stdout, stderr) {
                 if (error) {
                     console.log(chalk.red('Unable to call wkhtmltopdf. Is it installed and in path? See http://wkhtmltopdf.org'));
                     if (options.verbose === true) {
                         console.log(chalk.red(error));
                     }
                     mainProcess.exit(1);
-                } else {
+                }
+                else {
                     //warn if the version of wkhtmltopdf is not an expected version
                     var actualWkhtmltopdfVersion = stdout.trim();
                     if (actualWkhtmltopdfVersion !== wkhtmltopdfVersion) {
                         var warning = 'Warning: unexpected version of wkhtmltopdf, which may work but is not tested or supported';
-                        var expectedVersion = '   expected version: '+wkhtmltopdfVersion;
-                        var detectedVersion = '   detected version: '+actualWkhtmltopdfVersion;
+                        var expectedVersion = '   expected version: ' + wkhtmltopdfVersion;
+                        var detectedVersion = '   detected version: ' + actualWkhtmltopdfVersion;
                         console.log(chalk.yellow(warning));
                         console.log(chalk.yellow(expectedVersion));
                         console.log(chalk.yellow(detectedVersion));
@@ -775,46 +805,41 @@ function DocGen (process)
                     generatePdf();
                 }
             });
-        } else {
+        }
+        else {
             cleanUp();
         }
-    }
-
+    };
     /*
-        call wkhtmltopdf as an external executable
+      call wkhtmltopdf as an external executable
     */
-
     var generatePdf = function () {
         console.log(chalk.green('Creating the PDF copy (may take some time)'));
         var args = getPdfArguments();
-        var wkhtmltopdf = childProcess.spawn(options.wkhtmltopdfPath, args);
+        var wkhtmltopdf = (0, child_process_1.spawn)(options.wkhtmltopdfPath, args);
         var spinner = new cliSpinner(chalk.green('   Processing... %s'));
         spinner.setSpinnerString('|/-\\');
-
         wkhtmltopdf.on('error', function (error) {
             console.log(chalk.red('Error calling wkhtmltopdf to generate the PDF'));
             if (options.verbose === true) {
                 console.log(chalk.red(error));
             }
         });
-
         if (options.verbose !== true) {
             spinner.start(); //only show spinner when verbose is off (otherwise show raw wkhtmltopdf output)
-        } else {
+        }
+        else {
             //pipe the output from wkhtmltopdf back to stdout
             //however, wkhtmltpdf outputs to stderr, not stdout. See:
             //https://github.com/wkhtmltopdf/wkhtmltopdf/issues/1980
             wkhtmltopdf.stderr.pipe(mainProcess.stdout);
         }
-
         wkhtmltopdf.stdout.on('data', function (data) {
             //do nothing
         });
-
         wkhtmltopdf.stderr.on('data', function (data) {
             //do nothing
         });
-             
         wkhtmltopdf.on('close', function (code) {
             if (options.verbose !== true) {
                 spinner.stop();
@@ -826,43 +851,41 @@ function DocGen (process)
             }
             cleanUp();
         });
-    }
-
+    };
     var createRedirect = function () {
         if (options.redirect) {
-            var parent = options.output.replace(/\/$/, ""); //trim any trailing slash
-            parent = parent.split(path.sep).slice(-1).pop(); //get name of final directory in the path
+            var parent_1 = options.output.replace(/\/$/, ''); //trim any trailing slash
+            parent_1 = parent_1.split(path.sep).slice(-1).pop(); //get name of final directory in the path
             var homepage = meta.contents[0].pages[0];
-            var homepage = homepage.source.substr(0, homepage.source.lastIndexOf('.'))+'.html';
-            var redirectLink = parent+'/'+homepage;
-            $ = templates.redirect;
+            homepage =
+                homepage.source.substr(0, homepage.source.lastIndexOf('.')) + '.html';
+            var redirectLink = parent_1 + '/' + homepage;
+            var $ = templates.redirect;
             $('a').attr('href', redirectLink);
-            $('meta[http-equiv=REFRESH]').attr('content', '0;url='+redirectLink);
-            var file = options.output+'../'+'index.html';
+            $('meta[http-equiv=REFRESH]').attr('content', '0;url=' + redirectLink);
+            var file = options.output + '../' + 'index.html';
             try {
                 fs.outputFileSync(file, $.html(), 'utf-8');
-            } catch (error) {
-                console.log(chalk.red('Error writing redirect file: '+file));
+            }
+            catch (error) {
+                console.log(chalk.red('Error writing redirect file: ' + file));
                 if (options.verbose === true) {
                     console.log(chalk.red(error));
                 }
                 //don't exit because redirect error is not a fatal error
             }
         }
-    }
-
+    };
     /*
-        cleanup
+      cleanup
     */
-
     var cleanUp = function () {
         createRedirect();
         //remove temp files
         if (options.pdf === true) {
-            removeDirSync(options.output+'temp');
+            removeDirSync(options.output + 'temp');
         }
         console.log(chalk.green.bold('Done!'));
-    }
+    };
 }
-
 module.exports = DocGen;