index_images is a Python script that scans a directory for image files and creates a HTML index of any found images. Currently the script only looks for *.jpg and *.png files.
Mouseover images may be added using a file naming convention.
An image that has a file name (excluding the extension) ending with -over, where there is another image with the same file name (without the "-over"), is treated as a mouseover image. The purpose of a mouseover image might be to add annotations to, or highlight sections of, an original image.
For example, if screen_20220808_1904.png is the name of an image included in the index, then a file named screen_20220808_1904-over.jpg will be displayed on mouseover. Note the file type (extension) does not need to be the same.
Inline JavaScript is added to the anchor tag to display the image when the mouseover event fires.
Mouseover images are not included in the index document. They are only referenced in the JavaScript.
This images-index.html was created by running index_images.py on the screenshots (screenshots of screenshots) used to make the following animated GIF.
usage: index_images [-h] [-r] [-n OUT_NAME] [-d OUT_DIR] [--no-list] [dir_name]
Create an HTML index of images.
positional arguments:
dir_name Name of the directory to scan for image files (*.png
and *.jpg). Optional. If not specified, the current
working directory is scanned.
options:
-h, --help show this help message and exit
-r, --recurse Recursively scan subdirectories for image files.
Optional.
-n OUT_NAME, --name OUT_NAME
Name of the output HTML file. Optional. If not
specified, the file is named 'images-index.html'.
-d OUT_DIR, --out-dir OUT_DIR
Directory in which to create the output HTML file.
Optional. If not specified, the file is written to the
same directory as is scanned for image files.
--no-list Do not include a Contents section listing links to
each image.