This project contains resources to transform docbook to PDF and HTML.

view-repo's generating snapshot artifacts uses resources from this project.

To use the resources:

- Local DEV environment:
    - checkout the project from JPL GitHub into your git directory; typical path is /home/[USERNAME]/git/docbookgen/.

- EMS Server:
    - checkout the project from JPL GitHub into /opt/local/docbookgen directory.

Unknown issue:

- Be sure the account (i.e.: alfresco or root) running alfresco has read permission to docbookgen directory.
  In addition, be sure docbookgen/for-1.0/fop properly set with execute right. 
  If it's not, issue the command chmod u+x,g+x,o+x fop

Using the DocGen Stylesheet

README for Docgen mgss.xsl script

This stylesheet is designed to implement a more professional format for documents outputted from docgen. Setting up use of this sheet will allow users to automatically generate JPL quality documents with a minimum of setup. Below are the tagged values and their format for using the stylesheet within docbook:

MagicDraw Tags

NOTE These are now found under the Front Matter group of the DocumentView Specification (as of MDK 17.02.07):

Title Page:

---

Document Title (this is the <> Package Name) Logo Alignment (This is the align attribute in the mediaobject/image/object tag) Logo Location Formal Project Title JPL Document ID JPL Version Project Acronym Document Acronym Title Page Legal Notice Footer Legal Notice

Signature Page:

---

Author Approver Acceptance (as of MDK 2.0 must be entered manually see Tutorials) Concurrence

Revision Page:

---

Revision History Collaborator Email

TUTORIALS:

---

To generate a file locally:

---

You cannot change the logo unless you are locally generating your document as a pdf. Follow SSCAE instructions to install Oxygen Obtain a copy of the mgss.xsl stylesheet from MBEE Open your Oxygen install directory and navigate to frameworks/docbook/xsl/fo and save mgss.xsl to that directory Open your xml output from docgen On the right hand side right click "DocBook PDF" within transformation scenarios Select "Duplicate", a new window will open Rename your new scenario as desired Select the XSL URL text box and replace "${frameworks}/docbook/xsl/fo/docbook_custom.xsl" with ${frameworks}/docbook/xsl/fo/mgss.xsl" Click "OK" To generate a new pdf double-click on your new transformation in the Transformation Scenarios window

Changing the JPL logo in the stylesheet

---

Follow instructions for setting up local file generation Open Oxygen Select "File/Open" Navigate to the Oxygen install directory/frameworks/dockbook/xsl/fo and select mgss.xsl Recommended: Select "Save as…" and rename the mgss.xsl to something else to ensure you have a fresh copy Create a new transformation scenario for this non-JPL logo document Hit "Ctrl-F" and search for "JPL.logo.image" Locate the line <xsl:param name="JPL.logo.image">http://sec274.jpl.nasa.gov/img/logos/jpl_logo(220x67).gif</xsl:param> Replace the URL with the Full location of the image to be used (either C:/ or http:/) Modify the two lines below as needed (or delete the text) Open your XML from docbook Run your transformation scenario

Manual Additions to DocBookGen XML

---

Adding Electronic signature

---

Follow instructions for setting up local file generation Open your .xml docbook output and add the following (as needed) into the tag for each author, 9-2-14

Example: Author Name
Signature Date Title Organization Division

Adding an “Accepted By” Author

---

Follow instructions for setting up local file generation Open your .xml docbook output and add the following (as needed) into the tag First NameLast Name
 Electronic Signature Date
 Job Title Organization Division

Controlling TOC Display

---

Follow instructionsfor setting up local file generation Open your .xml docbook output and add the following (as needed) into the tag Omit the TOC types that are not desired (keeping title always). 
 
 book toc,title,figure,table,example,equation
 


Release Notes:

---

V4.2

-Modified to conform to Europa Document Configuration Management Template -Added capability for ‘Accepted By’ author -Added ability to turn TOC elements on and off -Added Electronic Signature notification

V4.1

-Added support for live links on title page -Fixed error with live link that prevents document from compiling

V4.0

-Docgen was modified for this new stylesheet version, -added a tagged value for project logo alignment -moved tagged values under a new section "Front Matter" within <> to improve clarity -minor bug fixes

-Redesigned footer to ensure that there will always be an institutional logo on the title matter -Wrote a tutorial for changing Institutional Logo for non JPL documents -Modified front page to allow more room for various logo sizes -No signature page, collaborator/revision history page will generate now if these items are not populated -Added space between first and last names in signature page -Removed "JPL D-" hardcoded in the document to support non JPL documents -Updated readme with tutorials and tagged values

V3.0

-No changes required to Docgen Implementation of stylesheet -Added higher resolution JPL logo -Added space between Title and Subtitle on first page -Generalized document link location -Fixed the JPL logo so it will remain at the bottom of the page regardless of content -BugFixes -Created README

V2.0

-Docgen will now produce a usable slightly pretty document without stylesheet implementation -Changed Bookinfo back to info

Upcoming Projects:

• Update of system to allow "Model based Construction" of title elements
• Run Through from scratch creation scenarios to determine which tagged values need defaults

Known Tagged values needing defaults (as of 4.1):

-Logo Location -Docushare Link