myarbrough / orm_book_samples

Sample book files for O'Reilly content

orm_book_samples

This directory contains skeleton/boilerplate book files for use with the O'Reilly Media, Inc. internal publishing tools.

NOTE: If you update any boilerplate in this repo, please update each filetype (HTMLBook, AsciiDoc, DocBook) as necessary and then deploy to the Atlas templates by following the instructions below.

File Organization

• root - standard files
  • book files for use with all Atlas projects regardless of content format
  • pdf.css (common theme overrides)
  • layout.html (use to specify EPUB/MOBI metadata)
  • README.md (this file)
  • LICENSE (license for use of files in this repo)
• asciidoc_only/
  • book files for use in AsciiDoc projects only
  • v1_only/
    • book files for use with AsciiDoc projects in Atlas v1 (deprecated)
• docbook_only/
  • book files for use in DocBook projects only
  • v1_only/
    • book files for use with DocBook projects in Atlas v1 (deprecated)
• htmlbook_only/
  • book files for use in HTMLBook projects only

Steps for Updating Atlas Template Repos

1. Log on to Touchstone

   This script can be run anywhere on Touchstone.

2. Decide what you want to update.

   • Peripheral files that are common to each repo can be updated.

     NOTE: Updating peripheral files will push to all three Atlas template repos.

   • Format specific files that are specific to each template can be updated.

     NOTE: You need to explicitly state which formats you want to update.

3. Run the script

   $ [variables] v2sample_template_update

   Here's a list of the variables to specify when you run the command:

   • To update format specific files

          format_specific=true asc=true # Specifies to update asciidoc template repo
          format_specific=true db=true # Specifies to update db template repo
          format_specific=true html=true # Specifies to update html template repo

   • To update peripheral files

     peripheral=true # Specifies to update every template repo's common files (like, titlepage.html, 
                                                                                toc.html, and so on) 

TIPs:

1. You can update format specific files for more than one sample repo at a time.

   #Examples
   $ format_specific=true asc=true db=true v2sample_template_update
   $ format_specific=true asc=true db=true html=true v2sample_template_update
   

2. You can update format specific files and peripheral files at the same time. (Peripheral file updates will be pushed to every template repo, but the format specific updates only apply to the repo specified):

   #Examples
   $ peripheral=true format_specific=true asc=true v2sample_template_update
   $ peripheral=true format_specific=true asc=true db=true html=true v2sample_template_update
   

---

Script Man File (current as of 3/12/2015):

Usage
$ [options] v2sample_template_update

Examples
$ peripheral=true v2sample_template_update
$ format_specific=true asc=true v2sample_template_update

Variables

peripheral
   =true  - Specifies that peripheral files should be updated (this updates to every template) 

format_specific
   =all    - (NOT ADDED YET) Pushes updates to each atlas template's format specific files
   =true   - Use in conjunction with a asc/db/html variables to specify which main content files
             should be updated.    
   asc
      =true  - Specifies that the asciidoc template repo's format specific files will be updated
   db
      =true  - Specifies that the docbook template repo's format specific files will be updated
   html
      =true  - Specifies that the htmlbook template repo's format specific files will be updated

eso
    =true   - (NOT ADDED YET) used for pushing esoteric files (in case we want this)

---