source: project/sigma/trunk/sigma-eggdoc.scm @ 7316

Last change on this file since 7316 was 7316, checked in by Ivan Raikov, 12 years ago

Added support for making CD images.

File size: 8.8 KB
Line 
1;;
2;;
3;; sigma documentation for the Chicken Scheme module system.
4;;
5;;
6;; Version $Revision$
7;;
8;;
9;;
10;; This program is free software: you can redistribute it and/or
11;; modify it under the terms of the GNU General Public License as
12;; published by the Free Software Foundation, either version 3 of the
13;; License, or (at your option) any later version.
14;;
15;; This program is distributed in the hope that it will be useful, but
16;; WITHOUT ANY WARRANTY; without even the implied warranty of
17;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18;; General Public License for more details.
19;;
20;; A full copy of the GPL license can be found at
21;; <http://www.gnu.org/licenses/>.
22;;
23;;
24
25
26(use eggdoc)
27
28(define doc
29  `((eggdoc:begin
30
31     (name "sigma")
32
33     (description "Image gallery generator.")
34
35     (author (url "mailto:iraikov@ece.gatech.edu" "Ivan Raikov"))
36
37     (history
38      (version "1.7" "Added support for CD image generation")
39      (version "1.6" "Bug fix in the highlights index generation")
40      (version "1.5" "Documentation updates")
41      (version "1.4" "Added support for highlights functionality")
42      (version "1.3" "Bug fix in image directory reading")
43      (version "1.2" "Added commands interface")
44      (version "1.1" "Bug fix in the meta file; ability to specify captions for subfolders")
45      (version "1.0" "Initial release"))
46
47     (requires (url "args.html" "args")
48               (url "sxml-transforms.html" "sxml-transforms")
49               (url "doctype.html" "doctype")
50               (url "utf8.html" "utf8")
51               (url "uri.html" "uri")
52               (url "fmt.html" "fmt"))
53
54     (usage "sigma [options...] [commands...]")
55     (download "sigma.egg")
56
57      (documentation
58
59       (p (tt "sigma") " is a simple program for creating a Web gallery
60 of images with a single command. It is based on the igal program by
61 Eric Pop and generates a set of HTML 4.0+CSS-compliant static slides.
62 The appearance of the image gallery can be altered by modifying the
63 default CSS file, as well as the slide template and index page
64 template files that appear in the image directory. Unlike igal, the
65 templates are written as S-expressions, and follow the conventions of
66 SXML.")
67
68       (p (tt "sigma") " also checks for the existence of a $HOME/.sigma
69 directory where users can store their own templates, overriding the
70 site-wide /usr/share/sigma. ")
71
72
73      (p (tt "sigma") " relies on the ImageMagick package, and if
74sorting by image date is desired, it can use the " (tt "exif") "
75program to extract EXIF date information from JPEG files.  The " (tt "convert") 
76" command from the ImageMagick package is required to process image
77files and the " (tt "identify") " command enables " (tt "sigma") " to
78include size information in the HTML it generates and to determine
79whether large images need to be rescaled. ")
80
81      (p "If the -c option is used, " (tt "sigma") " creates a " (tt ".captions")
82" file, which contains captions to be inserted under each slide. "
83"The captions must be in S-expression format and may include SXML tags. "
84"Each caption entry can be in one of two forms: "
85(ol 
86 (li (tt "(fname caption [option1 option2 ...])")
87     (p "The first element is the image file name, and the second element is the caption. "
88        "The file name and the caption are required. They can be followed by any number of "
89        "options keywords. The only option keyword currently recognized is " (tt "hl") 
90        ", which  indicates that the slide should be included on the optional highlights page. "))
91 (li  (tt "(subdir name caption) ")
92      (p "Entries of this form  be used to specify captions for subfolders. ")))
93
94"To add any comments to this file or to exclude any images from the slide "
95"show, add a semicolon the beginning of their respective lines. "
96"You may also change the order of images in your slide show at this time. ")
97
98      (subsection "Commands"
99          (p
100           (symbol-table
101            (describe "gallery"   "Create an image gallery (default if no command given)")
102            (describe "thumbs"    "Create image thumbnails (implicit when gallery is also given)")
103            (describe "sort"      "Sort images by EXIF date or file creation date")
104            (describe "cdimage"   "Create a CD image containing the image slides")
105            (describe "clean"     "Clean generated files"))))
106
107      (subsection "Options"
108          (p
109               (symbol-table
110                (describe "-a"                 "write image sizes under thumbnails on index page")
111                (describe "-c"                 "first generate and then use captions")
112                (describe "-C"                 "like -c, but preserve file names as captions")
113                (describe "-d DIR"             "operate on files in directory DIR (default: .)")
114                (describe "-f"                 "force thumbnail regeneration and scaled slides")
115                (describe "-g TITLE"           "gallery title (default: Default Gallery Title)")
116                (describe "-k"                 "use the image captions for the HTML slide titles")
117                (describe "-R"                 "recursively descend subdirectories")
118                (describe "-t DIR"             ("place gallery files in directory DIR "
119                                                "(will be created if it doesn't exist)"))
120                (describe "-u"                 "write captions under thumbnails on index page")
121                (describe "-U"                 "write slide names under thumbnails on index page")
122                (describe "-x"                 "omit the image count from the captions")
123                (describe "-y N"               "scale all thumbnails to the same height  (default: 75)")
124                (describe "--ad"               "like -a, but write only the image dimensions")
125                (describe "--as"               "like -a, but write only the file size (in kbytes)")
126                (describe "--author=AUTHOR"    "specify author name (default: $USER)")
127                (describe "--con=OPTS"         ("options to pass to " (tt "convert")))
128                (describe "--cd-dir=DIR"       "directory for CD image output (default: $HOME/tmp)")
129                (describe "--cd-file=DIR"      "name of CD image file if --gcd is not specified (default: Photos)")
130                (describe "--gcd=TITLE"        "like -g, but also sets CD image file name")
131                (describe "--hls"              "creates a highlights page")
132                (describe "--hls-main"         "creates a highlights page as the main page")
133                (describe "--html-ext=SUFFIX"  "suffix of output HTML files (default: html)")
134                (describe "--html-index=NAME"  "name (without suffix) of the main thumbnail index file (default: index)")
135                (describe "--html-hindex=NAME" "name (without suffix) of the highlights index file (default: hindex)")
136                (describe "--in"               "use image file names for the HTML slide files")
137                (describe "--top"              "create index pages for directories that only contain subfolders")
138                (describe "--tp=PREFIX"        "sets the thumbnail image prefix (default: .thumb_)")
139                (describe "--sp=PREFIX"        "sets the slide image prefix (default: .slide_)")
140                (describe "--up"               "create Up links even in top-level image galleries")
141                (describe "--verbose=LEVEL"    "set verbose mode (0: quiet; 1: info; 2: debug)")
142                (describe "--www"              "makes all SIGMA files world-readable")
143                (describe "--xy=N"             "scale thumbnails to N pixels in their longer dimension")
144                (describe "--yslide=N"         "scale slides to the given maximum height")
145                (describe "-h, --help"         "print help"))))
146
147       (subsection "Files"
148               (symbol-table
149                (describe "/usr/share/sigma/index-template.scm"
150                          "The default index template file.")
151                (describe "/usr/share/sigma/slide-template.scm"
152                          "The default slide template file.")
153                (describe "/usr/share/sigma/sigma.css"
154                          "The default style sheet."))
155
156               (p (tt "sigma") " also checks for the existence of a "
157 (tt "$HOME/.sigma") " directory where the user can store their own
158 templates, overriding the site-wide " (tt "/usr/share/sigma") ". ")))
159
160     (examples (pre #<<EOF
161
162  ## Creates an image gallery using the image files 
163  ## found in the current directory and its subdirectories;
164  ## uses directory album to write the HTML files and slides;
165  ## writes image sizes and captions under the thumbnails on the index pages;
166  ## creates and reads .captions file; resizes the slide images to a maximum
167  ## height of 500 pixels
168
169  sigma -a -c -u -R --yslide=500 -t album 
170
171
172EOF
173))
174
175     (license
176      "Copyright 2007 Ivan Raikov.
177
178Based on the igal program by Eric Pop. 
179ISO 9660 image creation code based on code by Walter C. Pelissero.
180
181This program is free software: you can redistribute it and/or modify
182it under the terms of the GNU General Public License as published by
183the Free Software Foundation, either version 3 of the License, or (at
184your option) any later version.
185
186This program is distributed in the hope that it will be useful, but
187WITHOUT ANY WARRANTY; without even the implied warranty of
188MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
189General Public License for more details.
190
191A full copy of the GPL license can be found at
192<http://www.gnu.org/licenses/>."))))
193
194(if (eggdoc->html doc) (void))
Note: See TracBrowser for help on using the repository browser.