Browse Source

Small enhancements for plugins doc

pull/293/merge
Simon Conseil 8 years ago
parent
commit
a4367f674f
  1. 16
      sigal/plugins/copyright.py
  2. 18
      sigal/plugins/nomedia.py

16
sigal/plugins/copyright.py

@ -5,13 +5,15 @@
Settings:
- ``copyright``: the copyright text.
- ``copyright_text_font``: the copyright text font - either system/user font-name or absolute path to font.tff file.
If no font is specified, or specified font is not found, default font is used.
- ``copyright_text_font_size``: the copyright text font-size. If no font is specified, this setting is ignored.
- ``copyright_text_color``: the copyright text color in 3 tuple (R, G, B) Decimal RGB code.
e.g. (255, 255, 255) is White.
- ``copyright_text_position``: the copyright text position in 2 tuple (left, top).
By default text would be positioned at bottom-left corner.
- ``copyright_text_font``: the copyright text font - either system/user
font-name or absolute path to font.ttf file. If no font is specified, or
specified font is not found, the default font is used.
- ``copyright_text_font_size``: the copyright text font-size. If no font is
specified, this setting is ignored.
- ``copyright_text_color``: the copyright text color in a tuple (R, G, B)
with decimal RGB code, e.g. ``(255, 255, 255)`` is white.
- ``copyright_text_position``: the copyright text position in 2 tuple (left,
top). By default text would be positioned at bottom-left corner.
"""

18
sigal/plugins/nomedia.py

@ -23,8 +23,8 @@
""" This plugin offers more fine-grained control over exluded images and
folders, similarly to how it's handled on Android.
To ignore a folder or image put a .nomedia file next to it in its parent folder
and put its name into the file. E.g.::
To ignore a folder or image put a ``.nomedia`` file next to it in its parent
folder and put its name into the file. E.g.::
content of folder:
IMG_3425.JPG, IMG_2426.JPG, IMG_2427.JPG, subfolder, .nomedia
@ -35,16 +35,16 @@ and put its name into the file. E.g.::
will ignore all images but IMG_3425.JPG and the subfolder.
Alternatively, if you put a .nomedia file into a folder and leave it blank
(i.e. an empty file called .nomedia in a folder containing images), this
Alternatively, if you put a ``.nomedia`` file into a folder and leave it blank
(i.e. an empty file called ``.nomedia`` in a folder containing images), this
ignores the whole folder it's located in (like on Android).
WARNING: When you have a pre-existing gallery from a previous run of sigal
adding a new .nomedia file will not remove the newly ignored images/albums from
the existing gallery (only the entries in the parent gallery pointing to it).
They might still be reachable thereafter. Either remove the whole gallery to be
sure or remove the ignored files/folders inside the gallery to remove them for
good.
adding a new ``.nomedia`` file will not remove the newly ignored images/albums
from the existing gallery (only the entries in the parent gallery pointing to
it). They might still be reachable thereafter. Either remove the whole gallery
to be sure or remove the ignored files/folders inside the gallery to remove
them for good.
"""

Loading…
Cancel
Save