Minor fixes and improvements to the default example
[mpp.py.git] / mpp-templates / README
1 Creating a template is trivial. All you have to do is create your html code
2 and insert text variables inside the code. mpp.py will just change these
3 variables for the real information. Below is the list of variables
4 supported by mpp.py:
5
6 * Shared by both templates (img_page and index):
7
8     * __ALBUM_DIR__:         album current directory (relative)
9     * __ALBUM_TITLE__:       title, from .ini file
10     * __ALBUM_TITLE2__:      title2, from .ini file
11     * __ALBUM_TITLE3__:      title3, from .ini file
12     * __ALBUM_PERIOD__:      period, from .ini file
13     * __ALBUM_DESCRIPTION__: description, from .ini file
14     * __ALBUM_MODIF_DATE__:  current date
15     * __MPP_PROJECT_LINK__:  html link to mpp.py
16     * __ALBUM_NUM_IMGS__:    number of images on this album
17     * __LANG_LINKS__:        links to the current page in other languages
18     * __LANG_ALTERNATE_LINKS__: language alternate links, see
19                                 http://googlewebmastercentral.blogspot.com/2010/09/unifying-content-under-multilingual.html
20                                 (use this if your translation is semi-automatic
21                                 or if you have a lot of duplicated content)
22
23 * Exclusive to the index template:
24
25     * __ALBUM_HTML_DESC__:   html description, (from description file)
26     * __ALBUM_IMGS_TABLE__:  table (html) with the thumbnails and links
27
28 * Exclusive to the img_page template:
29
30     * __IMG_NAME__:          image file name (relative path)
31     * __IMG_DATE__:          date this image was shot (if available)         
32     * __IMG_WIDTH__:         image width
33     * __IMG_HEIGHT__:        image height
34     * __IMG_CAPTION__:       image caption (or name if no caption is set)
35     * __IMG_DESCRIPTION__:   image description (same as caption right now)
36     * __IMG_NEXT__:          next image name on this album
37     * __IMG_PREV__:          previous image name on this album
38     * __IMG_NUMBER__:        image number on this album
39     * __IMG_EXIF__:          image exif information (html text with linebreaks)
40     * __IMG_EXIF_RAW__:      image exif information in raw form (from extractor)
41     * __ALBUM_INDEX_PAGE__:  index file (relative path)
42
43 The templates should be put inside the directory specified by
44 'templates_dir' in the ini file (default: mpp-templates). Templates for
45 additional languages should be put inside a lang-dir sub-directory.
46
47 By default, legacy HTML tables are used to generate the index page, but mpp.py
48 supports generating index pages using Bootstrap (http://getbootstrap.com/),
49 which is the recommended method. To use it, create a proper template and set
50 'bootstrap = on' in the configuration file.
51
52 In legacy mode, templates should get their formatting from CSS. If that's not
53 the case and you want the index table to have some basic formatting, set
54 'format_from_css = no' in the .ini file. If a mpp.css file exists inside the
55 templates dir, it's copied to all albums generated by mpp.py.
56
57 Notice that "en" is the default/primary language in the templates provided as
58 examples. If you want to use it as a secondary language, create an "en"
59 directory, copy the main templates to there and and fix the link references
60 inside the html (add '../' to img and index links).
61
62 Below is the default structure of the templates dir:
63
64     mpp-templates/
65     |-- README
66     |-- img_page.html
67     |-- index.html
68     |-- mpp.css
69     `-- pt
70         |-- img_page.html
71         `-- index.html
72
73 # vim: et:tw=80:

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