gallery

Background and rationale

Galleries are a convenient way to display images, PDFs, or other attachments in a regular grid, usually with links to show these at original size. This is possible in MoinMoin, using tables containing imbedded attachments with appropriate links, however the the markup gets a bit complex. So handling this process programatically with a parser is a convenient option. MediaWiki has galleries, so conversion of its pages to markup to MoinMoin is facilitated by this parser, although the full capabilities would be difficult to replicate directly in MoinMoin markup (it would require creating HTML output with java scripts).

Description

A simple parser that reads key:value pairs from a listing of images (attachments) and captions then formats these for display in a gallery (table), with links to view the attachment in a separate window/tab. Defaults to eight column table with captions below centred images. If more than seven key:value pairs are provided, additional rows are added. The user can set options to (1) set the number of columns, (2) change the image height (other than the default of 100px), (3) remove frames and background, and (4) show only the markup for re-use with modifications, if desired, or for debugging purposes.

The key:value list must be in the form " gallery_file:: caption" with a leading space (as moin dictionary entries). All non-conforming lines are ignored without warning.

The parser is intended for page section use only. The parser name is followed by a list of keywords separated by spaces to specify any options required.

Keywords and numerical arguments

c-[1-8]: sets the number of columns between 1 and 8.
nnn[px]: requested width of figure, where n is digits from 50 to 250; 'px' is optional. If outside this range, the lower or upper defaults is applied without warning. If two or more width options are given, the first takes precedence and others are ignored (even if the first is invalid and the default width applied).
pdf-[vert|horz]: requests that if the file is a PDF, then adjust height to suit the orientation. 'pdf-vert' is default and takes precedence. This option is best used when the gallery only includes PDFs.
noframe: request gallery be rendered without frames and backgrounds.
nospace: request gallery be rendered without spaces between items.
nolink: request that no click links be inserted on the items. This can be useful if the items are embedded PDFs because the links are not overly effective and can interfere with other functionality.
nocaption: request no caption row to be included. If captions are blank or not needed, this make for a more compact gallery, especially if a multi-row gallery.
caplink: add links in the captions as well. Helpful for Chrome & Firefox where the click on image for embedded PDFs is not so effective.
markup: shows the markup if you wish to re-use this with modification (assuming the default tabulation does not suit a specific purpose) or for debugging purposes.
#: inserted at the beginning of the caption requests that captions be inserted as in-line comments.
&: inserted at the end of the caption requests that link be inserted. This is an alternative to 'caplink', to have links added only to selection cations.

Defaults are width 100px, eight columns (so no options for these are needed).

Keywords can appear in any order, other than as indicated above for conflicting choices.

Usage

As parser section

{{{#!gallery [c-[1-8] ][nnn[px] ][pdf-vert|pdf-horz ][noframe ][nospace ][markup ]
 gallery_file:: [#]caption
 gallery_file:: [#]caption
 ...
}}}

Download & Release Notes

Download	Release Version	Moin Version	Release Notes
gallery-1.0.py	1.0	1.9.8

Examples

See Example

History

Version 1.0 - 11.10.2018: initial version

Developed with inspiration and code from:

Copyright

License

GNU GPL, see COPYING for details.

Known issues and limitations

Although the defaults are suitable for Safari, for Chrome and Firefox, it might be better to use nolink and caplink options.

Possible improvements

Allow for vertical and horizontal PDFs within a single row.

Hits: 208

gallery.py