docgenerator 2.1.1 → 3.0.0

data/lib/docgenerator/packages/todonotes.rb

@@ -32,10 +32,10 @@ class Todo < Element
 			:linecolor		=>	Attribute.create( [ :texkeyval], [ String ] ),
 			:bordercolor		=>	Attribute.create( [ :texkeyval], [ String ] ),
 			:inline		=>	Attribute.create( [ :texkeyval], [ true, false ] ),
+			:line		=>	Attribute.create( [ :texkeyval], [ true, false ] ),
+			:noline		=>	Attribute.create( [ :texkeyval], [ true, false ] ),
 =begin      
     more options:
-      line / noline
-      inline / noinline
       size
       list / nolist When the option nolist is given, the todo item will not appear in the list of todos.
       caption For listoftodos

data/lib/docgenerator/packages/url.rb

@@ -1,5 +1,9 @@
 module Docgenerator
   module Packages
+
+      class Path < Element       
+        add_latex_output '#{linebreak(@crbefore)}\path{#{@content}}#{linebreak(@crafter)}'
+      end #Checkbox
   #
   #Small Administration class for websites and their description
   #

data/lib/docgenerator/sections.rb

@@ -76,10 +76,11 @@ Is redefined by set_wikilevel( level )
       
       #Small helper to make TeX-Hyperlinks like in HTML (attribute id)
       def hypertarget(id)
-        return "\\hypertarget{#{id}}{}" if id.is_a?(String)
+        #~ return "\\hypertarget{#{id}}{}" if id.is_a?(String)
         #~ return '' if ! id.content or id.content.to_s =~/\A\s*\Z/
         return '' if ! id.content or id.content.join =~/\A\s*\Z/  #Ruby 1.9
-        return "\\hypertarget{#{id}}{}"
+        #~ return "\\hypertarget{#{id}}{}"
+        return "\\hypertarget{#{id}}{}\\label{#{id}}"
       end
 =begin rdoc
 Determine the TeX-Makroname from class name
@@ -244,7 +245,28 @@ Attributes see class DummySectioning.
       add_html_tag 'h6'
     end #H6
 
+=begin rdoc
+Define Element :addpart
+
+\\addpart is a command provided by koma-script.
 
+Create an instance with
+  element( :addpart, [ attributes, [content]] )
+or
+  addpart.new( [ attributes, [content]] )
+  
+Attributes may be:
+* HTML_ATTR_ALL
+=end
+    class Addpart < Element
+      add_attributes HTML_ATTR_CORE
+      add_attributes HTML_ATTR_I18N
+      add_attributes HTML_ATTR_EVENTS
+      add_attribute :lang, ATTR_LANG
+      add_html_tag 'h2'
+      add_latex_output '#{linebreak(@crbefore)}' + '\addpart{#{@content}}' + '#{linebreak(@crafter)}'
+    end #addpart
+    
 =begin rdoc
 Define Element :addsec
 

data/lib/docgenerator/tabular.rb

@@ -2,7 +2,6 @@
 =begin rdoc
 Definition of tabular elements for docgenerator-gem.
 =end
-
 #
 module Docgenerator
 =begin rdoc
@@ -12,6 +11,7 @@ Definition of tabular elements for docgenerator-gem.
     #Define some constants to include packages into document header.
     TEX_PACKAGE_TABULARX	= element(:usepackage,{},'tabularx').cr
     TEX_PACKAGE_LONGTABLE= element(:usepackage,{},'longtable').cr
+    TEX_PACKAGE_LTXTABLE= element(:usepackage,{},'ltxtable').cr #Longtable and tab­u­larx merge
     TEX_PACKAGE_BOOKTABS	= element(:usepackage,{},'booktabs').cr
 
 =begin rdoc
@@ -37,7 +37,7 @@ fixme:  check on attributes. columnsdescription
       add_attributes HTML_ATTR_ALL
       #Problem: Nicht weitervererbt
       add_attribute	:columndescription	,  Attribute.create( [:latex, :required ] ) 
-      add_attribute	:columns			,  Attribute.create( [:required], [ Fixnum ] ) 
+      add_attribute	:columns			,  Attribute.create( [:required], [ Integer ] ) 
       add_attribute	:border			,  Attribute.create( [:html] ) 
       add_attribute	:bgcolor			, Attribute.create( [ :html ] )
       add_attribute	:width			, Attribute.create( [ :html ], [ Integer, String ] )	#String necessary for percentage
@@ -113,10 +113,12 @@ Output a complete tabular in wikimedia-like tabular extension for creole.
     end #class Tabular
   
 =begin rdoc
-Use longtable-package.
+Use longtable-package: http://ctan.org/pkg/longtable
 
 Requires
 	doc.head	<< element(:usepackage,{},'longtable')  
+or  
+	doc.head	<< Docgenerator::Tables::TEX_PACKAGE_LONGTABLE
   
 =end
     class Longtable < Tabular
@@ -141,10 +143,12 @@ Requires
       end
     end #class Longtable
 =begin rdoc
-Use Tabularx-package.
+Use Tabularx-package: http://ctan.org/pkg/tabularx
 
 Requires
-	doc.head	<< element(:usepackage,{},'longtable')
+	doc.head	<< element(:usepackage,{},'tabularx')
+or  
+	doc.head	<< Docgenerator::Tables::TEX_PACKAGE_TABULARX
 
 fixme :width is obligatory
 =end
@@ -161,9 +165,9 @@ fixme :width is obligatory
         cmd	=	''
         cmd	<<	"\n" if @crbefore
         cmd	<<	"\\begin{tabularx}{"
-        cmd	<<	@attr[:width].content.to_s
+        cmd	<<	@attr[:width].content.join
         cmd	<<	"}{"
-        cmd	<<	@attr[:columndescription].content.to_s
+        cmd	<<	@attr[:columndescription].content.join
         cmd	<<	"}"
         cmd	<<	"\n" if @crmid
         cmd	<< @content.to_doc(:latex, o )
@@ -172,6 +176,40 @@ fixme :width is obligatory
         return cmd
       end
     end   #class Tabularx
+
+=begin rdoc
+Use ltxtable-package (Longtable and tab­u­larx merge): 
+http://ctan.org/pkg/ltxtable
+
+Requires
+	doc.head	<< element(:usepackage,{},'ltxtable')  
+or  
+	doc.head	<< Docgenerator::Tables::TEX_PACKAGE_LTXTABLE
+
+
+=end
+    class Ltxtable < Tabular
+      add_attributes Tabular.get_attribute_list( )
+      #Position of the ltxtable in paragraph
+      add_attribute	:texalignment,  Attribute.create( [:latex], %w{l c r} ) 
+      def to_latex(options={})
+        o = set_option_defaults(options)
+        o[:log].debug("enter to_latex for ltxtable") if o[:log].debug?
+        cmd	=	''
+        cmd	<<	"\n" if @crbefore
+        cmd	<<	"\\begin{ltxtable}"
+        cmd	<<	"[%s]" % @attr[:texalignment].content.first if @attr[:texalignment]
+        cmd	<<	"{"
+        cmd	<<	@attr[:columndescription].content.to_doc(:latex, o)
+        cmd	<<	"}"
+        cmd	<<	"\n" if @crmid
+        cmd	<< @content.to_latex(o)
+        cmd	<<	"\\end{ltxtable}"
+        cmd	<<	"\n" if @crafter
+        return cmd
+      end
+    end #class ltxtable
+
 =begin rdoc
 May only be used inside a tabular. Tabular must set the columns-value.
 
@@ -462,9 +500,7 @@ Attributes are not defined for this element.
     end #Endlastfoot
 
 =begin rdoc
-A column in a tabular.
-
-
+A column/cell in a tabular.
 =end
     class Column < Element
       has_no_content :empty_ok
@@ -490,7 +526,9 @@ A column in a tabular.
             "#{@content.to_latex(o)}"
           end
         cmd	<<	"\n" if @crafter
-        return cmd
+        #The sub.command is needed to avoid problems like [xx] after a \\
+        #Details see https://de.wikibooks.org/wiki/LaTeX-W%C3%B6rterbuch:_TeX_Primitiven:_%5Crelax
+        return cmd.sub(/\A\[/, '\relax [')
       end
       def content?; :empty_ok; end
       def htmltag()
@@ -552,10 +590,10 @@ Multicolumn
 
     #~ add_attributes( HTML_ATTR_ALL ) 
       add_attributes( { 
-        #~ :columns	=>  Attribute.create( [:required], [ Fixnum ] ) ,	#colspan
-        :colspan	=> 	Attribute.create( [:required, :html, :latex], [ Fixnum ], 2 ) ,
+        #~ :columns	=>  Attribute.create( [:required], [ Integer ] ) ,	#colspan
+        :colspan	=> 	Attribute.create( [:required, :html, :latex], [ Integer ], 2 ) ,
         :columns => :colspan,
-        :rowspan	=> 	Attribute.create( [:html ], [ Fixnum ], 2 ),
+        :rowspan	=> 	Attribute.create( [:html ], [ Integer ], 2 ),
         :pos		=>  Attribute.create( [:latex] ) ,
         :align	=>  HTML_ATTR_ALIGN,
         :width 	=> Attribute.create( [ :html ] ),
@@ -588,10 +626,16 @@ Multicolumn
         return "<Class Multicolumn @content=#{@content.inspect}>"
       end
     end
+=begin rdoc
+Define a caption.
 
+If the option longtable is set, then a \\ is added 
+(needed if a \caption is set inside a longtable-environment)
+=end
     class Caption < Element
       #
       add_attribute :optional, Attribute.create( [ :latex ] )
+      add_attribute :longtable, Attribute.create( [ :latex] )
       
       def to_latex(options= {})
         cmd	=	''
@@ -606,6 +650,7 @@ Multicolumn
         cmd	<<	"{"
         cmd	<< @content.to_latex(options)
         cmd	<<	"}"
+        cmd << '\\\\' if @attr[:longtable].content != []
         cmd	<<	"\n" if @crafter
         return cmd
       end

data/lib/docgenerator/templates/docgenerator_template.rb

@@ -70,6 +70,7 @@ Base for the document to be created.
   attr_reader :target
   #Target encoding of the template
   attr_reader :encoding
+  attr_reader :key
   
   def inspect()
     "<#{self.class} #{@key} for #{@target.inspect}>"

data/lib/docgenerator/templates/docgenerator_template.yaml

@@ -170,6 +170,34 @@
     \end{document}
     % ----------------------------------------------------------------
 
+:report_utf8: 
+  :target: :latex
+  :encoding: utf-8
+  :source: |
+    <<prefix>>
+    \documentclass[<<classoptions>>]{scrreprt}
+    \usepackage{babel}
+    %Encoding-package depends on TeX-engine
+    \usepackage{ifpdf,ifxetex,ifluatex}
+    \ifxetex
+      \usepackage{fontspec}	%Without, umlauts are missing
+    \fi
+    \ifluatex
+      \usepackage[utf8]{luainputenc} %Or in first line: % !Mode:: "TeX:UTF-8".
+    \else
+      \ifpdf\relax
+        \usepackage[utf8]{inputenc}
+      \fi
+    \fi
+    \usepackage{hyperref}
+    % ----------------------------------------------------------------
+    <<head>>
+    % ----------------------------------------------------------------
+    \begin{document}
+    <<body>>
+    \end{document}
+    % ----------------------------------------------------------------
+
 :standalone: 
   :target: :latex
   :encoding: utf-8
@@ -189,7 +217,8 @@
         \usepackage[utf8]{inputenc}
       \fi
     \fi
-    %\usepackage{hyperref}
+    \usepackage{luatex85} %%Needed since TeXLive 2016
+    \usepackage{hyperref}
     % ----------------------------------------------------------------
     <<head>>
     % ----------------------------------------------------------------

data/lib/docgenerator/version.rb

@@ -137,10 +137,22 @@
 * Packages:
   * Docgenerator::Packages::PDFPages
   New: Docgenerator::Packages::PDFPages::IncludePDFmerge
+
+==2.1.2
+* Replace test-unit by minitest. 
+
+
+==3.0.0 2018-03-25
+* Remove Docgenerator::Creole
+ Use the docgenerator-creole.gem instead
+* Default-template for LaTeX is :article_utf8
+* standalone-template: include lualatex85
+* Switch Fixnum -> Integer (ruby 2.4)
+pdfpages: add option 'options'
 =end
 
 #
 module Docgenerator
   #Define Version number. 
-  VERSION = '2.1.1'
+  VERSION = '3.0.0'
 end

data/meta_test_and_doc/build__meta.rb

@@ -9,7 +9,9 @@ require 'rake'
 Load all Docgenerator parts
 =end
 $:.unshift('../lib')
+$:.unshift('../../docgenerator-creole/lib')
 require 'docgenerator'
+require 'docgenerator-creole'
 module Docgenerator
 =begin rdoc
 Extend Element to get ids.
@@ -47,16 +49,6 @@ require 'docgenerator/packages/struktex.rb'
 require 'docgenerator/packages/todonotes.rb'
 require 'docgenerator/packages/url.rb'
 
-##does not influence this
-require 'creole/creole2doc.rb'
-require 'creole/plugins/rail.rb'
-require 'creole/plugins/rubycode4creole.rb'
-require 'creole/plugins/struktex.rb'
-require 'creole/plugins/todonotes.rb'
-
-require 'wiki2doc/wiki2docgenerator.rb'
-require 'wiki2doc/plugins/rubycode4wiki.rb'
-require 'wiki2doc/plugins/struktex.rb'
 
 =begin rdoc
 List all known elements
@@ -112,6 +104,7 @@ Docgenerator::Element::SOURCE.each{|sourcefile, elementlist|
   'environments.rb' => Docgenerator::Element.each.select{|cl| cl.name =~ /::Environments::/},
   'lists.rb'            => Docgenerator::Element.each.select{|cl| cl.name =~ /::Lists::/},
   'footnote.rb'       => Docgenerator::Element.each.select{|cl| cl.name =~ /::Footnote/}, #no own module
+  'images.rb'       => Docgenerator::Element.each.select{|cl| cl.name =~ /::Img/}, #no own module
   'sectioning.rb'    => Docgenerator::Element.each.select{|cl| cl.name =~ /::Sectioning::/} - [  ],
   'tables.rb'          => Docgenerator::Element.each.select{|cl| cl.name =~ /::Tables::/},
   #~ #If not already read by others  

data/meta_test_and_doc/build_doc.rb

@@ -20,7 +20,6 @@ xx
 Prepare a documentation, based on execution and meta-analyse.
 =end
 def mk_element_doc(elementlist, filename )
-  
   rd_code = [
     DOCHEADER,
     list_of_elements = [],
@@ -302,6 +301,7 @@ 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
@@ -349,12 +349,14 @@ end
 #~ task :local_default => 'manpages/elements.rb'
 #~ task 'manpages/characters.rb' => :force
 #~ task :local_default => 'manpages/characters.rb'
+#~ file 'manpages/images.rb' => :force
+#~ task :local_default => 'manpages/images.rb'
 
 #~ 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
+#~ task :local_default => :rdoc_manpages
 
 if $0 == __FILE__
   app = Rake.application

data/meta_test_and_doc/build_test.rb

@@ -7,7 +7,7 @@ Generates:
 * create an element
 * make a test output and create unit tests for the elemnt.
 
-The resultof this process is not a test for correctness,
+The result of this process is not a test for correctness,
 but a test of "state of the art".
 
 Effects of changes may be checked wih the result of this test.
@@ -31,11 +31,13 @@ Test generated by #{__FILE__} #{Date.today}
 This is not a 'real' test unit.
 The tests are created with #{__FILE__}:
 
-1) Each Docgenerator::Element is taken and a test is generated.
+Each Docgenerator::Element is taken and a test is generated.
+The assertions reflect the actual behaviour, 
+it must not be the wanted or expected result.
 =end
 
-gem 'test-unit'
-require 'test/unit'
+gem 'minitest'
+require 'minitest/autorun'
 
 if $0 == __FILE__
   #Add lib, two insertions, depending on target directory level
@@ -102,23 +104,23 @@ def mk_element_testcase(cl)
         loglevel = Log4r::DEBUG
     end
     
-    @@log = Log4r::Logger.new(cl.element_ids.first.to_s, loglevel)
-    @@log.outputters = @@logoutputter = ArrayOutputter.new('xx')
-    @@el = cl.new(:log => @@log )
+    log = Log4r::Logger.new(cl.element_ids.first.to_s, loglevel)
+    log.outputters = logoutputter = ArrayOutputter.new('xx')
+    el = cl.new(:log => log )
     
     testcode << <<code
 =begin rdoc
 Test #{cl.name}.
 =end
-class #{testclass} < Test::Unit::TestCase
+class #{testclass} < MiniTest::Test
   def self.startup()
     @@log = Log4r::Logger.new('#{cl.element_ids.first.to_s}', Log4r::#{Log4r::LNAMES[loglevel]})
     @@log.outputters = @@logoutputter = ArrayOutputter.new('xx')
     @@el = #{cl.name}.new(:log => @@log)
 code
-      @@el.attr.sort_by{|k,a| a.sortkey}.each{|k,a|
+      el.attr.sort_by{|k,a| a.sortkey}.each{|k,a|
         #this may give an error, if the attribute has wrong type/layout...
-        @@el[k] << "Attr_#{k}" if a.required? 
+        el[k] << "Attr_#{k}" if a.required? 
         testcode  << "%s   @@el[%-10s] << %-20s #%s attribute" % [
           a.required?  ? '  ' : '#~',#only as template for optional values
           k.inspect,
@@ -127,8 +129,8 @@ code
         ]
       }
       
-      if @@el.content?
-        @@el << 'content'
+      if el.content?
+        el << 'content'
         testcode<< "    #fill content"
         testcode<< "    @@el << 'content'"
       else
@@ -138,28 +140,29 @@ code
       testcode<< "    #Store log messages"
       testcode<< "    @@messages = @@logoutputter.flush"
     #test log-content
-    @@messages = @@log.outputters.first.flush
+    messages = log.outputters.first.flush
     testname = "test_element_#{cl.name.downcase.gsub(/::/, '_')}_log"
     
     testcode<< <<code
     end #self.startup()
+    startup #minitest does not support self.startup. so we call it here.
 =begin rdoc
 Check messages from logger.
 This may include warnings for wrong content format...
 
 The following messages are expected:
-#{@@messages.to_yaml}
+#{messages.to_yaml}
 =end
   def #{testname}
     assert_equal(
-      #{@@messages.inspect},
+      #{messages.inspect},
       @@messages
     )
   end ##{testname}
 code
     %w{latex html context text wiki creole}.each{|target|
         testname = "test_element_#{cl.name.downcase.gsub(/::/, '_')}_#{target}"
-        result = @@el.send("to_#{target}".to_sym, :log => @@log)
+        result = el.send("to_#{target}".to_sym, :log => log)
         
 #~ The target #{target} is #{@@el.send("#{target}?".to_sym) ? '' : 'not' } supported for #{cl.name}
         testcode<< <<code
@@ -187,7 +190,7 @@ Problem: %{inhalt} macht Probleme bei Strings mit { und }
         testcode<< "      @@el.to_#{target}( :log => @@log).encode('utf-8')"
         testcode<< "    )"
         
-        messages = @@logoutputter.flush
+        messages = logoutputter.flush
         if messages.empty?
           testcode<< "    assert_equal([],@@logoutputter.flush, 'No messages expected')"
         else
@@ -254,6 +257,7 @@ end
 #~ file 'unittest/unittest_sectioning.rb' => :force
 #~ file 'unittest/unittest_tables.rb' => :force
 #~ file 'unittest/unittest_elements.rb' => :force
+#~ file 'unittest/unittest_images.rb' => :force
 #~ file 'unittest/unittest_others.rb' => :force
 
 task :local_default => :create_test_files