diff --git a/docs/_static/logo.xcf b/docs/_static/logo.xcf new file mode 100644 index 0000000..6224fe3 Binary files /dev/null and b/docs/_static/logo.xcf differ diff --git a/docs/index.rst b/docs/index.rst index 7ea969c..8703177 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -72,48 +72,16 @@ Optional arguments: ``-d, --debug`` Show all message, including debug messages + Configuration ------------- The configuration for the gallery must be set in ``/sigal.conf``. +An example file with explanations on the settings is available in +``tests/sample/sigal.conf`` and is shown below: -.. code-block:: ini - - [sigal] - - # theme - theme = default - - # size of resized image - img_size = 640x480 - - # generate thumbnails - make_thumbs = 1 - - # directory of the thumbnails - thumb_dir = thumbnail - - # prefix for thumbnails name - thumb_prefix = tn- - - # thumbnail size - thumb_size = 200x150 - - # crop the image to fill the box - thumb_fit = 1 - - # keep big image - big_img = 1 - bigimg_dir = original - - # jpeg quality - jpg_quality = 90 - - # keep exif metadatas in output image - exif = 1 - - # add a copyright text on the image - copyright = An example copyright message +.. literalinclude:: ../tests/sample/sigal.conf + :language: ini Album information @@ -130,12 +98,14 @@ named `index.mkd` :: If this file does not exist the directory's name is used for the title, and the first image of the directory is used as representative. + Credits ------- * galleria: http://galleria.aino.se/ * WordPress Photography Theme: http://thethemefoundry.com/photography/ + Changelog --------- diff --git a/sigal/settings.py b/sigal/settings.py index bf62ef6..3ba10a8 100644 --- a/sigal/settings.py +++ b/sigal/settings.py @@ -30,7 +30,7 @@ _DEFAULT_CONFIG = { 'thumb_prefix': '', 'thumb_suffix': '', 'thumb_size': '150x112', - 'thumb_dir': '', + 'thumb_dir': 'thumbnails', 'thumb_fit': '1', 'keep_orig': '0', 'orig_dir': 'original', diff --git a/tests/sample/sigal.conf b/tests/sample/sigal.conf index c762624..3a6d11a 100644 --- a/tests/sample/sigal.conf +++ b/tests/sample/sigal.conf @@ -1,36 +1,43 @@ [sigal] -# theme -theme = default +# 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 + +# theme : +# - default, galleria, or the path to a custom theme directory +# theme = default # size of resized image -img_size = 640x480 +# img_size = 640x480 # generate thumbnails -make_thumbs = 1 +# make_thumbs = 1 -# directory of the thumbnails -thumb_dir = thumbnail +# subdirectory of the thumbnails +# thumb_dir = thumbnails -# prefix for thumbnails name -thumb_prefix = +# prefix and/or suffix for thumbnail names (default: '') +# thumb_prefix = thumb_suffix = .tn -# thumbnail size +# thumbnail size (default: 150x112) thumb_size = 200x150 # crop the image to fill the box -thumb_fit = 1 +# thumb_fit = 1 -# keep big image +# keep original image (default: 0) keep_orig = 1 -orig_dir = original + +# subdirectory for original images +# orig_dir = original # jpeg quality -jpg_quality = 90 +# jpg_quality = 90 -# keep exif metadatas in output image +# keep exif metadatas in output image (default: 0) exif = 1 -# add a copyright text on the image +# add a copyright text on the image (default: '') copyright = An example copyright message