1This directory is a sample project that you can start with and then
2modify it to use your files instead.
3
4If you are located in Docset-xx directory, cd to the 'examples/site'
5directory:
6
7  % cd examples/site
8
9It includes a shrinked version of perl.apache.org, with many docs
10removed or reduced to the mininumum. There are still quite a lot of
11documents left so you can see the big picture.
12
13To build the HTML version of the site and see what it does, run:
14
15  % bin/build -v
16
17Without -v the build won't print anything.
18
19Now you can see the output in the 'dst_html' directory.
20
21To build PDF, use -d option, e.g.:
22
23  % bin/build -vd
24
25Now you can read one of the generated PDF books from the 'dst_ps'
26directory and its sub-directories, e.g.:
27
28  % acroread dst_ps/docs/1.0/guide/guide.pdf
29
30or
31
32  % acroread dst_html/docs/1.0/guide/guide.pdf
33
34since it's copied there, so the dst_html dir is the final version that
35can be published on the web and includes the sources, the htmls and
36pdfs.
37
38Normally if you modify certain files, only they will be rebuilt, but
39if you change a template you may want to force a complete rebuilt with
40'-f':
41
42  % bin/build -vf
43
44========================================
45
46The layout of the project tree:
47
48./src/config.conf -- the main config file that you should change
49
50./README -- this file
51
52Sources directory:
53
54./src            -- the source files (pod, html, images, etc)
55./src/config.cfg     -- config file
56and lots of source files in various formats.
57
58After the first run cache files will also appear in the 'src' dir and
59its sub-dirs.
60
61Templates:
62
63./tmpl                -- templates files directory
64./tmpl/custom         -- custom templates
65./tmpl/std            -- standard templates libs (do not touch)
66
67Execution scripts:
68
69./bin/build       -- a sample script that builds the site
70
71In the directory conf you will find sample configuration files the
72behavior of html2ps:
73
74conf/html2ps.conf        -- normal book mode
75conf/hyphen.tex          -- this file is required by config files
76
77To learn how to modify the default html2ps behavior read the
78documentation at http://www.tdb.uu.se/~jan/html2ps.html. You specify
79which html2ps config file to use in the config.cfg file as explained
80in the DocSet::Config manpage.
81
82---
83
84If you want to build your own documentation project/site, simple start
85off this example and change things to fit your content/style. For more
86info read the DocSet manpages.
87
88Questions can be asked at the template-docset mailing list. For
89mailing list archives and subscription information please see:
90http://template-toolkit.org/mailman/listinfo/template-docset
91