jeff/siglican
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
a static gallery generator plugin for Pelican using Colorbox and Galleria
26 commits 1 branch 1 tag 8.1 MiB
Python 100%
Find a file
sawall 2bc1e6fa73 added examples, documentation improvement
2014-10-03 09:03:43 -05:00
examples added examples, documentation improvement 2014-10-03 09:03:43 -05:00
themes grand SIGAL_ => SIGLICAN_ transmogrification 2014-10-03 02:10:57 -05:00
__init__.py initial commit - siglican 0.0.1a 2014-09-29 14:12:00 -05:00
album.py added settings to documentation 2014-10-03 08:03:51 -05:00
compat.py grand SIGAL_ => SIGLICAN_ transmogrification 2014-10-03 02:10:57 -05:00
image.py grand SIGAL_ => SIGLICAN_ transmogrification 2014-10-03 02:10:57 -05:00
LICENSE initial commit - siglican 0.0.1a 2014-09-29 14:12:00 -05:00
pkgmeta.py initial commit - siglican 0.0.1a 2014-09-29 14:12:00 -05:00
README.md more notes 2014-10-03 08:10:55 -05:00
siglican.py cleanup, but possibly broken 2014-10-03 08:44:53 -05:00
utils.py initial commit - siglican 0.0.1a 2014-09-29 14:12:00 -05:00
video.py initial commit - siglican 0.0.1a 2014-09-29 14:12:00 -05:00
writer.py cleanup, but possibly broken 2014-10-03 08:44:53 -05:00

README.md

siglican

A static gallery generator plugin for Pelican, based on the Sigal Colorbox/Galleria static site generator.

##How To

  1. Put this folder into your Pelican plugins directory. Add 'siglican' to PLUGINS in pelicanconf.py.
  2. Create a 'siglican' directory in your base directory, at the same level as 'content'. Drag 'colorbox' or 'galleria' from the 'themes' directory into this folder. Also create an 'images' subdirectory under 'siglican'.
  3. Create album and image metadata, as desired.
  4. Create theme directory inside of 'siglican'. Use the colorbox or galleria theme as a starting point. Make sure that your Pelican theme's base.html template has a 'head' block defined before </head>.

###Example directory tree:

   /site
     /content/*
     /plugins/siglican/*.py
     /siglican
       /images
         /album1
         /album2
         /...
       /[colorbox|galleria]
         /static/*
         /templates/album.html

###Pelican Configuration Settings

These are the default values of the settings that can be configured in pelicanconf.py:

  • SIGLICAN_ALBUMS_SORT_REVERSE: False
  • SIGLICAN_AUTOROTATE_IMAGES: True
  • SIGLICAN_COLORBOX_COLUMN_SIZE: 4
  • SIGLICAN_COPY_EXIF_DATA: False
  • SIGLICAN_DESTINATION: 'gallery'
  • SIGLICAN_FILES_TO_COPY: ()
  • SIGLICAN_IGNORE_DIRECTORIES: ['.']
  • SIGLICAN_IGNORE_FILES: []
  • SIGLICAN_IMG_PROCESSOR: 'ResizeToFit'
  • SIGLICAN_IMG_SIZE: (640, 480)
  • SIGLICAN_INDEX_IN_URL: False
  • SIGLICAN_JPG_OPTIONS: {'quality': 85, 'optimize': True, 'progressive': True}
  • SIGLICAN_LINKS: ''
  • SIGLICAN_LOCALE: ''
  • SIGLICAN_MEDIAS_SORT_ATTR: 'filename'
  • SIGLICAN_MEDIAS_SORT_REVERSE: False
  • SIGLICAN_MAKE_THUMBS: True
  • SIGLICAN_ORIG_DIR: 'original'
  • SIGLICAN_ORIG_LINK: False
  • SIGLICAN_SOURCE: 'siglican'
  • SIGLICAN_THEME: 'colorbox'
  • SIGLICAN_THUMB_DIR: 'thumbs'
  • SIGLICAN_THUMB_FIT: True
  • SIGLICAN_THUMB_PREFIX: ''
  • SIGLICAN_THUMB_SIZE: (200, 150)
  • SIGLICAN_THUMB_SUFFIX: ''
  • SIGLICAN_VIDEO_SIZE: (480, 360)
  • SIGLICAN_WEBM_OPTIONS: ['-crf', '10', '-b:v', '1.6M','-qmin', '4', '-qmax', '63']
  • SIGLICAN_WRITE_HTML: True
  • SIGLICAN_ZIP_GALLERY: False
  • SIGLICAN_ZIP_MEDIA_FORMAT: 'resized'

Future

  1. Unit tests.
  2. Update colorbox/galleria example themes to deal better with nested albums.
  3. Streamline/refactor/merge modules.

Notes

For more on creating Pelican generator plugins, see the [Pelican plugin documentation] (http://docs.getpelican.com/en/latest/plugins.html#how-to-create-plugins) and Pelican internals.

##Credits

  • Around 2/3 of the core Python code is ported from Sigal v0.8.0 by Simon Conseil.
  • Heavily leverages Pelican, Jinja2, Colorbox, and Galleria.
  • Pelican generator plugin implementation and integration by Scott Boone (sawall@github).