dokkit 0.1.0

data/lib/dokkit/projects/invoice/doc/res/tex/include/macro.inc

@@ -0,0 +1,67 @@
+% macro.inc
+% ----------
+%
+%   Copyright (C)2005 Alca Coop. a r. l.
+%
+%   This program is free software; you can redistribute it and/or modify
+%   it under the terms of the GNU General Public License as published by
+%   the Free Software Foundation; either version 2 of the License, or
+%   (at your option) any later version.
+%
+%   This program is distributed in the hope that it will be useful,
+%   but WITHOUT ANY WARRANTY; without even the implied warranty of
+%   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+%   GNU General Public License for more details.
+%
+%   You should have received a copy of the GNU General Public License
+%   along with this program; if not, write to the Free Software
+%   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+%
+
+
+% ENVIRONMENT
+% -----------------------------------------------------------------------------
+
+% checkboxize
+% ------------
+% Ambiente per creare elenchi con checkbox (ad esempio per i test di valutazione)
+%
+\newenvironment{checkboxize}{\renewcommand{\labelitemi}{\(\Box\)}\begin{itemize}}{\end{itemize}}
+
+
+% COMANDI
+% -----------------------------------------------------------------------------
+
+% \firma[lunghezza]{firmatario}
+% -------------------
+% Argomenti:
+% - lunghezza (opzionale, default 7cm)
+% - firmatario: ci� che va scritto sopra la linea orizzontale
+%
+\newcommand{\firma}[2][7cm]{\begin{minipage}{#1}\begin{center}{#2}\\\vspace{1cm}\rule{\textwidth}{0.1mm}\end{center}\end{minipage}}
+
+% \luogoedata[luogo]
+% -------------------
+% Argomenti:
+% - luogo (opzionale, default linea orizz. di 4 cm)
+%
+\newcommand{\luogoedata}[1][\rule{4cm}{0.1mm}]{{#1}, l� \rule{0.6cm}{0.1mm}/\rule{0.6cm}{0.1mm}/200\rule{0.3cm}{0.1mm}}
+
+% \textbox[lunghezza]{testo}
+% --------------------
+% Argomenti:
+% - lunghezza (opzionale, default 7cm)
+% - testo
+%
+\newcommand{\textbox}[2][7cm]{{#2}~\rule{#1}{0.1mm}}
+
+% \oggetto{oggetto}
+% ------------------
+% Argomenti:
+% - oggetto: l'oggetto...
+%
+\newcommand{\oggetto}[1]{\noindent\textbf{\underline{OGGETTO: {#1}.}}}
+
+% ALTRO
+% -----------------------------------------------------------------------------
+\definecolor{gray50}{gray}{.5}

data/lib/dokkit/projects/invoice/doc/res/tex/include/packages.inc

@@ -0,0 +1,51 @@
+% Packages
+% -----------------------------------------------------------------------------
+
+% http://www.tug.org/tex-archive/info/italian/fancyhdr/itfancyhdr.pdf
+%
+\usepackage{fancyhdr}
+
+% A nice font
+%
+\usepackage{palatino}
+
+\usepackage{setspace}
+
+% http://www.tug.org/teTeX/tetex-texmfdist/doc/latex/geometry/geometry.pdf
+%
+\usepackage{geometry}
+
+% http://www.comp.leeds.ac.uk/andyr/misc/latex/latextutorial4.html
+%
+\usepackage{multirow}
+
+% Symbols
+%
+\usepackage{latexsym}
+
+\usepackage{lastpage}
+
+% http://www.ctan.org/tex-archive/macros/latex/required/graphics/grfguide.ps
+%
+\usepackage{color}
+
+\usepackage{longtable}
+
+% http://www.linux.it/~salve/TeX-FAQ/TeX-FAQ-tex.html
+%
+\usepackage{graphicx}
+
+% Euro symbol
+%
+\usepackage{eurosym}
+
+\usepackage{array}
+ 
+% compatibility packages for deplate
+\usepackage{hyperref}
+\usepackage[square,numbers,sort,super]{natbib}
+
+\usepackage[italian]{babel}
+\usepackage[latin1]{inputenc}
+
+% -----------------------------------------------------------------------------

data/lib/dokkit/projects/invoice/lib/invoice.rb

@@ -0,0 +1,104 @@
+#--
+# Invoice class for Dokkit
+# (c)2006 Andrea Fazzi (and contributors)
+#
+# See 'dokkit.rb' or LICENSE for licence information.
+#++
+
+require 'rote'
+require 'rote/format'
+require 'dokkit/page'
+
+module Rote
+
+  class Page
+
+    alias dokkitpage_initialize initialize
+
+    def initialize(template_name, pages_dir = '.', layout_dir = pages_dir, config_dir = pages_dir, &block)
+      
+      invoice = YAML::load( File.open(template_name) )
+
+      @services = invoice['services']
+
+      @id = invoice['invoice']['id']
+      @vat = invoice['invoice']['vat']
+      @date = invoice['invoice']['date'] || today
+
+      @basic_price = 0
+      @total_price = 0
+      @vat_price = 0
+
+      dokkitpage_initialize(template_name, pages_dir, layout_dir, config_dir, &block)
+      calc_prices
+    end
+
+     def do_render!
+      # Render the page content into the @content_for_layout
+      unless @template_text.nil?
+        render_services_tex
+      end
+      
+      # FIXME: Quick fix for incorrect COMMON.rb layout nesting.
+      # All we do here is reset the layout to be the last layout
+      # added. 
+      #
+      # If it turns out that the ability to nest from COMMON/page
+      # really is useless, we should remove the layout queue entirely,
+      # and then just have the render layout loop run until
+      # layout at end == layout at start.
+      @layout_names = [@layout_names.last] unless layout_names.empty?
+      
+      # Do layout _after_ page eval. As we go through this, the layouts
+      # we load may add to the end of the layout names array, so nested
+      # layout is supported by just chasing the end of the array until
+      # it's empty. The process is basically
+      #
+      #    Page is loaded, calls 'layout' with it's layout.
+      #    During render, that fn is taken, and loaded. Layout code
+      #      again calls 'layout'.
+      #    On next loop iteration, that new filename is loaded, and it's
+      #    code is executed ... and so on.
+      #
+      #    Each loop puts the result into @content_for_layout, so that
+      #    nested layouts can work just the same as regular.
+      @layout_names.each do |fn|
+        txt = load_layout(fn)
+        
+        @layout_text ||= txt    # legacy support    vv0.3.2 v-0.4
+        
+        # render into the layout if supplied.
+        if txt
+          erb = ERB.new(txt)
+          erb.filename = fn
+          @content_for_layout = erb.result(binding)   
+        end
+      end
+      
+      @result = render_post_filters(@content_for_layout)      
+      freeze
+      
+      @result 
+    end
+  
+  private
+ 
+    def calc_prices
+      @services.each { |service| @basic_price += service['service']['quantity'] * service['service']['price'] }
+      @vat_price = @basic_price / 100 * @vat
+      @total_price = @basic_price + @vat_price
+    end
+
+    def today
+      "#{Date.today.day}.#{Date.today.month}.#{Date.today.year}"
+    end
+
+    def render_services_tex
+      @content_for_layout = ""
+      @services.each do |service|
+        @content_for_layout += "#{ render_page_filters(service['service']['description'].to_s)} & #{service['service']['quantity']} & #{service['service']['price']} & #{service['service']['price'] * service['service']['quantity']}\\\\ \\hline "
+      end
+    end
+
+  end
+end

data/lib/dokkit/projects/tech_report/README

@@ -0,0 +1,49 @@
+This is the auto-generated Rote documentation source.
+
+To render it using Rote's command-line wrapper (ignoring the included
+Rakefile), type:
+
+  rote doc
+
+from the top-level directory (this one).
+
+To render using the included Rakefile (the result is the same in either
+case) type instead:
+
+  rake doc
+  
+If you prefer, you can omit the 'doc' task, since it is configured
+as the default.  
+
+In either case, you should see some output as the pages are rendered 
+and resources copied, and get output in a (created) 'html' directory.
+Once you have rendered the site, running the command again will appear
+to do nothing, because only changed resources are re-rendered. To 
+start over:
+
+  (rote|rake) clobber
+
+Alternatively, modify the page or resource files, and rerun the first
+command to transform only the modified resource.
+
+WHAT NEXT?
+
+	+ See what else you can do by typing:
+	
+			  (rote|rake) --tasks
+			  
+			  rote --usage		( with the command-line wrapper )
+			  
+  + Modify the included page template and layout to suit your needs. 
+
+  + Edit the included Rakefile to add or change tasks, or delete it
+    if you're sticking with the command-line wrapper.
+
+  + Add more pages and layouts.
+
+  + Start Rote in monitor mode, and have your changes rendered as
+    you work:
+
+        (rote|rake) doc_monitor
+
+

data/lib/dokkit/projects/tech_report/Rakefile

@@ -0,0 +1,102 @@
+# Standard Rakefile for dokkit documentation build
+#
+# 
+begin 
+  require 'rubygems'
+rescue LoadError
+  nil # optional
+end
+
+require 'rake'
+require 'rake/clean'
+require 'rote/format'
+require 'dokkit'
+require 'dokkit/filters'
+require 'lib/tech_report'
+
+include Rote
+include Dokkit
+
+CMD_LATEX = "latex -interaction=batchmode"
+CMD_BIBTEX = "bibtex"
+
+# Check if bibliography exists.
+
+def bib_exists?
+  if Dir["*.bib"].empty?
+    false
+  else 
+    true
+  end
+end
+
+# Create a set of tasks with the prefix 'doc' to  build the
+# documentation set. The directory layout is as for the
+# command-line wrapper (but can be changed of course).
+#
+# This creates the following tasks:
+#
+#   * doc           - transform/copy all modified pages / resources
+#   * doc_pages     - transform all modified pages
+#   * doc_res       - copy all modified resources
+#   * doc_monitor   - Start monitor mode, transform changed files automatically
+#
+#   * [html/**/*]   - Transform single page / resource unconditionally
+#
+#   * clobber_doc   - Remove output (hooks into main 'clobber' task)
+#
+# In addition to these tasks, you may also wish to define a 'doc_refresh' task
+# to be run whenever modified resources are processed in monitor mode.
+
+doc = Rote::DocTask.new(:doc) do |site| 
+  site.output_dir = 'tex'
+  site.layout_dir = 'doc/layouts'
+  site.config_dir = 'doc/config'
+
+  site.pages.dir = 'doc/pages'
+  site.pages.include('**/*')   
+  site.pages.exclude('**/*.yaml')
+
+  site.res.dir = 'doc/res/tex'
+  site.res.include('**/*')
+
+  site.ext_mapping(/dpltex/, 'tex') do |page|
+    page.page_filter Dokkit::Filters::Deplate.new('latex-notemplate') do |dpltex|
+      dpltex.options.pdftex = true
+    end
+  end    
+
+end
+
+doc_dvi = Rote::DocTask.new(:doc_dvi) do |site|
+
+  site.output_dir = 'tex'
+  site.pages.dir = 'doc/pages'
+end
+
+task :doc_dvi => [:doc] do
+  pwd = Dir.getwd
+  Dir.chdir(doc_dvi.output_dir)
+  Dir["*.tex"].each { |file| 2.times { sh "#{CMD_LATEX} #{file}" } }
+
+  if bib_exists? then
+    Dir["*.aux"].each do |file|
+      if File.exists?(File.basename(file).sub(/.aux$/,".bib"))
+        sh "#{CMD_BIBTEX} #{file}"
+        2.times { sh "#{CMD_LATEX} #{File.basename(file).sub(/.aux$/,".tex")}" }
+      end
+    end 
+  end
+
+  Dir.chdir(pwd)
+end
+
+task :default => [:doc]
+
+# import user-level tasks
+#import "#{ENV['HOME']}/.rotetasks.rf" if File.exists?("#{ENV['HOME']}/.rotetasks.rf")
+#import 'local.rf' if File.exists?('local.rf')
+
+# TODO Define your custom tasks here
+
+

data/lib/dokkit/projects/tech_report/doc/config/company.yaml

@@ -0,0 +1,13 @@
+company:
+ name: MyCompany
+ address: Address
+ vat_number: 1234
+ telephone: (+39)666666
+ fax: (+39)777777
+ email: info@company.com
+ website: www.company.com
+ bank_name: MyBank
+ bank_current_account: 1234
+ bank_abi: 1234
+ bank_cab: 1234
+ bank_cin: X

data/lib/dokkit/projects/tech_report/doc/config/tech_report.yaml

@@ -0,0 +1,3 @@
+title: Techinical Report
+author: john Doe
+

data/lib/dokkit/projects/tech_report/doc/layouts/report.dpltex

@@ -0,0 +1,40 @@
+\documentclass[a4paper,10pt]{article}
+
+\input{include/packages.inc}
+
+\usepackage{include/deplate}
+
+\newcommand{\layout}[1][]{
+	\geometry{
+		left=2cm,
+		right=2cm,
+		top=2cm,
+		bottom=1.7cm,
+		headheight=1cm,
+		headsep=1cm,
+		footskip=1cm,
+		includeheadfoot}
+	\pagestyle{fancy}
+	\fancyhead{}
+	\fancyfoot{}
+	\lhead{\includegraphics[height=1cm]{images/logo.eps}}
+	\rhead{\fontfamily{cmss}\large\textbf{#1}\vspace*{\stretch{1}}\normalsize}
+	\lfoot{
+		\fontfamily{cmss}\scriptsize\textbf{<%= @config['company']['name'] %>} $\star$ \textbf{Address} <%= @config['company']['address'] %> $\star$ \textbf{Tel.} <%= @config['company']['telephone'] %>\\\textbf{Fax} <%= @config['company']['fax'] %> $\star$ \textbf{E-mail} <%= @config['company']['email'] %> $\star$ \textbf{Web} <%= @config['company']['website'] %> \normalsize
+	}
+	\rfoot{
+		\fontfamily{cmss}\textit{pag. \thepage\ / \pageref{LastPage}}
+	}
+	\renewcommand{\footrulewidth}{0.4pt}
+}
+
+\layout[<%= @config['title'] %>]
+
+\sffamily
+\parindent=0pt
+
+\begin{document}
+
+<%= @content_for_layout %>
+
+\end{document}

data/lib/dokkit/projects/tech_report/doc/pages/COMMON.rb

@@ -0,0 +1,12 @@
+# Shared code for all pages below this directory.
+#
+# This is executed for every file transformed, in the binding of 
+# the appropriate Rote::Page instance. Individual page sources
+# ([pagename].rb) override anything defined here.
+#
+# Any COMMON.rb files found in directories above this will also
+# be loaded.
+
+
+# Apply the 'report' layout to all project's document
+layout 'report.dpltex'

data/lib/dokkit/projects/tech_report/doc/pages/report.dpltex

@@ -0,0 +1,37 @@
+#INCLUDE: doc/pages/report.inc
+
+#BIB: report.bib
+
+#TITLE: <%= @config['title'] %>
+#AUTHOR: <%= @config['author'] %>
+
+#MAKETITLE
+----8<----
+
+#LIST: toc
+----8<----
+
+* Abstract
+From a document of Jim{cite: author:jim}
+
+* Introduction
+
+* Main section
+
+** Subsection One
+** Subsection Two
+
+* Conclusions
+
+----8<----
+
+#MAKEBIB: ieeetr
+----8<----
+
+* Appendices
+
+** Attachement One
+#WITH file=doc/res/attachments/attachment_1: Verbatim
+
+** Attachement Two
+#WITH file=doc/res/attachments/attachment_2: Verbatim

data/lib/dokkit/projects/tech_report/doc/pages/report.inc

@@ -0,0 +1,2 @@
+#VAR: _var_1=''var 1''
+#VAR: _var_2=''var 2''

data/lib/dokkit/projects/tech_report/doc/pages/report.rb

@@ -0,0 +1,3 @@
+config 'tech_report.yaml'
+config 'company.yaml'
+