swish-e/doc/swish.conf

package Pod::HtmlPsPdf::Config::Local;

# Note that the doc builder chdir's to directory of this file, so all
# the directories can be specified relative to this directory. Of
# course you can specify the full path, but then if you moves the
# whole thing into a different location, you will have to update the
# hardcoded paths as well.

use vars qw(%c);

    # pod files in the order you want to see them in the linked html
    # (and the book)

%c =
    (

     dir => {
 	     
 	     # the source files directory (directory above
 	     src        => '../pod',
 	     
 	     # the resulting html files directory
 	     rel_html   => '../html',
 	     
 	     # the resulting ps and pdf files directory (and special
 	     # set of html files used for creating the ps and pdf
 	     # versions.)
 	     rel_ps     => './rel_ps',
 	     
 	     # the resulting split version html files directory
 	     split_html => '../html/split',
 	     
	     # the name of the directory the resulting files should be
	     # packaged under
	     out        => './rel_package',
	     
 	    },	

     file => {
	      # the location of the toc_file
	      toc_file      => './bin/toc_file',
	      
	      # the file with version number e.g:
	      # 
	      # package Foo::Bar;
	      # $VERSION = '1.26';
	      # 1;
	      version_file  => './Version.pm',
	      
	      # the html2ps configuration file
	      html2ps_conf  => './conf/html2ps.conf',
	      
	     },
     
     # the package name as declared in $c{file}{version_file}
     package_name => 'SWISHE::Doc',

     # an ordered list pod files relative to $c{src}
     # the order is important for a correct placing of the chapters
     ordered_pod_files => [
			   qw(
                    README.pod
                    INSTALL.pod
                    CHANGES.pod
                    SWISH-CONFIG.pod
                    SWISH-RUN.pod
                    SWISH-SEARCH.pod
                    SWISH-FAQ.pod
                    SWISH-LIBRARY.pod
                    SWISH-PERL.pod
                    SWISH-BUGS.pod
                    SWISH-3.0.pod
		     )
			  ],

     # non-pod/html files or dirs to be copied unmodified
     # relative to $c{src}
     non_pod_files => [
		       qw(
    			  style.css
    			  .htaccess
    			  search.cgi

    			  images/swish.gif
    			  images/swish2.gif
    			  images/swish2b.gif
    			  images/swishbanner1.gif
    			  images/dotrule1.gif
    			)
		      ],
     
     # template files
     tmpl => {
	      index_html => "./tmpl/index.tmpl",  
	      index_ps   => "./tmpl/indexps.tmpl",
	      # index_split => "./tmpl/indexsplit.tmpl  -- why not?

	      page_html  => "./tmpl/page.tmpl", 
	      page_ps    => "./tmpl/pageps.tmpl",
	      page_split_html  => "./tmpl/splitpage.tmpl",
	     },
     
     # the base name of the created tar.gz file
     out_name      => "swish-e_documentation",

     mode => {
	      # you can override the directories creation mode
	      dir      => 0755,
	     },

    );


# don't forget!!!
1;

__END__
1	adcroft	1.1	package Pod::HtmlPsPdf::Config::Local;
2
3			# Note that the doc builder chdir's to directory of this file, so all
4			# the directories can be specified relative to this directory. Of
5			# course you can specify the full path, but then if you moves the
6			# whole thing into a different location, you will have to update the
7			# hardcoded paths as well.
8
9			use vars qw(%c);
10
11			# pod files in the order you want to see them in the linked html
12			# (and the book)
13
14			%c =
15			(
16
17			dir => {
18
19			# the source files directory (directory above
20			src => '../pod',
21
22			# the resulting html files directory
23			rel_html => '../html',
24
25			# the resulting ps and pdf files directory (and special
26			# set of html files used for creating the ps and pdf
27			# versions.)
28			rel_ps => './rel_ps',
29
30			# the resulting split version html files directory
31			split_html => '../html/split',
32
33			# the name of the directory the resulting files should be
34			# packaged under
35			out => './rel_package',
36
37			},
38
39			file => {
40			# the location of the toc_file
41			toc_file => './bin/toc_file',
42
43			# the file with version number e.g:
44			#
45			# package Foo::Bar;
46			# $VERSION = '1.26';
47			# 1;
48			version_file => './Version.pm',
49
50			# the html2ps configuration file
51			html2ps_conf => './conf/html2ps.conf',
52
53			},
54
55			# the package name as declared in $c{file}{version_file}
56			package_name => 'SWISHE::Doc',
57
58			# an ordered list pod files relative to $c{src}
59			# the order is important for a correct placing of the chapters
60			ordered_pod_files => [
61			qw(
62			README.pod
63			INSTALL.pod
64			CHANGES.pod
65			SWISH-CONFIG.pod
66			SWISH-RUN.pod
67			SWISH-SEARCH.pod
68			SWISH-FAQ.pod
69			SWISH-LIBRARY.pod
70			SWISH-PERL.pod
71			SWISH-BUGS.pod
72			SWISH-3.0.pod
73			)
74			],
75
76			# non-pod/html files or dirs to be copied unmodified
77			# relative to $c{src}
78			non_pod_files => [
79			qw(
80			style.css
81			.htaccess
82			search.cgi
83
84			images/swish.gif
85			images/swish2.gif
86			images/swish2b.gif
87			images/swishbanner1.gif
88			images/dotrule1.gif
89			)
90			],
91
92			# template files
93			tmpl => {
94			index_html => "./tmpl/index.tmpl",
95			index_ps => "./tmpl/indexps.tmpl",
96			# index_split => "./tmpl/indexsplit.tmpl -- why not?
97
98			page_html => "./tmpl/page.tmpl",
99			page_ps => "./tmpl/pageps.tmpl",
100			page_split_html => "./tmpl/splitpage.tmpl",
101			},
102
103			# the base name of the created tar.gz file
104			out_name => "swish-e_documentation",
105
106			mode => {
107			# you can override the directories creation mode
108			dir => 0755,
109			},
110
111			);
112
113
114			# don't forget!!!
115			1;
116
117			__END__