dokkit-model-simpledocument 0.1.0

data/CHANGES

@@ -0,0 +1,7 @@
+= dokkit simpledocument model Changelog
+
+== Version 0.1.0
+
+This the first release of dokkit simpledocument model. With this
+release you can build minimalistic document like tutorials, howto,
+guides, etc. See http://dokkit.rubyforge.org/ for further details.

data/INSTALL

@@ -0,0 +1,18 @@
+= Installation notes
+
+* If you have installed this model using rubygems then you are done.
+
+* If you have downloaded the file <modelname>.tar.gz then, in order to
+  install the model, you need to put its content in
+  $HOME/.dokkit/models/<modelname> or simply execute:
+  
+  $ tar xvzf <modelname>.tar.gz -C $HOME/.dokkit/models
+
+* To check if the model has been successfully installed execute:
+
+  $ dokkit --list
+
+  and see if the desidered model is in the list.
+
+* For more information about dokkit models, please check dokkit website
+  at http://dokkit.rubyforge.org/

data/README

@@ -0,0 +1,2 @@
+For information about this model please refer to the README file in lib/model
+directory.

data/Rakefile

@@ -0,0 +1,130 @@
+begin 
+  require 'rubygems'
+rescue LoadError
+  nil # optional
+end
+
+$:.unshift('lib')
+require 'rake/gempackagetask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'dokkit/render_task_factory'
+
+PKG_NAME = "dokkit-model-simpledocument"
+PKG_VERSION = "0.1.0"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_FILES = FileList.new( ['lib/**/*', 'model/**/*', '[A-Z]*'] ) do |fl| 
+  fl.exclude(/TEMPLATE\./).to_a
+end
+
+task :default => [:gem]
+
+# Create a task that will package the dokkit model into distributable
+# tar, zip and gem files.
+spec = Gem::Specification.new do |s|
+  # Basic information.
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "dokkit simple document model"
+  s.description = <<-EOF
+    This is a simple document model for dokkit. You can use this model as a base to create simple documents
+    like tutorials, howtos, guides, technical reports.
+  EOF
+
+  s.files = PKG_FILES.to_a
+  s.require_path = 'lib'
+  s.autorequire = 'dokkit'
+
+  s.add_dependency('dokkit', '>= 0.2.0')
+
+  #### Documentation and testing.
+
+  #### Author and project details.
+
+  s.author = "Andrea Fazzi"
+  s.email = "andrea.fazzi@alca.le.it"
+  s.homepage = "http://dokkit.rubyforge.org/"
+  s.rubyforge_project = "dokkit"
+end
+
+desc "Build Gem"
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+# Support Tasks ------------------------------------------------------
+
+desc "Look for TODO and FIXME tags in the code"
+task :todo do
+  Pathname.new(File.dirname(__FILE__)).egrep(/#.*(FIXME|TODO|TBD|DEPRECATED)/) do |match|
+    puts match
+  end
+end
+
+task :release => [:verify_env_vars, :release_files, :publish_doc, :publish_news]
+
+task :verify_env_vars do
+  raise "RUBYFORGE_USER environment variable not set!" unless ENV['RUBYFORGE_USER']
+  raise "RUBYFORGE_PASSWORD environment variable not set!" unless ENV['RUBYFORGE_PASSWORD']
+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"
+  ]
+
+  Rake::XForge::Release.new(MetaProject::Project::XForge::RubyForge.new('dokkit')) do |release|
+    # Never hardcode user name and password in the Rakefile!
+    release.user_name = ENV['RUBYFORGE_USER']
+    release.password = ENV['RUBYFORGE_PASSWORD']
+    release.files = release_files.to_a
+    release.release_name = "#{PKG_NAME} #{PKG_VERSION}"
+    # The rest of the options are defaults (among others, release_notes and release_changes, parsed from CHANGES)
+  end
+end
+
+desc "Publish news on RubyForge"
+task :publish_news => [:gem] do
+  require 'rake/meta_project'
+  require 'rake/contrib/xforge'
+  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 "Delete output and intermediate files"
+task :clean_output do
+  OUTPUT_FL.each { |file| sh "rm -rf #{file}"} 
+end
+
+factory = Dokkit::RenderTaskFactory.instance
+factory.create_render_text(:render_readme) do |task|
+  task.output_dir = 'lib/model/'
+  task.layout_dir = 'lib/doc/layouts'
+  task.config_dir = 'lib/model/doc/config'
+  task.pages.dir = 'lib/model/doc/pages'
+end
+
+desc "Generate README file from a deplate source"
+task :readme => [:render_readme] do
+  File.move('lib/model/simpledocument.text', 'lib/model/README')
+end
+
+desc "Tag the working tree and copy it to dokkit-models/simpledocument/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-models/simpledocument/tags/#{reltag}/ -m \"tag #{reltag}\"" if ENV['RUBYFORGE_USER']
+end

data/lib/doc/layouts/simpledocument.html

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title><%= config_hash('document')['title'] %></title>
+  </head>
+  <body>
+    <%= @content_for_layout %>
+  </body>
+</html>

data/lib/doc/layouts/simpledocument.tex

@@ -0,0 +1,17 @@
+\documentclass[a4paper,12pt]{article}
+
+\usepackage{hyperref}
+\usepackage{color}
+\usepackage{<%= relative('/deplate') %>}
+
+\title{<%= @config['document']['title'] %>}
+\author{<%= @config['document']['author'] %>}
+
+\begin{document}
+
+\maketitle
+\clearpage
+
+<%= @content_for_layout %>
+
+\end{document}

data/lib/doc/layouts/simpledocument.text

@@ -0,0 +1 @@
+<%= @content_for_layout %>

data/lib/model/README

@@ -0,0 +1,119 @@
+
+Table of Contents
+=================
+
+  1 Description of the model
+  2 Edit and render your document
+      2.1 Render a pdf document
+  3 Rendering the modified parts of the document and cleaning up
+  4 How to get other dokkit models
+  5 WHAT'S NEXT?
+
+
+1 Description of the model
+==========================
+
+This is a simple document model for dokkit. You can use this model
+as a base to create simple documents like tutorials, howtos, technical
+reports, etc.
+
+
+2 Edit and render your document
+===============================
+
+To edit the content of the document simply edit doc/pages/simpledocument.dpl
+(this file) or create a new file with dpl extension in doc/pages directory.
+
+To get further information about the wiki syntax to use please check
+deplate[1] homepage.
+
+To render this document in html, open a terminal and type:
+
+    $ dokkit
+
+from the top-level directory or from any subdirectory contained in
+it.
+
+To render this document in latex format, type:
+
+    $ dokkit render_tex
+
+To render this document in plain text format, type:
+
+    $ dokkit render_text
+
+In any case, you should get the output
+
+  * in the html directory for the html generated output
+  * in the tex directory for the tex generated output
+  * in the text directory for the plain text generated output
+
+
+2.1 Render a pdf document
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If a latex distribution is present on your system then the command:
+
+    $ dokkit render_pdf
+
+will try to generate a pdf file for your document.
+
+If you are an ubuntu/debian user then you can obtain a complete latex
+distribution running the command:
+
+    $ sudo apt-get install texlive
+
+
+3 Rendering the modified parts of the document and cleaning up
+==============================================================
+
+Once you have rendered the document, running the dokkit command again
+will appear to do nothing, because only changed resources are re-rendered.
+To clean the output and start over run:
+
+    $ dokkit clobber
+
+Note that if you modify any part of the document then you must re-run
+dokkit command in order to apply changes and to re-generate the desidered
+output.
+
+So, once you have modified your document, run:
+
+    $ dokkit render_<xxx>
+
+Only the modified resources will be transformed.
+
+
+4 How to get other dokkit models
+================================
+
+To search for other document models open a terminal and type:
+
+    $ gem list dokkit-model
+
+To get a particular model named <model_name> run:
+
+    $ gem install dokkit-model-<model_name>
+
+or check http://rubyforge.org/projects/dokkit/.[2]
+
+
+5 WHAT'S NEXT?
+==============
+
+  * See what else you can do by typing:
+
+    $ dokkit --tasks
+    EOB
+    
+     - Modify the configuration of the document by editing
+       ''doc/config/simpledocument.yaml''.
+    
+     - Override the default layout creating in ''doc/layouts'' a custom
+       layout with the same name of your document.
+    
+    For further information about ''dokkit'' see http://dokkit.rubyforge.org/.
+    
+
+[1] http://deplate.sf.net/deplate.html
+[2] http://rubyforge.org/projects/dokkit/.

data/lib/model/Rakefile

@@ -0,0 +1,35 @@
+#                                                                          
+# File 'Rakefile' created on 09 ott 2007 at 16:06:57.                    
+#
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (C) 2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# Rakefile for simpledocument project model
+
+require 'dokkit'
+require 'dokkit/app'
+require 'dokkit/render_task_factory'
+
+PDFLATEX = 'pdflatex'
+
+factory = Dokkit::RenderTaskFactory.instance
+
+render_html = factory.create_render_html
+render_tex = factory.create_render_tex
+render_text = factory.create_render_text
+
+# Still experimental! The task below must be constructed through a factory instance.
+desc "Produces pdf files [experimental]"
+task :render_pdf => [:render_tex] do
+  pwd = Dir.getwd
+  Dir[File.join(render_tex.output_dir,'**/*.tex')].each do |file|
+    Dir.chdir(File.dirname(file))
+    2.times { sh "#{PDFLATEX} #{File.basename(file)}" }
+    Dir.chdir(pwd)
+  end
+end
+
+task :default => [:render_html]
+
+

data/lib/model/doc/config/model.yaml

@@ -0,0 +1,14 @@
+#
+# File 'model.yaml' created on 09 ott 2007 at 16:11:01.
+# See 'dokkit.rb' or LICENSE for licence information.
+#
+# (c)2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
+#                                                                          
+# This is a config file for the current document. This file is written      
+# using YAML so you can easily modify it using YAML syntax. For further    
+# information about YAML please visit http://yaml.org/.                       
+#                                                                          
+
+model:
+  name: simpledocument
+  version: 0.1.0

data/lib/model/doc/config/simpledocument.yaml

@@ -0,0 +1,17 @@
+#
+# File 'simple_document.yaml' created on 09 ott 2007 at 16:11:35.
+# See 'dokkit.rb' or LICENSE for licence information.
+#
+# (c)2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
+#                                                                          
+# This is a config file for the current document. This file is written      
+# using YAML so you can easily modify it using YAML syntax. For further    
+# information about YAML please visit http://yaml.org/.                       
+#                                                                          
+
+document:
+  title: The simpledocument model
+  author: Andrea Fazzi
+
+
+

data/lib/model/doc/pages/simpledocument.dpl

@@ -0,0 +1,123 @@
+%% Dynamic generation of the Table of Contents.
+%% Generate TOC only if formatter is different from html.
+#IF: fmt==html-notemplate
+#VAR: headings=plain
+#ELSE
+#LIST: toc
+----8<----
+#ENDIF
+
+
+* Description of the model
+
+This is a simple document model for ''dokkit''. You can use this model
+as a base to create simple documents like tutorials, howtos, technical
+reports, etc.
+
+* Edit and render your document
+
+To edit the content of the document simply edit
+''doc/pages/simpledocument.dpl'' (this file) or create a new file with
+''dpl'' extension in ''doc/pages'' directory.
+
+To get further information about the wiki syntax to use please check
+[[http://deplate.sf.net/deplate.html][deplate]] homepage.
+
+To render this document in ''html'', open a terminal and type:
+
+#Verbatim <<EOB
+$ dokkit
+EOB
+
+from the top-level directory or from any subdirectory contained in it.
+  
+To render this document in ''latex'' format, type:
+
+#Verbatim <<EOB
+$ dokkit render_tex
+EOB
+
+To render this document in ''plain text'' format, type:
+
+#Verbatim <<EOB
+$ dokkit render_text
+EOB
+
+In any case, you should get the output
+
+  - in the ''html'' directory for the ''html'' generated output
+  - in the ''tex'' directory for the ''tex'' generated output
+  - in the ''text'' directory for the ''plain text'' generated output
+
+** Render a pdf document
+
+If a ''latex'' distribution is present on your system then the command:
+
+#Verbatim <<EOB
+$ dokkit render_pdf
+EOB
+
+will try to generate a ''pdf'' file for your document (__still experimental__).
+
+If you are an ''ubuntu/debian'' user then you can obtain a complete ''latex''
+distribution running the command:
+
+#Verbatim <<EOB
+$ sudo apt-get install texlive
+EOB
+
+* Rendering the modified parts of the document and cleaning up
+
+Once you have rendered the document, running the ''dokkit'' command again will
+appear to do nothing, because only changed resources are re-rendered.
+To clean the output and start over run:
+
+#Verbatim <<EOB
+$ dokkit clobber
+EOB
+
+Note that if you modify any part of the document then you must re-run
+''dokkit'' command in order to apply changes and to re-generate the
+desidered output. 
+
+So, once you have modified your document, run:
+
+#Verbatim <<EOB
+$ dokkit render_<xxx>
+EOB
+
+Only the modified resources will be transformed.
+
+
+* How to get other ''dokkit'' models
+
+To search for other document models open a terminal and type:
+
+#Verbatim <<EOB
+$ gem list dokkit-model
+EOB
+
+To get a particular model named <model_name> run:
+
+#Verbatim <<EOB
+$ gem install dokkit-model-<model_name>
+EOB
+
+or check http://rubyforge.org/projects/dokkit/. 
+
+* What's next?
+
+ * See what else you can do by typing:
+
+   ''$ dokkit --tasks''
+
+
+ - Modify the configuration of the document by editing
+   ''doc/config/simpledocument.yaml''.
+
+ - Override the default layout creating in ''doc/layouts'' a custom
+   layout with the same name of your document.
+
+For further information about ''dokkit'' see http://dokkit.rubyforge.org/.
+
+

data/lib/model/doc/res/tex/deplate.sty

@@ -0,0 +1,46 @@
+\newcommand{\customListPrefs}{\setlength{\parsep}{0cm}\setlength{\itemsep}{0cm}}
+\newenvironment{customList}{\begin{list}{}{\customListPrefs{}}}{\end{list}}
+\newcommand{\customItem}[2]{\item[#1] #2}
+
+\newenvironment{tasklist}{\begin{list}{}{\customListPrefs{}}}{\end{list}}
+\newcommand{\task}[2]{\item[\textbf{#1}] #2}
+
+\definecolor{taskA}{rgb}{1,.5,.5}
+\definecolor{taskB}{rgb}{.5,1,.5}
+\definecolor{taskC}{rgb}{.5,.5,1}
+\definecolor{taskD}{rgb}{.5,1,1}
+\definecolor{taskE}{rgb}{1,.5,1}
+\definecolor{taskF}{rgb}{1,1,.5}
+\definecolor{taskdone}{rgb}{.5,.5,.5}
+
+\newcommand{\taskdone}[1]{{\footnotesize\textcolor{taskdone}{#1}}}
+\newcommand{\taskA}[1]{\colorbox{taskA}{#1}}
+\newcommand{\taskB}[1]{\colorbox{taskB}{#1}}
+\newcommand{\taskC}[1]{\colorbox{taskC}{#1}}
+\newcommand{\taskD}[1]{\colorbox{taskD}{#1}}
+\newcommand{\taskE}[1]{\colorbox{taskE}{#1}}
+\newcommand{\taskF}[1]{\colorbox{taskF}{#1}}
+
+\newcommand{\emphStyle}{\em}
+\newcommand{\emphSpan}[1]{\emph{#1}}
+\newcommand{\boldSpan}[1]{\textbf{#1}}
+\newcommand{\remoteSpan}[1]{#1}
+
+\newenvironment{overlayBlock}{}{}
+\newenvironment{scriptsizeBlock}{\scriptsize{}}{}
+\newenvironment{boxBlock}{}{}
+\newenvironment{footnotesizeBlock}{\footnotesize{}}{}
+\newenvironment{smallBlock}{\small{}}{}
+\newenvironment{landscapeBlock}{}{}
+\newenvironment{gridBlock}{}{}
+\newenvironment{formalBlock}{}{}
+
+\newenvironment{todoBlock}{}{}
+
+\newenvironment{bookBlock}{}{}
+\newenvironment{booksList}{\begin{list}{}{\customListPrefs{}}}{\end{list}}
+\newcommand{\booksItem}[2]{\item[\textbf{#1}] #2}
+
+\newenvironment{exampleBlock}{\bfseries{}}{}
+\newenvironment{examplesList}{\begin{list}{}{\customListPrefs{}}}{\end{list}}
+\newcommand{\examplesItem}[2]{\item[#1] #2}

data/lib/scripts/simpledocument.rb

@@ -0,0 +1,16 @@
+#--
+# TechReport class for Dokkit
+# (c)2006 Andrea Fazzi (and contributors)
+#
+# See 'dokkit.rb' or LICENSE for licence information.
+#++
+
+require 'dokkit/page'
+
+module Rote
+
+  class Page
+
+  end
+
+end

data/lib/tasks/builtin/builtin.rf

@@ -0,0 +1,3 @@
+import File.join(Dokkit.projects_dir, 'share', 'builtin.rf')
+
+

data/lib/tasks/rakefile.rf

@@ -0,0 +1,2 @@
+import File.join(Dokkit.projects_dir, 'share', 'rakefile.rf')
+  

data/lib/tests/test_structure.rb

@@ -0,0 +1,49 @@
+require 'test/unit'
+require 'dokkit'
+require 'dokkit/app'
+require 'rake'
+
+module Rake
+  class Application
+    def collect_tasks(tasks = nil)
+      return @top_level_tasks unless tasks
+      @top_level_tasks.concat tasks
+    end
+  end
+end
+
+module Dokkit
+  class Application
+    def collect_tasks(tasks)
+      Rake.application.collect_tasks(tasks)
+    end
+  end
+end
+
+class TestBuiltinTask < Test::Unit::TestCase
+  OUTPUT_DIR = 'tests/data/output'
+  def test_builtin_task
+    Dokkit.application.init
+    Dokkit.application.define_builtin_tasks
+    assert_equal('create', Dokkit.application['create'].to_s)
+  end
+
+  def test_create_default_project_task
+    Dokkit.application.init
+    Dokkit.application.define_builtin_tasks
+    Dokkit.application.collect_tasks ["create", "#{OUTPUT_DIR}/simple_document"]
+    Dokkit.application.run
+    dir_content = Dir["#{OUTPUT_DIR}/simple_document/*"]
+    assert(!dir_content.empty? && !dir_content.include?('lib'))
+  end
+
+  def test_create_website_task
+    Dokkit.application.init
+    Dokkit.application.do_option('--project',"website")
+    Dokkit.application.define_builtin_tasks
+    Dokkit.application.collect_tasks ["create", "#{OUTPUT_DIR}/website_project"]
+    Dokkit.application.run
+    assert(Dir["#{OUTPUT_DIR}/website_project/*"].size > 1)
+   end
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: dokkit-model-simpledocument
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-12-25 00:00:00 +01:00
+summary: dokkit simple document model
+require_paths: 
+- lib
+email: andrea.fazzi@alca.le.it
+homepage: http://dokkit.rubyforge.org/
+rubyforge_project: dokkit
+description: This is a simple document model for dokkit. You can use this model as a base to create simple documents like tutorials, howtos, guides, technical reports.
+autorequire: dokkit
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Andrea Fazzi
+files: 
+- lib/scripts
+- lib/scripts/simpledocument.rb
+- lib/doc
+- lib/doc/layouts
+- lib/doc/layouts/simpledocument.text
+- lib/doc/layouts/simpledocument.tex
+- lib/doc/layouts/simpledocument.html
+- lib/doc/config
+- lib/model
+- lib/model/README
+- lib/model/doc
+- lib/model/doc/config
+- lib/model/doc/config/model.yaml
+- lib/model/doc/config/simpledocument.yaml
+- lib/model/doc/pages
+- lib/model/doc/pages/simpledocument.dpl
+- lib/model/doc/res
+- lib/model/doc/res/tex
+- lib/model/doc/res/tex/deplate.sty
+- lib/model/Rakefile
+- lib/tests
+- lib/tests/test_structure.rb
+- lib/tasks
+- lib/tasks/builtin
+- lib/tasks/builtin/builtin.rf
+- lib/tasks/rakefile.rf
+- README
+- INSTALL
+- CHANGES
+- Rakefile
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dokkit
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: