Split documentation in multiple pages.
This commit is contained in:
Simon Conseil
43
docs/album_information.rst
Normal file
43
docs/album_information.rst
Normal file
@@ -0,0 +1,43 @@
|
||||
.. _album-information-label:
|
||||
|
||||
===================
|
||||
Album information
|
||||
===================
|
||||
|
||||
Information on an album can be given in a file using the `markdown`_ syntax,
|
||||
named ``index.md`` :
|
||||
|
||||
::
|
||||
|
||||
Title: Another example gallery
|
||||
Thumbnail: test2.jpg
|
||||
|
||||
And a description with *Markdown* syntax.
|
||||
|
||||
Some meta-data keys are used by Sigal to get the useful informations on the
|
||||
gallery:
|
||||
|
||||
- *Title*: the gallery title.
|
||||
- *Thumbnail*: the thumbnail that will be used in the parent directory to
|
||||
represent the gallery.
|
||||
|
||||
Any additional meta-data is available in the templates. For instance::
|
||||
|
||||
Authors: Waylan Limberg
|
||||
John Doe
|
||||
|
||||
can be used in the template with:
|
||||
|
||||
.. code-block:: jinja
|
||||
|
||||
{% if 'authors' in meta %}
|
||||
<p>Authors: {{ meta.authors|join(', ') }}</>
|
||||
{% endif %}
|
||||
|
||||
If this file does not exist or if some meta-data is missing:
|
||||
|
||||
- The directory's name is used for the title (dashes and underscores are
|
||||
replaced with spaces).
|
||||
- The first image of the directory is used as thumbnail.
|
||||
|
||||
.. _markdown: http://daringfireball.net/projects/markdown/
|
||||
83
docs/changelog.rst
Normal file
83
docs/changelog.rst
Normal file
@@ -0,0 +1,83 @@
|
||||
===========
|
||||
Changelog
|
||||
===========
|
||||
|
||||
Version 0.4.1
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Released on 2013-07-19.
|
||||
|
||||
- Fix a bug with unicode paths and filenames.
|
||||
- Update colorbox to 1.4.26
|
||||
- Add links to the original images.
|
||||
|
||||
Version 0.4.0
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Released on 2013-06-12.
|
||||
|
||||
- Add a setting to disable the writing of HTML files.
|
||||
- Use Pilkit.
|
||||
- Remove multiprocessing.
|
||||
- Add new settings for the source and destination directories.
|
||||
- All meta-data are available in the templates.
|
||||
- Galleria theme is now responsive
|
||||
- Add a setting to choose the pilkit processor used to resize the images.
|
||||
|
||||
Version 0.3.3
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Released on 2013-03-20.
|
||||
|
||||
- Catch exception when PIL fails to read the exif metadata.
|
||||
|
||||
Version 0.3.2
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Released on 2013-03-14.
|
||||
|
||||
- Bugfix for PNG files which don't have exif metadata.
|
||||
- Move unit tests to py.test.
|
||||
- Fix images path in colorbox theme.
|
||||
- Group package meta in a module.
|
||||
|
||||
Version 0.3.1
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Released on 2013-03-11.
|
||||
|
||||
- Fix the path of the sample config file (which was not included in the
|
||||
previous release).
|
||||
|
||||
Version 0.3
|
||||
~~~~~~~~~~~
|
||||
|
||||
Released on 2013-03-04.
|
||||
|
||||
- Fix packaging issues.
|
||||
- New setting ``index_in_url`` to optionally add `index.html` to the URLs.
|
||||
- New setting ``links`` to specify a list of links.
|
||||
- Use EXIF info to fix orientation.
|
||||
- Replace the ``jpg_quality`` setting with a dict of options.
|
||||
- Manage directories with only sub-directories and add some checks.
|
||||
- Change the command-line interface to use sub-commands: ``init``, ``build``
|
||||
and ``serve``.
|
||||
- Parallel processing.
|
||||
|
||||
Version 0.2
|
||||
~~~~~~~~~~~
|
||||
|
||||
Released on 2012-12-20.
|
||||
|
||||
- Improve the bundled themes (update galleria, new colorbox theme).
|
||||
- Improve the CLI (new arguments, nicer output).
|
||||
- Change the licence to MIT.
|
||||
- Change the description file to a markdown syntax file.
|
||||
- Change the settings file to a python file, and add more settings.
|
||||
|
||||
Version 0.1
|
||||
~~~~~~~~~~~
|
||||
|
||||
Released on 2012-05-13.
|
||||
|
||||
First public release.
|
||||
12
docs/configuration.rst
Normal file
12
docs/configuration.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
===============
|
||||
Configuration
|
||||
===============
|
||||
|
||||
The configuration must be set in a ``sigal.conf.py`` file in the current
|
||||
directory. It can also be specified with the ``-c`` flag. An example file with
|
||||
explanations on the settings is available in ``sigal/templates/sigal.conf.py``
|
||||
and is shown below. This file is copied to the current directory with the
|
||||
``sigal init`` commmand.
|
||||
|
||||
.. literalinclude:: ../sigal/templates/sigal.conf.py
|
||||
:language: python
|
||||
63
docs/getting_started.rst
Normal file
63
docs/getting_started.rst
Normal file
@@ -0,0 +1,63 @@
|
||||
=================
|
||||
Getting started
|
||||
=================
|
||||
|
||||
How to Use
|
||||
~~~~~~~~~~
|
||||
|
||||
Init
|
||||
To get started, just run ``sigal init`` which will copy an example
|
||||
configuration file in the current directory. All configuration values have a
|
||||
default; values that are commented out serve to show the default. Default
|
||||
values are specified when modified in this example config file.
|
||||
|
||||
Build
|
||||
After adapting the configuration to your needs, put your images in a
|
||||
sub-directory and run ``sigal build <your images directory>``. The next time
|
||||
you run ``sigal build``, only the new images will be processed. Use the
|
||||
``-f`` flag to force the reprocessing of all the images.
|
||||
|
||||
Serve
|
||||
To visualize your gallery, you can use ``sigal serve`` which runs a basic
|
||||
web server. This server should only be used for local browsing, not in
|
||||
production. Another option is to use the ``index_in_url = True`` setting,
|
||||
which will add ``index.html`` to the urls to allow browsing without a
|
||||
server.
|
||||
|
||||
|
||||
Help of the ``sigal build`` command
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
$ sigal build [-h] [-d] [-v] [-f] [-c CONFIG] [-t THEME]
|
||||
[source] [destination]
|
||||
|
||||
Required arguments:
|
||||
|
||||
``source``
|
||||
Input directory
|
||||
|
||||
``destination``
|
||||
Output directory (default: ``_build/``)
|
||||
|
||||
Optional arguments:
|
||||
|
||||
``-h, --help``
|
||||
Show this help message and exit
|
||||
|
||||
``-f, --force``
|
||||
Force the reprocessing of existing images and thumbnails
|
||||
|
||||
``-v, --verbose``
|
||||
Show all messages
|
||||
|
||||
``-d, --debug``
|
||||
Show all message, including debug messages
|
||||
|
||||
``-c CONFIG, --config CONFIG``
|
||||
Configuration file (default: ``sigal.conf.py`` in the current working
|
||||
directory)
|
||||
|
||||
``-t THEME, --theme THEME``
|
||||
Specify a theme directory, or a theme name for the themes included with Sigal
|
||||
369
docs/index.rst
369
docs/index.rst
@@ -14,364 +14,15 @@ Javascript libraries:
|
||||
.. _galleria demo: http://saimon.org/sigal-demo/galleria/
|
||||
.. _colorbox demo: http://saimon.org/sigal-demo/colorbox/
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
|
||||
Install the extension with one of the following commands::
|
||||
|
||||
$ easy_install sigal
|
||||
|
||||
or alternatively if you have pip installed::
|
||||
|
||||
$ pip install sigal
|
||||
|
||||
Dependencies
|
||||
~~~~~~~~~~~~
|
||||
|
||||
- Argh
|
||||
- Clint
|
||||
- Jinja2
|
||||
- Pilkit
|
||||
- Python Imaging Library (PIL / Pillow, see below)
|
||||
- Python Markdown
|
||||
|
||||
PIL or Pillow ?
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
PIL_ is almost dead, the last release was in 2009. If possible you should
|
||||
prefer to use Pillow_, a fork of PIL which is actively developped, with
|
||||
packaging improvements, Python 3 compatibility, etc.
|
||||
|
||||
You can install Pillow with ``pip install Pillow``, preferably in a
|
||||
virtualenv_. To have JPG and PNG support, you must first install the
|
||||
developpement packages of libjpeg, freetype2 and zlib.
|
||||
|
||||
- For Debian/Ubuntu, this is possible with::
|
||||
|
||||
apt-get build-dep python-dev python-imaging
|
||||
|
||||
- For Archlinux, there is a package_ for sigal in the AUR which already uses
|
||||
Pillow.
|
||||
|
||||
.. _PIL: http://www.pythonware.com/products/pil/
|
||||
.. _Pillow: https://github.com/python-imaging/Pillow
|
||||
.. _package: https://aur.archlinux.org/packages/sigal/
|
||||
.. _virtualenv: http://www.virtualenv.org/
|
||||
|
||||
How to Use
|
||||
----------
|
||||
|
||||
Init
|
||||
To get started, just run ``sigal init`` which will copy an example
|
||||
configuration file in the current directory. All configuration values have a
|
||||
default; values that are commented out serve to show the default. Default
|
||||
values are specified when modified in this example config file.
|
||||
|
||||
Build
|
||||
After adapting the configuration to your needs, put your images in a
|
||||
sub-directory and run ``sigal build <your images directory>``. The next time
|
||||
you run ``sigal build``, only the new images will be processed. Use the
|
||||
``-f`` flag to force the reprocessing of all the images.
|
||||
|
||||
Serve
|
||||
To visualize your gallery, you can use ``sigal serve`` which runs a basic
|
||||
web server. This server should only be used for local browsing, not in
|
||||
production. Another option is to use the ``index_in_url = True`` setting,
|
||||
which will add ``index.html`` to the urls to allow browsing without a
|
||||
server.
|
||||
|
||||
|
||||
Help of the ``sigal build`` command
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
::
|
||||
|
||||
$ sigal build [-h] [-d] [-v] [-f] [-c CONFIG] [-t THEME]
|
||||
[source] [destination]
|
||||
|
||||
Required arguments:
|
||||
|
||||
``source``
|
||||
Input directory
|
||||
|
||||
``destination``
|
||||
Output directory (default: ``_build/``)
|
||||
|
||||
Optional arguments:
|
||||
|
||||
``-h, --help``
|
||||
Show this help message and exit
|
||||
|
||||
``-f, --force``
|
||||
Force the reprocessing of existing images and thumbnails
|
||||
|
||||
``-v, --verbose``
|
||||
Show all messages
|
||||
|
||||
``-d, --debug``
|
||||
Show all message, including debug messages
|
||||
|
||||
``-c CONFIG, --config CONFIG``
|
||||
Configuration file (default: ``sigal.conf.py`` in the current working
|
||||
directory)
|
||||
|
||||
``-t THEME, --theme THEME``
|
||||
Specify a theme directory, or a theme name for the themes included with Sigal
|
||||
|
||||
|
||||
Configuration
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
The configuration must be set in a ``sigal.conf.py`` file in the current
|
||||
directory. It can also be specified with the ``-c`` flag. An example file with
|
||||
explanations on the settings is available in ``sigal/templates/sigal.conf.py``
|
||||
and is shown below. This file is copied to the current directory with the
|
||||
``sigal init`` commmand.
|
||||
|
||||
.. literalinclude:: ../sigal/templates/sigal.conf.py
|
||||
:language: python
|
||||
|
||||
|
||||
Templates
|
||||
---------
|
||||
|
||||
Gallery pages are created from a `Jinja2`_ template ``index.html`` that must be located in ``THEME_DIR/templates``.
|
||||
|
||||
.. _Jinja2: http://jinja.pocoo.org/docs/
|
||||
|
||||
|
||||
Variables
|
||||
~~~~~~~~~
|
||||
|
||||
You can use the following variables in your template:
|
||||
|
||||
``albums``
|
||||
List of ``album`` objects. An ``album`` object has the following attributes:
|
||||
|
||||
- ``album.name``
|
||||
- ``album.title``
|
||||
- ``album.url``
|
||||
- ``album.thumb``
|
||||
|
||||
``breadcrumb``
|
||||
List of ``(url, title)`` tuples defining the current breadcrumb path.
|
||||
|
||||
``index_title``
|
||||
Name of the index. This is either the directory name or the title specified
|
||||
in the ``index.md``.
|
||||
|
||||
``index_url``
|
||||
URL to the index page.
|
||||
|
||||
``medias``
|
||||
List of ``media`` objects. A ``media`` object has the following attributes:
|
||||
|
||||
- ``media.type``: Either ``"img"`` or ``"vid"``.
|
||||
- ``media.file``: Location of the resized image.
|
||||
- ``media.thumb``: Location of the corresponding thumbnail image.
|
||||
- ``media.big``: If not None, location of the unmodified image.
|
||||
- ``media.exif``: If not None contains a dict with the most common tags. For
|
||||
more information, see :ref:`simple-exif-data`.
|
||||
- ``media.raw_exif``: If not ``None``, it contains the raw EXIF tags.
|
||||
|
||||
``meta`` and ``description``
|
||||
Meta data and album description. For details how to annotate your albums
|
||||
with meta data, see :ref:`album-information-label`.
|
||||
|
||||
``theme.name``
|
||||
Name of the currently used theme.
|
||||
|
||||
``settings``
|
||||
The entire dictionary from ``sigal.conf.py``. For example, you could use
|
||||
this to output an optional download link for zipped archives:
|
||||
|
||||
.. code-block:: jinja
|
||||
|
||||
{% if settings.zip_gallery %}
|
||||
<a href="{{ settings.zip_gallery }}">Download archive</a>
|
||||
{% endif %}
|
||||
|
||||
``sigal_link``
|
||||
URL to the Sigal homepage.
|
||||
|
||||
``zip_gallery``
|
||||
If not None, it contains the location of a zip archive with all original
|
||||
images of the corresponding directory.
|
||||
|
||||
|
||||
.. _simple-exif-data:
|
||||
|
||||
Simpler EXIF data output
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Because the tags in the ``media.raw_exif`` dictionary are a little bit
|
||||
cumbersome to use, some common tags are extracted and formatted for easy use in
|
||||
templates. If available, you can use:
|
||||
|
||||
``media.exif.iso``
|
||||
The ISO speed rating.
|
||||
|
||||
``media.exif.focal``
|
||||
The focal length, formatted as a decimal number.
|
||||
|
||||
``media.exif.exposure``
|
||||
The exposure time formatted as a fractional number, e.g. "1/500".
|
||||
|
||||
``media.exif.fstop``
|
||||
The aperture value given as an F-number and formatted as a decimal.
|
||||
|
||||
``media.exif.datetime``
|
||||
The time the image was *taken*. It is a datetime object, that can be
|
||||
formatted with ``strftime``:
|
||||
|
||||
.. code-block:: jinja
|
||||
|
||||
{% if media.exif.datetime %}
|
||||
{{ media.exif.datetime.strftime('%A, %d. %B %Y') }}
|
||||
{% endif %}
|
||||
|
||||
This will output something like "Monday, 25. June 2013", depending on your
|
||||
locale.
|
||||
|
||||
``media.exif.gps``
|
||||
If not None, the dict contains two keys ``lat`` and ``lon`` denoting the
|
||||
GPS coordinates of the location where the image was taken. ``lat`` will
|
||||
always be referenced to the north pole whereas ``lon`` will be referenced to
|
||||
east to the prime meridan. To provide a link on an OpenStreetMap you could
|
||||
write a template like this:
|
||||
|
||||
.. code-block:: jinja
|
||||
|
||||
{% if media.exif.gps %}
|
||||
<a href="http://openstreetmap.org/index.html?lat={{
|
||||
media.exif.gps.lat }}&lon={{ media.exif.long}}">Go to location</a>
|
||||
{% endif %}
|
||||
|
||||
|
||||
.. _album-information-label:
|
||||
|
||||
Album information
|
||||
-----------------
|
||||
|
||||
Information on an album can be given in a file using the `markdown`_ syntax,
|
||||
named ``index.md`` :
|
||||
|
||||
::
|
||||
|
||||
Title: Another example gallery
|
||||
Thumbnail: test2.jpg
|
||||
|
||||
And a description with *Markdown* syntax.
|
||||
|
||||
Some meta-data keys are used by Sigal to get the useful informations on the
|
||||
gallery:
|
||||
|
||||
- *Title*: the gallery title.
|
||||
- *Thumbnail*: the thumbnail that will be used in the parent directory to
|
||||
represent the gallery.
|
||||
|
||||
Any additional meta-data is available in the templates. For instance::
|
||||
|
||||
Authors: Waylan Limberg
|
||||
John Doe
|
||||
|
||||
can be used in the template with:
|
||||
|
||||
.. code-block:: jinja
|
||||
|
||||
{% if 'authors' in meta %}
|
||||
<p>Authors: {{ meta.authors|join(', ') }}</>
|
||||
{% endif %}
|
||||
|
||||
If this file does not exist or if some meta-data is missing:
|
||||
|
||||
- The directory's name is used for the title (dashes and underscores are
|
||||
replaced with spaces).
|
||||
- The first image of the directory is used as thumbnail.
|
||||
|
||||
.. _markdown: http://daringfireball.net/projects/markdown/
|
||||
|
||||
|
||||
Changelog
|
||||
---------
|
||||
|
||||
Version 0.4.1
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Released on 2013-07-19.
|
||||
|
||||
- Fix a bug with unicode paths and filenames.
|
||||
- Update colorbox to 1.4.26
|
||||
- Add links to the original images.
|
||||
|
||||
Version 0.4.0
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Released on 2013-06-12.
|
||||
|
||||
- Add a setting to disable the writing of HTML files.
|
||||
- Use Pilkit.
|
||||
- Remove multiprocessing.
|
||||
- Add new settings for the source and destination directories.
|
||||
- All meta-data are available in the templates.
|
||||
- Galleria theme is now responsive
|
||||
- Add a setting to choose the pilkit processor used to resize the images.
|
||||
|
||||
Version 0.3.3
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Released on 2013-03-20.
|
||||
|
||||
- Catch exception when PIL fails to read the exif metadata.
|
||||
|
||||
Version 0.3.2
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Released on 2013-03-14.
|
||||
|
||||
- Bugfix for PNG files which don't have exif metadata.
|
||||
- Move unit tests to py.test.
|
||||
- Fix images path in colorbox theme.
|
||||
- Group package meta in a module.
|
||||
|
||||
Version 0.3.1
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
Released on 2013-03-11.
|
||||
|
||||
- Fix the path of the sample config file (which was not included in the
|
||||
previous release).
|
||||
|
||||
Version 0.3
|
||||
~~~~~~~~~~~
|
||||
|
||||
Released on 2013-03-04.
|
||||
|
||||
- Fix packaging issues.
|
||||
- New setting ``index_in_url`` to optionally add `index.html` to the URLs.
|
||||
- New setting ``links`` to specify a list of links.
|
||||
- Use EXIF info to fix orientation.
|
||||
- Replace the ``jpg_quality`` setting with a dict of options.
|
||||
- Manage directories with only sub-directories and add some checks.
|
||||
- Change the command-line interface to use sub-commands: ``init``, ``build``
|
||||
and ``serve``.
|
||||
- Parallel processing.
|
||||
|
||||
Version 0.2
|
||||
~~~~~~~~~~~
|
||||
|
||||
Released on 2012-12-20.
|
||||
|
||||
- Improve the bundled themes (update galleria, new colorbox theme).
|
||||
- Improve the CLI (new arguments, nicer output).
|
||||
- Change the licence to MIT.
|
||||
- Change the description file to a markdown syntax file.
|
||||
- Change the settings file to a python file, and add more settings.
|
||||
|
||||
Version 0.1
|
||||
~~~~~~~~~~~
|
||||
|
||||
Released on 2012-05-13.
|
||||
|
||||
First public release.
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
installation
|
||||
getting_started
|
||||
configuration
|
||||
album_information
|
||||
themes
|
||||
changelog
|
||||
|
||||
44
docs/installation.rst
Normal file
44
docs/installation.rst
Normal file
@@ -0,0 +1,44 @@
|
||||
==============
|
||||
Installation
|
||||
==============
|
||||
|
||||
Install the extension with one of the following commands::
|
||||
|
||||
$ easy_install sigal
|
||||
|
||||
or alternatively if you have pip installed::
|
||||
|
||||
$ pip install sigal
|
||||
|
||||
Dependencies
|
||||
~~~~~~~~~~~~
|
||||
|
||||
- Argh
|
||||
- Clint
|
||||
- Jinja2
|
||||
- Pilkit
|
||||
- Python Imaging Library (PIL / Pillow, see below)
|
||||
- Python Markdown
|
||||
|
||||
PIL or Pillow ?
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
PIL_ is almost dead, the last release was in 2009. If possible you should
|
||||
prefer to use Pillow_, a fork of PIL which is actively developped, with
|
||||
packaging improvements, Python 3 compatibility, etc.
|
||||
|
||||
You can install Pillow with ``pip install Pillow``, preferably in a
|
||||
virtualenv_. To have JPG and PNG support, you must first install the
|
||||
developpement packages of libjpeg, freetype2 and zlib.
|
||||
|
||||
- For Debian/Ubuntu, this is possible with::
|
||||
|
||||
apt-get build-dep python-dev python-imaging
|
||||
|
||||
- For Archlinux, there is a package_ for sigal in the AUR which already uses
|
||||
Pillow.
|
||||
|
||||
.. _PIL: http://www.pythonware.com/products/pil/
|
||||
.. _Pillow: https://github.com/python-imaging/Pillow
|
||||
.. _package: https://aur.archlinux.org/packages/sigal/
|
||||
.. _virtualenv: http://www.virtualenv.org/
|
||||
117
docs/themes.rst
Normal file
117
docs/themes.rst
Normal file
@@ -0,0 +1,117 @@
|
||||
========
|
||||
Themes
|
||||
========
|
||||
|
||||
Gallery pages are created from a `Jinja2`_ template ``index.html`` that must
|
||||
be located in ``THEME_DIR/templates``.
|
||||
|
||||
.. _Jinja2: http://jinja.pocoo.org/docs/
|
||||
|
||||
|
||||
Variables
|
||||
~~~~~~~~~
|
||||
|
||||
You can use the following variables in your template:
|
||||
|
||||
``albums``
|
||||
List of ``album`` objects. An ``album`` object has the following attributes:
|
||||
|
||||
- ``album.name``
|
||||
- ``album.title``
|
||||
- ``album.url``
|
||||
- ``album.thumb``
|
||||
|
||||
``breadcrumb``
|
||||
List of ``(url, title)`` tuples defining the current breadcrumb path.
|
||||
|
||||
``index_title``
|
||||
Name of the index. This is either the directory name or the title specified
|
||||
in the ``index.md``.
|
||||
|
||||
``index_url``
|
||||
URL to the index page.
|
||||
|
||||
``medias``
|
||||
List of ``media`` objects. A ``media`` object has the following attributes:
|
||||
|
||||
- ``media.type``: Either ``"img"`` or ``"vid"``.
|
||||
- ``media.file``: Location of the resized image.
|
||||
- ``media.thumb``: Location of the corresponding thumbnail image.
|
||||
- ``media.big``: If not None, location of the unmodified image.
|
||||
- ``media.exif``: If not None contains a dict with the most common tags. For
|
||||
more information, see :ref:`simple-exif-data`.
|
||||
- ``media.raw_exif``: If not ``None``, it contains the raw EXIF tags.
|
||||
|
||||
``meta`` and ``description``
|
||||
Meta data and album description. For details how to annotate your albums
|
||||
with meta data, see :ref:`album-information-label`.
|
||||
|
||||
``theme.name``
|
||||
Name of the currently used theme.
|
||||
|
||||
``settings``
|
||||
The entire dictionary from ``sigal.conf.py``. For example, you could use
|
||||
this to output an optional download link for zipped archives:
|
||||
|
||||
.. code-block:: jinja
|
||||
|
||||
{% if settings.zip_gallery %}
|
||||
<a href="{{ settings.zip_gallery }}">Download archive</a>
|
||||
{% endif %}
|
||||
|
||||
``sigal_link``
|
||||
URL to the Sigal homepage.
|
||||
|
||||
``zip_gallery``
|
||||
If not None, it contains the location of a zip archive with all original
|
||||
images of the corresponding directory.
|
||||
|
||||
|
||||
.. _simple-exif-data:
|
||||
|
||||
Simpler EXIF data output
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Because the tags in the ``media.raw_exif`` dictionary are a little bit
|
||||
cumbersome to use, some common tags are extracted and formatted for easy use in
|
||||
templates. If available, you can use:
|
||||
|
||||
``media.exif.iso``
|
||||
The ISO speed rating.
|
||||
|
||||
``media.exif.focal``
|
||||
The focal length, formatted as a decimal number.
|
||||
|
||||
``media.exif.exposure``
|
||||
The exposure time formatted as a fractional number, e.g. "1/500".
|
||||
|
||||
``media.exif.fstop``
|
||||
The aperture value given as an F-number and formatted as a decimal.
|
||||
|
||||
``media.exif.datetime``
|
||||
The time the image was *taken*. It is a datetime object, that can be
|
||||
formatted with ``strftime``:
|
||||
|
||||
.. code-block:: jinja
|
||||
|
||||
{% if media.exif.datetime %}
|
||||
{{ media.exif.datetime.strftime('%A, %d. %B %Y') }}
|
||||
{% endif %}
|
||||
|
||||
This will output something like "Monday, 25. June 2013", depending on your
|
||||
locale.
|
||||
|
||||
``media.exif.gps``
|
||||
If not None, the dict contains two keys ``lat`` and ``lon`` denoting the
|
||||
GPS coordinates of the location where the image was taken. ``lat`` will
|
||||
always be referenced to the north pole whereas ``lon`` will be referenced to
|
||||
east to the prime meridan. To provide a link on an OpenStreetMap you could
|
||||
write a template like this:
|
||||
|
||||
.. code-block:: jinja
|
||||
|
||||
{% if media.exif.gps %}
|
||||
<a href="http://openstreetmap.org/index.html?lat={{
|
||||
media.exif.gps.lat }}&lon={{ media.exif.long}}">Go to location</a>
|
||||
{% endif %}
|
||||
|
||||
Reference in New Issue
Block a user