parade 0.9.2 → 0.10.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjNhNWQwYjM4NjFkMmVmMTRiY2MyZTJiMjIwZjQ2OWJiYjcxNmNmYg==
+  data.tar.gz: !binary |-
+    MTBkM2E3OTA5NmY0ODBhMGM3NDViZjk0M2NlYmNjNTA5ODQ1NGY4NA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    Y2M5MjcyYTg4OWQyNDQ1MmNkNGJlZGNlNTljMTM0NDUwMTU5YWVmODFiNTA4
+    ZTlhNGMwZWJlOTcwNzI1NDQ5OGMxZjM4OGRjOTc2OWEyZjQwYmQ4NzllMzlj
+    NTljMmRjOTA3YzhjMGQ4MGM2ZWQwMDg5YTE5MTZiNDNkYmE2ZjA=
+  data.tar.gz: !binary |-
+    OGE1Yjg2ZDgzNmVjZTVhZWU3OTBkNzY1YmU5NTQ3ZWE3ODhhNzhkZDc5MDlj
+    ODIzZWJiNGE4ZTc3YjFmYjYwZDdhMTc5MDU1M2U4YTk3NGRjOGFmN2E0M2I3
+    OTViNmY2MmYwYjE5NDc0MjA0MTcxODk3NmFjNTA5OWExNDlhMjg=

data/README.md

@@ -1,8 +1,8 @@
 # Parade Presentation Software
 
-Parade is a Sinatra web app that reads serves up markdown files in a
-presentation format. Parade can serve a directory or be configured to run with
-a simple configuration file.
+Parade is an open source presentation software that consists of a Sinatra web
+app that serves up markdown files in a presentation format. Parade can serve a
+directory or be configured to run with a simple configuration file.
 
 ## Comparison Vs PowerPoint / Keynote
 
@@ -10,7 +10,7 @@ Parade is easily out-done by professional presentation software packages as
 far as out-of-the-box style and design. However, there are benefits that
 Parade has over presentational software:
 
-### The Good
+### Highlights
 
 * Markdown backed data
 
@@ -21,34 +21,34 @@ Parade has over presentational software:
 * Syntax Highlighting
 
     > Using GitHub flavored markdown, code fences will automatically be
-    syntax highlighted making it incredibly easy to integrate code samples
+    syntax highlighted, making it incredibly easy to integrate code samples.
 
 * Code Execution
 
-    > Slides are able to provide execution and show results for JavaScript,
-    and Coffeescript live within the browser. Allowing for live
+    > Slides are able to provide execution and show results for JavaScript
+    and Coffeescript live within the browser. This allows for live
     demonstrations of code.
 
 * Web
 
-    > The system is simply a website which allows for a lot of possibilities
+    >Slide presentations are basically websites -- they run in your browser from your desktop. This allows for a wide range of possibilities for customization and expandability.
 
-### The Ugly
+* Basic Templating and Color Schemes
 
-* Lack of style
+    > Several templates and color scheme options have been provided to help you get started. While Parade does not currently provide anything near the variety of many other presentation packages, it is well-suited for basic presentations.
 
-    > Most presentation packages are going to provide for you better templates
+* Design Flexibility (pros and cons)
 
-* Speed of Layout and Animation
+    > Unless you're skilled in CSS/Animations, you will likely have a harder
+    time creating presentations with as much polish as other programs provide. However, this approach also makes Parade incredibly flexible if you do understand CSS/Animations.
 
-    > Unless you're skills are great with CSS/Animations, you are likely going
-    to have a harder time creating presentations with as much polish.
+
+### Works In Progress
 
 * Resizing
 
-    > Currently the presentation system can change gradual sizes, but is not
-    very capable of growing well to the full resolution of current presentation
-    resolution.
+    > Currently, the presentation system can change gradual sizes, but does not
+    have true full screen mode.
 
 # Installation and Usage
 
@@ -62,9 +62,9 @@ $ gem install parade
 $ parade
 ```
 
-By default running parade with start a presentation from the current working
-directory. It will find all markdown files, `**/*.md`, within the directory
-and create a presentation out of them.
+By default, running parade starts a presentation from the current working
+directory. It finds all markdown files, `**/*.md`, within the directory
+and creates a presentation out of them.
 
 >  By default parade will split slides along lines that start with a single `#`
 
@@ -73,16 +73,16 @@ and create a presentation out of them.
 
 You can manage the presentation with the following keys:
 
-> ### *space* or *cursor right*
+> ### *space* or *cursor right* or *cursor down*
 >
 > Advance to the next slide or advance the next incremental bullet point
 or show the end result of the code execution.
 >
-> ### *shift-space* or *cursor left*
+> ### *shift-space* or *cursor left* or *cursor up*
 >
 > Move to the previous slide
 >
-> ### *z* or *?*
+> ### *h* or *?*
 >
 > Toggle help
 >
@@ -90,18 +90,14 @@ or show the end result of the code execution.
 >
 > Toggle footer (which shows slide count of total slides, percentage)
 >
-> ### *d*
->
-> Toggle DEBUG information
->
 > ### *c* or *t*
 >
 > Toggle the display of the Table of Contents
 >
-> ### *p*
+> ### Visit "http://localhost:9090/print"
+>
+> Visiting this URL will generate a single page presentation that is printable
 >
-> Toggle pre-show
-
 
 ### Serving a specific directory
 
@@ -109,12 +105,12 @@ or show the end result of the code execution.
 $ parade [directory]
 ```
 
-This will start a presentation from the specified directory. Again, finding all
+This will start a presentation from the specified directory, finding all
 markdown files contained within the directories or sub-directories.
 
 ### Serving specific files
 
-To include certain files, specify an order, duplicate slides, you will need to
+To include certain files, specify an order, or duplicate slides, you will need to
 define a `parade` file. Within that file, you may define specific files,
 specific folders, and the order of the presentation.
 
@@ -124,12 +120,12 @@ slides "intro.md"
 section "directory_name"
 ```
 
-> **slides** and **section** are exactly the same, however you may choose to
-  use one over the other depending of you are mentioning a specific file of
+> **slides** and **section** are exactly the same. However, you may choose to
+  use one over the other depending on if you are mentioning a specific file of
   slides or a directory which could contain another `parade` or be considered
   a section.
 
-You can so define sub sections with a title and slides or additional sections.
+You can also define sub-sections with a title and slides or additional sections.
 
 ```ruby
 
@@ -152,12 +148,12 @@ end
 
 ### Separator: **#**
 
-Slides are simply markdown format. As stated previously, slides will be
-separated along the `#`elements within your document.
+Slides are simply markdown format. Slides will be separated along
+the `#`elements within your document.
 
 ### Separator: !SLIDE
 
-Relying on the `#` as a separator is not always ideal. So you may alternatively
+Relying on the `#` as a separator is not always ideal. Alternatively, you can
 use the `!SLIDE` separator. This also provides you with the ability to define
 additional metadata with your slides and presentation.
 
@@ -261,25 +257,28 @@ All remaining single terms are added as css classes to the slide's `div`.
 
 Parade defines a number of special CSS classes:
 
+> ### title
+> places the content closer to the center of the page
+>
 > ### center
 > centers images on a slide
 >
-> ### full-page
-> allows an image to take up the whole slide
+> ### title-and-content
+> places the title at the top and the content is left-aligned below it.
+>
+> ### section-header
+> similar to a `title` class except it is a litle further down the page.
 >
 > ### bullets
 > sizes and separates bullets properly (fits up to 5, generally)
 >
-> ### columns
+> ### columns / comparison
 >
 > creates columns for every `##` markdown element in your slides (up to 4)
 >
 > ### smbullets
 > sizes and separates more bullets (smaller, closer together)
 >
-> ### subsection
-> creates a different background for titles
->
 > ### command
 > monospaces h1 title slides
 >
@@ -287,22 +286,21 @@ Parade defines a number of special CSS classes:
 > for pasted commandline sections (needs leading '$' for commands, then
 > output on subsequent lines)
 >
-> ### code
-> monospaces everything on the slide
->
 > ### incremental
 > can be used with 'bullets' and 'commandline' styles, will incrementally
 >  update elements on arrow key rather than switch slides
 >
-> ### small
-> make all slide text 80%
->
-> ### smaller
-> make all slide text 70%
+> ### text-size-(percentage)
+> make all slide text size from 70% up to 150%, by percent increments of
+> ten. E.G.: text-size-150, text-size-120, text-size-90, text-size-70.
 >
 > ### execute
 > on Javascript and Coffeescript highlighted code slides, you can
 > click on the code to execute it and display the results on the slide
+>
+> ### blank
+> a slide without content is removed unless you specify that the slide is
+> blank.
 
 
 # Presentation Customization
@@ -330,6 +328,32 @@ end
 * merlot
 * slate
 
+### Customized Footer
+
+The presentation has the following default footer:
+
+```html
+<div id="footer">
+  <span id="slideInfo"></span>
+  <span id="debugInfo"></span>
+  <span id="notesInfo"></span>
+</div>
+```
+
+You can override the default footer of the presentation by specifying a file path to a customized footer.
+
+```ruby
+title "My Presentation"
+
+footer "custom_footer.erb"
+
+section "Introduction" do
+  slides "intro.md"
+end
+```
+
+This example will load a file named `customer_footer.erb` within your presentation directory.
+
 ## Loading Custom CSS and JavaScript
 
 By default Parade will load most CSS and JavaScript it finds within the the
@@ -508,7 +532,7 @@ Shows list of commands or help for one command
 
 Create new parade presentation
 
-This command helps start a new parade presentation by setting up the proper directory structure for you.  It takes the directory name you would like parade to create for you.
+This command helps start a new parade presentation by setting up the proper directory structure for you.  It takes the directory name you would like Parade to create for you.
 
 > ### Options
 >

data/bin/parade

@@ -54,9 +54,10 @@ command [:s,:serve,:server] do |c|
     puts "
 -------------------------
 
-yourr Parade presentation is now starting up.
+  Your Parade presentation is now starting up.
 
-To view it plainly, visit [ #{url} ]
+  To view it visit [ #{url} ]
+  To view a printable version [ #{url}/print ]
 
 -------------------------
 

data/lib/parade/commands/html_output.rb

@@ -36,6 +36,7 @@ module Parade
 
         template_options = {  'erb_template_file' => File.join(default_view_path, "#{options['template']}.erb"),
                               'custom_asset_path' => root_path,
+                              'presentation' => root_node,
                               'slides' => root_node.to_html }
 
         render_template template_options

data/lib/parade/commands/static_html.rb

@@ -16,7 +16,7 @@ module Parade
       end
 
       def generate(options)
-        options.merge!('template' => 'onepage')
+        options.merge!('template' => 'print')
 
         html_generator = HtmlOutput.new
         html_content = html_generator.generate(options)

data/lib/parade/helpers/template_generator.rb

@@ -28,8 +28,8 @@ module Parade
     #
     # @param [String] filepath the filepath to the javascript file
     # @return [String] HTML content that is inlined javascript data
-    def js(filepath)
-      js_template(filepath).render
+    def js(*filepaths)
+      filepaths.map {|filepath| js_template(filepath).render }.join("\n")
     end
 
     #
@@ -38,8 +38,8 @@ module Parade
     # @param [String] filepath the filepath to the stylesheet file
     # @return [String] HTML content that is inlined stylesheet data
     #
-    def css(filepath)
-      css_template(filepath).render
+    def css(*filepaths)
+      filepaths.map {|filepath| css_template(filepath).render }.join("\n")
     end
 
     def custom_css_files
@@ -50,12 +50,12 @@ module Parade
       end
     end
 
-    def custom_js_files
-      if custom_asset_path
-        Dir.glob("#{custom_asset_path}**/*.js").map do |path|
-          js_template(path).render
-        end.join("\n")
-      end
+    #
+    # This helper method is called within the header to return the theme specified
+    # by the preseation
+    #
+    def theme_css
+      css("themes/#{presentation.theme}.css") if presentation.theme
     end
 
     #
@@ -78,14 +78,15 @@ module Parade
       template_file = ERB.new File.read(erb_template_file)
       template_file.result(binding)
     end
+
   end
 
   #
   # Generate inline CSS assets. Using CssParser it is able to traverse imports
   # to ensure all CSS is inlined within the document.
-  # 
+  #
   # Also embeds all images contained within the CSS into the inlined CSS.
-  # 
+  #
   class CSSTemplateGenerator < TemplateGenerator
     include Helpers::EncodeImage
 

data/lib/parade/parsers/dsl.rb

@@ -101,6 +101,14 @@ module Parade
         current_section.theme = theme_name
       end
 
+      #
+      # Sets the current sections footer to the specified template file
+      # @note this will only work at the top level section of the presentation
+      #
+      def footer(footer_name)
+        current_section.footer = File.join(options[:current_path], footer_name)
+      end
+
       def pause_message(message)
         current_section.pause_message = message
       end

data/lib/parade/renderers/update_image_paths.rb

@@ -26,47 +26,50 @@ module Parade
       end
 
       def render(content,options = {})
+        # puts "UpdateImagePaths: #{options}"
         render_root_path = options[:root_path] || root_path || "."
 
         content.gsub(/img src=["'](?!https?:\/\/)\/?([^\/].*?)["']/) do |image_source|
           image_name = Regexp.last_match(1)
-          
+
           html_image_path = File.join("/","image",image_name)
           updated_image_source = %{img src="#{html_image_path}"}
 
           html_asset_path = File.join(render_root_path,image_name)
-          width, height = get_image_size(html_asset_path)
+          width, height = get_image_size(html_asset_path,options)
           updated_image_source << %( width="#{width}" height="#{height}") if width and height
 
           updated_image_source
         end
       end
 
-      def get_image_size(path) ; end
+      def get_image_size(path,options={}) ; end
 
       if defined?(Magick)
 
-        def get_image_size(path)
-          unless cached_image_size.key?(path)
+        def get_image_size(path,options={})
+          image = Magick::Image.ping(path).first
+          # image = Magick::Image.read(path).first
+          # # don't set a size for svgs so they can expand to fit their container
+          if image.mime_type == 'image/svg+xml'
+            [nil, nil]
+          else
 
-            image = Magick::Image.ping(path).first
+            final_width = image.columns
+            final_height = image.rows
 
-            # # don't set a size for svgs so they can expand to fit their container
-            if image.mime_type == 'image/svg+xml'
-              cached_image_size[path] = [nil, nil]
-            else
-              cached_image_size[path] = [image.columns, image.rows]
+            if !options[:width].nil? && image.columns.to_i > options[:width].to_i
+              final_width = (options[:width].to_f - 100) / image.columns * image.columns
             end
 
-          end
-          cached_image_size[path]
-        end
+            if !options[:height].nil? && image.rows.to_i > options[:height].to_i
+              final_height = (options[:height].to_f - 100) / image.rows * image.rows
+            end
 
-        def cached_image_size
-          @cached_image_size ||= {}
+            [final_width, final_height]
+          end
         end
 
-
       end
 
     end