summaryrefslogtreecommitdiff
path: root/templates/default.xml
blob: 2ac8354966818d249c33f0267c271040f6c58686 (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
146
147
148
149
150
151
152
153
154
155
156
<?xml version="1.0" encoding="utf-8"?>
<design_setup version="2.0">

  <!-- image size definitions -->
  <image_sizes>
    <!-- Every image size automatically corresponds to the <item> tag parameter
         of the same name in album source files. E.g. image size named "hires"
         would correspond to <item hires=".."> tags. Use the image size parameter
         "tagname" to override that.   -->

    <!-- "original", "preview" and "thumbnail" sizes are somewhat special here
         in order to keep compatibility with previous versions. In case when
         "original" size is not available due to <nofullsize> tag present,
         the "preview" size will be used instead.  -->

    <!-- Meaning of "original" is shifted here from previous versions;
         it's considered more like a bigger preview size for large screens now.
         However it still serves the purpose of supplying metadata (EXIF etc.). -->
    <!-- Corresponds with mandatory <item src> tag in album source file.  -->
    <!-- Note that the series of legacy <nofullsize> and <fullsize> tags control
         this image size availability on the page. -->
    <size name="original">
      <landscape w="1200" h="800" />
      <portrait w="1024" h="1024" />
      <quality value="97" />
      <!-- With the presence of the "no_resize" tag, no resizing will be done and
           image file will be copied as is (this is a default for backwards
           compatibility). -->
      <no_resize />
    </size>

    <!-- The "preview" size is considered default and should be displayed
         on a first visit.  -->
    <size name="preview" tagname="preview">
      <!-- Note that "preview" sizes can be further overriden by album legacy
           <images> tag and also per-image by "width"/"height" <item> tag
           attributes. Same goes for quality. -->
      <landscape w="1067" h="600" />
      <portrait w="800" h="800" />
      <quality value="95" />
      <!-- Similar to the "original" size where the image has to be always supplied,
           the image won't get resized only when an image file is supplied by the
           <item preview="..."> tag. Otherwise this tag is ignored and image will
           be resized from the "original" size (backwards compatibility).
           This rule applies also for any other optional image sizes.  -->
      <no_resize />
    </size>

    <!-- Thumbnail section is mandatory. -->
    <!-- The "type" attribute has to be set to "thumbnail" to be treated as such. -->
    <!-- Note that thumbnail images are always resized even for custom supplied files.  -->
    <!-- An optional "style" attribute affects cropping:
           * normal  - image is resized to fit the dimension limits, maintaining
                       aspect ratio without any crop (default)
           * squared - image is cropped to a squared size and resized to fit
           * fixed   - image is cropped to a specified dimension and cropped to
                       fit the specified aspect ratio
         An optional album item <thumbnail crop> tags may affect the crop area.  -->
    <size name="thumbnail" type="thumbnail" style="normal">
      <landscape w="180" h="120" />
      <portrait w="120" h="180" />
      <square size="180" />
      <crop w="180" h="120" />   <!--  valid only for the "fixed" crop style  -->
      <quality value="80" />
    </size>

    <!-- Here you can define custom sizes which will be generated from the file
         defined in <item src> tag. Currently, there's no way how to supply custom
         sized images from album source file (might be changed in the future). -->
    <size name="mobile">
      <landscape w="320" h="240" />
      <portrait w="240" h="320" />
      <quality value="90" />
    </size>
  </image_sizes>

  <!-- Global support files, common files used by several themes. -->
  <supplemental_files><![CDATA[
  ]]></supplemental_files>


  <!--  particular design setup  -->
  <theme enabled="yes">
    <!-- Index pages may only contain thumbnails. When the <index> structure is
         missing, album design will be used for both list of albums and list
         of pictures. -->
    <index>
      <template>template_index.html</template>
      <target_filename>index.html</target_filename>
      <!-- specify thumbnail image size to be used here. -->
      <thumbnail_size>thumbnail</thumbnail_size>
      <!--  In case of a protected album, show special thumbnail (must be included
            in supplemental_files). Comment out to use real thumbnail.  -->
      <protected_thumbnail>emblems-readonly_120.png</protected_thumbnail>
    </index>

    <!-- Album definition is mandatory. -->
    <album>
      <template>template_album.html</template>
      <target_filename>index.html</target_filename>
      <!--  thumbnail_size is optional, omit it when thumbnails are not used on
            album pages (will skip some tags substitution).  -->
      <thumbnail_size>thumbnail</thumbnail_size>
      <!--  Just like thumbnail_size, also picture_size is optional, omit it
            when images in their full sizes are not used on album pages.  -->
      <picture_size>preview</picture_size>
    </album>

    <!-- When the <picture> structure is missing, no pages for the particular
         images will be generated. Images are processed in either case, for
         potential use within album pages. -->
    <picture>
      <template>template_picture.html</template>
      <!--  '%s' will be replaced with actual picture filename  -->
      <target_filename>%s.html</target_filename>
      <!--  which picture size to use  -->
      <picture_size>preview</picture_size>
    </picture>

    <!--  support files for current theme                                 -->
    <!--  should include all used CSS styles, images, scripts...          -->
    <!--  subdirectories are allowed and will be mirrored to destination  -->
    <supplemental_files><![CDATA[
      styles.css
      scripts-general.js
      emblems-readonly_120.png
    ]]></supplemental_files>

    <!-- User defines, used in theme templates. Value is optional, empty string
         will be used if value was requested but not specified. Defines can either
         act as block conditionals (combo "ifdef(DEFINE_NAME)" and "endif(DEFINE_NAME)")
         or as a value constant (specify "value(DEFINE_NAME)" to retrieve the value).
         For "ifdef" negation, use "ifndef" or "else". -->
    <!-- Some defines are added during runtime and take priority over custom defines
         here. This way you can define default values which would get eventually
         overriden by the generator. -->

    <!--  image border style, overriden by <border style> tags from the album source file  -->
    <define name="BORDER_STYLE" value="border_single" />
    <!--  show EXIF table in single photo view (comment out to hide it)  -->
    <define name="SHOW_EXIF_TABLE" />
    <!--  show "Go Up..." links if not top-level  -->
    <define name="SHOW_GO_UP" />

    <!-- Other defines set by the generator:
           IS_ROOT - indicates whether the index/album page is a main (root) page
    -->
  </theme>

  <!-- Here you can define another theme, with different templates etc.
       The purpose is to allow switching between them or as a result of
       device capabilities autodetection. Don't forget to change target
       filenames to avoid conflicts.  -->

</design_setup>