condom 0.1.0 → 0.1.1

data/{CHANGELOG → CHANGELOG.rdoc}

@@ -1,9 +1,11 @@
-0.1.0
-=====
+== 0.1.1
+
+Made the executable prettier (confirmation and help).
+
+== 0.1.0
 
 Added the language option. This option should be a LaTeX language. Default is 'francais'.
 
-0.0.1
-=====
+== 0.0.1
 
 Initial version of Condom gem.

data/README.rdoc

@@ -0,0 +1,83 @@
+= Condom
+
+A Ruby lib to create a skeleton for a LaTeX document.
+
+== Installation
+
+  $ gem install condom
+
+== Usage
+
+For the usage of the lib, see the documentation (gem server for example).
+
+Condom gem provides a condom shell command.
+
+  $ condom --help
+  Usage: condom [options] [destination]
+  Available options:
+      -m, --math                       Math packages
+      -l, --listings                   Listings package
+      -f, --fancyhdr                   Fancyhdr package
+      -p, --pdf                        PDF config
+      -g, --graphics                   Images packages
+      -n, --filename=FILENAME          Define a file name
+      -a, --author=AUTHOR              Define the author
+      -t, --title=TITLE                Define the title
+      -d, --date=DATE                  Define the date
+      -c, --class=CLASS                Define the document class
+      -L, --language=LANGUAGE          Define the language
+      -P, --package=PACKAGE            Add another package
+      -v, --version                    Print version
+  destination:
+      /home/v0n (current directory)
+
+In generated files, there is a Makefile.
+Just use your document (from the source folder) like below.
+
+compile with:
+  $ make
+or compile and open with:
+  $ make view
+clean sources (remove .out, .toc, etc. files) with:
+  $ make clean
+archive the whole document with:
+  $ make archive
+
+== Technique
+
+The following command:
+  $ condom -mlfpg -t "Condom makes LaTeX easier" here
+
+will generate:
+  $ tree here/
+  here/
+  ├── fig
+  ├── fig.tex
+  ├── inc
+  │   ├── colors.tex
+  │   ├── commands.tex
+  │   ├── lst-conf.tex
+  │   └── packages.tex
+  ├── main.tex
+  ├── Makefile
+  └── src
+
+=== fig/
+This is the folder where you should put your images.
+
+=== inc/
+This folder has all configuration tex files:
+* colors.tex - customized colors
+* commands.tex - customized commands
+* lst-conf.tex - configuration file for the listings package
+* packages - all needed packages
+
+=== main.tex
+The main tex file. If you specify a filename with -n option, then the generated pdf file will have this name, not the main tex file.
+
+=== Makefile
+Makefile to manage your document sources easily (see the usage above).
+
+=== src/
+This is the folder where to put listings (a result of -l option).
+

data/bin/condom

@@ -7,14 +7,13 @@
 
 require 'condom'
 require 'optparse'
-require 'yaml'
+#require 'yaml'
 
 ops = Condom::Document::DEFAULT_OPTIONS
 
 ARGV.options do |o|
   o.banner = "Usage: #{File.basename $0} [options] [destination]\n"
-  o.on_head("Available options:")
-
+  o.on_head("\nAvailable options:")
   o.on("-m", "--math",                      "Math packages")             { ops[:math] = true }
   o.on("-l", "--listings",                  "Listings package")          { ops[:listings] = true }
   o.on("-f", "--fancyhdr",                  "Fancyhdr package")          { ops[:fancyhdr] = true }
@@ -28,8 +27,6 @@ ARGV.options do |o|
   o.on("-L", "--language=LANGUAGE", String, "Define the language")       { |v| ops[:language] = v }
   o.on("-P", "--package=PACKAGE",   String, "Add another package")       { |v| ops[:packages].push v }
   #o.on("-v", "--version",                   "Print version")             { puts "Condom lib: version #{Condom::VERSION}" ; exit }
-
-  o.on_tail("destination:\n    " << ops[:outputdir] + (ops[:outputdir] == Dir.getwd ? " (current directory)" : ""))
 end
 
 begin
@@ -41,7 +38,15 @@ begin
   end
 
   # Ask for confirmation
-  puts ops.to_yaml # Could it be prettier?
+  ops.each do |key, val|
+    value = case val
+            when true: "yes"
+            when false: "no"
+            when Array: val.join(", ")
+            else val
+            end
+    printf "%-15s=> %s\n", key, value
+  end
   print "\nContinue [Y/n/h]? "
   case STDIN.gets.strip
   when 'Y', 'y', ''
@@ -56,7 +61,7 @@ begin
   doc = Condom::Document.new(ops)
   doc.create
 
-  puts "OK"
+  puts "Document created in #{doc.outputdir}."
 rescue => e
   STDERR.puts "error: #{e}"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: condom
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Vivien Didelot
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-09 00:00:00 +10:00
+date: 2010-08-12 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -38,8 +38,8 @@ files:
 - lib/views/Makefile.erb
 - lib/views/commands.tex.erb
 - lib/condom.rb
-- README
-- CHANGELOG
+- README.rdoc
+- CHANGELOG.rdoc
 - bin/condom
 has_rdoc: true
 homepage: 

data/README

@@ -1,85 +0,0 @@
-Condom
-------
-
-A Ruby lib to create a skeleton for a LaTeX document.
-
-Installation
-------------
-
-$ gem install condom
-
-Usage
------
-
-For the usage of the lib, see the documentation (gem server for example).
-
-Condom gem provides a condom shell command.
-
-$ condom --help
-Usage: condom [options] [destination]
-Available options:
-    -m, --math                       Math packages
-    -l, --listings                   Listings package
-    -f, --fancyhdr                   Fancyhdr package
-    -p, --pdf                        PDF config
-    -g, --graphics                   Images packages
-    -n, --filename=FILENAME          Define a file name
-    -a, --author=AUTHOR              Define the author
-    -t, --title=TITLE                Define the title
-    -d, --date=DATE                  Define the date
-    -c, --class=CLASS                Define the document class
-    -P, --package=PACKAGE            Add another package
-    -v, --version                    Print version
-destination:
-    /home/v0n (current directory)
-
-In generated files, there is a Makefile.
-Just use your document this way (from the source folder):
-- compile with:
-$ make
-or
-$ make view # this will open the generated document after
-
-- clean sources with:
-$ make clean
-
-- archive the whole document with:
-$ make archive
-
-Technique
----------
-
-The following command:
-$ condom -mlfpg -t "Condom makes LaTeX easier" here
-
-will generate:
-here/
-├── fig
-├── fig.tex
-├── inc
-│   ├── colors.tex
-│   ├── commands.tex
-│   ├── lst-conf.tex
-│   └── packages.tex
-├── main.tex
-├── Makefile
-└── src
-
-fig/
-This is the folder where you should put your images.
-
-inc/
-This folder has all configuration tex files:
-  colors.tex - customized colors
-  commands.tex - customized commands
-  lst-conf.tex - configuration file for the listings package
-  packages - all needed packages
-
-main.tex
-  The main tex file. If you specify a filename with -n option, then the generated pdf file will have this name, not the main tex file.
-
-Makefile
-  Makefile to manage your document sources easily (see the usage above).
-
-src/
-  This is the folder where to put listings (a result of -l option).