present 0.0.3 → 0.1.0

data/README

@@ -6,7 +6,7 @@ Presentation tool for terminal.
 == Description
 
 This program is for terminal addicts.
-You can present your slide by using your favorite terminal.
+You can make a presentation by using your favorite terminal.
 
 == Installation
 
@@ -21,6 +21,12 @@ You can present your slide by using your favorite terminal.
 
 == Features/Problems
 
+- You can make a presentation by using your favorite terminal.
+- You need to configure font size of terminal by yourself.
+- You can't use pictures, yet.
+  Making pictures into ASCII art is a future work ;-)
+- You must encode presentation files as EUC-JP if you want to use Japanese.
+  This limitation comes from ruby-ncurses.
 
 == Synopsis
 
@@ -34,6 +40,40 @@ You can present your slide by using your favorite terminal.
     `page` specifies the page number which will be started from. This is
     optional. The default value is 1.
 
+== File Format
+
+The presentation file is a text file which includes series of pages of which
+you will present.
+
+The pages are separated by blank lines.  The page itself consists of lines.
+Each line has a command at the beginning and text follows it.  The command and
+the text are separated by white spaces.  The available commands are as follows.
+
+= Title. The text follows will be rendered at the center of screen with larger
+  font.
+- Explanation. The text will follow the previous text. The text is right
+  alignment.
+* Header. The text will appear at the top of the page with bold style.
++ Bullet. The text will follow the previous text with bullet mark at the
+  beginning. The text is left alignment. Bullets can be nested by doubling or
+  tripling the symbol.
+  You can avoid margin between the line and the previous line by appending `-`
+  symbol, like this `+-`.
+< Left alignment text.
+> Right aligment text.
+% Color. You can change color of texts which appears after the line.
+The color specified by the name of basic colors, such as red, blue, white,
+black, and so on. If the text is `0`, the color is reset.
+, Wait. Wait for your hitting keys if the text is `-`.  Wait for specified
+  interval if the text is a number in sec
+: Execute command. The text will be executed as a internal command.
+# Message. The text will be displayed with large font in the middle.
+. Final message.
+
+The command can be empty, it means that the line starts with white spaces.  The
+texts of these lines are simply added to the texts of previous lines
+respectively.
+
 == Copyright
 
 Author::    Genki Takiuchi <genki@s21g.com>

data/lib/present.rb

@@ -6,7 +6,7 @@ require 'nkf'
 require 'present/page'
 
 class Present
-  VERSION = '0.0.3'
+  VERSION = '0.1.0'
   TIOCGWINSZ = 0x5413
 
   def initialize(path, timer = 5, page = 1)

data/lib/present/page.rb

@@ -15,11 +15,13 @@ class Present
       end
       @lines.each do |line|
         text, command = line.split(/\s+/, 2).reverse
-        if command
+        if command.nil?
+          next
+        elsif command.empty?
+          stack.last[1] += "\n#{text}"
+        else
           execute_command.call
           stack.push [command, text]
-        else
-          stack.last[1] += "\n#{text}"
         end
       end
       execute_command.call
@@ -49,6 +51,11 @@ class Present
         @screen.color *text.split(/\s+/)
       when ','
         @screen.wait text.to_f
+      when ':'
+        command, *args = text.split(/\s+/)
+        @screen.send "do_#{command}", *args rescue nil
+      when '`'
+        # do nothing
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: present
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Genki Takiuchi