Minor fixes and improvements to the default example
[mpp.py.git] / mpp-albums-example.ini
1 ; configuration/ini file for mpp.py
2 ; http://www.ademar.org/mpp.py/
3
4 ; boolean variables accept yes/no, true/false or 0/1, no case-sensitive;
5 ; lists accept new-lines if they're prefixed with spaces or tabs;
6 ; quotes are optional on text values.
7
8 ; several entries are optional... below a minimalistic example which should
9 ; work using default values:
10 ;[global]
11 ;albums = <list of albums ids>
12 ;
13 ;[<album-id>]
14 ;title = <album title>
15 ;title2 = <album title 2> ; optional
16 ;title3 = <album title 3> ; optional
17 ;period = <date/time>
18 ;
19
20 ;
21 ; variables can be set on a global or per-album basis
22 ; album settings override global ones
23 ;
24
25 [global]
26 ; comma-separated list of destination dirs to create albums,
27 ; no spaces allowed on album dirs, but subdirs are ok
28 ; each album must have its own section later on this file
29 ; example:
30 ; albums = personal, friends,
31 ;  places/brazil/curitiba,
32 ;  places/brazil/porto-galinhas
33 albums = dot
34
35 ; language used by default when in multi-lang mode
36 ; default is "en"
37 default_lang = en
38
39 ; html file mode (in octal, as accepted by chmod(1))
40 ; default is
41 file_mode = 0755
42
43 ; compatible with bootstrap
44 ; if set to yes, the generated html (index table) will be compatible
45 ; with the bootstrap grid system. If not set, the thumbnails table
46 ; will be created in legacy html (using <table>)
47 ; default: no
48 bootstrap = no
49
50 ; html formating comes from css?
51 ; if set to no, the generated html (index table) will contain
52 ; some formatting tags, if set to no, it trusts the template
53 ; to include all formating inside the CSS.
54 ; default: no
55 format_from_css = yes
56
57 ; how many columns on index table?
58 ; default: 3
59 table_columns = 3
60
61 ; directory with templates for html pages, relative to
62 ; working dir (pwd when running mpp.py). Absolute paths are OK
63 ; default: mpp-templates
64 templates_dir = mpp-templates
65
66 ; when working on the current directory (not importing),
67 ; save copy of images before making any operation on them?
68 ; default: yes
69 backup = no
70
71 ; thumbnail size. Notice it's the max size, aspect ratio is always
72 ; kept when rescaling
73 ; default: 180x180
74 thumbs_size = 180x180
75
76 ; image size for individual page. Notice it's the max size, aspect
77 ; ratio is always kept when rescaling
78 ; default: 800x800
79 imgs_size = 640x640
80
81 ; force an import even if the web-album dir is already
82 ; populated. See also --force_import
83 ; default: no
84 force_import = no
85
86 ; must be a command that returns EXIF on stdout. The image file will be
87 ; passed as first argument, program must be on PATH
88 ; default: auto-detect (know applications are: metacam, jhead and exif)
89 exif_extractor = metacam
90
91 ; label added to images
92 ; default: no label
93 embedded_label = "http://www.ademar.org/mpp.py/"
94
95 ; should an image sitemap be generated?
96 ; default: no
97 sitemap = yes
98
99 ; site base URL from where albums will be hosted
100 ; (required if sitemap is enabled)
101 ; default: empty
102 site_url = http://www.ademar.org/mpp.py/examples/
103
104 ; license URL
105 ; default: empty
106 license_url = http://creativecommons.org/licenses/by-sa/3.0/
107
108 ; Set the base directory where pictures come from. The actual
109 ; directory will be a composition of <from_dir><album id>.
110 ; If the resulting directory is a web-album exported by Picasa(TM),
111 ; it'll be automatically detected.
112 ; Relative to working dir (pwd when running mpp.py).
113 ; Absolute paths are OK.
114 ; - do not set from_dir to be the same dir where the album will
115 ;   be created (album id), this may cause some undesirable effect
116 ; default: none, in which case it'll work on the album's directory, reworking
117 ; only the html pages without importing data from anywhere
118 from_dir = /storage/pictures
119
120 ;
121 ; REMEMBER:
122 ; all variables can be set on a global or per-album basis
123 ; album settings override global ones
124 ;
125
126
127 ; album name, will be used as base directory
128 ; subdirs are accepted. Example: [family/dot]
129 [dot]
130
131 ; list of extra languages to generate versions of this album
132 ; example:
133 ; extra_langs = pt-BR, en-US, ru, jp
134 ; default: empty
135 extra_langs = pt-BR
136
137 ; main title for this album
138 ; if extra-languages are used, add it as a sufix
139 ; examples:
140 ; title.en = "Pictures from..."
141 ; title.ru = "Pictures from..."
142 title = "Pictures from Dot, our little cat"
143 title.pt-BR = "Fotos do Dot, nosso gato"
144
145 ; second title for this album
146 ; if extra-languages are used, add it as a sufix
147 title2 = "Dot, our little cat"
148 title2.pt-BR = "Dot, nosso filhote"
149
150 ; period/date these pictures were taken
151 ; if extra-languages are used, add it as a sufix
152 period = dez-2006 to may-2007
153 period.pt-BR = dez-2006 a mai-2007
154
155 ; optional description to be used by the template
156 ; if extra-languages are used, add it as a sufix
157 description = "Pictures from our cat, taken between December, 2006 and May, 2007.
158 description.pt-BR = "Fotos do nosso gato Dot, tiradas entre dezembro de 2006 e maio de 2007.
159
160 ; optional geolocation information
161 ; if extra-languages are used, add it as a sufix
162 geolocation = "Manaus, Brazil"
163 geolocation.pt-BR = "Manaus, Amazonas, Brasil"
164
165 ; file with html code to be placed before the thumbnails
166 ; (description of the album)
167 ; path is always relative to album-dir/<extra-lang>/
168 ; default: html-description.txt
169 html_desc_file = html-description.txt
170
171 ; file with image captions
172 ; path is always relative to album-dir/<extra-lang>/
173 ; default: captions.txt
174 captions_file = captions.txt
175
176 ; Set the directory where pictures come from.
177 ; Will override the global 'from_dir', setting a specific
178 ; directory instead of a base prefix.
179 from_dir = dot-source
180
181 ; list of images which are ignored by mpp.py in this album. Both
182 ; the image and the respective .html file are ignored.
183 ; deafult: empty
184 ;ignored_images = foobar.jpg, lala.jpg
185
186 ; vim: ts=4:et:

(C) 2002-2009 Ademar de Souza Reis Jr.
http://www.ademar.org/
http://blog.ademar.org/