dokkit 0.1.1 → 0.2.0

data/README

@@ -0,0 +1,32 @@
+= WHAT'S dokkit?
+
++dokkit+ is an open source documentation environment based on
+ruby. 
+
++dokkit+ puts together the flexibility of +rote+ and the great
+variety of +deplate+'s output formats.
+
+With +dokkit+ you can:
+
+* generate many types of documentation in many formats (html, tex,
+ docbook, plain text, etc.)
+* write your documents using a simple wiki syntax (emacs-wiki like)
+* generate different output formats from the same source document
+* use a big set of models to quickly generate the documents you want (technical report, invoice, howto,
+ guides, presentation, website, etc.)
+* simply derive new document models from the existing ones
+* simply modify existing models to fit your needs
+
++dokkit+'s success keys are:
+
+* a smart task system based on +rake+ a consistent documentation
+   per-model framework organized in templates, layouts, ruby classes,
+   configuration files, resources based on +rote+ 
+* a powerful templating system based on +erb+ 
+* a simple and flexible configuration system based on +yaml+
+
++dokkit+ aims to be modular and extensible: you can easily add
+new filters, formatters and document models.
+
+See http://dokkit.rubyforge.org for further information.
+

data/Rakefile

@@ -1,18 +1,12 @@
-# Standard Rakefile for custom Dokkit build
+# Rakefile for dokkit
+#
+# (C) 2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
 #
-# 
-
-begin 
-  require 'rubygems'
-rescue LoadError
-  nil # optional
-end
 
 $:.unshift('lib')
-require 'meta_project'
+
 require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
-require 'rake/contrib/xforge'
 require 'rake/clean'
 require 'rake/testtask'
 require 'rake/rdoctask'
@@ -25,23 +19,37 @@ require 'rake/rdoctask'
 # Later DamageControl can bump PATCH automatically.
 #
 # REMEMBER TO KEEP PKG_VERSION IN SYNC WITH THE CHANGES FILE!
+#
+# Determine the current version of the software
+
+if `ruby -Ilib ./bin/dokkit --version` =~ /\S+$/
+  CURRENT_VERSION = $&
+else
+  CURRENT_VERSION = "0.0.0"
+end
+
 PKG_NAME = "dokkit"
-PKG_VERSION = "0.1.1"
+PKG_VERSION = CURRENT_VERSION
 PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-PKG_FILES = FileList['lib/**/*', 'bin/*', '[A-Z]*', 'tests/*', 'tests/**/**'].exclude(/alca/).to_a
-
+PKG_FILES = FileList.new( ['lib/**/*', 'bin/*', '[A-Z]*', 'tests/**/*'] ) do |fl| 
+  fl.exclude(/TEMPLATE\./).to_a
+end
 
 task :default => [:gem]
 
 rd = Rake::RDocTask.new do |rd|
+  rd.title = "dokkit"
   rd.main = "README"
-  rd.rdoc_files.include("README", "lib/**/*.rb", "tests/*.rb")
-  rd.rdoc_dir = "apidoc"
-  rd.options.push('-d').push('-F')
+  rd.rdoc_files.include("[A-Z]*", "lib/**/*.rb", "tests/*.rb")
+  rd.rdoc_dir = "doc/rdoc"
 end	
 
+task :man do
+  sh "rd2 -r rd/rd2man-lib.rb bin/dokkit | gzip > doc/man/dokkit.1.gz"
+end
+
 # ====================================================================
-# Create a task that will package the Rake software into distributable
+# Create a task that will package the software into distributable
 # tar, zip and gem files.
 
 spec = Gem::Specification.new do |s|
@@ -50,21 +58,29 @@ spec = Gem::Specification.new do |s|
 
   s.name = PKG_NAME
   s.version = PKG_VERSION
-  s.summary = "Ruby Documentation ToolKit"
+  s.summary = "Ruby Documentation toolKit"
   s.description = <<-EOF
-    dokkit is an open source documentation environment based on ruby.
+    dokkit is an open source document generator based on rote.
   EOF
 
   s.files = PKG_FILES.to_a
   s.require_path = 'lib'
   s.autorequire = 'dokkit'
+  s.bindir = "bin"                               # Use these for applications.
+  s.executables = ["dokkit"]
+  s.default_executable = "dokkit"
+
+  s.add_dependency('deplate', '>= 0.8')
+  s.add_dependency('rote', '>= 0.3.4')
+  s.add_dependency('rake')
+  s.add_dependency('syntax')
 
   #### Documentation and testing.
 
   s.has_rdoc = true
   s.extra_rdoc_files = rd.rdoc_files.reject { |fn| fn =~ /\.rb$/ }.to_a
   s.rdoc_options <<
-    '--title' <<  'Dokkit' <<
+    '--title' <<  'dokkit' <<
     '--main' << 'README' <<
     '--line-numbers'
 
@@ -72,7 +88,7 @@ spec = Gem::Specification.new do |s|
 
   s.author = "Andrea Fazzi"
   s.email = "andrea.fazzi@alca.le.it"
-  s.homepage = "http://dokkit.rubyforge.org"
+  s.homepage = "http://dokkit.rubyforge.org/"
   s.rubyforge_project = "dokkit"
 end
 
@@ -98,13 +114,22 @@ task :verify_env_vars do
   raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
 end
 
-task :publish_doc do
-  publisher = Rake::RubyForgePublisher.new('dokkit', ENV['RUBYFORGE_USER'])
-  publisher.upload
+task :publish_doc => [:rdoc] do
+  if user = ENV['RUBYFORGE_USER']
+    Rake::SshDirPublisher.new(
+      "#{user}@rubyforge.org",
+      "/var/www/gforge-projects/dokkit/rdoc/",
+      "doc/rdoc/"
+    ).upload
+  else
+    $stderr << "Skipping documentation upload - Need to set RUBYFORGE_USER to your rubyforge.org user name\n"
+  end
 end
 
 desc "Release files on RubyForge"
 task :release_files => [:gem] do
+  require 'meta_project'
+  require 'rake/contrib/xforge'
   release_files = FileList[
     "pkg/#{PKG_FILE_NAME}.gem"
   ]
@@ -124,10 +149,19 @@ task :publish_news => [:gem] do
   release_files = FileList[
     "pkg/#{PKG_FILE_NAME}.gem"
   ]
-
   Rake::XForge::NewsPublisher.new(MetaProject::Project::XForge::RubyForge.new('dokkit')) do |news|
     # Never hardcode user name and password in the Rakefile!
     news.user_name = ENV['RUBYFORGE_USER']
     news.password = ENV['RUBYFORGE_PASSWORD']
   end
 end
+
+desc "Tag the working tree and copy it to dokkit-core/tags/REL_X_Y_Z on RubyForge"
+task :tag do
+  reltag = "REL_#{PKG_VERSION.gsub(/\./, '_')}"
+  puts "Tagging current head with [#{reltag}]"
+  sh "svn copy ./ svn+ssh://#{ENV['RUBYFORGE_USER']}@rubyforge.org/var/svn/dokkit/dokkit-core/tags/#{reltag}/ -m \"tag #{reltag}\"" if ENV['RUBYFORGE_USER']
+end
+
+
+

data/bin/dokkit

@@ -1,53 +1,63 @@
+#                                                                          
+# File 'dokkit' created on 09 ott 2007 at 15:57:46.                    
 #
-# Commandline launcher for Dokkit, (c)2006 Andrea Fazzi (and contributors)
+# See 'dokkit.rb' or LICENSE for licence information.                      
+#                                                                          
+# (c)2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
 #
+# Commandline launcher for Dokkit.
 # Get set up with library paths, however we're installed.
+#                                                                          
 
-def croak
-	puts "Cannot locate Dokkit libraries - Do you need to set $DOKKIT_LIB ?"
-	exit(1)
-end
+=begin
 
-begin 
-	require 'rubygems'
-rescue LoadError
-	# just ignore, don't use gems
-end
+= NAME
+dokkit - Ruby Documentation toolKit
+
+= SYNOPSIS
+
+dokkit [options] [task1] .. [taskN]
+
+= DESCRIPTION
+
+dokkit is a documentation environment. It is based on rote and it uses deplate to generate output in a large variety of formats (tex, html, docbook, plain text, ...).
+
+For more information please execute:
+
+$ dokkit --help
 
-fail = false
+= OPTIONS
 
-dokkit_lib = nil
+For a complete list of the options please execute:
+ 
+$ dokkit --help
+
+= AUTHOR
+
+Andrea Fazzi <andrea.fazzi@alca.le.it>
+
+= SEE ALSO
+
+ruby(1)
+
+=end
+
+def croak
+  puts "Cannot locate Dokkit libraries - Do you need to set $DOKKIT_LIB?"
+  exit(1)
+end
 
 begin
-	require 'dokkit'
-	require 'dokkit/app'
-		
-	# find this later
-	dokkit_lib = nil
+  require 'rubygems'
 rescue LoadError
-	unless fail || !(dokkit_lib = ENV['DOKKIT_LIB'])	
-		$: << dokkit_lib		
-		# at least we can know this now...
-		builtin = File.join(dokkit_lib,'dokkit/builtin.rake')
-		fail = true		# next time.
-		retry
-	else
-		croak
-	end 
+  nil # just ignore, don't use gems
 end
 
-# If we're loaded via RubyGems or some such we need to locate
-# the builtin rakefile.
-unless dokkit_lib
-  $:.each { |it|
-    if File.exists?(File.join(it,'dokkit/builtin.rake'))
-      dokkit_lib = it
-      break
-    end
-  }  
-end
+require 'dokkit'
+require 'dokkit/app'
+
+croak unless Dokkit.dokkit_lib
 
-croak unless dokkit_lib
+Dokkit.application.run
 
-Dokkit::Application.new(dokkit_lib).run
 

data/lib/dokkit/#render_task_factory.rb#

@@ -0,0 +1,94 @@
+#                                                                          
+# File 'render_task_factory.rb' created on 18 Nov 2007 at 16:01:42.                    
+#
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (C) 2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+
+require 'singleton'
+require 'rote/format/html'
+require 'dokkit/filters'
+require 'dokkit/dokkittasks'
+
+module Dokkit
+  class RenderTaskFactory
+    include Singleton
+    def create_render_html(name = :render_html)
+      Rote::DocTask.new(name) do |task|
+        task.output_dir = 'html'
+
+        task.layout_dir = 'doc/layouts'
+        task.config_dir = 'doc/config'
+
+        task.pages.dir = 'doc/pages'
+        task.pages.include('**/*')
+        task.pages.exclude('**/*.yaml')
+
+        task.res.dir = 'doc/res/html'
+        task.res.include('**/*')
+        
+        yield task if block_given?
+        
+        task.ext_mapping(/dpl/, 'html', task.output_dir) do |page|
+          page.extend Rote::Format::HTML
+          page.page_filter Dokkit::Filters::Deplate.new('html-notemplate')
+        end
+      end
+    end
+    def create_render_tex(name = :render_tex)
+      Rote::DocTask.new(name) do |task|
+        task.output_dir = 'tex'
+
+        task.layout_dir = 'doc/layouts'
+        task.layout_defext = '.tex'
+        
+        task.config_dir = 'doc/config'
+
+        task.pages.dir = 'doc/pages'
+        task.pages.include('**/*')
+        task.pages.exclude('**/*.yaml')
+
+        task.res.dir = 'doc/res/tex'
+        task.res.include('**/*')
+        
+        yield task if block_given?
+        
+        task.ext_mapping(/dpl/, 'tex', task.output_dir) do |page|
+          #FIXME: render_tex task must have its own format extension
+          page.extend Rote::Format::HTML
+          page.page_filter Dokkit::Filters::Deplate.new('latex-notemplate')
+        end
+      end
+    end
+    def create_render_text(name = :render_text)
+      Rote::DocTask.new(name) do |task|
+        task.output_dir = 'text'
+
+        task.layout_dir = 'doc/layouts'
+        task.layout_defext = '.text'
+        
+        task.config_dir = 'doc/config'
+
+        task.pages.dir = 'doc/pages'
+        task.pages.include('**/*')
+        task.pages.exclude('**/*.yaml')
+
+        task.res.dir = 'doc/res/text'
+        task.res.include('**/*')
+        
+        yield task if block_given?
+        
+        task.ext_mapping(/dpl/, 'text', task.output_dir) do |page|
+          #FIXME: render_text task must have its own format extension
+          page.extend Rote::Format::HTML
+          page.page_filter Dokkit::Filters::Deplate.new('plain')
+        end
+      end
+    end
+    def create_render_pdf
+      Rake::Task.new 
+    end
+  end
+end
+