hyla 1.0 → 1.0.1

data/lib/templates/sample/asciidoc_image.adoc

@@ -0,0 +1,26 @@
+== Asciidoc(tor) Reference
+
+- http://asciidoctor.org/docs/user-manual/#images[Images]
+
+== A block centered image with subtitle, id and link to refer
+
+[[id_of_hyla_picture]]
+.Title of the picture displayed under the picture
+image::image/hyla_arborea.jpg[Hyla Arborea,width="40%",height="40%", align="center"]
+
+[.text-center]
+Link to Figure Image : <<id_of_hyla_picture,A beautiful Hyla Arborea Picture>>
+
+== A block image pulled to the right and centered within the block
+
+image::image/hyla_arborea.jpg[Hyla Arborea,40,40,float="right",align="center"]
+
+== An inline image pulled to the left of the paragraph text
+
+image::image/hyla_arborea.jpg[Hyla Arborea,30,30,float="left"]
+You can find Hyla in American, Europe or Asian Tropical Rain forrests !
+
+== A hyperlinked image with caption
+[[img-sunset]]
+.A mountain sunset
+image::image/hyla_arborea.jpg[Sunset, 300, 200, link="http://www.flickr.com/photos/javh/5448336655"]

data/lib/templates/sample/asciidoc_report.adoc

@@ -0,0 +1,66 @@
+:data-uri:
+:author: Bob Moran
+:firstname: Bob
+:middlename:
+:lastname: Moran
+:authorinitials: bmo
+:email: bmoran@redhat.com
+:date: January 7, 2013
+
+== image:images/hyla_arborea.jpg[{author}, 40%, 35%, float="left"] {author}'s weekly Report - {date}
+
+=== {email}
+
+[width="100%"]
+|==============================================
+|*Completed Activities* |*Weekly Meetings* |*To Do Activities*
+|Completed Modules - Lab Setup, Package Management, Networking, Device Management, Storage |11/6/2013  BLD migration to BPMS6|Review Materials and Upload to Dokeos
+|Fuse Service Works   |11/6/2013  SumTotal UAT Checkpoint|Review Demos and Connect to EC2 to create new ones with updated interface
+|Updated materials from html to asciidoc  Transfered rest of project to Zach  |11/7/2013  asciidoc Overview  |asciidoc Themes - update themes to match Branding Guidelines fonts, colors and backgrounds
+|BPMS6 | |RHEL Implementation Take Home
+|Updated BAM files into asciidoc | |Complete the Services, Authentication, Virtualization, Security and Advanced Installation Labs
+|https://mojo.redhat.com/docs/DOC-30653 |  |
+|==============================================
+
+== Issues
+====
+- *Dokeos Support Issues*
+* Request #13857: **** TIME SENSITIVE **** progress bar not working in SumTotal -  Not Resolved - Getting 404 Page not Found errors when viewing Dokeos content in SumTotal
+  ** The resolution to this issue is the following:
+    . Export a module from Dokeos (Navigation inside content) and uploaded it in SumTotal and now you can see the progress as 100% when the whole module is finished by the learner.
+    . Clear cache in RDC Windows Internet Explorer envionment, Reload SCORM materials move into Production,  As Learner you are able to register and open the course.  When contents are loading get 404 error that goes to the content when click OK
+    . The issue with this resolution is that when I click on the arrows from SumTotal and pass the test it returns with the Not Attempted in the Topic Status window
+    . The exported with Navigation inside content allows for the next/previous buttons but no table of contents to show how many sections there are in the module
+  ** Another issue is that when the module is not completed it starts back at the beginning and not where the user left off like it should
+
+====
+
+== Meeting(s)
+====
+- Demo/presentation of Project Hyla - Tooling & Template for Modules Training creation
+- Discuss/Reivew Bob's issues
+====
+
+== General
+====
+- Project Hyla (on going)
+- Admin tasks : cash reward, expenses
+====
+
+== Partners
+====
+- Meeting with Finavia customer
+====
+
+== Community
+====
+- Problems fixed for Hyla :
+  * Dependency issue with listen 1.3.1 & 2.0. Remove `2.0` from gemspec file
+  * Watch command does not work with files having names `.asciidoc, .ad, .adoc` as extensions
+  * Import asciidoctor backends (haml and slim)
+  * Improve rendering adoc2slides to support deckjs, revealjs
+  * Add a YAML config file to each project created to reduce options to be added for command line
+  * Merge JSON YAML config file with DEFAULTS & options keys
+  * Add control if no yaml config file is find to use DEFAULT and Commad Lines Options
+  * Allow to generate content with relative directories --> source is '.' and destination 'generated_content'
+====

data/lib/templates/sample/asciidoc_source.adoc

@@ -0,0 +1,53 @@
+:source-highlighter: coderay
+
+== Asciidoc(tor) Reference
+
+- http://asciidoctor.org/docs/user-manual/#syntax-highlighting[Source Highlighting]
+- http://asciidoctor.org/docs/user-manual/#passthrough-macros[Pass through Macros]
+
+== Syntax HighLighter
+
+=== Text
+
+Text explaining where the code is located in *+++<span style="font-family: 'courier new', courier, monospace;">/directory structure</span>+++*
+
+Instructions of what the code is doing
+
+[source, txt, indent=0, subs="macros"]
++++[directory structure]#+++ pass:quotes[*command syntax*]
+
+Remark : Asciidoctor substitution with macros is used
+
+=== Java
+[source,java]
+----
+public class HelloWorld {
+
+    public static void main(String[] args) {
+        System.out.println(">> Hello Hyla Students");
+    }
+
+}
+----
+
+=== XML
+[source,xml]
+----
+<note>
+<to>Tove</to>
+<from>Jani</from>
+<heading>Reminder</heading>
+<body>Don't forget me this weekend!</body>
+</note>
+----
+
+=== Ruby
+
+[source,ruby]
+----
+require 'asciidoctor'
+
+puts Asciidoctor.render_file('sample.adoc', :header_footer => true)
+----
+
+

data/lib/templates/sample/asciidoc_table.adoc

@@ -0,0 +1,36 @@
+:data-uri:
+
+== Asciidoc(tor) Reference
+
+- http://www.methods.co.nz/asciidoc/chunked/ch23.html[Asciidoc Table]
+- http://asciidoctor.org/docs/user-manual/#tables[Table]
+- http://asciidoctor.org/docs/user-manual/#column-specifiers[Columns alignments]
+
+== Table with 2 columns left aligned with header
+[cols="2*<", options="header"]
+.Table Title
+|===
+| Column 1 | Column 2
+| Text 1 | Text 1
+| Text 2 | Text 2
+| Text 3 | Text 3
+|===
+
+Remarks :
+
+- Columns can be aligned to the top +++(<)+++, middle +++(^)+++, or bottom +++(>)+++
+- To vertically align the content to the middle of the cells in all of the columns, add a . and then the ^ operator after the multiplier : +++[cols="2*.<"]+++
+
+== Table with colored header
+[cols="2*<", options="header"]
+.Table Title
+|===
+| Column 1 {set:cellbgcolor:red} | Column 2 {set:cellbgcolor:red}
+| Text 1 {set:cellbgcolor:white} | Text 1
+| Text 2 {set:cellbgcolor:grey}  | Text 2
+| Text 3 {set:cellbgcolor:white} | Text 3
+|===
+
+Remark:
+
+- should be better to define colors using css instead of +++{set:cellbgcolor:red}+++

data/lib/templates/sample/asciidoc_video.adoc

@@ -1,4 +1,12 @@
+== Asciidoc(tor) Reference
+
+- http://asciidoctor.org/docs/user-manual/#video[Video]
+
 == Video
 
-video::video/small.ogv[options=autoplay]
+.Video Caption Title
+video::../video/small.ogv[options=autoplay]
+
+'''
+[.big]#Video Text or Directions#
 

data/lib/templates/sample/slideshow_revealjs.adoc

@@ -0,0 +1,26 @@
+= Getting Started with Reveal.js
+:description: RevealJS Template to create a beautiful HTML Slideshow
+:backend: revealjs
+:author: Charles Moulliard
+// Themes : default, beige, moon, blood, night, serif, simple, sky, solarized
+:revealjs_theme: solarized
+
+== Reveal.js
+
+HTML Presentations Made Easy
+
+[small]#Created by
+http://cmoulliard.github.io[Charles Moulliard] / http://twitter.com/cmoulliard[@cmoulliard]#
+
+== Heads Up
+
+reveal.js is a framework for easily creating beautiful presentations using HTML. You'll need a browser with
+support for CSS 3D transforms to see it in its full glory.
+
+[sidebar]
+Oh hey, these are some notes. They'll be hidden in your presentation, but you can see them if you open the speaker notes window (hit 's' on your keyboard).
+
+== Another Slide
+
+
+

data/lib/templates/training-exercises/_config.yml

@@ -0,0 +1,3 @@
+source:
+destination: generated_content
+backend: HTML5

data/lib/templates/training/{introduction → module-1}/article.adoc

@@ -1,5 +1,7 @@
 :icons: font
 :data-uri:
+:sectlink: true                      // to turn section titles into links
+:sectanchors: true                   // An anchor (empty link) is added before the section title
 
 == Links
 
@@ -40,8 +42,11 @@ Nullam tristique mauris vitae feugiat consectetur. Ut pellentesque turpis faucib
 *** Reflection pool
 
 == Image
-.Text of the picture
-image::image/hyla_frog.jpg[width="100%"]
+[[id_of_hyla_picture]]
+.Title of the picture displayed under the picture
+image::image/hyla_arborea.jpg[width="40%"]
+
+Link to Figure Image : <<id_of_hyla_picture,A beautiful Hyla Arborea Picture>>
 
 == Admonition
 

data/lib/templates/training/{development → module-2}/article.adoc

@@ -1,5 +1,7 @@
 :icons: font
 :data-uri:
+:sectlink: true                      // to turn section titles into links
+:sectanchors: true                   // An anchor (empty link) is added before the section title
 
 == Links
 
@@ -40,8 +42,11 @@ Nullam tristique mauris vitae feugiat consectetur. Ut pellentesque turpis faucib
 *** Reflection pool
 
 == Image
-.Text of the picture
-image::image/hyla_frog.jpg[width="40%"]
+[[id_of_hyla_picture]]
+.Title of the picture displayed under the picture
+image::image/hyla_arborea.jpg[width="40%"]
+
+Link to Figure Image : <<id_of_hyla_picture,A beautiful Hyla Arborea Picture>>
 
 == Admonition
 

data/lib/templates/training/readme.adoc

@@ -1 +1,10 @@
-#
+= Training Asciidoctor Project
+
+This is an empty Training project.
+
+- To create **asciidoc(tor)** content, more info are available http://asciidoctor.org/docs/user-manual[here]
+- Otherwise, you can add content to this newly project created using this hyla command :
+
+    hyla create --t asciidoc --a xxx  --d pathToProjectCreated
+
+    where xxx can be article, book, source, audio, video, ..."

data/scenario.adoc

@@ -3,56 +3,149 @@
 ==== 1. Delete Temp directory
 
     rm -rf ~/hyla/MyBlankProject/
+    rm -rf ~/hyla/MyBookProject
     rm -rf ~/hyla/MyTocProject/
     rm -rf ~/hyla/MyTrainingProject/
+    rm -rf ~/hyla/MyTrainingExercisesProject/
+    rm -rf ~/hyla/MyDeckSlideShow/
+    rm -rf ~/hyla/MyRevealSlideShow/
 
-== 1.Create a Blank Project
+==== 2. Install Gem Hyla 1.0.x
 
-=== 1. Create a new project
+    gem install hyla -v 1.0.x
 
-    ./hyla new --blank ~/hyla/MyBlankProject
+== 1. Blank Project & Artefacts
 
-=== 2. Idem but with force option
+Using hyla we will create a new project (= directory) and add artefacts (article, audio, video, image, source, table)
 
-    ./hyla new --blank ~/hyla/MyBlankProject --force
+== 1. Create a Blank Project (with or without --force option)
 
-=== 3. Add an artefact (article, audio, video)
+    hyla new --blank ~/hyla/MyBlankProject
+    hyla new --blank ~/hyla/MyBlankProject --force
 
-    ./hyla create --t asciidoc --a article --d ~/hyla/MyBlankProject
-    ./hyla create --t asciidoc  --a audio --d ~/hyla/MyBlankProject
-    ./hyla create --t asciidoc  --a video --d ~/hyla/MyBlankProject
-    ./hyla create --t asciidoc  --a source_highlight --d ~/hyla/MyBlankProject
+== 2. Create a Blank Project without _config.yaml config file, add artefact
+
+    cd ~/hyla
+    rm -rf MyBlankProject/
+    hyla new --blank MyBlankProject --force
+    hyla create --t asciidoc --a article --d ~/hyla/MyBlankProject
+    hyla create --t asciidoc --a book --d ~/hyla/MyBlankProject
+    hyla create --t asciidoc --a image --d ~/hyla/MyBlankProject
+    hyla create --t asciidoc --a audio --d ~/hyla/MyBlankProject
+    hyla create --t asciidoc --a video --d ~/hyla/MyBlankProject
+    hyla create --t asciidoc --a source --d ~/hyla/MyBlankProject
+    hyla create --t asciidoc --a table --d ~/hyla/MyBlankProject
+
+== 3.  Create a Blank Project using _config.yaml config file, add artefacts
+
+    cd ~/hyla
+    rm -rf MyBlankProject/
+    hyla new --blank MyBlankProject --force
+    cd MyBlankProject
+    hyla create --a article
+    hyla create --a book
+    hyla create --a image
+    hyla create --a audio
+    hyla create --a video
+    hyla create --a source
+    hyla create --a table
 
 === 4. Generate HTML Content of an existing project (asciidoc 2 html)
 
-    ./hyla generate --r adoc2html --s ~/hyla/MyBlankProject/ --d ~/hyla/MyBlankProject/generated_content
+    hyla generate --r adoc2html --s ~/hyla/MyBlankProject/ --d ~/hyla/MyBlankProject/generated_content
+
+=== 5. Generate HTML Content of an existing project (asciidoc 2 html) with a different style
+
+    Styles available : redhat, asciidoctor, colony, foundation, foundation-lime, foundation-potion, github, golo, iconic, maker, readthedocs, riak, rocket-panda, rubygems
+
+    hyla generate --r adoc2html --s ~/hyla/MyBlankProject/ --d ~/hyla/MyBlankProject/generated_content --style redhat
+    hyla generate --r adoc2html --s ~/hyla/MyBlankProject/ --d ~/hyla/MyBlankProject/generated_content --style github
+    hyla generate --r adoc2html --s ~/hyla/MyBlankProject/ --d ~/hyla/MyBlankProject/generated_content --style foundation
+
+=== 6. Generate HTML Content within project
+
+    hyla generate --r adoc2html --s . --d generated_content
+
+=== 7. Generate HTML Content within project & using Config File
+
+   As destination directory is not longer '.' (which is the case when we add artefacts using `hyla create` command, then we must change the destination directory to `generated_content`. the original file is
+   still available as it will backuped by ruby
+
+   ruby -i.bak -pe 'sub(%r{destination: .},"destination: generated_content")' _config.yml
+   hyla generate
+
 
 == 2. Project from Template
 
 === 1. Create a project using a template (training)
 
-    ./hyla new --force --t training ~/hyla/MyTrainingProject
-    ./hyla new --force --t training-exercises ~/hyla/MyTrainingExercisesProject
+    hyla new --t training ~/hyla/MyTrainingProject --force
+    hyla new --t training-exercises ~/hyla/MyTrainingExercisesProject --force
+    hyla new --t book --force ~/hyla/MyBookProject --force
 
 === 2. Generate content and watch it
 
-    ./hyla generate --r adoc2html --s ~/hyla/MyTrainingProject/ --d ~/hyla/MyTrainingProject/generated_content
+    cd ~/hyla/MyTrainingProject
+    ruby -i.bak -pe 'sub(%r{destination: .},"destination: generated_content")' _config.yml
+    hyla generate
 
-    ./hyla watch --s ~/hyla/MyTrainingProject/ --d ~/hyla/MyTrainingProject/generated_content
+    hyla watch --s ~/hyla/MyTrainingProject/ --d ~/hyla/MyTrainingProject/generated_content
 
 == 3. Table Of Content To asciidoc
 
 === 1. Generate an asciidoctor project from a Table of Content
 
-    ./hyla generate --r toc2html --p my-project --d ~/hyla/MyTocProject/ --toc ~/MyProjects/hyla/data/toc.adoc
+    hyla generate --r toc2adoc --p my-project --d ~/hyla/MyTocProject/ --toc ~/MyProjects/hyla/data/toc.adoc
+    hyla generate --r adoc2html --s ~/hyla/MyTocProject/ --d ~/hyla/MyTocProject/generated_content
+
+    hyla watch --s ~/hyla/MyTocProject/ --d ~/hyla/MyTocProject/generated_content
+
+=== 2. Generate an asciidoctor project from a Table of Content using YAML config file and watch content
+
+    rm -rf ~/hyla/MyTocProject
+    cd ~/hyla
+    hyla new --blank MyTocProject
+    cd MyTocProject
+    hyla generate --r toc2adoc
+
+    # Change destination in config files or pass info as option
+    # cd ../MyTocProject/
+    # subl _config.yml
+    hyla generate --r adoc2html
+
+    hyla watch --s ~/hyla/MyTocProject/ --d generated_content
+
+== 4. Generate a DeckJS Slideshow from Table Of Content
+
+    hyla generate --backend deckjs --s  ~/hyla/MyTocProject/A_Introduction_module/ --d ~/hyla/MyTocProject/A_Introduction_module/generated_content --r adoc2slide
+
+== 5. Server content locally - HTTP Server
+
+    hyla serve -P 4000 -H localhost --out_dir ~/hyla/MyTrainingProject/generated_content/ -b /hyla/
+
+== 6. Generate a Slideshow
+
+=== 1. DeckJS using a template
+
+   rm -rf  ~/hyla/MyDeckSlideShow
+   cd ~/hyla
+   hyla new --blank MyDeckSlideShow
+   hyla create --t slideshow --a deckjs --d MyDeckSlideShow
+   hyla generate --backend deckjs --s  ~/hyla/MyDeckSlideShow --d ~/hyla/MyDeckSlideShow/generated_content --r adoc2slide
 
-    ./hyla generate --r adoc2html --s ~/hyla/MyTocProject/ --d ~/hyla/MyTocProject/generated_content
+=== 2. Different DeckJS Style options
 
-    ./hyla watch --s ~/hyla/MyTocProject/ --d ~/hyla/MyTocProject/generated_content
+   hyla generate --backend deckjs --s  ~/hyla/MyDeckSlideShow --d ~/hyla/MyDeckSlideShow/generated_content --r adoc2slide --a deckjs_theme=swiss,deckjs_transition=fade
+   hyla generate --backend deckjs --s  ~/hyla/MyDeckSlideShow --d ~/hyla/MyDeckSlideShow/generated_content --r adoc2slide --a deckjs_theme=web-2.0,deckjs_transition=horizontal-slide
 
-== 4. Server content locally - HTTP Server
+===  3. RevealJS
 
-    ./hyla serve -P 4000 -H localhost --out_dir ~/hyla/MyTrainingProject/generated_content/ -b /hyla/
+   rm -rf ~/hyla/MyRevealSlideShow
+   cd ~/hyla
+   hyla new --blank MyRevealSlideShow
+   hyla create --t slideshow --a revealjs --d MyRevealSlideShow
+   cd MyRevealSlideShow
+   hyla generate --backend revealjs --s . --d generated_content --r adoc2slide