dokkit 0.1.1 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/CHANGES +15 -1
- data/LICENSE +673 -19
- data/README +32 -0
- data/Rakefile +59 -25
- data/bin/dokkit +48 -38
- data/lib/dokkit/#render_task_factory.rb# +94 -0
- data/lib/dokkit/app.rb +212 -257
- data/lib/dokkit/deplate/fmt/latex-notemplate.rb +3 -1
- data/lib/dokkit/dokkittasks.rb +45 -15
- data/lib/dokkit/filters/deplate.rb +11 -5
- data/lib/dokkit/hash.rb +41 -0
- data/lib/dokkit/models/Rakefile.tpl +9 -0
- data/lib/dokkit/models/share/builtin.rf +28 -0
- data/lib/dokkit/page.rb +161 -20
- data/lib/dokkit/render_task_factory.rb +91 -0
- data/lib/dokkit.rb +35 -42
- data/tests/data/output/simple_document/README +57 -0
- data/tests/data/output/simple_document/Rakefile +7 -0
- data/tests/data/output/simple_document/doc/config/simple_document.yaml +5 -0
- data/tests/data/output/simple_document/doc/pages/simple_document.dpl +12 -0
- data/{lib/dokkit/projects/website → tests/data/output/website_project}/Rakefile +2 -1
- data/tests/data/projects/simple-document/README +57 -0
- data/tests/data/projects/simple-document/Rakefile +22 -0
- data/tests/data/projects/simple-document/doc/config/author.yaml +4 -0
- data/tests/data/projects/simple-document/doc/config/model.yaml +18 -0
- data/tests/data/projects/simple-document/doc/config/simple_document.yaml +6 -0
- data/tests/data/projects/simple-document/doc/layouts/another_simple_document.html +8 -0
- data/tests/data/projects/simple-document/doc/layouts/another_simple_document.tex +10 -0
- data/tests/data/projects/simple-document/doc/layouts/layout_with_custom_name.html +8 -0
- data/tests/data/projects/simple-document/doc/layouts/semantic.cache +23 -0
- data/tests/data/projects/simple-document/doc/pages/COMMON.yaml +23 -0
- data/tests/data/projects/simple-document/doc/pages/another_simple_document.dpl +12 -0
- data/tests/data/projects/simple-document/doc/pages/simple_document.dpl +12 -0
- data/tests/data/projects/simple-document/doc/pages/simple_document_without_layout.dpl +12 -0
- data/tests/data/projects/simple-document/doc/pages/subdir/COMMON.yaml +4 -0
- data/tests/data/projects/simple-document/doc/pages/subdir/simple_document_in_subdir.dpl +12 -0
- data/tests/data/projects/simple-document/doc/pages/subdir/simple_document_in_subdir.yaml +3 -0
- data/tests/data/projects/simple-document/doc/pages/subdir/subdir/COMMON.yaml +2 -0
- data/tests/data/projects/simple-document/doc/pages/subdir/subdir/another_simple_document_in_subdir.dpl +12 -0
- data/tests/data/projects/simple-document/doc/pages/yet_another_simple_document.dpl +12 -0
- data/tests/data/projects/simple-document/doc/pages/yet_another_simple_document.yaml +8 -0
- data/tests/spec_page.rb +25 -0
- data/tests/test.rb +2 -0
- data/tests/test_application.rb +40 -0
- data/tests/test_builtin_tasks.rb +37 -0
- data/tests/test_config.rb +108 -0
- data/tests/test_core.rb +12 -0
- data/tests/test_dokkit_commandline.rb +18 -0
- data/tests/test_exception.rb +7 -0
- data/tests/test_filters.rb +1 -1
- data/tests/test_layout.rb +64 -0
- data/tests/test_options.rb +33 -0
- data/tests/test_project_tasks.rb +48 -0
- data/tests/test_recursive_merge.rb +42 -0
- data/tests/test_task_factory.rb +38 -0
- metadata +138 -94
- data/Rakefile.old +0 -62
- data/lib/dokkit/builtin.rake +0 -55
- data/lib/dokkit/projects/invoice/Rakefile +0 -100
- data/lib/dokkit/projects/invoice/doc/config/company.yaml +0 -12
- data/lib/dokkit/projects/invoice/doc/config/customer.yaml +0 -4
- data/lib/dokkit/projects/invoice/doc/layouts/invoice.dpltex +0 -90
- data/lib/dokkit/projects/invoice/doc/pages/COMMON.rb +0 -12
- data/lib/dokkit/projects/invoice/doc/pages/invoice.rb +0 -5
- data/lib/dokkit/projects/invoice/doc/pages/invoice.yamltex +0 -16
- data/lib/dokkit/projects/invoice/doc/res/tex/deplate.sty +0 -46
- data/lib/dokkit/projects/invoice/doc/res/tex/images/logo.eps +0 -209
- data/lib/dokkit/projects/invoice/doc/res/tex/include/deplate.sty +0 -46
- data/lib/dokkit/projects/invoice/doc/res/tex/include/layout.inc +0 -24
- data/lib/dokkit/projects/invoice/doc/res/tex/include/macro.inc +0 -67
- data/lib/dokkit/projects/invoice/doc/res/tex/include/packages.inc +0 -51
- data/lib/dokkit/projects/invoice/lib/invoice.rb +0 -104
- data/lib/dokkit/projects/tech_report/README +0 -49
- data/lib/dokkit/projects/tech_report/Rakefile +0 -102
- data/lib/dokkit/projects/tech_report/doc/config/company.yaml +0 -13
- data/lib/dokkit/projects/tech_report/doc/config/tech_report.yaml +0 -3
- data/lib/dokkit/projects/tech_report/doc/layouts/report.dpltex +0 -40
- data/lib/dokkit/projects/tech_report/doc/pages/COMMON.rb +0 -12
- data/lib/dokkit/projects/tech_report/doc/pages/report.dpltex +0 -37
- data/lib/dokkit/projects/tech_report/doc/pages/report.inc +0 -2
- data/lib/dokkit/projects/tech_report/doc/pages/report.rb +0 -3
- data/lib/dokkit/projects/tech_report/doc/res/attachments/attachment_2 +0 -0
- data/lib/dokkit/projects/tech_report/doc/res/tex/images/logo.eps +0 -311
- data/lib/dokkit/projects/tech_report/doc/res/tex/include/deplate.sty +0 -46
- data/lib/dokkit/projects/tech_report/doc/res/tex/include/layout.inc +0 -24
- data/lib/dokkit/projects/tech_report/doc/res/tex/include/macro.inc +0 -67
- data/lib/dokkit/projects/tech_report/doc/res/tex/include/packages.inc +0 -48
- data/lib/dokkit/projects/tech_report/doc/res/tex/report.bib +0 -4
- data/lib/dokkit/projects/tech_report/lib/tech_report.rb +0 -17
- data/lib/dokkit/projects/website/README +0 -49
- /data/{lib/dokkit/projects/invoice → tests/data/output/website_project}/README +0 -0
- /data/{lib/dokkit/projects/website → tests/data/output/website_project}/doc/layouts/normal.thtml +0 -0
- /data/{lib/dokkit/projects/website → tests/data/output/website_project}/doc/pages/COMMON.rb +0 -0
- /data/{lib/dokkit/projects/website → tests/data/output/website_project}/doc/pages/deplate.dplhtml +0 -0
- /data/{lib/dokkit/projects/website → tests/data/output/website_project}/doc/pages/index.rb +0 -0
- /data/{lib/dokkit/projects/website → tests/data/output/website_project}/doc/pages/index.thtml +0 -0
- /data/{lib/dokkit/projects/website → tests/data/output/website_project}/doc/res/images/rote-tiny.png +0 -0
- /data/{lib/dokkit/projects/tech_report/doc/res/attachments/attachment_1 → tests/pages/test.dpltex} +0 -0
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
% Packages
|
|
2
|
-
% -----------------------------------------------------------------------------
|
|
3
|
-
|
|
4
|
-
% http://www.tug.org/tex-archive/info/italian/fancyhdr/itfancyhdr.pdf
|
|
5
|
-
%
|
|
6
|
-
\usepackage{fancyhdr}
|
|
7
|
-
|
|
8
|
-
% A nice font
|
|
9
|
-
%
|
|
10
|
-
\usepackage{palatino}
|
|
11
|
-
|
|
12
|
-
\usepackage{setspace}
|
|
13
|
-
|
|
14
|
-
% http://www.tug.org/teTeX/tetex-texmfdist/doc/latex/geometry/geometry.pdf
|
|
15
|
-
%
|
|
16
|
-
\usepackage{geometry}
|
|
17
|
-
|
|
18
|
-
% http://www.comp.leeds.ac.uk/andyr/misc/latex/latextutorial4.html
|
|
19
|
-
%
|
|
20
|
-
\usepackage{multirow}
|
|
21
|
-
|
|
22
|
-
% Symbols
|
|
23
|
-
%
|
|
24
|
-
\usepackage{latexsym}
|
|
25
|
-
|
|
26
|
-
\usepackage{lastpage}
|
|
27
|
-
|
|
28
|
-
% http://www.ctan.org/tex-archive/macros/latex/required/graphics/grfguide.ps
|
|
29
|
-
%
|
|
30
|
-
\usepackage{color}
|
|
31
|
-
|
|
32
|
-
\usepackage{longtable}
|
|
33
|
-
|
|
34
|
-
% http://www.linux.it/~salve/TeX-FAQ/TeX-FAQ-tex.html
|
|
35
|
-
%
|
|
36
|
-
\usepackage{graphicx}
|
|
37
|
-
|
|
38
|
-
% Euro symbol
|
|
39
|
-
%
|
|
40
|
-
\usepackage{eurosym}
|
|
41
|
-
|
|
42
|
-
\usepackage{array}
|
|
43
|
-
|
|
44
|
-
% compatibility packages for deplate
|
|
45
|
-
\usepackage{hyperref}
|
|
46
|
-
\usepackage[square,numbers,sort,super]{natbib}
|
|
47
|
-
|
|
48
|
-
% -----------------------------------------------------------------------------
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
#--
|
|
2
|
-
# TechReport class for Dokkit
|
|
3
|
-
# (c)2006 Andrea Fazzi (and contributors)
|
|
4
|
-
#
|
|
5
|
-
# See 'dokkit.rb' or LICENSE for licence information.
|
|
6
|
-
#++
|
|
7
|
-
|
|
8
|
-
require 'rote'
|
|
9
|
-
require 'rote/format'
|
|
10
|
-
require 'dokkit/page'
|
|
11
|
-
|
|
12
|
-
module Rote
|
|
13
|
-
|
|
14
|
-
class Page
|
|
15
|
-
|
|
16
|
-
end
|
|
17
|
-
end
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
This is the auto-generated Rote documentation source.
|
|
2
|
-
|
|
3
|
-
To render it using Rote's command-line wrapper (ignoring the included
|
|
4
|
-
Rakefile), type:
|
|
5
|
-
|
|
6
|
-
rote doc
|
|
7
|
-
|
|
8
|
-
from the top-level directory (this one).
|
|
9
|
-
|
|
10
|
-
To render using the included Rakefile (the result is the same in either
|
|
11
|
-
case) type instead:
|
|
12
|
-
|
|
13
|
-
rake doc
|
|
14
|
-
|
|
15
|
-
If you prefer, you can omit the 'doc' task, since it is configured
|
|
16
|
-
as the default.
|
|
17
|
-
|
|
18
|
-
In either case, you should see some output as the pages are rendered
|
|
19
|
-
and resources copied, and get output in a (created) 'html' directory.
|
|
20
|
-
Once you have rendered the site, running the command again will appear
|
|
21
|
-
to do nothing, because only changed resources are re-rendered. To
|
|
22
|
-
start over:
|
|
23
|
-
|
|
24
|
-
(rote|rake) clobber
|
|
25
|
-
|
|
26
|
-
Alternatively, modify the page or resource files, and rerun the first
|
|
27
|
-
command to transform only the modified resource.
|
|
28
|
-
|
|
29
|
-
WHAT NEXT?
|
|
30
|
-
|
|
31
|
-
+ See what else you can do by typing:
|
|
32
|
-
|
|
33
|
-
(rote|rake) --tasks
|
|
34
|
-
|
|
35
|
-
rote --usage ( with the command-line wrapper )
|
|
36
|
-
|
|
37
|
-
+ Modify the included page template and layout to suit your needs.
|
|
38
|
-
|
|
39
|
-
+ Edit the included Rakefile to add or change tasks, or delete it
|
|
40
|
-
if you're sticking with the command-line wrapper.
|
|
41
|
-
|
|
42
|
-
+ Add more pages and layouts.
|
|
43
|
-
|
|
44
|
-
+ Start Rote in monitor mode, and have your changes rendered as
|
|
45
|
-
you work:
|
|
46
|
-
|
|
47
|
-
(rote|rake) doc_monitor
|
|
48
|
-
|
|
49
|
-
|
|
File without changes
|
/data/{lib/dokkit/projects/website → tests/data/output/website_project}/doc/layouts/normal.thtml
RENAMED
|
File without changes
|
|
File without changes
|
/data/{lib/dokkit/projects/website → tests/data/output/website_project}/doc/pages/deplate.dplhtml
RENAMED
|
File without changes
|
|
File without changes
|
/data/{lib/dokkit/projects/website → tests/data/output/website_project}/doc/pages/index.thtml
RENAMED
|
File without changes
|
/data/{lib/dokkit/projects/website → tests/data/output/website_project}/doc/res/images/rote-tiny.png
RENAMED
|
File without changes
|
/data/{lib/dokkit/projects/tech_report/doc/res/attachments/attachment_1 → tests/pages/test.dpltex}
RENAMED
|
File without changes
|