pages/projects/degal.tmpl
author Tero Marttila <terom@fixme.fi>
Sun, 14 Sep 2014 12:56:10 +0300
changeset 55 eabf155f5327
parent 53 158854761213
permissions -rw-r--r--
pages proejcts/degal: typofix
<%

import os

RELEASE_PATH = "/home/projects/degal/releases"
RELEASE_URL = "http://projects.qmsk.net/degal/releases"

# load release links
releases = []

for filename in os.listdir(RELEASE_PATH) :
    if filename.startswith('.') :
        continue

    path = os.path.join(RELEASE_PATH, filename)
    url = "%s/%s" % (RELEASE_URL, filename)

    releases.append((filename, url))

releases.sort()

%>

<h1>Degal</h1>
    <h2>About</h2>
        <p>
            <strong>Degal</strong> is a HTML photo gallery script written in Python.
        </p>
    
    <h2>History</h2>
        <p>
            Degal was originally based on a similar HTML gallery script called <a href="http://pajukanta.fi/projects/egal/">EGAL</a>,
            written by Santtu Pajukanta, rewritten to add more features such as support for sub-folders (!).
        </p>

        <p>
            Releases 0.1 - 0.2 remained fairly simplistic single-module scripts which were manageable, but development
            in the old SVN repository quickly split the code up into a package. At this point the packaging and
            structure quickly fell apart, with the resulting code and CGI scripts being barely useable by myself.
        </p>

        <p>
            In early summer 2009, I picked up development again, heavily refactoring the old svn code into a (hopefully)
            better structure.
        </p>

        <p>
            Currently, the only releases are still from the old first-generation era, but hopefully we should be seeing a
            third-generation release fairly soon :)
        </p>
    
    <h2>Features</h2>
        <ul>
            <li>Generate static per-folder/img .html files for a directory tree</li>
            <li>Generate thumbnail and preview versions of each image</li>
        </ul>
 
    <h2>Download</h2>
        <h3>Release versions</h3>
            <ul>
            % for filename, url in releases :
                <li><a href="${url}">${filename}</a></li>
            % endfor
            </ul>
            
        <h3>Development version</h3>
            <code>hg clone http://hg.qmsk.net/degal</code>
    
    <h2>Installation and usage (for release versions)</h2>
        <p>Extract the archive file and move these files and directories to where your images are:</p>
        <ul>
            <li>.htaccess</li>
            <li>degal.py</li>
            <li>utils.py</li>
            <li>shorturl.cgi</li>
            <li>style.css</li>
            <li>templates/</li>
        </ul>
        <p>If you wish to use ShortURLs and run DeGAL with mod_userdir, you may need to modify the .htaccess to set the RewriteBase.</p>
        <p>If you now execute degal.py on the command line, it will scan through your images, create thumbnails, preview images, as well as generate the HTML gallery pages.</p>
        <p>Gallery (directory) titles may optionaly be specified in a file called title.txt in each directory. If present, it should contain a short title that will be used for all links to that gallery. You may also add a longer description (after the title, seperated by three dashes, ---, extra whitespace will be stripped away) which will be shown on the directory's index page.</p>
        <p>The same may be done for induvidual images (replace the file extension with .txt, i.e. DSC0001.jpg becomes DSC0001.txt) whereupon the URL for the image will use a simplified version of the image's title.</p>
        <p>It is also possible to specify a list of directories/files to index as command-line arguments to degal.py, in which case it will only process those files. Note that a directory index will only be updated if the directory itself is included in the filter.</p>
        
   
    <h2>Requirements</h2>
        <h3>Release version / Development core</h3>
            <ul>
                <li><a href="http://www.python.org/">Python</a> 2.5</li>
                <li><a href="http://www.pythonware.com/products/pil/">PIL</a> 1.1.6</li>
            </ul>

        <h3>Development optional</h3>
            <ul>
                <li><a href="http://tilloy.net/dev/pyexiv2/">pyexiv2</a></li>
                <li><a href="http://sourceforge.net/projects/exif-py">EXIFpy</a></li>
            </ul>
    
    <h2>Changelog</h2>
        <ul>
            <li>
                0.2
                <ul>
                    <li>Added ShortURL feature</li>
                    <li>Added ability to specify a list of files to update on the command line</li>
                </ul>
            </li>
        </ul>

    <h2>Links</h2>
        <h3>Source Repository</h3>
            <p>
                Mercurial: <a href="http://hg.qmsk.net/degal">http://hg.qmsk.net/degal</a>
            </p>
            
        <h3>Example Gallery</h3>
            <p>
                <a href="http://photos.qmsk.net/">http://photos.qmsk.net/</a>
            </p>