docbook_files 0.3.0 → 0.4.0

data/Gemfile

@@ -3,6 +3,7 @@ source "http://rubygems.org"
 gem "libxml-ruby", :require => 'xml'
 gem "term-ansicolor"
 gem "wand"
+gem "json"
 
 group :development do
   gem "bones"

data/Gemfile.lock

@@ -13,6 +13,7 @@ GEM
       thor (~> 0.14.6)
     guard-rspec (0.5.0)
       guard (>= 0.8.4)
+    json (1.6.1)
     libxml-ruby (2.2.2)
     little-plugger (1.1.2)
     loquacious (1.9.0)
@@ -29,7 +30,7 @@ GEM
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.6.0)
     safe_shell (1.0.1)
-    term-ansicolor (1.0.6)
+    term-ansicolor (1.0.7)
     thor (0.14.6)
     turn (0.8.3)
       ansi
@@ -45,6 +46,7 @@ DEPENDENCIES
   growl_notify
   guard
   guard-rspec
+  json
   libxml-ruby
   rb-fsevent
   rspec

data/Guardfile

@@ -1,4 +1,4 @@
-# -*- encoding:utf-8; mode:ruby -*-
+# -*- encoding:utf-8 ; mode:ruby -*-
 guard 'rspec', :version => 2, :cli => '--color --format nested' do
   watch(%r{^spec/(.+)_spec\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }

data/History.txt

@@ -1,3 +1,12 @@
+== 0.4.0 / 2011-10-14
+
+* Added JSON and YAML output formats
+* Changed colorization to include other errors
+* Changed homepage to GitHub 
+* Minor fixes
+** Fixed Ruby 1.8 incompatibilities
+** Improved error handling
+
 == 0.3.0 / 2011-10-11
 
 * Reorganized output

data/README.md

@@ -7,22 +7,46 @@ Features
 --------
 
 * lists and checks included files (XInclude)
-* lists and checks referenced files (media files and others, specidifed by _fileref_)
+* lists and checks referenced files (media files and others, specified by _fileref_)
 * shows errors, e.g. not existing files
 * provides a detail listing
+* offers alternative output formats (YAML, JSON)
 
 Synopsis
 --------
 
 docbook_files is a command line application, bin/docbook_files, which checks the files that are included or referenced in a DocBook 5 project. 
 
-   docbook_files myproject.xml
+    docbook_files myproject.xml
 
-This will result in a overview listing of the file names, starting from file _myproject.xml_ and following every XInclude link or _fileref_ reference. _fileref_ attributes are used in _mediaobject_ tags to specify external image, video, and audio files. Files that could not be found are shown in red.
+This will result in a overview listing of the file names, starting from file _myproject.xml_ and following every XInclude link or _fileref_ reference. _fileref_ attributes are used in _mediaobject_ tags to specify external image, video, and audio files. Files with problems are marked red.
 
-   docbook_files --details myproject.xml
+    docbook_files --details myproject.xml
 
-The --details option adds, well yes, details to the overview: Size, type information, timestamp and checksum.
+The _--details_ option adds, well yes, details to the overview: size, type information, timestamp and checksum.
+
+If you don't like the screen output or want to integrate docbook_file into a certain workflow, just use the YAML or JSON output format instead. The option _--outputformat_ lets you specify a different output format, for example:
+
+    docbook_files --outputformat=yaml myproject.xml
+
+The result is printed to STDOUT. The structure returned is equivalent to the normal terminal output, except that you always get the details. The structure returned is an array, where each entry contains the following key-value pairs: 
+
+ * type - file type (main, inc-luded, or ref-erenced)
+ * name - file name
+ * full_name - path relative to the main file
+ * level - the level in the file hierarchy, starting with 0
+ * parent - parent file that included or referenced this file
+ * status - error status: 0 = ok, 1 = file not found, 2 = processing error (see error_string)
+ * error_string - contains an error message, if status > 0
+ * namespace - XML namespace, if applicable
+ * version - XML version attribute, of applicable
+ * docbook - true for DocBook 5 files, else false
+ * tag - start tag for XML files (chapter, book, article ...)  
+ * ts - file modification time
+ * size - fiel size in byte
+ * checksum - SHA1 checksum
+ * mime - MIME type
+ 
 
 Requirements
 ------------

data/Rakefile

@@ -1,4 +1,4 @@
-#-*- mode:ruby -*-
+#-*- encoding:utf-8 ; mode:ruby -*-
 begin
   require 'bones'
 rescue LoadError
@@ -15,9 +15,11 @@ Bones {
   name         'docbook_files'
   authors      'Rainer Volz'
   email        'dev@textmulch.de'
-  url          'http://github.com/rvolz/docbook_files/'
+  url          'http://rvolz.github.com/docbook_files/'
   ignore_file  '.gitignore'
+  exclude      << 'dbf-about.org'
   depend_on    'libxml-ruby'
   depend_on    'term-ansicolor'
   depend_on    'wand'
+  depend_on    'json'
 }

data/bin/docbook_files

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# -*-encoding:utf-8 ; mode:ruby-*-
+# -*- encoding:utf-8 ; mode:ruby -*-
 ##
 #
 

data/lib/docbook_files/app.rb

@@ -1,4 +1,4 @@
-# -*-encoding:utf-8-*-
+# -*- encoding:utf-8 -*-
 
 require 'optparse'
 require 'yaml'
@@ -18,14 +18,21 @@ module DocbookFiles
     args ||= ARGV.dup.map! { |v| v.dup }
     ::DocbookFiles::App.new.run args
   end
-  
+
+  ##
+  # App class for the _binary_
+  #
+  # Return codes
+  # * 0 - ok
+  # * 1 - no arguments or file not found
+  # * 2 - processing error
+  #
   class App
     @@banner = <<EOB
 docbook_files, Version #{DocbookFiles::VERSION}
 
-Displays the include hierarchy of a DocBook 5 project. 
-Use the options to see additional information about each file. 
-Files that could not be found are shown in red.
+Shows the file hierarchy of a DocBook 5 project. 
+Files with problems (not found, invalid ...) are marked red.
 
 Usage: docbook_files [options] <DOCBOOK-FILE>
 EOB
@@ -39,24 +46,23 @@ EOB
       @opts[:output_format] ||= :screen
       @opts[:details] ||= false
       @props = [:name, :full_name, :namespace, :docbook,
-                :version, :tag, :parent, :exists, :ts, :size, :checksum, :mime]
+                :version, :tag, :parent, :status, :ts, :size, :checksum, :mime, :error_string]
     end
 
     def run(args)
       opts = OptionParser.new
       opts.on('--details','List file details') {|val| @opts[:details] = true}
-      # opts.on('--outputformat=yaml|json',['json','yaml'],
-      #         'Return the result in YAML or JSON format instead of printing it') {|format|
-      #   case
-      #   when format == 'yaml'
-      #     @opts[:output_format] = :yaml
-      #   when format == 'json'
-      #     @opts[:output_format] = :json
-      #   else
-      #     STDERR.puts "Unknown output format #{format}. Using screen output.".orange
-      #   end
-      # }  
-      
+      opts.on('--outputformat=yaml|json',['json','yaml'],
+              'Return the result in YAML or JSON format') {|format|
+        case
+        when format == 'yaml'
+          @opts[:output_format] = :yaml
+        when format == 'json'
+          @opts[:output_format] = :json
+        else
+          @stderr.puts "Warning: Unknown output format #{format}. Using screen output.".orange
+        end
+      }        
       opts.banner = @@banner
       rest = opts.parse(args)
 
@@ -66,20 +72,42 @@ EOB
         exit 1
       end
 
-      # The main routine
+      # Fail if argument not found
       @stdout.puts("docbook_files, Version #{DocbookFiles::VERSION}") if @opts[:output_format] == :screen
       unless File.exists?(rest[0])
         @stderr.puts "Error: File #{rest[0]} not found.".red
         exit 1
       end
 
+      # Main
       begin
         dbf = DocbookFiles::Docbook.new(rest[0])
         table = dbf.list_as_table(@props)
       rescue => exc
+        @stderr.puts "Something unexpected happend while docbook_files was running ..."
         @stderr.puts exc.inspect.red
+        exit 2
+      end
+      unless table.nil?
+        case @opts[:output_format]
+        when :json
+          mpath = table[0][:full_name]
+          ntable = table.map{|t|
+            t[:full_name] = relative2main(t[:full_name], mpath)
+            t
+          }
+          @stdout.puts ntable.to_json
+        when :yaml
+          mpath = table[0][:full_name]
+          ntable = table.map{|t|
+            t[:full_name] = relative2main(t[:full_name], mpath)
+            t
+          }
+          YAML.dump(ntable,@stdout)
+        else
+          output(table)
+        end
       end
-      output(table)
     end
 
     # Terminal output to @stdout
@@ -91,15 +119,19 @@ EOB
       @stdout.puts '-'*80
       sum_size = 0
       sum_not_existing = 0
+      sum_xml_err = 0
       table.each do |t|
         output = output_string % [t[:level],
                                   format_name(t[:level],t[:full_name],table[0][:full_name]),
                                   t[:type].to_s,
                                   format_size(t[:size])]
         sum_size += t[:size]
-        if t[:exists] == false
+        if t[:status] == FileData::STATUS_NOT_FOUND
           @stdout.puts output.red
           sum_not_existing += 1
+        elsif t[:status] == FileData::STATUS_ERR
+          @stdout.puts output.red
+          sum_xml_err += 1          
         else
           @stdout.puts output
         end
@@ -109,13 +141,16 @@ EOB
       if sum_not_existing > 0
         summary += " #{sum_not_existing} file(s) not found.".red
       end
+      if sum_xml_err > 0
+        summary += " #{sum_xml_err} file(s) with errors.".red
+      end
       @stdout.puts summary
       if @opts[:details]
         @stdout.puts
         @stdout.puts "Details".bold
         table.each do |t|
           fname = format_name(0,t[:full_name],table[0][:full_name])
-          @stdout.puts "File: %s" % [(t[:exists] ? fname : fname.red)]
+          @stdout.puts "File: %s" % [((t[:status] == FileData::STATUS_OK) ? fname : fname.red)]
           if (t[:type] == FileData::TYPE_MAIN)
             @stdout.puts "Main file"
           elsif (t[:type] == FileData::TYPE_INCLUDE)
@@ -123,15 +158,18 @@ EOB
           else
             @stdout.puts "Referenced by: %s" % [t[:parent]]
           end
-          next unless t[:exists]
-          @stdout.puts "Size: %s (%d)" % [format_size(t[:size]),t[:size]]
-          if t[:docbook]
-            @stdout.puts "Type: DocBook, Version #{t[:version]}, Tag: #{t[:tag]}"
-          else
-            @stdout.puts "MIME: #{val_s(t[:mime])}"
+          unless t[:status] == FileData::STATUS_NOT_FOUND
+            # show that part only if file exists
+            @stdout.puts "Size: %s (%d)" % [format_size(t[:size]),t[:size]]
+            if (t[:docbook])
+              @stdout.puts "Type: DocBook, Version #{t[:version]}, Tag: #{t[:tag]}"
+            else
+              @stdout.puts "MIME: #{val_s(t[:mime])}"
+            end
+            @stdout.puts "Timestamp: %s" % [t[:ts]]
+            @stdout.puts "Checksum: %s" % [t[:checksum]]
           end
-          @stdout.puts "Timestamp: %s" % [t[:ts]]
-          @stdout.puts "Checksum: %s" % [t[:checksum]]          
+          @stdout.puts "Error: %s" % [t[:error_string].to_s.red] unless (t[:error_string].nil?)            
           @stdout.puts
         end
       end
@@ -146,13 +184,7 @@ EOB
     # If the resulting string is too long for display it is shortened.
     #
     def format_name(level, full_name, main_name)
-      main_dir = File.dirname(main_name)
-      md = full_name.match("^#{main_dir}/")
-      if md.nil?
-        nname = full_name
-      else
-        nname = md.post_match
-      end
+      nname = relative2main(full_name, main_name)
       lnname = '  '*level+nname
       if (lnname.length > 60)
         lnname[0..3]+'...'+lnname[-54,lnname.length-1]
@@ -161,6 +193,18 @@ EOB
       end
     end
 
+    # Try to find the path of _file_name_ that is relative to the _main file_.
+    # If there is no common part return the _file_name_.
+    def relative2main(file_name,main_name)
+      main_dir = File.dirname(main_name)
+      md = file_name.match("^#{main_dir}/")
+      if md.nil?
+        file_name
+      else
+        md.post_match
+      end
+    end
+
     # :stopdoc:
     KB = 1024
     MB = 1048576

data/lib/docbook_files/docbook.rb

@@ -1,4 +1,4 @@
-# -*-encoding:utf-8-*-
+# -*- encoding:utf-8 -*-
 require 'xml'
 module DocbookFiles
 
@@ -15,10 +15,13 @@ module DocbookFiles
 
     # The FileData tree representing the file hierarchy
     attr_reader :fd_tree
-        
+
+    # Initialize vars and quiet the libxml error handler.
+    # See http://libxml.rubyforge.org/rdoc/classes/LibXML/XML/Error.html
     def initialize(fname)
       @main_name = fname
       @fd_tree = nil
+      XML::Error.set_handler(&XML::Error::QUIET_HANDLER)
     end
 
     # Return the FileData tree representing the include
@@ -114,18 +117,22 @@ private
     #
     def analyze_file(fname, parent_dir, parent_fd=nil)
       fl = FileData.new(fname, parent_dir, parent_fd)
-      begin
-        doc = XML::Document.file(fl.full_name)      
-        fl.namespace = namespace(doc)
-        fl.docbook = true if docbook?(doc)
-        fl.version = version(doc) if fl.docbook
-        fl.tag = start_tag(doc)
-        files = find_xincludes(doc)
-        fl.refs = find_referenced_files(doc,parent_dir,fl)
-      rescue Exception => e
-        files = []
+      if fl.exists?
+        begin
+          doc = XML::Document.file(fl.full_name)      
+          fl.namespace = namespace(doc)
+          fl.docbook = true if docbook?(doc)
+          fl.version = version(doc) if fl.docbook
+          fl.tag = start_tag(doc)
+          files = find_xincludes(doc)
+          fl.refs = find_referenced_files(doc,parent_dir,fl)
+        rescue Exception => e
+          fl.error_string = e.to_s
+          fl.status = FileData::STATUS_ERR
+          files = []
+        end
+        fl.includes = files.map {|f| analyze_file(f,parent_dir,fl)}
       end
-      fl.includes = files.map {|f| analyze_file(f,parent_dir,fl)}
       fl
     end
 

data/lib/docbook_files/file_data.rb

@@ -1,4 +1,4 @@
-# -*-encoding:utf-8-*-
+# -*- encoding:utf-8 -*-
 module DocbookFiles
   require 'date'
   require 'digest/sha1'
@@ -13,9 +13,17 @@ module DocbookFiles
     TYPE_REFERENCE = :ref
     # Type for included files
     TYPE_INCLUDE = :inc
-    
-    attr_accessor :name, :exists, :includes, :refs
 
+    # File exists and no error happened
+    STATUS_OK = 0
+    # File does not exist
+    STATUS_NOT_FOUND = 1
+    # Error while processing the file, see #error_string
+    STATUS_ERR = 2
+    
+    attr_accessor :name, :path, :exists, :includes, :refs
+    attr_accessor :status, :error_string
+    
     def FileData.init_vars()
       x = {:full_name => "file name + path",
         :ts => "last modified timestamp",
@@ -37,26 +45,28 @@ module DocbookFiles
     
 
     def initialize(name,parent_dir=".",parent_file=nil)
-      @name = name
+      @path = name
       @full_name = get_full_name(name, parent_dir)
       @name = File.basename(name)   
       @namespace = ""
       @docbook = false
       @version = ""
       @tag = ""
+      @error_string = nil
       @parent = (parent_file.nil? ? nil : parent_file.name)
       if (File.exists?(@full_name))
-        @exists = true        
+        @status = STATUS_OK
         @ts  = File.mtime(full_name)
         @size = File.size(full_name)        
         @checksum = calc_checksum()
         @mime = get_mime_type()
       else
-        @exists = false
+        @status = STATUS_NOT_FOUND
         @ts = Time.now
         @size = 0
         @checksum = ""
         @mime = ""
+        @error_string = "file not found"
       end
       @includes = []
       @refs = []
@@ -65,13 +75,13 @@ module DocbookFiles
 
     # Does the really file exist?
     def exists?
-      @exists
+      @status != STATUS_NOT_FOUND
     end
 
     # Return the names and parent files of non-existing files
     def find_non_existing_files
-      files = traverse([:name, :exists, :parent])
-      files.flatten.reject{|f| f[:exists] == true}.map{|f| f.delete(:exists); f}
+      files = traverse([:name, :status, :parent])
+      files.flatten.reject{|f| f[:status] != STATUS_NOT_FOUND}.map{|f| f.delete(:status); f}
     end
 
     # Return a tree-like array with all names
@@ -125,9 +135,18 @@ module DocbookFiles
 
 private
 
-    # Calculate the SHA1 checksum for the file
+    # Calculate the SHA1 checksum for the file.
+    #
+    #--
+    # Includes hack for Ruby 1.8
+    #++
     def calc_checksum
-        Digest::SHA1.hexdigest(IO.binread(@full_name))
+      if RUBY_VERSION=~ /^1.8/
+        contents = open(@full_name, "rb") {|io| io.read }
+      else
+        contents = IO.binread(@full_name)
+      end
+      Digest::SHA1.hexdigest(contents)
     end
 
     # Produce the full path for a filename

data/lib/docbook_files.rb

@@ -1,4 +1,4 @@
-# -*-encoding:utf-8-*-
+# -*- encoding:utf-8 -*-
 module DocbookFiles
 
   # :stopdoc:

data/spec/docbook_files/app_spec.rb

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding:utf-8 -*-
 require_relative '../spec_helper'
 
 module DocbookFiles

data/spec/docbook_files/docbook_spec.rb

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+# -*- encoding:utf-8 -*-
 require_relative '../spec_helper'
 
 module DocbookFiles
@@ -11,6 +11,8 @@ module DocbookFiles
       actual.name.should == "no-xml.xml"
       actual.size.should == 15
       actual.docbook.should be_false
+      actual.status.should == FileData::STATUS_ERR
+      actual.error_string.should_not be_nil
     end
     
     it "finds namespace, DocBookness, version" do
@@ -65,7 +67,7 @@ module DocbookFiles
       dbf = DocbookFiles::Docbook.new("spec/fixtures/refs/book-simple-err.xml")
       actual = dbf.list()
       actual.refs.map{|r|r.name}.should == ["orange.png","orange.jpeg"]
-      actual.refs.map{|r|r.exists}.should == [true,false]
+      actual.refs.map{|r|r.status != FileData::STATUS_NOT_FOUND}.should == [true,false]
     end
     
   end

data/spec/docbook_files/file_data_spec.rb

@@ -26,11 +26,11 @@ module  DocbookFiles
       f = FileData.new("spec/fixtures/bookxi.xml")
       actual = f.to_hash([:name,:mime,:size],FileData::TYPE_MAIN)
       actual.should == {:type => :main, :name=>"bookxi.xml", :mime=>"application/xml", :size=>481}
-      actual = f.to_hash([:name, :full_name, :namespace, :docbook, :version, :tag, :parent, :exists, :ts, :size, :checksum, :mime],FileData::TYPE_MAIN)
+      actual = f.to_hash([:name, :full_name, :namespace, :docbook, :version, :tag, :parent, :status, :ts, :size, :checksum, :mime],FileData::TYPE_MAIN)
       expected = {:type => :main, :name=>"bookxi.xml", 
         :full_name=>File.expand_path(".")+"/spec/fixtures/bookxi.xml", 
-        :namespace=>"", :docbook=>false, :version=>"", :tag=>"", :parent=>nil, :exists=>true, 
-        :ts=>Time.parse("2011-10-06 20:45:01 +0200"), :size=>481, 
+        :namespace=>"", :docbook=>false, :version=>"", :tag=>"", :parent=>nil, :status=>FileData::STATUS_OK, 
+        :ts=>File.mtime(File.expand_path(".")+"/spec/fixtures/bookxi.xml"), :size=>481, 
         :checksum=>"7d240e7a084c16665ac59e5b927acd6a06953897", :mime=>"application/xml"}
       actual.should == expected			
     end

data/version.txt

@@ -1 +1 @@
-0.3.0
+0.4.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docbook_files
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-11 00:00:00.000000000Z
+date: 2011-10-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
-  requirement: &2167031960 !ruby/object:Gem::Requirement
+  requirement: &2167326260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,21 +21,21 @@ dependencies:
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *2167031960
+  version_requirements: *2167326260
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
-  requirement: &2167031020 !ruby/object:Gem::Requirement
+  requirement: &2167325580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.6
+        version: 1.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2167031020
+  version_requirements: *2167325580
 - !ruby/object:Gem::Dependency
   name: wand
-  requirement: &2167030100 !ruby/object:Gem::Requirement
+  requirement: &2167324900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,21 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2167030100
+  version_requirements: *2167324900
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2167324260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2167324260
 - !ruby/object:Gem::Dependency
   name: bones
-  requirement: &2167029100 !ruby/object:Gem::Requirement
+  requirement: &2167323640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +65,7 @@ dependencies:
         version: 3.7.1
   type: :development
   prerelease: false
-  version_requirements: *2167029100
+  version_requirements: *2167323640
 description: docbook_files lists and checks all files related to a DocBook writing
   project.
 email: dev@textmulch.de
@@ -65,7 +76,6 @@ extra_rdoc_files:
 - History.txt
 - bin/docbook_files
 files:
-- About.org
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -81,7 +91,6 @@ files:
 - spec/docbook_files/docbook_spec.rb
 - spec/docbook_files/file_data_spec.rb
 - spec/docbook_files_spec.rb
-- spec/fixtures/.DS_Store
 - spec/fixtures/book-nonexisting.xml
 - spec/fixtures/bookxi.xml
 - spec/fixtures/c4/chapter4xi.xml
@@ -89,7 +98,6 @@ files:
 - spec/fixtures/chapter3xi.xml
 - spec/fixtures/no-ns.xml
 - spec/fixtures/no-xml.xml
-- spec/fixtures/refs/.DS_Store
 - spec/fixtures/refs/book-simple-err.xml
 - spec/fixtures/refs/book-simple.xml
 - spec/fixtures/refs/bookxi.xml
@@ -103,7 +111,7 @@ files:
 - spec/fixtures/section1xi.xml
 - spec/spec_helper.rb
 - version.txt
-homepage: http://github.com/rvolz/docbook_files/
+homepage: http://rvolz.github.com/docbook_files/
 licenses: []
 post_install_message: 
 rdoc_options:

data/About.org

@@ -1,77 +0,0 @@
-#+title: Notizen
-#+description: Notizen und Aufgaben für docbook_files
-
-* Eigenschaften
-
-** Grafische Ausgabe der Dateistruktur
-
-*** Graphviz?
-Für Ruby gibt es das viele Module, siehe zum Beispiel graph.
-
-  graph version 2.3.0 has been released!
-
-  * <https://github.com/seattlerb/graph>
-
-  Graph is a type of hash that outputs in graphviz's dot format. It
-  comes with a command-line interface that is easily pluggable.
-
-  It ships with plugins to graph dependencies and status of installed
-  rubygems, rake tasks, homebrew ports, mac ports, and freebsd ports,
-  coloring leaf nodes blue, outdated nodes red, and outdated leaf nodes
-  purple (red+blue).
-
-
-** Detailausgabe gegenüber Hierarchie
-
-Die Hierarchie ist die Hauptausgabe. Allerdings kann man sich über
-'--details' auch die Detailangaben zu allen beteiligten Dateien
-ausgeben lassen. Hier werden alle Angaben ausgegeben, die oben
-optional sind.
-
-Besonders wichtig ist die Zusammenfassung, also Dateien, die an
-mehreren Stellen eingebunden werden, also mehrere Eltern haben!
-
-Die Detailausgabe führt dann über zum Releasedokument.
-
-** Releasedokument
-
-Die Ausgabe kann in einer Datei gespeichert werden, die dann als
-Manifest für ein Archiv dienen kann. Anhand des Dokuments kann man
-schauen, ob die vorliegenden Dateien dem gespeicherten Stand
-entsprechen.
-
-** Ausgabeformate
-*** Graphviz & HTML
-*** TODO YAML, JSON
-*** DocBook
-*** RDF?
-
-** Zusammenhang mit SCM
-
-Wie bei Bones?
-
-** DONE Änderung Anzeige
-*** Hierarchie
-
-Nur der Hierarchiebaum, aber mit längeren Namen. Das heißt, die
-Dateien werden mit Pfad angezeigt, mit relativem zum Masterdokument.
-
-Falls zu lang am Anfang kürzen mit Ellipse.
-
-URIs oder nicht relative Dateien werden mit dem Anfang angezeigt,
-ggf. in der Mitte gekürzt.
-
-*** Zusammenfassung
-
- * X Dateien
- * Y inkludierte DocBooks
- * Z referenzierte
-
-YAML/JSON übernehmen und seinen eigenen machen.
-*** Details
-
-Die restlichen Angaben werden in die optionalen Details
-verschoben. Die Optionen sind dann nicht mehr notwendig.
-
-Wenn jemand den Bericht nicht mag, kann er gern die Daten über
-