summaryrefslogtreecommitdiff
path: root/sample/src/setup.xml
blob: 72ce9ddc1581c097a05536e2c582e9547a9d3008 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<?xml version="1.0" encoding="utf-8"?>
<gallery_setup>
  <templates>
    <!-- path to templates (design)  -->
    <path>../../templates</path>

    <!-- index: top level page -->
    <index>template-index.tmpl</index>   
    <!-- album: list of photos in directory -->
    <album>template-album.tmpl</album>
    <!-- photo: single photo page -->
    <photo>template-view_photo.tmpl</photo>

    <!--  support files for selected theme (templates)                    -->
    <!--  should include all used CSS styles, images, scripts...          -->
    <!--  subdirectories are allowed and will be mirrored to destination  -->
    <template_files><![CDATA[
      styles.css
      scripts-general.js
    ]]></template_files>

    <!--  specify index file name to use (default = index.html)                    -->
    <!--  e.g. you may want 'index.php' if your templates are server-side dynamic  -->
    <!--  filename extension is also used for separate image files                 -->
    <index_file>index.html</index_file>

    <!--  use root gallery directory to store all support files   -->
    <!--  and relative paths in sub-albums                        -->
    <!--  default = no (old behaviour)                            -->
    <support_files_use_common_root value="yes" />
  </templates>
  
  <images>
    <!--  default sizes of thumbnail and preview images  -->
    <thumbnail landscape_w="180" landscape_h="120" 
               portrait_w="120" portrait_h="180"
               square="180"
               quality="80" />
    <preview landscape_w="900" landscape_h="600" 
             portrait_w="500" portrait_h="750"
             quality="95" />
    <!--  preview image border style - use your custom CSS style to display frame around image -->
    <border style="border_single" />
    <!--  preload next image (allowed values: "yes", "no") default = yes  -->
    <preload value="yes" />

    <!--  get image title and description from IPTC and EXIF as a fallback                                -->
    <!--  if not overriden by <title> and <title_description> tags                                        -->
    <!--    (allowed values: "yes", "no") default = no                                                    -->
    <!--  titles are retrieved from the following fields (sorted by priority):                            -->
    <!--    Iptc.Application2.Caption, Jpeg.Comment, Exif.Image.ImageDescription, Exif.Photo.UserComment  -->
    <use_iptc_exif value="yes" />

    <!--  erase embedded thumbnail image (both from original and big images)?    -->
    <!--   (allowed values: "yes", "no") default = no                            -->
    <erase_embed_thumbnail value="yes" />

    <!--  don't copy full size (original) images                         -->
    <!--    <nofullsize/> can be used globally for whole gallery,        -->
    <!--    for full album or selectively for each image                 -->
    <!--    - override with <fullsize/> for album or for separate image  -->
<!--    <nofullsize />  -->

    <!--  target image directories  -->
    <thumbnail_dir>_thumb</thumbnail_dir>
    <preview_dir>_big</preview_dir>
    <original_dir>_orig</original_dir>

    <!--  printf() format-style string of thumbnail file names  -->
    <!--    %s is mandatory, represents file name (with ext.)   -->
    <!--    %d is optional, denotes item index in the album     -->
    <!--       this also avoids conflicts with identical names  -->
    <thumbnail_name_format>thn_%d_%s</thumbnail_name_format>

    <!--  Make thumbnails squared, crop in different ways:               -->
    <!--    none   - no squared thumbnails, retain previous behaviour (default)  -->
    <!--    simple - crop from center, shave 5% from borders             -->
    <!--    ... more to come! (looking for a fast and clever algorithm)  -->
    <squared_thumbnails type="none" />
  </images>

  <meta>
    <!--  Global metainformation for use in META tags in html head section  -->
    <!--  and also for the Atom feed. In case of META tags these will       -->
    <!--  automatically apply to _all_ pages unless overriden in the album. -->
    <!--  This is probably not a good idea for large galleries.             -->
    <author>John Doe</author>
    <author_email>johndoe@example.com</author_email>
    <description>CGG Sample gallery</description>
    <!--  keywords are usually not needed at all  -->
    <keywords>cataract, sample, gallery</keywords>

    <!--  use item (image) title as <meta description> tag value          -->
    <!--   (allowed values: "yes", "no") default = yes                    -->
    <!--  this setting is independent from the global meta tags settings  -->
    <use_title_as_meta value="yes" />

    <!--  mandatory site name, part of all page titles  -->
    <site title="CGG Testing Site" />

    <!--  add your copyright string to every picture                          -->
    <!--  stored in EXIF::Image::Copyright and IPTC::Application2::Copyright  -->
    <!--  usual format: "Copyright, John Smith, 19xx. All rights reserved."   -->
    <add_copyright>This is custom copyright string added to every picture.
And the second line.</add_copyright>

    <!--  favicon support, the "type" attribute is optional,   --> 
    <!--  please alter it to the right icon MIME type          -->
    <!--    http://www.w3.org/2005/10/howto-favicon            -->
    <!--  Please note that the <support_files_use_common_root> settings  --> 
    <!--    declared earlier applies to favicons as well                 -->
    <favicon type="image/png">apple-red.png</favicon>
  </meta>

  <navigation>
    <!--  enabled: jump to the parent item when going up in the structure  -->
    <!--  disabled: links will always go to the top of the parent page     -->
    <use_inpage_links value="yes" />

    <!--  enabled: show "Go Up..." links if not top-level (default)  -->
    <!--  disabled: never show that link                             -->
    <show_go_up value="yes" />

    <!--  show/hide exif table in single photo view  (default = yes)  -->
    <show_exif_table value="yes" />
  </navigation>

  <feed enable="yes">
    <!--  Atom feed generator, disabled by default.                  -->
    <!--  Feeds are used to keep users informed about site updates.  -->
    <!--  It's required to add corresponding <news> sections         -->
    <!--  to particular album index files.                           -->
    <filename>atomfeed.xml</filename>
    <title>CGG Sample gallery site news</title>
    <!--  It's crucial to set URL of the site. Enter root URL of the gallery.  -->
    <base_url>http://www.example.com/</base_url>
  </feed>

  <footer><![CDATA[
    So this is footer, suitable place for copyright, W3C validation links and advertisement! | 
    Generated with <a href="http://cgg.bzatek.net/" title="Cataract Gallery Generator">Cataract Gallery Generator</a>. |
    <a href="http://validator.w3.org/check/referer" title="Valid XHTML 1.0 Strict">XHTML 1.0 Strict</a> | <a href="http://jigsaw.w3.org/css-validator/check/referer" title="(in-)valid CSS 2.1">Invalid CSS 2.1</a>
  ]]></footer>

</gallery_setup>