docgenerator 2.1.0 → 2.1.1

data/lib/docgenerator.rb

@@ -1,7 +1,13 @@
+#encoding: utf-8
 =begin rdoc
 = NAME
 Docgenerator
 
+Version see Docgenerator::VERSION
+
+* For change history, please refer version.rb[link:files/lib/docgenerator/version_rb.html]
+
+
 = SYNOPSIS
 Docgenerator provides a ruby interface to build documents.
 
@@ -10,8 +16,10 @@ The document generation is build via 'Elements',
 the target format is generic, actual supported are:
 -LaTeX 
 -HTML
-Plain text and two Wiki-version exist also (Wikimedia and Creole), 
+-Creole
+Plain text and two Wikimedia-format are defined,
 but they are not well maintained.
+
 A context-export is planned for the future 
 (but it has a low level-importance for me).
 
@@ -66,23 +74,11 @@ HTML-Versions are not supported properly
 (main problem: End-Tag for br)
 
 More at http://ruby.lickert.net/docgenerator/index.html
-=end
-
-#
-#For quick test
-#
-if $0 == __FILE__ and RUBY_VERSION =~ /1.9/
-  $:.unshift('.')
-end
-
-
 
-=begin rdoc
+==Module Docgenerator
 All classes of this gem are encapsulated in module Docgenerator.
 =end
 module Docgenerator
-  #Define Version number  
-  VERSION = '2.1.0'
   class << self
     @trace = nil
 =begin rdoc
@@ -340,6 +336,14 @@ Instance-version of class method.
 end #module Docgenerator
 
 
+#
+#For quick syntax checks (and small tests)
+#
+if $0 == __FILE__ and RUBY_VERSION =~ /1.9/
+  $:.unshift('.')
+end
+
+require 'docgenerator/version' 
 require 'docgenerator/standard'
 require 'docgenerator/element_meta' #Meta-class definitions
 require 'docgenerator/element'  #includes definition of method 'element'
@@ -357,6 +361,7 @@ require 'docgenerator/lists'		#define environment
 require 'docgenerator/sections'
 require 'docgenerator/tabular'
 require 'docgenerator/footnote'
+require 'docgenerator/index'  #makeindex, index, printindex...
 require 'docgenerator/characters'	#special characters (spaces, euro-sign...)
 #~ require_relative 'docgenerator/characters'	#special characters (spaces, euro-sign...)
 
@@ -370,6 +375,6 @@ if $0 == __FILE__
   doc.body << 'text'
   #~ p doc.to_doc(:html, {:log => Docgenerator::DOCGENERATOR_DEFAULT_LOGGER})
   #~ p doc.to_doc(:latex, {:log => Docgenerator::DOCGENERATOR_DEFAULT_LOGGER})
-  doc.save('xx.html')
+  #~ doc.save('xx.html')
 end
 __END__

data/meta_test_and_doc/build_doc.rb

@@ -288,7 +288,6 @@ def  mk_attr_overview(variant, attr, el)
   
 end #mk_attr_overview
 
-
 desc "Create all manpages"
 task :all_man_files
 #Build single file tasks
@@ -299,6 +298,35 @@ FILE_SEPARATION.each{|key, elementlist|
   task :all_man_files => filename #add file task as prerequisite to :all_man_files
 }
 
+class Docgenerator::Element
+  #Helper to have access to all ids.
+  def self.ids; @@ids;end
+end
+file 'manpages/elementlist.rb' => :force do |tsk|
+  File.open(tsk.name, 'w:utf-8'){|f|
+    f << <<rdoc
+#encoding: utf-8
+
+=begin rdoc
+The following elements and characters are defined and can be used with
+    element(key, { options}, content)
+
+rdoc
+
+    Docgenerator::Element.ids.sort_by{|id, elclass|id.to_s}.each{|id, elclass|
+      f << "* <tt>%s</tt>: %s\n" % [id.inspect,elclass]
+      #~ f << "[<tt>%s</tt]: %s\n" % [id,elclass]  #labeled list  (rdoc4.0?)
+    }
+    f << <<rdoc
+=end
+def element
+end #element
+rdoc
+  }
+end #file 'manpages/elementlist.rb'
+task :all_man_files => 'manpages/elementlist.rb'
+
+
 task :force
 task :clean do
   Rake.application[:all_man_files].prerequisites.each{|f| 
@@ -314,20 +342,21 @@ end
 
 
 #~ task 'manpages/environments.rb' => :force
-#~ task :default => 'manpages/environments.rb'
+#~ task :local_default => 'manpages/environments.rb'
 #~ task 'manpages/sectioning.rb' => :force
-#~ task :default => 'manpages/sectioning.rb'
+#~ task :local_default => 'manpages/sectioning.rb'
 #~ task 'manpages/elements.rb' => :force
-#~ task :default => 'manpages/elements.rb'
+#~ task :local_default => 'manpages/elements.rb'
 #~ task 'manpages/characters.rb' => :force
-#~ task :default => 'manpages/characters.rb'
+#~ task :local_default => 'manpages/characters.rb'
 
-#~ task :default => :test
-task :default => :clean
-task :default => :all_man_files
-#~ task :default => :rdoc_manpages
+#~ task :local_default => 'manpages/elementlist.rb'
+#~ task :local_default => :test
+#~ task :local_default => :clean
+#~ task :local_default => :all_man_files
+task :local_default => :rdoc_manpages
 
 if $0 == __FILE__
   app = Rake.application
-  app[:default].invoke
+  app[:local_default].invoke
 end

data/meta_test_and_doc/build_test.rb

@@ -30,7 +30,8 @@ Test generated by #{__FILE__} #{Date.today}
 
 This is not a 'real' test unit.
 The tests are created with #{__FILE__}:
-1) Each Element is taken and field.
+
+1) Each Docgenerator::Element is taken and a test is generated.
 =end
 
 gem 'test-unit'
@@ -206,23 +207,28 @@ end # mk_element_testcase(cl)
 
 
 desc "Create all test files"
-task :all_test_files
+task :create_test_files
 
 #Create file tasks
 FILE_SEPARATION.each{|key, elementlist|
   filename = File.join('unittest', "unittest_#{key}")
-  file filename do |tsk| mk_element_test(elementlist, tsk.name, FILE_SEPARATION_REQUIREMENTS[key] ); end  #Create file task
-  task :all_test_files => filename  #add file task as prerequisite to :all_test_files
+  #~ puts "file '%s' => :force" % filename
+  desc "Create %s" % filename
+  file filename do |tsk| #Create file task
+    mk_element_test(elementlist, tsk.name, FILE_SEPARATION_REQUIREMENTS[key] )
+  end  
+  task :create_test_files => filename  #add file task as prerequisite to :create_test_files
 }
 
 task :force
 task :clean do
-  Rake.application[:all_test_files].prerequisites.each{|f| 
+  Rake.application[:create_test_files].prerequisites.each{|f| 
     File.delete(f) if File.exist?(f)
   } 
 end
 
-require 'knut_tools/rake/testtask.rb'
+$:.unshift('c:/usr/script/knut/knut-testtask/lib')  #get local dev. version
+require 'knut-testtask.rb'
 Rake::TestTask.new(:run_tests) do |t|
     t.dir = 'unittest'
     t.libs << '../lib'
@@ -231,13 +237,31 @@ Rake::TestTask.new(:run_tests) do |t|
     t.verbose = true
 end
   
-task :default => :clean
-task :default => :all_test_files
-#~ task :default => :run_tests
+#~ task :local_default => :clean
+#~ file 'unittest/unittest_attachfile.rb' => :force
+#~ file 'unittest/unittest_caption.rb' => :force
+#~ file 'unittest/unittest_hyperref.rb' => :force
+#~ file 'unittest/unittest_listings.rb' => :force
+#~ file 'unittest/unittest_pdfpages.rb' => :force
+#~ file 'unittest/unittest_scrlettr2.rb' => :force
+#~ file 'unittest/unittest_scrpage2.rb' => :force
+#~ file 'unittest/unittest_todonotes.rb' => :force
+#~ file 'unittest/unittest_wiki2docgenerator.rb' => :force
+#~ file 'unittest/unittest_characters.rb' => :force
+#~ file 'unittest/unittest_environments.rb' => :force
+#~ file 'unittest/unittest_lists.rb' => :force
+#~ file 'unittest/unittest_footnote.rb' => :force
+#~ file 'unittest/unittest_sectioning.rb' => :force
+#~ file 'unittest/unittest_tables.rb' => :force
+#~ file 'unittest/unittest_elements.rb' => :force
+#~ file 'unittest/unittest_others.rb' => :force
+
+task :local_default => :create_test_files
+#~ task :local_default => :run_tests
 
 if $0 == __FILE__
   app = Rake.application
-  app[:default].invoke
+  app[:local_default].invoke
 end
 
 #~ puts_elements
@@ -247,5 +271,3 @@ fixme:
 - tests mit #cr...
 - optionale attribute
 - testdaten in DB? (verschiedene Attributesausprägungen?)
-
-