album-4.17/ 0000755 0000000 0000000 00000000000 14215673616 011256 5 ustar root root album-4.17/Docs/ 0000775 0000000 0000000 00000000000 12661460265 012145 5 ustar root root album-4.17/Docs/conf.bak 0000644 0000000 0000000 00000004456 10067262453 013555 0 ustar root root New_Chunk = ITEM:
# Name of the short index, just links to the chapters
Short_Index = Short.html
# Name of the long index, links to chapters and chunks/questions
Long_Index = index.html
# Our list of text files (can use glob characters)
# Just make sure the filename ends with the section number.
Text_Files = txt_*
# Header
Header = "conf(my_head_head)
conf(my_start_table_top)
SPACE_OUT($NUMBER -- $TOPIC)
conf(my_start_table_bottom)
"
# Footer
Footer = " "
# Header for short index
Short_Header = "
conf(my_head_head)
conf(my_start_table_top)
SPACE_OUT(album Documentation)
conf(my_start_table_bottom)
"
# Footer for short index
Short_Footer = conf(Footer)
Long_Header = conf(Short_Header)
Long_Footer = conf(Short_Footer)
##################################################
# Local variables for the conf file (used in conf(..) constructs)
##################################################
my_head_head = "
MarginalHacks album Documentation
"
my_start_table_top = "
1: Methods
There are easy ways and complicated ways to create a custom theme,
depending on what you want to be able to do.
2: Editing current theme HTML
If you just want to slightly change the theme to match the output
of your site, it might make sense to edit a current theme.
In the theme directory there are two *.th files. album.th is
the template for album pages (the thumbnail pages) and image.th
is the template for image pages (where you can see medium or full
size images). The files are very similar to HTML except for
some embedded <: ePerl :> code. Even if you don't know perl or
ePerl you can still edit the HTML to make simple changes.
Good starting themes:
Any simmer_theme is going to be up to date and clean, such as "Blue" or
"Maste." If you only need 4 corner thumbnail borders then take a look
at "Eddie Bauer." If you want overlay/transparent borders, see FunLand.
If you want something demonstrating a minimal amount of code, try "simple"
but be warned that I haven't touched the theme in a long time.
3: The easy way, simmer_theme from graphics.
Most themes have the same basic form, show a bunch of thumbnails
for directories and then for images, with a graphic border, line and
background. If this is what you want, but you want to create new
graphics, then there is a tool that will build your themes for you.
If you create a directory with the images and a CREDIT file as well
as a Font or Style.css file, then simmer_theme will create theme for you.
Files:
Font/Style.css
This determines the fonts used by the theme. The "Font" file is the
older system, documented below. Create a Style.css file and define
styles for: body, title, main, credit and anything else you like.
See FunLand for a simple example.
Alternatively, use a font file. An example Font file is:
--------------------------------------------------
$TITLE_FONT = "size='4' color='#ffffff' face='Times New Roman,Georgia,Times'";
$MAIN_FONT = "face='Times New Roman,Georgia,Times'";
$CREDIT_FONT = "size='-1' face='Verdana' color='#ffffff'";
$BODY = "background='$PATH/bkgrnd.gif' link='#0099FF'">
--------------------------------------------------
CREDIT
The credit file is two lines and is used for the theme index at MarginalHacks.
If you're never submitting your theme to us, then you don't need this file.
(But please do!) If so, the two lines (and only two lines) are:
1) A short description of the theme (keep it all on one line)
2) Your name (can be inside a mailto: or href link)
Null.gif
Each simmer theme needs a spacer image, this is a 1x1 transparent gif.
You can just copy this from another simmer theme.
Optional image files:
Bar Images
The bar is composed of Bar_L.gif, Bar_R.gif and Bar_M.gif in the middle.
The middle is stretched. If you need a middle piece that isn't stretched, use:
Bar_L.gif, Bar_ML.gif, Bar_M.gif, Bar_MR.gif, Bar_R.gif
And then the Bar_ML.gif and Bar_MR.gif will be stretched. (See the
Craftsman theme for an example of this).
Locked.gif
A lock image for any directories that have .htaccess
Background image
If you want a background image, specify it in the Font file in the $BODY
section, as in the example above. The $PATH variable will be replaced
with the path to the theme files:
More.gif
When an album page has sub-albums to list, it first shows the 'More.gif'
image.
Next.gif, Prev.gif, Back.gif
For the next and previous arrows and the back button
Icon.gif
Shown at the top left by the parent albums, this is often just the text "Photos"
Border Images
There are many ways to slice up a border, from simple to complex, depending on
the complexity of the border and how much you want to be able to stretch it:
4 pieces Uses Bord_L.gif, Bord_R.gif, Bord_T.gif, Bord_B.gif
(The corners go with the left and right images)
4 piece borders usually don't stretch well so they don't work well on
image_pages. Generally you can cut the corners out of the left and
right images to make:
8 pieces Also includes Bord_TL.gif, Bord_TR.gif, Bord_BL.gif, Bord_BR.gif
8 piece borders allow you to stretch to handle most sized images
12 pieces Also includes Bord_LT.gif, Bord_RT.gif, Bord_LB.gif, Bord_RB.gif
12 pieces allow stretching of borders that have more complex corners (such
as Dominatrix6 or Ivy)
Overlay Borders Can use transparent images that can be partially
overlaying your thumbnail. See below.
Here's how the normal border pieces are laid out:
12 piece borders
TL T TR 8 piece borders 4 piece borders
LT RT TL T TR TTTTTTT
L IMG R L IMG R L IMG R
LB RB BL B BR BBBBBBB
BL B BR
Note that every row of images must be the same height, though the
widths do not have to line up. (i.e., height TL = height T = height TR)
(This is not true about overlay borders!)
Once you've created these files, you can run the simmer_theme tool
(an optional tool download at MarginalHacks.com) and your theme will
then be ready to use!
If you need different borders for the image pages, then use the same
filenames prefixed by 'I' - such as IBord_LT.gif, IBord_RT.gif,...
Overlay borders allow for really fantastic effects with image borders.
Currently there's no support for different overlay borders for images.
For using Overlay borders, create images:
Over_TL.png Over_T.png Over_TR.png
Over_L.png Over_R.png
Over_BL.png Over_B.png Over_BR.png
Then figure out how many pixels of the borders are padding (outside photo)
Then put those values in files: Over_T.pad Over_R.pad Over_B.pad Over_L.pad
See "Themes/FunLand" for a simple example
Multi-lingual Images
If your images have text, you can translate them into other languages
so that albums can be generated in other languages. For example, you
can create a Dutch "More.gif" image and put it in 'lang/nl/More.gif'
in the theme (nl is the language code for Dutch).
When the user runs album in Dutch (album -lang nl) then the theme
will use the Dutch image if found. Themes/Blue has a simple example.
The currently "translated" images are:
More, Back, Next, Prev and Icon
You can create an HTML table that shows the translations immediately
available to themes with -list_html_trans:
% album -list_html_trans > trans.html
Then view trans.html in a browser. Unfortunately different languages
have different charsets, and an HTML page can only have one. The
output is in utf-8, but you can edit the "charset=utf-8" to properly
view language characters in different charsets (such as hebrew).
If you need more words translated for themes, let me know, and if you
create any new language images for a theme, please send them to me!
4: From scratch, Theme API
This is a much heavier job - you need to have a very clear idea of
how you want album to place the images on your page. It might be
a good idea to start with modifying existing themes first to get
an idea of what most themes do. Also look at existing themes
for code examples (see suggestions above).
Themes are directories that contain at the minimum an 'album.th' file.
This is the album page theme template. Often they also contain an 'image.th'
which is the image theme template, and any graphics/css used by the theme.
Album pages contain thumbnails and image pages show full/medium sized images.
The .th files are ePerl, which is perl embedded inside of HTML. They
end up looking a great deal like the actual album and image HTML themselves.
To write a theme, you'll need to understand the ePerl syntax. You can
find more information from the actual ePerl tool available at MarginalHacks
(though this tool is not needed to use themes in album).
There are a plethora of support routines available, but often only
a fraction of these are necessary - it may help to look at other themes
to see how they are generally constructed.
Function table:
Required Functions
Meta() Must be called in the section of HTML
Credit() Gives credit ('this album created by..')
Must be called in the section of HTML
Body_Tag() Called inside the actual tag.
Paths and Options
Option($name) Get the value of an option/configuration setting
Version() Return the album version
Version_Num() Return the album version as just a number (i.e. "3.14")
Path($type) Returns path info for $type of:
album_name The name of this album
dir Current working album directory
album_file Full path to the album index.html
album_path The path of parent directories
theme Full path to the theme directory
img_theme Full path to the theme directory from image pages
page_post_url The ".html" to add onto image pages
parent_albums Array of parent albums (album_path split up)
Image_Page() 1 if we're generating an image page, 0 for album page.
Page_Type() Either 'image_page' or 'album_page'
Theme_Path() The filesystem path to the theme files
Theme_URL() The URL path to the theme files
Header and Footer
isHeader(), pHeader() Test for and print the header
isFooter(), pFooter() Same for the footer
Generally you loop through the images and directories using local variables:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
This will print the name of each image. Our object types are either 'pics'
for images or 'dirs' for the child directories. Here are the object functions:
Objects (type is either 'pics' (default) or 'dirs')
First($type) Get the first image or sub-album object.
Last($type) Last object
Next($obj) Given an object, return the next object
Next($obj,1) Same, loop past end to beginning.
Prev($obj), Prev($obj,1) Similar to Next()
num('pics') or just num() Total number of images in this album
num('dirs') Total number of children/sub-albums
Also:
num('parent_albums') Total number of parents leading up to this album.
Object lookup:
get_obj($num, $type, $loop)
Finds object by number ('pics' or 'dirs').
If $loop is set than the count will wrap around.
Object Properties
Each object (image or child albums) has properties.
Some properties are accessed by a single field:
Get($obj,$field) Get a single field of an object
Field Description
----- ----------
type What type of object? Either 'pics' or 'dirs'
is_movie Boolean: is this a movie?
name Name (cleaned and optionally from captions)
cap Image caption
capfile Optional caption file
alt Alt tag
num_pics [directories only, -dir_thumbs] Num of pics in directory
num_dirs [directories only, -dir_thumbs] Num of dirs in directory
Some properties are accessed by a field and subfield. For example,
each image has information for different sizes: full, medium and thumb
(though 'medium' is optional).
Get($obj,$size,$field) Get a property for a given size
Size Field Description
---- ----- ----------
$size x Width
$size y Height
$size file Filename (without path)
$size path Filename (full path)
$size filesize Filesize in bytes
full tag The tag (either 'image' or 'embed') - only for 'full'
We also have URL information which is access according to the
page it's coming 'from' and the image/page it's pointing 'to':
Get($obj,'URL',$from,$to) Get a URL for an object from -> to
Get($obj,'href',$from,$to) Same but wraps it in an 'href' string.
Get($obj,'link',$from,$to) Same but wraps the object name inside the href link.
From To Description
---- -- ----------
album_page image Image_URL from album_page
album_page thumb Thumbnail from album_page
image_page image Image_URL from image_page
image_page image_page This image page from another image page
image_page image_src The <img src> URL for the image page
image_page thumb Thumbnail from image_page
Directory objects also have:
From To Description
---- -- ----------
album_page dir URL to the directory from it's parent album page
Parent Albums
Parent_Album($num) Get a parent album string (including the href)
Parent_Albums() Return a list of the parent albums strings (including href)
Parent_Album($str) A join($str) call of Parent_Albums()
Back() The URL to go back or up one page.
Images
This_Image The image object for an image page
Image($img,$type) The <img> tags for type of medium,full,thumb
Image($num,$type) Same, but by image number
Name($img) The clean or captioned name for an image
Caption($img) The caption for an image
Child Albums
Name($alb)
Caption($img) The caption for an image
Convenience Routines
Pretty($str,$html,$lines) Pretty formats a name.
If $html then HTML is allowed (i.e., use 0 for <title> and the like)
Currently just puts prefix dates in a smaller font (i.e. '2004-12-03.Folder')
If $lines then multilines are allowed
Currently just follows dates with a 'br' line break.
New_Row($obj,$cols,$off) Should we start a new row after this object?
Use $off if the first object is offset from 1
Image_Array($src,$x,$y,$also,$alt)
Returns an <img> tag given $src, $x,...
Image_Ref($ref,$also,$alt)
Like Image_Array, but $ref can be a hash of
Image_Arrays keyed by language ('_' is default).
album picks the Image_Array by what languages are set.
Border($img,$type,$href,@border)
Border($str,$x,$y,@border)
Create the full bordered image.
See 'Borders' for more information.
If you're creating a theme from scratch, consider adding support for -slideshow.
The easiest way to do this is to cut/paste the "slideshow" code out of an
existing theme.
5: Submitting Themes
Have a custom theme? I'd love to see it, even if it's totally site-specific.
If you have a new theme you'd like to offer the public, feel free to send
it to me and/or a URL where I can see how it looks. Be sure to set the CREDIT
file properly and let me know if you are donating it to MarginalHacks for
everyone to use or if you want it under a specific license.
6: Converting v2.0 Themes to v3.0 Themes
album v2.0 introduced a theme interface which has been rewritten. Most
2.0 themes (especially those that don't use many of the global variables)
will still work, but the interface is deprecated and may disappear in
the near future.
It's not difficult to convert from v2.0 to v3.0 themes.
The v2.0 themes used global variables for many things. These are now
deprecated In v3.0 you should keep track of images and directories in
variables and use the 'iterators' that are supplied, for example:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Will loop through all the images and print their names.
The chart below shows you how to rewrite the old style calls which
used a global variable with the new style which uses a local variable,
but to use these calls you need to rewrite your loops as above.
Here is a conversion chart for helping convert v2.0 themes to v3.0:
# Global vars shouldn't be used
# ALL DEPRECATED - See new local variable loop methods above
$PARENT_ALBUM_CNT Rewrite with: Parent_Album($num) and Parent_Albums($join)
$CHILD_ALBUM_CNT Rewrite with: my $dir = First('dirs'); $dir=Next($dir);
$IMAGE_CNT Rewrite with: my $img = First('pics'); $pics=Next($pics);
@PARENT_ALBUMS Can instead use: @{Path('parent_albums')}
@CHILD_ALBUMS, @CHILD_ALBUM_NAMES, @CHILD_ALBUM_URLS, ...
# Old global variable modifiers:
# ALL DEPRECATED - See new local variable loop methods above
Next_Image(), Images_Left(), Image_Cnt(), Image_Prev(), Image_Next()
Set_Image_Prev(), Set_Image_Next(), Set_Image_This()
Next_Child_Album(), Child_Album_Cnt(), Child_Albums_Left()
# Paths and stuff
pAlbum_Name() Path('album_name')
Album_Filename() Path('album_file')
pFile($file) print read_file($file)
Get_Opt($option) Option($option)
Index() Option('index')
pParent_Album($str) print Parent_Album($str)
# Parent Albums
Parent_Albums_Left Deprecated, see '$PARENT_ALBUM_CNT' above
Parent_Album_Cnt Deprecated, see '$PARENT_ALBUM_CNT' above
Next_Parent_Album Deprecated, see '$PARENT_ALBUM_CNT' above
pJoin_Parent_Albums print Parent_Albums(\@_)
# Images, using variable '$img'
pImage() Use $img instead and:
print Get($img,'href','image');
print Get($img,'thumb') if Get($img,'thumb');
print Name($img), "</a>";
pImage_Src() print Image($img,'full')
Image_Src() Image($img,'full')
pImage_Thumb_Src() print Image($img,'thumb')
Image_Name() Name($img)
Image_Caption() Caption($img)
pImage_Caption() print Get($img,'Caption')
Image_Thumb() Get($img,'URL','thumb')
Image_Is_Pic() Get($img,'thumb')
Image_Alt() Get($img,'alt')
Image_Filesize() Get($img,'full','filesize')
Image_Path() Get($img,'full','path')
Image_Width() Get($img,'medium','x') || Get($img,'full','x')
Image_Height() Get($img,'medium','y') || Get($img,'full','y')
Image_Filename() Get($img,'full','file')
Image_Tag() Get($img,'full','tag')
Image_URL() Get($img,'URL','image')
Image_Page_URL() Get($img,'URL','image_page','image_page') || Back()
# Child album routines, using variable '$alb'
pChild_Album($nobr) print Get($alb,'href','dir');
my $name = Name($alb);
$name =~ s/<br>//g if $nobr;
print $name,"</a>";
Child_Album_Caption() Caption($alb,'dirs')
pChild_Album_Caption() print Child_Album_Caption($alb)
Child_Album_URL() Get($alb,'URL','dir')
Child_Album_Name() Name($alb)
# Unchanged
Meta() Meta()
Credit() Credit()
album-4.17/Docs/it/txt_2 0000644 0000000 0000000 00000013747 10547227225 013554 0 ustar root root MINI HOW-TO
ITEM: Un semplice album
Presupponendo che album sia stato installato correttamente,
illustriamo qualche semplice esempio. Se dovessero verificarsi degli
errori o problemi si prega di consultare la documentazione
d'installazione.
È necessaria una directory web dove mettere i temi e il vostro
album. In questo esempio useremo /home/httpd/test. Questa directory
dovrà essere visibile con un browser; in questo esempio assumiamo
sia visibile tramite il seguente URL: http://myserver/test/
Si prega di modificare gli esempi appropriatamente per riflettere la
propria configurazione.
Per iniziare, create una directory (ad esempio /home/httpd/test/Foto )
e aggiungeteci alcune immagini (ad esempio da "IMG_001.jpg" a
"IMG_004.jpg") ed eseguite
% album /home/httpd/test/Foto
Ora potete vedere il vostro album con un web browser all'indirizzo:
http://myserver/test/Foto
ITEM: Aggiungere titoli
Create un file /home/httpd/test/Foto/captions.txt con il seguente
contenuto (usate il tasto tabulatore dove è specificato [tab])
- -- captions.txt ---------
IMG_001.jpg [tab] Nome della prima immagine
IMG_002.jpg [tab] Seconda immagine
IMG_003.jpg [tab] Terza immagine [tab] con un titolo!
IMG_004.jpg [tab] Ultima immagine [tab] con un altro titolo
- -------------------------
ed eseguite nuovamente album:
% album /home/httpd/test/Foto
A questo punto dovreste vedere i titoli delle immagini sulle pagine
dell'album.
Create un file /home/httpd/test/Foto/header.txt e scriveteci
un'intestazione. Dopo aver nuovamente eseguito album potrete osservare
la vostra intestazione all'inizio di ogni pagina dell'album appena
generato.
ITEM: Nascondere immagini
Ci sono diversi modi per nascondere foto, file, e directory; per il
momento raggiungeremo lo scopo usando il file con i titoli.
Aggiungete '#'
all'inizio della riga corrispondente all'immagine da nascondere in
captions.txt:
- -- captions.txt ---------
IMG_001.jpg [tab] Prima immagine
#IMG_002.jpg [tab] Seconda immagine
IMG_003.jpg [tab] Un altra immagine [tab] con un titolo!
IMG_004.jpg [tab] Ultima immagine [tab] con un altro titolo
- -------------------------
Eseguite nuovamente album, e osserverete che IMG_002.jpg
non è più inclusa nell'album.
Dato che avevamo già eseguito album prima di
nascondere l'immagine, la directory con l'album conterrà
ancora le immagini intermedie o i thumbnail. Per rimuoverli usate
l'opzione -clean:
% album -clean /home/httpd/test/Foto
ITEM: Temi
Se i temi sono stati istallati correttamente e sono nel vostro
"theme_path", dovreste essere in grado di specificarli con
l'opzione "-theme":
% album -theme Blue /home/httpd/test/Foto
In questo caso l'album verrà generato con il tema "Blue". Se
l'album
dovesse presentarsi con delle immagini non leggibili, molto
probabilmente
il tema specificato non è stato installato in una
directory accessibile tramite il server web. In questo caso si prega di
consultare la documentazione d'installazione.
Album salva automaticamente le opzioni specificate, per cui
eseguendo:
% album /home/httpd/test/Foto
starete sempre usando il tema "Blue". Per disabilitare l'uso di un
tema su può specificare:
% album -no_theme /home/httpd/test/Foto
ITEM: Immagini intermedie
Le immagini a piena risoluzione sono solitamente troppo grandi per un
album sul web. Per questo motivo è possibile generare delle
immagini intermedie da presentare nelle pagine dell'album:
% album -medium 33% /home/httpd/test/Foto
Le immagini originali rimangono accessibili cliccando
sull'immagine intermedia. L'opzione "-just_medium" invece sopprime il
collegamento tra l'immagine intermedia e l'originale:
% album -just_medium /home/httpd/test/Foto
ITEM: Aggiungere i metadati EXIF nei titoli
Per aggiungere, ad esempio, i dati sull'apertura di ogni immagine al
titolo della stessa:
% album -exif "<br>aperture=%Aperture%" /home/httpd/test/
Foto
In questo modo, se l'informazione sull'apertura dell'obiettivo
è presente (specificando "Aperture" tra %), essa verrà
inserita nel titolo dopo una fine riga (<br>)
Per visualizzare anche la focale:
% album -exif "<br>focal: %FocalLength%" /home/httpd/test/
Foto
In modo analogo alla scelta del tema, album, memorizzando le opzioni
specificate
precedentemente, genererà pagine con entrambe le informazioni
(apertura e focale). Per rimuovere l'apertura:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/
test/Foto
L'opzione "-no_exif" deve essere identica all'opzione "-exif" che si
desidera rimuovere. È anche possibile modificare le opzioni
modificando direttamente il file di configurazione:
/home/httpd/test/Foto/album.conf
ITEM: Generare più album
Supponiamo di avere delle foto di un viaggio in Spagna a di metterle in:
/home/httpd/test/Foto/Spagna/
Eseguendo album in
% album /home/httpd/test/Foto
album riorganizzerà "Foto" in modo da collegare la directory
"Spagna" e genererà un album (con la stessa configurazione) per
le foto del viaggio in Spagna.
Supponiamo di fare un altro viaggio e di creare:
/home/httpd/test/Foto/Italia/
Eseguendo album in
% album /home/httpd/test/Foto,
album rianalizzerà anche la directory "Spagna", la quale nel
frattempo non
ha subito modifiche. Anche se album non rigenererà le pagine o i
thumbnail se non necessario, ricontrollare le immagini non
modificate richiede diverso tempo. Per specificare che si
è unicamente aggiunta una directory:
% album -add /home/httpd/test/Photos/Italia
In questo caso album aggiurnerà la pagina di indice (in "Foto")
e genererà l'album per le foto in "Italia".
ITEM: Tradotto da
Matteo Corti [http://matteocorti.ch/]
Proofread by: Antonio Vilei [http://www.bytetranslation.com/]
album-4.17/Docs/it/Section_5.html 0000644 0000000 0000000 00000047523 12661460265 015310 0 ustar root root
MarginalHacks album - Feature Requests, Bugs, Patches and Troubleshooting
- Documentation
A l b u m
F i v e - - F e a t u r e R e q u e s t s , B u g s , P a t c h e s a n d T r o u b l e s h o o t i n g
1: Feature Requests
If there's something you want added to album, first make sure
it doesn't already exist! Check the man page or the usage:
% man album% album -h
Also see -more and -usage options.
If you don't see it there, consider writing a patch or a plugin.
2: Bug reports
Before you submit a bug, please make sure you have the most current release of album!
When submitting a bug, I need to know at least:
1) Your operating system
2) The exact problem and the exact error messages
I'd also like to know, if possible:
1) The exact album command you ran
2) The output from the command
And I generally also need the debug output of album:
% album -d
Finally, make sure that you've got the most current
version of album, and the most current themes as well.
3: Writing Patches, Modifying album
If you want to modify album, you might want to check with me
first to make sure it's not already on my development plate.
If not, then consider writing it as a plugin instead of patching
the album source. This avoids adding complexity to album for
features that may not be globally used.
If it needs to go into album (for example, if it's a bug), then
please make sure to first download the most recent copy of album
first, then patch that and send me either a diff, a patch, or the
full script. If you comment off the changes you make that'd be great too.
4: Known Bugs
v3.11: -clear_* and -no_* doesn't clear out parent directory options.
v3.10: Burning CDs doesn't quite work with theme absolute paths.
v3.00: Array and code options are saved backwards, for example:
"album -lang aa .. ; album -lang bb .." will still use language 'aa'
Also, in some cases array/code options in sub-albums will not
be ordered right the first time album adds them and you may
need to rerun album. For example:
"album -exif A photos/ ; album -exif B photos/sub"
Will have "B A" for the sub album, but "A B" after: "album photos/sub"
5: PROBLEM: My index pages are too large!
I get many requests to break up the index pages after reaching a certain
threshold of images.
The problem is that this is hard to manage - unless the index pages are
treated just like sub-albums, then you now have three major components
on a page, more indexes, more albums, and thumbnails. And not only is
that cumbersome, but it would require updating all the themes.
Hopefully the next major release of album will do this, but until then
there is another, easier solution - just break the images up into
subdirectories before running album.
I have a tool that will move new images into subdirectories for you and
then runs album:
in_album6:ERROR: no delegate for this image format (./album)
You have the album script in your photo directory and it can't make
a thumbnail of itself! Either:
1) Move album out of the photo directory (suggested)
2) Run album with -known_images
7:ERROR: no delegate for this image format (some_non_image_file)
Don't put non-images in your photo directory, or else run with -known_images.
8:ERROR: no delegate for this image format (some.jpg)9:ERROR: identify: JPEG library is not available (some.jpg)
Your ImageMagick installation isn't complete and doesn't know how
to handle the given image type.
10:ERROR: Can't get [some_image] size from -verbose output.
ImageMagick doesn't know the size of the image specified. Either:
1) Your ImageMagick installation isn't complete and can't handle the image type.
2) You are running album on a directory with non-images in it without
using the -known_images option.
If you're a gentoo linux user and you see this error, then run this command
as root (thanks Alex Pientka):
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
album-4.17/Docs/it/txt_1 0000655 0000000 0000000 00000011534 10716453531 013544 0 ustar root root Installation
ITEM: Minimum Requirements
1) The album perl script
2) ImageMagick tools (specifically 'convert')
Put the 'album' script and the ImageMagick tools somewhere in your PATH,
or else call 'album' by it's full path (and specify the full path to
convert either in the album script or in the album configuration files.
ITEM: Initial Configuration
The first time you run album it will ask you a few questions to
setup the configuration for you. If you're on UNIX/OSX, then you
can run the first time as root so that it sets up the global configuration
and themes for everyone instead of just the current user.
ITEM: Optional Installation
3) Themes
4) ffmpeg (for movie thumbnails)
5) jhead (for reading EXIF info)
6) plugins
7) Various tools available at MarginalHacks.com
ITEM: UNIX
Most UNIX distros come with ImageMagick and perl, so just download
the album script and themes (#1 and #3 above) and you're done.
To test your install, run the script on a directory with images:
% album /path/to/my/photos/
ITEM: Debian UNIX
album is in debian stable, though right now it's a bit stale.
I recommend getting the latest version from MarginalHacks.
You can save the .deb package, and then, as root, run:
% dpkg -i album.deb
ITEM: Macintosh OSX
It works fine on OSX, but you have to run it from a terminal window. Just
install the album script and ImageMagick tools, and type in the path to album,
any album options you want, and then the path to the directory with the
photos in them (all separated by spaces), such as:
% album -theme Blue /path/to/my/photos/
ITEM: Win95, Win98, Win2000/Win2k, WinNT, WinXP
(Windows 95, Windows 98, Windows 2000, Windows NT, Windows XP)
There are two methods to run perl scripts on Windows, either using ActivePerl
or Cygwin.
ActivePerl is simpler and allows you to run album from a DOS prompt,
though I've heard that it doesn't work with themes.
Cygwin is a bulkier but more robust package that gives you access to
a bunch of UNIX like utilities, and album is run from a bash (UNIX shell)
prompt.
Cygwin method
-------------
1) Install Cygwin
Choose packages: perl, ImageMagick, bash
Do not use the normal ImageMagick install! You must use the Cygwin ImageMagick packages!
2) Install album in bash path or call using absolute path:
bash% album /some/path/to/photos
3) If you want exif info in your captions, you need the Cygwin version of jheadActivePerl method
-----------------
1) Install ImageMagick for Windows
2) Install ActivePerl, Full install (no need for PPM profile)
Choose: "Add perl to PATH" and "Create Perl file extension association"
3) If Win98: Install tcap in path
4) Save album as album.pl in windows path
5) Use dos command prompt to run:
C:> album.pl C:\some\path\to\photosNote: Some versions of Windows (2000/NT at least) have their
own "convert.exe" in the c:\windows\system32 directory (an NTFS utility?).
If you have this, then you either need to edit your path variable,
or else just specify the full path to convert in your album script.
ITEM: How do I edit the Windows path?
Windows NT4 Users
Right Click on My Computer, select Properties.
Select Environment tab.
In System Variables box select Path.
In Value edit box add the new paths separated by semicolons
Press OK/Set, press OK again.
Windows 2000 Users
Right Click My Computer, select Properties.
Select Advanced tab.
Click Environment Variables.
In System Variables box select double-click Path
In Value edit box add the new paths separated by semicolons
Press OK/Set, press OK again.
Windows XP Users
Click My Computer, select Change a Setting.
Double click System.
Select Advanced tab.
Select Environment Variables.
In System Variables box select double-click Path
In Value edit box add the new paths separated by semicolons
Press OK.
ITEM: Macintosh OS9
I don't have any plans to port this to OS9 - I don't know what
the state of shells and perl is for pre-OSX. If you have it working
on OS9, let me know.
album-4.17/Docs/it/flag.png 0000644 0000000 0000000 00000000227 10425737355 014202 0 ustar root root PNG
IHDR m?h bKGD tIME 1U 9IDAT8cduπ\}LCH
ܻ *KR0j< a
> IENDB` album-4.17/Docs/it/Section_4.html 0000644 0000000 0000000 00000047502 12661460265 015304 0 ustar root root
MarginalHacks album - Configuration Files
- Documentation
A l b u m
F o u r - - C o n f i g u r a t i o n F i l e s
1: Configuration Files
Album behavior can be controlled through command-line options, such as:
% album -no_known_images% album -geometry 133x100% album -exif "File: %File name% " -exif "taken with %Camera make%"
But these options can also be specified in a configuration file:
# Example configuration file # comments are ignored
known_images 0 # known_images=0 is same as no_known_images
geometry 133x100
exif "File: %File name% "
exif "taken with %Camera make%"
The configuration file format is one option per line optionally followed
by whitespace and the option value. Boolean options can be set without
the option value or can be cleared/set with 0 and 1.
2: Location Of Configuration Files
album looks for configuration files in a few locations, in order:
/etc/album/conf System-wide settings
/etc/album.conf System-wide settings
$BASENAME/album.conf In the 'album' install directory
$HOME/.albumrc User specific settings
$HOME/.album.conf User specific settings
$DOT/album.conf User specific (I keep my dot files elsewhere)
$USERPROFILE/album.conf For Windows (C:\Documents and Settings\TheUser)
album also looks for album.conf files inside the photo album directories.
Sub-albums can also have album.conf which will alter the settings
from parent directories (this allows you to, for example, have a
different theme for part of your photo album). Any album.conf files
in your photo album directories will configure the album and any sub-albums
unless overridden by any album.conf settings found in a sub-album.
As an example, consider a conf for a photo album at 'images/album.conf':
theme Dominatrix6
columns 3
And another conf inside 'images/europe/album.conf':
theme Blue
crop
album will use the Dominatrix6 theme for the images/ album and all of
it's sub-albums except for the images/europe/ album which will use
the Blue theme. All of the images/ album and sub-albums will have
3 columns since that wasn't changed in the images/europe/ album, however
all of the thumbnails in images/europe/ and all of it's sub-albums
will be cropped due to the 'crop' configuration setting.
3: Saving Options
Whenever you run an album, the command-line options are saved in
an album.conf inside the photo album directory. If an album.conf
already exists it will be modified not overwritten, so it is safe
to edit this file in a text editor.
This makes it easy to make subsequent calls to album. If you
first generate an album with:
% album -crop -no_known_images -theme Dominatrix6 -sort date images/
Then the next time you call album you can just:
% album images/
This works for sub-albums as well:
% album images/africa/
Will also find all of the saved options.
Some 'one-time only' options are not saved for obvious reasons, such
as -add, -clean, -force, -depth, etc..
Running album multiple times on the same directories can
get confusing if you don't understand how options are saved.
Here are some examples.
Premises:
1) Command-line options are processed before conf options found
in the album directory.
2) Album should run the same the next time you call it if you
don't specify any options.
For example, consider running album twice on a directory:
% album -exif "comment 1" photos/spain% album photos/spain
The second time you run album you'll still get the "comment 1"
exif comment in your photos directory.
3) Album shouldn't end up with multiple copies of the same array
options if you keep calling it with the same command-line
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 1" photos/spain
The second time you run album you will NOT end up with multiple
copies of the "comment 1" exif comment.
However, please note that if you re-specify the same options
each time, album may run slower because it thinks it needs to
regenerate your html!
As an example, if you run:
% album -medium 640x640 photos/spain
(then later...)
% album -medium 640x640 photos/spain
Then the second time will unnecessarily regenerate all your
medium images. This is much slower.
It's better to specify command-line options only the first time
and let them get saved, such as:
% album -medium 640x640 photos/spain
(then later...)
% album photos/spain
Unfortunately these constraints mean that any new array options will
be put at the beginning of your list of -exif options.
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 2" photos/spain
The comments will actually be ordered "comment 2" then "comment 1"
To specify exact ordering, you may need to re-specify all options.
Either specify "comment 1" to put it back on top:
% album -exif "comment 1" photos/spain
Or just specify all the options in the order you want:
% album -exif "comment 1" -exif "comment 2" photos/spain
Sometimes it may be easier to merely edit the album.conf file directly
to make any changes.
Finally, this only allows us to accumulate options.
We can delete options using -no and -clear, see the section on Options,
these settings (or clearings) will also be saved from run to run.
1: Un semplice album
Presupponendo che album sia stato installato correttamente,
illustriamo qualche semplice esempio. Se dovessero verificarsi degli
errori o problemi si prega di consultare la documentazione
d'installazione.
È necessaria una directory web dove mettere i temi e il vostro
album. In questo esempio useremo /home/httpd/test. Questa directory
dovrà essere visibile con un browser; in questo esempio assumiamo
sia visibile tramite il seguente URL: http://myserver/test/
Si prega di modificare gli esempi appropriatamente per riflettere la
propria configurazione.
Per iniziare, create una directory (ad esempio /home/httpd/test/Foto )
e aggiungeteci alcune immagini (ad esempio da "IMG_001.jpg" a
"IMG_004.jpg") ed eseguite
% album /home/httpd/test/Foto
Ora potete vedere il vostro album con un web browser all'indirizzo:
http://myserver/test/Foto
2: Aggiungere titoli
Create un file /home/httpd/test/Foto/captions.txt con il seguente
contenuto (usate il tasto tabulatore dove è specificato [tab])
- -- captions.txt ---------
IMG_001.jpg [tab] Nome della prima immagine
IMG_002.jpg [tab] Seconda immagine
IMG_003.jpg [tab] Terza immagine [tab] con un titolo!
IMG_004.jpg [tab] Ultima immagine [tab] con un altro titolo
- -------------------------
ed eseguite nuovamente album:
% album /home/httpd/test/Foto
A questo punto dovreste vedere i titoli delle immagini sulle pagine
dell'album.
Create un file /home/httpd/test/Foto/header.txt e scriveteci
un'intestazione. Dopo aver nuovamente eseguito album potrete osservare
la vostra intestazione all'inizio di ogni pagina dell'album appena
generato.
3: Nascondere immagini
Ci sono diversi modi per nascondere foto, file, e directory; per il
momento raggiungeremo lo scopo usando il file con i titoli.
Aggiungete '#'
all'inizio della riga corrispondente all'immagine da nascondere in
captions.txt:
- -- captions.txt ---------
IMG_001.jpg [tab] Prima immagine
#IMG_002.jpg [tab] Seconda immagine
IMG_003.jpg [tab] Un altra immagine [tab] con un titolo!
IMG_004.jpg [tab] Ultima immagine [tab] con un altro titolo
- -------------------------
Eseguite nuovamente album, e osserverete che IMG_002.jpg
non è più inclusa nell'album.
Dato che avevamo già eseguito album prima di
nascondere l'immagine, la directory con l'album conterrà
ancora le immagini intermedie o i thumbnail. Per rimuoverli usate
l'opzione -clean:
% album -clean /home/httpd/test/Foto4: Temi
Se i temi sono stati istallati correttamente e sono nel vostro
"theme_path", dovreste essere in grado di specificarli con
l'opzione "-theme":
% album -theme Blue /home/httpd/test/Foto
In questo caso l'album verrà generato con il tema "Blue". Se
l'album
dovesse presentarsi con delle immagini non leggibili, molto
probabilmente
il tema specificato non è stato installato in una
directory accessibile tramite il server web. In questo caso si prega di
consultare la documentazione d'installazione.
Album salva automaticamente le opzioni specificate, per cui
eseguendo:
% album /home/httpd/test/Foto
starete sempre usando il tema "Blue". Per disabilitare l'uso di un
tema su può specificare:
% album -no_theme /home/httpd/test/Foto5: Immagini intermedie
Le immagini a piena risoluzione sono solitamente troppo grandi per un
album sul web. Per questo motivo è possibile generare delle
immagini intermedie da presentare nelle pagine dell'album:
% album -medium 33% /home/httpd/test/Foto
Le immagini originali rimangono accessibili cliccando
sull'immagine intermedia. L'opzione "-just_medium" invece sopprime il
collegamento tra l'immagine intermedia e l'originale:
% album -just_medium /home/httpd/test/Foto6: Aggiungere i metadati EXIF nei titoli
Per aggiungere, ad esempio, i dati sull'apertura di ogni immagine al
titolo della stessa:
% album -exif "<br>aperture=%Aperture%" /home/httpd/test/
Foto
In questo modo, se l'informazione sull'apertura dell'obiettivo
è presente (specificando "Aperture" tra %), essa verrà
inserita nel titolo dopo una fine riga (<br>)
Per visualizzare anche la focale:
% album -exif "<br>focal: %FocalLength%" /home/httpd/test/
Foto
In modo analogo alla scelta del tema, album, memorizzando le opzioni
specificate
precedentemente, genererà pagine con entrambe le informazioni
(apertura e focale). Per rimuovere l'apertura:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/
test/Foto
L'opzione "-no_exif" deve essere identica all'opzione "-exif" che si
desidera rimuovere. È anche possibile modificare le opzioni
modificando direttamente il file di configurazione:
/home/httpd/test/Foto/album.conf
7: Generare più album
Supponiamo di avere delle foto di un viaggio in Spagna a di metterle in:
/home/httpd/test/Foto/Spagna/
Eseguendo album in
% album /home/httpd/test/Foto
album riorganizzerà "Foto" in modo da collegare la directory
"Spagna" e genererà un album (con la stessa configurazione) per
le foto del viaggio in Spagna.
Supponiamo di fare un altro viaggio e di creare:
/home/httpd/test/Foto/Italia/
Eseguendo album in
% album /home/httpd/test/Foto,
album rianalizzerà anche la directory "Spagna", la quale nel
frattempo non
ha subito modifiche. Anche se album non rigenererà le pagine o i
thumbnail se non necessario, ricontrollare le immagini non
modificate richiede diverso tempo. Per specificare che si
è unicamente aggiunta una directory:
% album -add /home/httpd/test/Photos/Italia
In questo caso album aggiurnerà la pagina di indice (in "Foto")
e genererà l'album per le foto in "Italia".
8: Tradotto da
Matteo Corti [http://matteocorti.ch/]
Proofread by: Antonio Vilei [http://www.bytetranslation.com/]
album-4.17/Docs/it/txt_7 0000655 0000000 0000000 00000023653 11015005334 013542 0 ustar root root Plugins, Usage, Creation,..
ITEM: What are Plugins?
Plugins are snippets of code that allow you to modify the behavior
of album. They can be as simple as a new way to create EXIF captions,
to something as complex as creating the album based on a database of
images instead of using the filesystem hierarchy.
ITEM: Installing Plugins and plugin support
There are a number of plugins available with the standard installation of
album. If you are upgrading album with plugins from an earlier version
of album that did not have plugins (pre v3.10), you may need to once do:
% album -configure
You will not need to do this with future upgrades of album.
This will install the current plugins into one of the default
plugin directories - album will look for plugins in a number of
locations, the default locations are:
/etc/album/plugins/
/usr/share/album/plugins/
$HOME/.album/plugins/
In reality, these are 'plugins' directories found in the set of
locations specified by '--data_path' - hence the defaults are:
/etc/album/
/usr/share/album/
$HOME/.album/
You can specify a new location with --data_path and then add a 'plugins'
directory to that location, or use the --plugin_path option.
Plugins usually end with the ".alp" prefix, but you do not need
to specify this prefix when using plugins. For example, if you
have a plugin installed at:
/etc/album/plugins/utils/mv.alp
Then you would specify the plugin as: utils/mv
ITEM: Loading/Unloading Plugins
To list all the currently installed plugins:
% album -list_plugins
To show information about a specific plugin (using 'utils/mv' as an example):
% album -plugin_info utils/mv
Plugins will be saved in the configuration for a given album, so
they don't need to be respecified every time (excluding one-time
plugins such as 'utils/mv')
You can use -no_plugin and -clear_plugin to turn off plugins that have
been saved in an album configuration. As with normal album options,
-no_plugin will turn off a specific plugin, and -clear_plugin will
turn off all plugins. Any saved plugin options for that plugin will be
erased as well.
ITEM: Plugin Options
A few plugins may be able to take command-line options, to view usage
for these plugins:
% album -plugin_usage utils/mv
But when specifying plugin options, you need to tell album which plugin
the option belongs to. Instead of specifying as a normal album option:
% album -some_option
You prefix the option with the plugin name followed by a colon:
% album -some_plugin:some_option
For example, you can specify the generated 'index' created by
the 'utils/capindex' plugin.
% album -plugin utils/capindex -utils/capindex:index blah.html
That's a bit unwieldy. You can shorten the name of the plugin as
long as it doesn't conflict with another plugin you've loaded (by
the same name):
% album -plugin utils/capindex -capindex:index
Obviously the other types of options (strings, numbers and arrays) are
possible and use the same convention. They are saved in album configuration
the same as normal album options.
One caveat: As mentioned, once we use a plugin on an album it is saved
in the configuration. If you want to add options to an album that is
already configured to use a plugin, you either need to mention the plugin
again, or else use the full name when specifying the options (otherwise
we won't know what the shortened option belongs to).
For example, consider an imaginary plugin:
% album -plugin some/example/thumbGen Photos/Spain
After that, let's say we want to use the thumbGen boolean option "fast".
This will not work:
% album -thumbGen:fast Photos/Spain
But either of these will work:
% album -plugin some/example/thumbGen -thumbGen:fast blah.html Photos/Spain% album -some/example/thumbGen:fast Photos/Spain
ITEM: Writing Plugins
Plugins are small perl modules that register "hooks" into the album code.
There are hooks for most of the album functionality, and the plugin hook
code can often either replace or supplement the album code. More hooks
may be added to future versions of album as needed.
You can see a list of all the hooks that album allows:
% album -list_hooks
And you can get specific information about a hook:
% album -hook_info <hook_name>
We can use album to generate our plugin framework for us:
% album -create_plugin
For this to work, you need to understand album hooks and album options.
We can also write the plugin by hand, it helps to use an already
written plugin as a base to work off of.
In our plugin we register the hook by calling the album::hook() function.
To call functions in the album code, we use the album namespace.
As an example, to register code for the clean_name hook our plugin calls:
album::hook($opt,'clean_name',\&my_clean);
Then whenever album does a clean_name it will also call the plugin
subroutine called my_clean (which we need to provide).
To write my_clean let's look at the clean_name hook info:
Args: ($opt, 'clean_name', $name, $iscaption)
Description: Clean a filename for printing.
The name is either the filename or comes from the caption file.
Returns: Clean name
The args that the my_clean subroutine get are specified on the first line.
Let's say we want to convert all names to uppercase. We could use:
sub my_clean {
my ($opt, $hookname, $name, $iscaption) = @_;
return uc($name);
}
Here's an explanation of the arguments:
$opt This is the handle to all of album's options.
We didn't use it here. Sometimes you'll need it if you
call any of albums internal functions. This is also true
if a $data argument is supplied.
$hookname In this case it will be 'clean_name'. This allows us
to register the same subroutine to handle different hooks.
$name This is the name we are going to clean.
$iscaption This tells us whether the name came from a caption file.
To understand any of the options after the $hookname you
may need to look at the corresponding code in album.
In this case we only needed to use the supplied $name, we called
the perl uppercase routine and returned that. The code is done, but now
we need to create the plugin framework.
Some hooks allow you to replace the album code. For example, you
could write plugin code that can generate thumbnails for pdf files
(using 'convert' is one way to do this). We can register code for
the 'thumbnail' hook, and just return 'undef' if we aren't looking
at a pdf file, but when we see a pdf file, we create a thumbnail
and then return that. When album gets back a thumbnail, then it
will use that and skip it's own thumbnail code.
Now let's finish writing our uppercase plugin. A plugin must do the following:
1) Supply a 'start_plugin' routine. This is where you will likely
register hooks and specify any command-line options for the plugin.
2) The 'start_plugin' routine must return the plugin info
hash, which needs the following keys defined:
author => The author name
href => A URL (or mailto, of course) for the author
version => Version number for this plugin
description => Text description of the plugin
3) End the plugin code by returning '1' (similar to a perl module).
Here is our example clean_name plugin code in a complete plugin:
sub start_plugin {
my ($opt) = @_;
album::hook($opt,'clean_name',\&my_clean);
return {
author => 'David Ljung Madison',
href => 'http://MarginalHacks.com/',
version => '1.0',
description => "Conver image names to uppercase",
};
}
sub my_clean {
return uc($name);
}
1;
Finally, we need to save this somewhere. Plugins are organized in the
plugin directory hierarchy, we could save this in a plugin directory as:
captions/formatting/NAME.alp
In fact, if you look in examples/formatting/NAME.alp you'll find that
there's a plugin already there that does essentially the same thing.
If you want your plugin to accept command-line options, use 'add_option.'
This must be done in the start_plugin code. Some examples:
album::add_option(1,"fast",album::OPTION_BOOL, usage=>"Do it fast");
album::add_option(1,"name", album::OPTION_STR, usage=>"Your name");
album::add_option(1,"colors",album::OPTION_ARR, usage=>"Color list");
For more info, see the 'add_option' code in album and see all of the uses
of it (at the top of album and in plugins that use 'add_option')
To read an option that the user may have set, we use option():
my $fast = album::option($opt, "fast");
If the user gave a bad value for an option, you can call usage():
album::usage("-colors array can only include values [red, green, blue]");
If your plugin needs to load modules that are not part of the
standard Perl distribution, please do this conditionally. For
an example of this, see plugins/extra/rss.alp.
You can also call any of the routines found in the album script
using the album:: namespace. Make sure you know what you are doing.
Some useful routines are:
album::add_head($opt,$data, "<meta name='add_this' content='to the <head>'>");
album::add_header($opt,$data, "<p>This gets added to the album header");
album::add_footer($opt,$data, "<p>This gets added to the album footer");
The best way to figure out how to write plugins is to look at other
plugins, possibly copying one that is similar to yours and working
off of that. Plugin development tools may be created in the future.
Again, album can help create the plugin framework for you:
% album -create_plugin
album-4.17/Docs/it/langmenu 0000644 0000000 0000000 00000001507 12661460265 014313 0 ustar root root English Deutsch Español Français Nederlands Русский Italiano magyar
album-4.17/Docs/it/langhtml 0000644 0000000 0000000 00000001602 12661460265 014307 0 ustar root root
album-4.17/Docs/it/Section_1.html 0000644 0000000 0000000 00000047312 12661460265 015300 0 ustar root root
MarginalHacks album - Installation
- Documentation
1: Minimum Requirements
1) The album perl script
2) ImageMagick tools (specifically 'convert')
Put the 'album' script and the ImageMagick tools somewhere in your PATH,
or else call 'album' by it's full path (and specify the full path to
convert either in the album script or in the album configuration files.
2: Initial Configuration
The first time you run album it will ask you a few questions to
setup the configuration for you. If you're on UNIX/OSX, then you
can run the first time as root so that it sets up the global configuration
and themes for everyone instead of just the current user.
3: Optional Installation
3) Themes
4) ffmpeg (for movie thumbnails)
5) jhead (for reading EXIF info)
6) plugins
7) Various tools available at MarginalHacks.com
4: UNIX
Most UNIX distros come with ImageMagick and perl, so just download
the album script and themes (#1 and #3 above) and you're done.
To test your install, run the script on a directory with images:
% album /path/to/my/photos/5: Debian UNIX
album is in debian stable, though right now it's a bit stale.
I recommend getting the latest version from MarginalHacks.
You can save the .deb package, and then, as root, run:
% dpkg -i album.deb6: Macintosh OSX
It works fine on OSX, but you have to run it from a terminal window. Just
install the album script and ImageMagick tools, and type in the path to album,
any album options you want, and then the path to the directory with the
photos in them (all separated by spaces), such as:
% album -theme Blue /path/to/my/photos/7: Win95, Win98, Win2000/Win2k, WinNT, WinXP
(Windows 95, Windows 98, Windows 2000, Windows NT, Windows XP)
There are two methods to run perl scripts on Windows, either using ActivePerl
or Cygwin.
ActivePerl is simpler and allows you to run album from a DOS prompt,
though I've heard that it doesn't work with themes.
Cygwin is a bulkier but more robust package that gives you access to
a bunch of UNIX like utilities, and album is run from a bash (UNIX shell)
prompt.
Cygwin method
-------------
1) Install Cygwin
Choose packages: perl, ImageMagick, bash
Do not use the normal ImageMagick install! You must use the Cygwin ImageMagick packages!
2) Install album in bash path or call using absolute path:
bash% album /some/path/to/photos
3) If you want exif info in your captions, you need the Cygwin version of jheadActivePerl method
-----------------
1) Install ImageMagick for Windows
2) Install ActivePerl, Full install (no need for PPM profile)
Choose: "Add perl to PATH" and "Create Perl file extension association"
3) If Win98: Install tcap in path
4) Save album as album.pl in windows path
5) Use dos command prompt to run:
C:> album.pl C:\some\path\to\photosNote: Some versions of Windows (2000/NT at least) have their
own "convert.exe" in the c:\windows\system32 directory (an NTFS utility?).
If you have this, then you either need to edit your path variable,
or else just specify the full path to convert in your album script.
8: How do I edit the Windows path?Windows NT4 Users
Right Click on My Computer, select Properties.
Select Environment tab.
In System Variables box select Path.
In Value edit box add the new paths separated by semicolons
Press OK/Set, press OK again.
Windows 2000 Users
Right Click My Computer, select Properties.
Select Advanced tab.
Click Environment Variables.
In System Variables box select double-click Path
In Value edit box add the new paths separated by semicolons
Press OK/Set, press OK again.
Windows XP Users
Click My Computer, select Change a Setting.
Double click System.
Select Advanced tab.
Select Environment Variables.
In System Variables box select double-click Path
In Value edit box add the new paths separated by semicolons
Press OK.
9: Macintosh OS9
I don't have any plans to port this to OS9 - I don't know what
the state of shells and perl is for pre-OSX. If you have it working
on OS9, let me know.
album-4.17/Docs/it/txt_4 0000655 0000000 0000000 00000012757 10313504407 013547 0 ustar root root Configuration Files
ITEM: Configuration Files
Album behavior can be controlled through command-line options, such as:
% album -no_known_images% album -geometry 133x100% album -exif "File: %File name% " -exif "taken with %Camera make%"
But these options can also be specified in a configuration file:
# Example configuration file # comments are ignored
known_images 0 # known_images=0 is same as no_known_images
geometry 133x100
exif "File: %File name% "
exif "taken with %Camera make%"
The configuration file format is one option per line optionally followed
by whitespace and the option value. Boolean options can be set without
the option value or can be cleared/set with 0 and 1.
ITEM: Location Of Configuration Files
album looks for configuration files in a few locations, in order:
/etc/album/conf System-wide settings
/etc/album.conf System-wide settings
$BASENAME/album.conf In the 'album' install directory
$HOME/.albumrc User specific settings
$HOME/.album.conf User specific settings
$DOT/album.conf User specific (I keep my dot files elsewhere)
$USERPROFILE/album.conf For Windows (C:\Documents and Settings\TheUser)
album also looks for album.conf files inside the photo album directories.
Sub-albums can also have album.conf which will alter the settings
from parent directories (this allows you to, for example, have a
different theme for part of your photo album). Any album.conf files
in your photo album directories will configure the album and any sub-albums
unless overridden by any album.conf settings found in a sub-album.
As an example, consider a conf for a photo album at 'images/album.conf':
theme Dominatrix6
columns 3
And another conf inside 'images/europe/album.conf':
theme Blue
crop
album will use the Dominatrix6 theme for the images/ album and all of
it's sub-albums except for the images/europe/ album which will use
the Blue theme. All of the images/ album and sub-albums will have
3 columns since that wasn't changed in the images/europe/ album, however
all of the thumbnails in images/europe/ and all of it's sub-albums
will be cropped due to the 'crop' configuration setting.
ITEM: Saving Options
Whenever you run an album, the command-line options are saved in
an album.conf inside the photo album directory. If an album.conf
already exists it will be modified not overwritten, so it is safe
to edit this file in a text editor.
This makes it easy to make subsequent calls to album. If you
first generate an album with:
% album -crop -no_known_images -theme Dominatrix6 -sort date images/
Then the next time you call album you can just:
% album images/
This works for sub-albums as well:
% album images/africa/
Will also find all of the saved options.
Some 'one-time only' options are not saved for obvious reasons, such
as -add, -clean, -force, -depth, etc..
Running album multiple times on the same directories can
get confusing if you don't understand how options are saved.
Here are some examples.
Premises:
1) Command-line options are processed before conf options found
in the album directory.
2) Album should run the same the next time you call it if you
don't specify any options.
For example, consider running album twice on a directory:
% album -exif "comment 1" photos/spain% album photos/spain
The second time you run album you'll still get the "comment 1"
exif comment in your photos directory.
3) Album shouldn't end up with multiple copies of the same array
options if you keep calling it with the same command-line
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 1" photos/spain
The second time you run album you will NOT end up with multiple
copies of the "comment 1" exif comment.
However, please note that if you re-specify the same options
each time, album may run slower because it thinks it needs to
regenerate your html!
As an example, if you run:
% album -medium 640x640 photos/spain
(then later...)
% album -medium 640x640 photos/spain
Then the second time will unnecessarily regenerate all your
medium images. This is much slower.
It's better to specify command-line options only the first time
and let them get saved, such as:
% album -medium 640x640 photos/spain
(then later...)
% album photos/spain
Unfortunately these constraints mean that any new array options will
be put at the beginning of your list of -exif options.
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 2" photos/spain
The comments will actually be ordered "comment 2" then "comment 1"
To specify exact ordering, you may need to re-specify all options.
Either specify "comment 1" to put it back on top:
% album -exif "comment 1" photos/spain
Or just specify all the options in the order you want:
% album -exif "comment 1" -exif "comment 2" photos/spain
Sometimes it may be easier to merely edit the album.conf file directly
to make any changes.
Finally, this only allows us to accumulate options.
We can delete options using -no and -clear, see the section on Options,
these settings (or clearings) will also be saved from run to run.
album-4.17/Docs/it/txt_3 0000655 0000000 0000000 00000036071 12475152364 013555 0 ustar root root Running album / Basic Options
ITEM: Basic execution
Create a directory with nothing but images in it. The album script and
other tools should not go here. Then run album specifying that directory:
% album /example/path/to/images/
Or, if you're in the /example/path/to directory:
% album images/
When it's done, you'll have a photo album inside that directory starting
with images/index.html.
If that path is in your web server, then you can view it with your
browser. If you can't find it, talk to your sysadmin.
ITEM: Options
There are three types of options. Boolean options, string/num options
and array options. Boolean options can be turned off by prepending -no_:
% album -no_image_pages
String and number values are specified after a string option:
% album -type gif
% album -columns 5
Array options can be specified two ways, with one argument at a time:
% album -exif hi -exif there
Or multiple arguments using the '--' form:
% album --exif hi there --
You can remove specific array options with -no_<option>
and clear all the array options with -clear_<option>.
To clear out array options (say, from the previous album run):
% album -clear_exif -exif "new exif"
(The -clear_exif will clear any previous exif settings and then the
following -exif option will add a new exif comment)
And finally, you can remove specific array options with 'no_':
% album -no_exif hi
Which could remove the 'hi' exif value and leave the 'there' value intact.
Also see the section on Saving Options.
To see a brief usage:
% album -h
To see more options:
% album -more
And even more full list of options:
% album -usage=2
You can specify numbers higher than 2 to see even more options (up to about 100)
Plugins can also have options with their own usage.
ITEM: Themes
Themes are an essential part of what makes album compelling.
You can customize the look of your photo album by downloading a
theme from MarginalHacks or even writing your own theme to match
your website.
To use a theme, download the theme .tar or .zip and unpack it.
Themes are found according to the -theme_path setting, which is
a list of places to look for themes. Those paths need to be somewhere
under the top of your web directory, but not inside a photo album
directory. It needs to be accessible from a web browser.
You can either move the theme into one of the theme_paths that album
is already using, or make a new one and specify it with the -theme_path
option. (-theme_path should point to the directory the theme is in,
not the actual theme directory itself)
Then call album with the -theme option, with or without -theme_path:
% album -theme Dominatrix6 my_photos/
% album -theme Dominatrix6 -theme_path /home/httpd/album/Themes/ my_photos/
You can also create your own themes pretty easily, this is covered
later in this documentation.
ITEM: Sub-albums
Make directories inside your first directory and put images in that.
Run album again, and it will run through all the child directories
and create sub-albums of the first album.
If you make changes to just a sub-album, you can run album on that
and it will keep track of all the parent links.
If you don't want to traverse down the tree of directories, you
can limit it with the depth option. Example:
% album images/ -depth 1
Will only generate photo albums for the images directory.
If you have many sub-albums, and you want to add a new sub-album
without regenerating all the previous sub-albums, then you can use -add:
% album -add images/new_album/
Which will add the new_album to the HTML for 'images/' and then
generate the thumbs and HTML for everything inside 'images/new_album/'
ITEM: Avoiding Thumbnail Regeneration
album tries to avoid unnecessary work. It only creates thumbnails if
they don't exist and haven't changed. This speeds up successive runs
of album.
This can cause a problem if you change the size or cropping of your
thumbnails, because album won't realize that the thumbnails have changed.
You can use the force option to force album to regenerate thumbnails:
% album -force images/
But you shouldn't need to use -force every time.
ITEM: Cleaning Out The Thumbnails
If you remove images from an album then you'll have leftover thumbs and HTML.
You can remove them by running album once with the -clean option:
% album -clean images/
ITEM: Medium size images
When you click on an album thumbnail you're taken to an 'image_page.'
The image_page shows, by default, the full size image (as well as
navigation buttons and captions and such). When you click on the
image on the image_page, you'll be taken to the URL for just the full
size image.
If you want a medium size image on the image_page, use the -medium
option and specify a geometry for the medium size image. You can
specify any geometry that ImageMagick can use (see their man page
for more info). Some examples:
# An image that is half the full size
% album -medium 50%
# An image that fits inside 640x480 (maximum size)
% album -medium 640x480
# An image that is shrunk to fit inside 640x480
# (but won't be enlarged if it's smaller than 640x480)
% album -medium '640x480>'
You need the 'quotes' on the last example with most shells because
of the '>' character.
ITEM: Captions
Images and thumbnails can have names and captions. There are a number
of ways to specify/change names and captions in your photo albums.
The name is linked to the image or image_page,
and the caption follows underneath.
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
One way to specify a caption is in a .txt file
with the same name as the image. For this example,
"Kodi_Cow.txt" could contain "Kodi takes down a cow!"
You can rename your images and specify captions in bulk
for an album directory with a captions.txt file.
Each line of the file should be an image or directory filename,
followed by a tab, followed by the new name. You can also
specify (separated by tabs), an optional caption and then an optional
image ALT tag. (To skip a field, use 'tab' 'space' 'tab')
Example:
001.gif My first photo
002.gif Mom and Dad My parents in the grand canyon
003.gif Ani DiFranco My fiancee Yowsers!
The images and directories will also be sorted in the order they are found
in the caption file. You can override this with '-sort date' and '-sort name'
If your editor doesn't handle tabs very well, then you can separate the
fields by double-colons, but only if the caption line doesn't contain any
tabs at all:
003.gif :: Ani DiFranco :: My fiancee :: Yowsers!
If you only want captions on image pages (not on album pages) use:
% album -no_album_captions
If you want web access to create/edit your captions, look at the
caption_edit.cgi CGI script (but be sure to limit access to the
script or anyone can change your captions!)
ITEM: EXIF Captions
You can also specify captions that are based off of EXIF information
(Exchangeable Image File Format) which most digital cameras add to images.
First you need 'jhead' installed. You should be able to run jhead
on a JPG file and see the comments and information.
EXIF captions are added after the normal captions and are specified with -exif:
% album -exif "<br>File: %File name% taken with %Camera make%"
Any %tags% found will be replaced with EXIF information. If any %tags%
aren't found in the EXIF information, then that EXIF caption string is
thrown out. Because of this you can specify multiple -exif strings:
% album -exif "<br>File: %File name% " -exif "taken with %Camera make%"
This way if the 'Camera make' isn't found you can still get the 'File name'
caption.
Like any of the array style options you can use --exif as well:
% album --exif "<br>File: %File name% " "taken with %Camera make%" --
Note that, as above, you can include HTML in your EXIF tags:
% album -exif "<br>Aperture: %Aperture%"
To see the possible EXIF tags (Resolution, Date/Time, Aperture, etc..)
run a program like 'jhead' on an digital camera image.
You can also specify EXIF captions only for album or image pages, see
the -exif_album and -exif_image options.
ITEM: Headers and Footers
In each album directory you can have text files header.txt and footer.txt
These will be copied verbatim into the header and footer of your album (if
it's supported by the theme).
ITEM: Hiding Files/Directories
Any files that album does not recognize as image types are ignored.
To display these files, use -no_known_images. (-known_images is default)
You can mark an image as a non-image by creating an empty file with
the same name with .not_img added to the end.
You can ignore a file completely by creating an empty file with
the same name with .hide_album on the end.
You can avoid running album on a directory (but still include it in your
list of directories) by creating a file <dir>/.no_album
You can ignore directories completely by creating a file <dir>/.hide_album
The Windows version of album doesn't use dots for no_album, hide_album
and not_img because it's difficult to create .files in Windows.
ITEM: Cropping Images
If your images are of a large variety of aspect ratios (i.e., other than
just landscape/portrait) or if your theme only allows one orientation,
then you can have your thumbnails cropped so they all fit the same geometry:
% album -crop
The default cropping is to crop the image to center. If you don't
like the centered-cropping method that the album uses to generate
thumbnails, you can give directives to album to specify where to crop
specific images. Just change the filename of the image so it has a
cropping directive before the filetype. You can direct album to crop
the image at the top, bottom, left or right. As an example, let's
say you have a portrait "Kodi.gif" that you want cropped on top for
the thumbnail. Rename the file to "Kodi.CROPtop.gif" and this will
be done for you (you might want to -clean out the old thumbnail).
The "CROP" string will be removed from the name that is printed in
the HTML.
The default geometry is 133x133. This way landscape images will
create 133x100 thumbnails and portrait images will create 100x133
thumbnails. If you are using cropping and you still want your
thumbnails to have that digital photo aspect ratio, then try 133x100:
% album -crop -geometry 133x100
Remember that if you change the -crop or -geometry settings on a
previously generated album, you will need to specify -force once
to regenerate all your thumbnails.
ITEM: Video
album can generate snapshot thumbnails of many video formats if you
install ffmpeg
If you are running linux on an x86, then you can just grab the binary,
otherwise get the whole package from ffmpeg.org (it's an easy install).
ITEM: Burning CDs (using file://)
If you are using album to burn CDs or you want to access your albums with
file://, then you don't want album to assume "index.html" as the default
index page since the browser probably won't. Furthermore, if you use
themes, you must use relative paths. You can't use -theme_url because
you don't know what the final URL will be. On Windows the theme path
could end up being "C:/Themes" or on UNIX or OSX it could be something
like "/mnt/cd/Themes" - it all depends on where the CD is mounted.
To deal with this, use the -burn option:
% album -burn ...
This requires that the paths from the album to the theme don't change.
The best way to do this is take the top directory that you're going to
burn and put the themes and the album in that directory, then specify
the full path to the theme. For example, create the directories:
myISO/Photos/
myISO/Themes/Blue
Then you can run:
% album -burn -theme myISO/Themes/Blue myISO/Photos
Then you can make a CD image from the myISO directory (or higher).
If you are using 'galbum' (the GUI front end) then you can't specify
the full path to the theme, so you'll need to make sure that the version
of the theme you want to burn is the first one found in the theme_path
(which is likely based off the data_path). In the above example you
could add 'myISO' to the top of the data_path, and it should
use the 'myISO/Themes/Blue' path for the Blue theme.
You can also look at shellrun for windows users, you can have it
automatically launch the album in a browser. (Or see winopen)
ITEM: Indexing your entire album
To navigate an entire album on one page use the caption_index tool.
It uses the same options as album (though it ignores many
of them) so you can just replace your call to "album" with "caption_index"
The output is the HTML for a full album index.
See an example index
for one of my example photo albums
ITEM: Updating Albums With CGI
First you need to be able to upload the photo to the album directory.
I suggest using ftp for this. You could also write a javascript that
can upload files, if someone could show me how to do this I'd love to know.
Then you need to be able to remotely run album. To avoid abuse, I
suggest setting up a CGI script that touches a file (or they can just
ftp this file in), and then have a cron job that checks for that
file every few minutes, and if it finds it it removes it and runs album.
[unix only] (You will probably need to set $PATH or use absolute paths
in the script for convert)
If you want immediate gratification, you can run album from a CGI script
such as this one.
If your photos are not owned by the webserver user, then you
need to run through a setud script which you run from a CGI [unix only].
Put the setuid script in a secure place, change it's ownership to be the
same as the photos, and then run "chmod ug+s" on it. Here are example
setuid and CGI scripts. Be sure to edit them.
Also look at caption_edit.cgi which allows you (or others) to edit
captions/names/headers/footers through the web.
album-4.17/Docs/it/txt_6 0000655 0000000 0000000 00000045742 10670046152 013555 0 ustar root root Creating Themes
ITEM: Methods
There are easy ways and complicated ways to create a custom theme,
depending on what you want to be able to do.
ITEM: Editing current theme HTML
If you just want to slightly change the theme to match the output
of your site, it might make sense to edit a current theme.
In the theme directory there are two *.th files. album.th is
the template for album pages (the thumbnail pages) and image.th
is the template for image pages (where you can see medium or full
size images). The files are very similar to HTML except for
some embedded <: ePerl :> code. Even if you don't know perl or
ePerl you can still edit the HTML to make simple changes.
Good starting themes:
Any simmer_theme is going to be up to date and clean, such as "Blue" or
"Maste." If you only need 4 corner thumbnail borders then take a look
at "Eddie Bauer." If you want overlay/transparent borders, see FunLand.
If you want something demonstrating a minimal amount of code, try "simple"
but be warned that I haven't touched the theme in a long time.
ITEM: The easy way, simmer_theme from graphics.
Most themes have the same basic form, show a bunch of thumbnails
for directories and then for images, with a graphic border, line and
background. If this is what you want, but you want to create new
graphics, then there is a tool that will build your themes for you.
If you create a directory with the images and a CREDIT file as well
as a Font or Style.css file, then simmer_theme will create theme for you.
Files:
Font/Style.css
This determines the fonts used by the theme. The "Font" file is the
older system, documented below. Create a Style.css file and define
styles for: body, title, main, credit and anything else you like.
See FunLand for a simple example.
Alternatively, use a font file. An example Font file is:
--------------------------------------------------
$TITLE_FONT = "size='4' color='#ffffff' face='Times New Roman,Georgia,Times'";
$MAIN_FONT = "face='Times New Roman,Georgia,Times'";
$CREDIT_FONT = "size='-1' face='Verdana' color='#ffffff'";
$BODY = "background='$PATH/bkgrnd.gif' link='#0099FF'">
--------------------------------------------------
CREDIT
The credit file is two lines and is used for the theme index at MarginalHacks.
If you're never submitting your theme to us, then you don't need this file.
(But please do!) If so, the two lines (and only two lines) are:
1) A short description of the theme (keep it all on one line)
2) Your name (can be inside a mailto: or href link)
Null.gif
Each simmer theme needs a spacer image, this is a 1x1 transparent gif.
You can just copy this from another simmer theme.
Optional image files:
Bar Images
The bar is composed of Bar_L.gif, Bar_R.gif and Bar_M.gif in the middle.
The middle is stretched. If you need a middle piece that isn't stretched, use:
Bar_L.gif, Bar_ML.gif, Bar_M.gif, Bar_MR.gif, Bar_R.gif
And then the Bar_ML.gif and Bar_MR.gif will be stretched. (See the
Craftsman theme for an example of this).
Locked.gif
A lock image for any directories that have .htaccess
Background image
If you want a background image, specify it in the Font file in the $BODY
section, as in the example above. The $PATH variable will be replaced
with the path to the theme files:
More.gif
When an album page has sub-albums to list, it first shows the 'More.gif'
image.
Next.gif, Prev.gif, Back.gif
For the next and previous arrows and the back button
Icon.gif
Shown at the top left by the parent albums, this is often just the text "Photos"
Border Images
There are many ways to slice up a border, from simple to complex, depending on
the complexity of the border and how much you want to be able to stretch it:
4 pieces Uses Bord_L.gif, Bord_R.gif, Bord_T.gif, Bord_B.gif
(The corners go with the left and right images)
4 piece borders usually don't stretch well so they don't work well on
image_pages. Generally you can cut the corners out of the left and
right images to make:
8 pieces Also includes Bord_TL.gif, Bord_TR.gif, Bord_BL.gif, Bord_BR.gif
8 piece borders allow you to stretch to handle most sized images
12 pieces Also includes Bord_LT.gif, Bord_RT.gif, Bord_LB.gif, Bord_RB.gif
12 pieces allow stretching of borders that have more complex corners (such
as Dominatrix6 or Ivy)
Overlay Borders Can use transparent images that can be partially
overlaying your thumbnail. See below.
Here's how the normal border pieces are laid out:
12 piece borders
TL T TR 8 piece borders 4 piece borders
LT RT TL T TR TTTTTTT
L IMG R L IMG R L IMG R
LB RB BL B BR BBBBBBB
BL B BR
Note that every row of images must be the same height, though the
widths do not have to line up. (i.e., height TL = height T = height TR)
(This is not true about overlay borders!)
Once you've created these files, you can run the simmer_theme tool
(an optional tool download at MarginalHacks.com) and your theme will
then be ready to use!
If you need different borders for the image pages, then use the same
filenames prefixed by 'I' - such as IBord_LT.gif, IBord_RT.gif,...
Overlay borders allow for really fantastic effects with image borders.
Currently there's no support for different overlay borders for images.
For using Overlay borders, create images:
Over_TL.png Over_T.png Over_TR.png
Over_L.png Over_R.png
Over_BL.png Over_B.png Over_BR.png
Then figure out how many pixels of the borders are padding (outside photo)
Then put those values in files: Over_T.pad Over_R.pad Over_B.pad Over_L.pad
See "Themes/FunLand" for a simple example
Multi-lingual Images
If your images have text, you can translate them into other languages
so that albums can be generated in other languages. For example, you
can create a Dutch "More.gif" image and put it in 'lang/nl/More.gif'
in the theme (nl is the language code for Dutch).
When the user runs album in Dutch (album -lang nl) then the theme
will use the Dutch image if found. Themes/Blue has a simple example.
The currently "translated" images are:
More, Back, Next, Prev and Icon
You can create an HTML table that shows the translations immediately
available to themes with -list_html_trans:
% album -list_html_trans > trans.html
Then view trans.html in a browser. Unfortunately different languages
have different charsets, and an HTML page can only have one. The
output is in utf-8, but you can edit the "charset=utf-8" to properly
view language characters in different charsets (such as hebrew).
If you need more words translated for themes, let me know, and if you
create any new language images for a theme, please send them to me!
ITEM: From scratch, Theme API
This is a much heavier job - you need to have a very clear idea of
how you want album to place the images on your page. It might be
a good idea to start with modifying existing themes first to get
an idea of what most themes do. Also look at existing themes
for code examples (see suggestions above).
Themes are directories that contain at the minimum an 'album.th' file.
This is the album page theme template. Often they also contain an 'image.th'
which is the image theme template, and any graphics/css used by the theme.
Album pages contain thumbnails and image pages show full/medium sized images.
The .th files are ePerl, which is perl embedded inside of HTML. They
end up looking a great deal like the actual album and image HTML themselves.
To write a theme, you'll need to understand the ePerl syntax. You can
find more information from the actual ePerl tool available at MarginalHacks
(though this tool is not needed to use themes in album).
There are a plethora of support routines available, but often only
a fraction of these are necessary - it may help to look at other themes
to see how they are generally constructed.
Function table:
Required Functions
Meta() Must be called in the section of HTML
Credit() Gives credit ('this album created by..')
Must be called in the section of HTML
Body_Tag() Called inside the actual tag.
Paths and Options
Option($name) Get the value of an option/configuration setting
Version() Return the album version
Version_Num() Return the album version as just a number (i.e. "3.14")
Path($type) Returns path info for $type of:
album_name The name of this album
dir Current working album directory
album_file Full path to the album index.html
album_path The path of parent directories
theme Full path to the theme directory
img_theme Full path to the theme directory from image pages
page_post_url The ".html" to add onto image pages
parent_albums Array of parent albums (album_path split up)
Image_Page() 1 if we're generating an image page, 0 for album page.
Page_Type() Either 'image_page' or 'album_page'
Theme_Path() The filesystem path to the theme files
Theme_URL() The URL path to the theme files
Header and Footer
isHeader(), pHeader() Test for and print the header
isFooter(), pFooter() Same for the footer
Generally you loop through the images and directories using local variables:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
This will print the name of each image. Our object types are either 'pics'
for images or 'dirs' for the child directories. Here are the object functions:
Objects (type is either 'pics' (default) or 'dirs')
First($type) Get the first image or sub-album object.
Last($type) Last object
Next($obj) Given an object, return the next object
Next($obj,1) Same, loop past end to beginning.
Prev($obj), Prev($obj,1) Similar to Next()
num('pics') or just num() Total number of images in this album
num('dirs') Total number of children/sub-albums
Also:
num('parent_albums') Total number of parents leading up to this album.
Object lookup:
get_obj($num, $type, $loop)
Finds object by number ('pics' or 'dirs').
If $loop is set than the count will wrap around.
Object Properties
Each object (image or child albums) has properties.
Some properties are accessed by a single field:
Get($obj,$field) Get a single field of an object
Field Description
----- ----------
type What type of object? Either 'pics' or 'dirs'
is_movie Boolean: is this a movie?
name Name (cleaned and optionally from captions)
cap Image caption
capfile Optional caption file
alt Alt tag
num_pics [directories only, -dir_thumbs] Num of pics in directory
num_dirs [directories only, -dir_thumbs] Num of dirs in directory
Some properties are accessed by a field and subfield. For example,
each image has information for different sizes: full, medium and thumb
(though 'medium' is optional).
Get($obj,$size,$field) Get a property for a given size
Size Field Description
---- ----- ----------
$size x Width
$size y Height
$size file Filename (without path)
$size path Filename (full path)
$size filesize Filesize in bytes
full tag The tag (either 'image' or 'embed') - only for 'full'
We also have URL information which is access according to the
page it's coming 'from' and the image/page it's pointing 'to':
Get($obj,'URL',$from,$to) Get a URL for an object from -> to
Get($obj,'href',$from,$to) Same but wraps it in an 'href' string.
Get($obj,'link',$from,$to) Same but wraps the object name inside the href link.
From To Description
---- -- ----------
album_page image Image_URL from album_page
album_page thumb Thumbnail from album_page
image_page image Image_URL from image_page
image_page image_page This image page from another image page
image_page image_src The <img src> URL for the image page
image_page thumb Thumbnail from image_page
Directory objects also have:
From To Description
---- -- ----------
album_page dir URL to the directory from it's parent album page
Parent Albums
Parent_Album($num) Get a parent album string (including the href)
Parent_Albums() Return a list of the parent albums strings (including href)
Parent_Album($str) A join($str) call of Parent_Albums()
Back() The URL to go back or up one page.
Images
This_Image The image object for an image page
Image($img,$type) The <img> tags for type of medium,full,thumb
Image($num,$type) Same, but by image number
Name($img) The clean or captioned name for an image
Caption($img) The caption for an image
Child Albums
Name($alb)
Caption($img) The caption for an image
Convenience Routines
Pretty($str,$html,$lines) Pretty formats a name.
If $html then HTML is allowed (i.e., use 0 for <title> and the like)
Currently just puts prefix dates in a smaller font (i.e. '2004-12-03.Folder')
If $lines then multilines are allowed
Currently just follows dates with a 'br' line break.
New_Row($obj,$cols,$off) Should we start a new row after this object?
Use $off if the first object is offset from 1
Image_Array($src,$x,$y,$also,$alt)
Returns an <img> tag given $src, $x,...
Image_Ref($ref,$also,$alt)
Like Image_Array, but $ref can be a hash of
Image_Arrays keyed by language ('_' is default).
album picks the Image_Array by what languages are set.
Border($img,$type,$href,@border)
Border($str,$x,$y,@border)
Create the full bordered image.
See 'Borders' for more information.
If you're creating a theme from scratch, consider adding support for -slideshow.
The easiest way to do this is to cut/paste the "slideshow" code out of an
existing theme.
ITEM: Submitting Themes
Have a custom theme? I'd love to see it, even if it's totally site-specific.
If you have a new theme you'd like to offer the public, feel free to send
it to me and/or a URL where I can see how it looks. Be sure to set the CREDIT
file properly and let me know if you are donating it to MarginalHacks for
everyone to use or if you want it under a specific license.
ITEM: Converting v2.0 Themes to v3.0 Themes
album v2.0 introduced a theme interface which has been rewritten. Most
2.0 themes (especially those that don't use many of the global variables)
will still work, but the interface is deprecated and may disappear in
the near future.
It's not difficult to convert from v2.0 to v3.0 themes.
The v2.0 themes used global variables for many things. These are now
deprecated In v3.0 you should keep track of images and directories in
variables and use the 'iterators' that are supplied, for example:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Will loop through all the images and print their names.
The chart below shows you how to rewrite the old style calls which
used a global variable with the new style which uses a local variable,
but to use these calls you need to rewrite your loops as above.
Here is a conversion chart for helping convert v2.0 themes to v3.0:
# Global vars shouldn't be used
# ALL DEPRECATED - See new local variable loop methods above
$PARENT_ALBUM_CNT Rewrite with: Parent_Album($num) and Parent_Albums($join)
$CHILD_ALBUM_CNT Rewrite with: my $dir = First('dirs'); $dir=Next($dir);
$IMAGE_CNT Rewrite with: my $img = First('pics'); $pics=Next($pics);
@PARENT_ALBUMS Can instead use: @{Path('parent_albums')}
@CHILD_ALBUMS, @CHILD_ALBUM_NAMES, @CHILD_ALBUM_URLS, ...
# Old global variable modifiers:
# ALL DEPRECATED - See new local variable loop methods above
Next_Image(), Images_Left(), Image_Cnt(), Image_Prev(), Image_Next()
Set_Image_Prev(), Set_Image_Next(), Set_Image_This()
Next_Child_Album(), Child_Album_Cnt(), Child_Albums_Left()
# Paths and stuff
pAlbum_Name() Path('album_name')
Album_Filename() Path('album_file')
pFile($file) print read_file($file)
Get_Opt($option) Option($option)
Index() Option('index')
pParent_Album($str) print Parent_Album($str)
# Parent Albums
Parent_Albums_Left Deprecated, see '$PARENT_ALBUM_CNT' above
Parent_Album_Cnt Deprecated, see '$PARENT_ALBUM_CNT' above
Next_Parent_Album Deprecated, see '$PARENT_ALBUM_CNT' above
pJoin_Parent_Albums print Parent_Albums(\@_)
# Images, using variable '$img'
pImage() Use $img instead and:
print Get($img,'href','image');
print Get($img,'thumb') if Get($img,'thumb');
print Name($img), "</a>";
pImage_Src() print Image($img,'full')
Image_Src() Image($img,'full')
pImage_Thumb_Src() print Image($img,'thumb')
Image_Name() Name($img)
Image_Caption() Caption($img)
pImage_Caption() print Get($img,'Caption')
Image_Thumb() Get($img,'URL','thumb')
Image_Is_Pic() Get($img,'thumb')
Image_Alt() Get($img,'alt')
Image_Filesize() Get($img,'full','filesize')
Image_Path() Get($img,'full','path')
Image_Width() Get($img,'medium','x') || Get($img,'full','x')
Image_Height() Get($img,'medium','y') || Get($img,'full','y')
Image_Filename() Get($img,'full','file')
Image_Tag() Get($img,'full','tag')
Image_URL() Get($img,'URL','image')
Image_Page_URL() Get($img,'URL','image_page','image_page') || Back()
# Child album routines, using variable '$alb'
pChild_Album($nobr) print Get($alb,'href','dir');
my $name = Name($alb);
$name =~ s/<br>//g if $nobr;
print $name,"</a>";
Child_Album_Caption() Caption($alb,'dirs')
pChild_Album_Caption() print Child_Album_Caption($alb)
Child_Album_URL() Get($alb,'URL','dir')
Child_Album_Name() Name($alb)
# Unchanged
Meta() Meta()
Credit() Credit()
album-4.17/Docs/it/Section_7.html 0000644 0000000 0000000 00000061027 12661460265 015305 0 ustar root root
MarginalHacks album - Plugins, Usage, Creation,..
- Documentation
A l b u m
S e v e n - - P l u g i n s , U s a g e , C r e a t i o n , . .
1: What are Plugins?
Plugins are snippets of code that allow you to modify the behavior
of album. They can be as simple as a new way to create EXIF captions,
to something as complex as creating the album based on a database of
images instead of using the filesystem hierarchy.
2: Installing Plugins and plugin support
There are a number of plugins available with the standard installation of
album. If you are upgrading album with plugins from an earlier version
of album that did not have plugins (pre v3.10), you may need to once do:
% album -configure
You will not need to do this with future upgrades of album.
This will install the current plugins into one of the default
plugin directories - album will look for plugins in a number of
locations, the default locations are:
/etc/album/plugins/
/usr/share/album/plugins/
$HOME/.album/plugins/
In reality, these are 'plugins' directories found in the set of
locations specified by '--data_path' - hence the defaults are:
/etc/album/
/usr/share/album/
$HOME/.album/
You can specify a new location with --data_path and then add a 'plugins'
directory to that location, or use the --plugin_path option.
Plugins usually end with the ".alp" prefix, but you do not need
to specify this prefix when using plugins. For example, if you
have a plugin installed at:
/etc/album/plugins/utils/mv.alp
Then you would specify the plugin as: utils/mv3: Loading/Unloading Plugins
To list all the currently installed plugins:
% album -list_plugins
To show information about a specific plugin (using 'utils/mv' as an example):
% album -plugin_info utils/mv
Plugins will be saved in the configuration for a given album, so
they don't need to be respecified every time (excluding one-time
plugins such as 'utils/mv')
You can use -no_plugin and -clear_plugin to turn off plugins that have
been saved in an album configuration. As with normal album options,
-no_plugin will turn off a specific plugin, and -clear_plugin will
turn off all plugins. Any saved plugin options for that plugin will be
erased as well.
4: Plugin Options
A few plugins may be able to take command-line options, to view usage
for these plugins:
% album -plugin_usage utils/mv
But when specifying plugin options, you need to tell album which plugin
the option belongs to. Instead of specifying as a normal album option:
% album -some_option
You prefix the option with the plugin name followed by a colon:
% album -some_plugin:some_option
For example, you can specify the generated 'index' created by
the 'utils/capindex' plugin.
% album -plugin utils/capindex -utils/capindex:index blah.html
That's a bit unwieldy. You can shorten the name of the plugin as
long as it doesn't conflict with another plugin you've loaded (by
the same name):
% album -plugin utils/capindex -capindex:index
Obviously the other types of options (strings, numbers and arrays) are
possible and use the same convention. They are saved in album configuration
the same as normal album options.
One caveat: As mentioned, once we use a plugin on an album it is saved
in the configuration. If you want to add options to an album that is
already configured to use a plugin, you either need to mention the plugin
again, or else use the full name when specifying the options (otherwise
we won't know what the shortened option belongs to).
For example, consider an imaginary plugin:
% album -plugin some/example/thumbGen Photos/Spain
After that, let's say we want to use the thumbGen boolean option "fast".
This will not work:
% album -thumbGen:fast Photos/Spain
But either of these will work:
% album -plugin some/example/thumbGen -thumbGen:fast blah.html Photos/Spain% album -some/example/thumbGen:fast Photos/Spain5: Writing Plugins
Plugins are small perl modules that register "hooks" into the album code.
There are hooks for most of the album functionality, and the plugin hook
code can often either replace or supplement the album code. More hooks
may be added to future versions of album as needed.
You can see a list of all the hooks that album allows:
% album -list_hooks
And you can get specific information about a hook:
% album -hook_info <hook_name>
We can use album to generate our plugin framework for us:
% album -create_plugin
For this to work, you need to understand album hooks and album options.
We can also write the plugin by hand, it helps to use an already
written plugin as a base to work off of.
In our plugin we register the hook by calling the album::hook() function.
To call functions in the album code, we use the album namespace.
As an example, to register code for the clean_name hook our plugin calls:
album::hook($opt,'clean_name',\&my_clean);
Then whenever album does a clean_name it will also call the plugin
subroutine called my_clean (which we need to provide).
To write my_clean let's look at the clean_name hook info:
Args: ($opt, 'clean_name', $name, $iscaption)
Description: Clean a filename for printing.
The name is either the filename or comes from the caption file.
Returns: Clean name
The args that the my_clean subroutine get are specified on the first line.
Let's say we want to convert all names to uppercase. We could use:
sub my_clean {
my ($opt, $hookname, $name, $iscaption) = @_;
return uc($name);
}
Here's an explanation of the arguments:
$opt This is the handle to all of album's options.
We didn't use it here. Sometimes you'll need it if you
call any of albums internal functions. This is also true
if a $data argument is supplied.
$hookname In this case it will be 'clean_name'. This allows us
to register the same subroutine to handle different hooks.
$name This is the name we are going to clean.
$iscaption This tells us whether the name came from a caption file.
To understand any of the options after the $hookname you
may need to look at the corresponding code in album.
In this case we only needed to use the supplied $name, we called
the perl uppercase routine and returned that. The code is done, but now
we need to create the plugin framework.
Some hooks allow you to replace the album code. For example, you
could write plugin code that can generate thumbnails for pdf files
(using 'convert' is one way to do this). We can register code for
the 'thumbnail' hook, and just return 'undef' if we aren't looking
at a pdf file, but when we see a pdf file, we create a thumbnail
and then return that. When album gets back a thumbnail, then it
will use that and skip it's own thumbnail code.
Now let's finish writing our uppercase plugin. A plugin must do the following:
1) Supply a 'start_plugin' routine. This is where you will likely
register hooks and specify any command-line options for the plugin.
2) The 'start_plugin' routine must return the plugin info
hash, which needs the following keys defined:
author => The author name
href => A URL (or mailto, of course) for the author
version => Version number for this plugin
description => Text description of the plugin
3) End the plugin code by returning '1' (similar to a perl module).
Here is our example clean_name plugin code in a complete plugin:
sub start_plugin {
my ($opt) = @_;
album::hook($opt,'clean_name',\&my_clean);
return {
author => 'David Ljung Madison',
href => 'http://MarginalHacks.com/',
version => '1.0',
description => "Conver image names to uppercase",
};
}
sub my_clean {
return uc($name);
}
1;
Finally, we need to save this somewhere. Plugins are organized in the
plugin directory hierarchy, we could save this in a plugin directory as:
captions/formatting/NAME.alp
In fact, if you look in examples/formatting/NAME.alp you'll find that
there's a plugin already there that does essentially the same thing.
If you want your plugin to accept command-line options, use 'add_option.'
This must be done in the start_plugin code. Some examples:
album::add_option(1,"fast",album::OPTION_BOOL, usage=>"Do it fast");
album::add_option(1,"name", album::OPTION_STR, usage=>"Your name");
album::add_option(1,"colors",album::OPTION_ARR, usage=>"Color list");
For more info, see the 'add_option' code in album and see all of the uses
of it (at the top of album and in plugins that use 'add_option')
To read an option that the user may have set, we use option():
my $fast = album::option($opt, "fast");
If the user gave a bad value for an option, you can call usage():
album::usage("-colors array can only include values [red, green, blue]");
If your plugin needs to load modules that are not part of the
standard Perl distribution, please do this conditionally. For
an example of this, see plugins/extra/rss.alp.
You can also call any of the routines found in the album script
using the album:: namespace. Make sure you know what you are doing.
Some useful routines are:
album::add_head($opt,$data, "<meta name='add_this' content='to the <head>'>");
album::add_header($opt,$data, "<p>This gets added to the album header");
album::add_footer($opt,$data, "<p>This gets added to the album footer");
The best way to figure out how to write plugins is to look at other
plugins, possibly copying one that is similar to yours and working
off of that. Plugin development tools may be created in the future.
Again, album can help create the plugin framework for you:
% album -create_plugin
1: Using languages
(Requires album v4.0 or higher)
Album comes prepackaged with language files (we're in need of translation
help, see below!). The language files will alter most of album's output
messages, as well as any HTML output that isn't generated by the theme.
Altering any text in a theme to match your language is as simple as editing
the Theme files - there is an example of this with the "simple-Czech" theme.
To use a language, add the "lang" option to your main album.conf, or else
specify it the first time you generate an album (it will be saved with that
album afterwards).
Languages can be cleared like any code/array option with:
% album -clear_lang ...
You can specify multiple languages, which can matter if a language is
incomplete, but you'd like to default to another language than english.
So, for example, if you wanted Dutch as the primary language, with the
backup being Swedish Chef, you could do:
% album -lang swedish_chef -lang nl ...
If you specify a sublanguage (such as es-bo for Spanish, Bolivia), then
album will attempt 'es' first as a backup.
Note that because of a known bug, you should specify all the desired
languages at the same time instead of over multiple invocations of album.
To see what languages are available:
% album -list_langs
Sadly, most of the (real) languages are barely complete, but this
is a chance for people to help out by becoming a..
2: Translation Volunteers
The album project is in need of volunteers to do translations,
specifically of:
1) The Mini How-To. Please translate from the source.
2) album messages, as explained below.
If you are willing to do the translation of either one or both
of these items, please contact me!
If you're feeling particularly ambitious, feel free to translate any
of the other Documentation sources as well, just let me know!
3: Documentation Translation
The most important document to translate is the "Mini How-To".
Please translate from the text source.
Also be sure to let me know how you want to be credited,
by your name, name and email, or name and website.
And please include the proper spelling and capitalization of the
name of your language in your language. For example, "franais"
instead of "French"
I am open to suggestions for what charset to use. Current options are:
1) HTML characters such as [é]] (though they only work in browsers)
2) Unicode (UTF-8) such as [é] (only in browsers and some terminals)
3) ASCII code, where possible, such as [] (works in text editors, though
not currently in this page because it's set to unicode)
4) Language specific iso such as iso-8859-8-I for Hebrew.
Currently Unicode (utf-8) seems best for languages that aren't covered
by iso-8859-1, because it covers all languages and helps us deal with
incomplete translations (which would otherwise require multiple charsets,
which is a disaster). Any iso code that is a subset of utf-8 can be used.
If the main terminal software for a given language is in an iso charset
instead of utf, then that could be a good exception to use non-utf.
4: Album messages
album handles all text messages using it's own language support
system, similar to the system used by the perl module Locale::Maketext.
(More info on the inspiration for this is in TPJ13)
An error message, for example, may look like this:
No themes found in [[some directory]].
With a specific example being:
No themes found in /www/var/themes.
In Dutch, this would be:
Geen thema gevonden in /www/var/themes.
The "variable" in this case is "/www/var/themes" and it obviously
isn't translated. In album, the actual error message looks like:
'No themes found in [_1].'
# Args: [_1] = $dir
The translation (in Dutch) looks like:
'No themes found in [_1].' => 'Geen thema gevonden in [_1].'
After translating, album will replace [_1] with the directory.
Sometimes we'll have multiple variables, and they may change places:
Some example errors:
Need to specify -medium with -just_medium option.
Need to specify -theme_url with -theme option.
In Dutch, the first would be:
Met de optie -just_medium moet -medium opgegeven worden.
The actual error with it's Dutch translation is:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet [_1] opgegeven worden'
# Args: [_1]='-medium' [_2]='-just_medium'
Note that the variables have changed places.
There is also a special operator for quantities, for example,
we may wish to translate:
'I have 42 images'
Where the number 42 may change. In English, it is adequate to say:
0 images, 1 image, 2 images, 3 images...
Whereas in Dutch we would have:
0 afbeeldingen, 1 afbeelding, 2 afbeeldingen, 3 afbeeldingen..
But other languages (such as many slavic languages) may have special
rules as to whether "image" should be pluralized based on whether the
quantity is mod 2, 3 or 4, and so on! The simplest case is covered
by the [quant] operator:
[quant,_1,image]
This is similar to "[_1] image" except that "image" will be pluralized
if [_1] is 0 or greater than 1:
0 images, 1 image, 2 images, 3 images...
Pluralization is simply adding an 's' - if this isn't adequate, we can
specify the plural form:
[quant,_1,afbeelding,afbeeldingen]
Which gives us the Dutch count above.
And if we need a special form for 0, we can specify that:
[quant,_1,directory,directories,no directories]
Which would create:
no directories, 1 directory, 2 directories, ...
There is also a shorthand for [quant] using '*', so these are the same:
[quant,_1,image]
[*,_1,image]
So now an example translation for a number of images:
'[*,_1,image]'
=> '[*,_1,afbeelding,afbeeldingen]',
If you have something more complicated then you can use perl code, I
can help you write this if you let me know how the translation should work:
'[*,_1,image]'
=> \&russian_quantity; # This is a sub defined elsewhere..
Since the translation strings are (generally) placed in single-quotes (')
and due to the special [bracket] codes, we need to quote these correctly.
Single-quotes in the string need to be preceded by a slash (\):
'I can\'t find any images'
And square brackets are quoted using (~):
'Problem with option ~[-medium~]'
Which unfortunately can get ugly if the thing inside the square brackets
is a variable:
'Problem with option ~[[_1]~]'
Just be careful and make sure all brackets are closed appropriately.
Furthermore, in almost all cases, the translation should have the
same variables as the original:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet' # <- Where did [_1] go?!?
Fortunately, most of the work is done for you. Language files are
saved in the -data_path (or -lang_path) where album keeps it's data.
They are essentially perl code, and they can be auto-generated by album:
% album -make_lang sw
Will create a new, empty language file called 'sw' (Swedish). Go ahead
and edit that file, adding translations as you can. It's okay to leave
translations blank, they just won't get used. Some of the more important
translations (such as the ones that go into HTML pages) are at the top
and should probably be done first.
You will need to pick a charset, this is tricky, as it should be based
on what charsets you think people will be likely to have available
in their terminal as well as in their browser.
If you want to build a new language file, using translations from
a previous file (for example, to update a language with whatever
new messages have been added to album), you should load the language first:
% album -lang sw -make_lang sw
Any translations in the current Swedish language file will be copied
over to the new file (though comments and other code will not be copied!)
For the really long lines of text, don't worry about adding any newline
characters (\n) except where they exist in the original. album will
do word wrap appropriately for the longer sections of text.
Please contact me when you are starting translation work so I can
be sure that we don't have two translators working on the same parts,
and be sure to send me updates of language files as the progress, even
incomplete language files are useful!
If you have any questions about how to read the syntax of the language
file, please let me know.
5: Why am I still seeing English?
After choosing another language, you can still sometimes see English:
1) Option names are still in English. (-geometry is still -geometry)
2) The usage strings are not currently translated.
3) Plugin output is unlikely to be translated.
4) Language files aren't always complete, and will only translate what they know.
5) album may have new output that the language file doesn't know about yet.
6) Most themes are in English.
Fortunately the last one is the easiest to change, just edit the theme
and replace the HTML text portions with whatever language you like, or
create new graphics in a different language for icons with English.
If you create a new theme, I'd love to hear about it!
album-4.17/Docs/it/txt_8 0000655 0000000 0000000 00000022224 11615154173 013550 0 ustar root root Language Support
ITEM: Using languages
(Requires album v4.0 or higher)
Album comes prepackaged with language files (we're in need of translation
help, see below!). The language files will alter most of album's output
messages, as well as any HTML output that isn't generated by the theme.
Altering any text in a theme to match your language is as simple as editing
the Theme files - there is an example of this with the "simple-Czech" theme.
To use a language, add the "lang" option to your main album.conf, or else
specify it the first time you generate an album (it will be saved with that
album afterwards).
Languages can be cleared like any code/array option with:
% album -clear_lang ...
You can specify multiple languages, which can matter if a language is
incomplete, but you'd like to default to another language than english.
So, for example, if you wanted Dutch as the primary language, with the
backup being Swedish Chef, you could do:
% album -lang swedish_chef -lang nl ...
If you specify a sublanguage (such as es-bo for Spanish, Bolivia), then
album will attempt 'es' first as a backup.
Note that because of a known bug, you should specify all the desired
languages at the same time instead of over multiple invocations of album.
To see what languages are available:
% album -list_langs
Sadly, most of the (real) languages are barely complete, but this
is a chance for people to help out by becoming a..
ITEM: Translation Volunteers
The album project is in need of volunteers to do translations,
specifically of:
1) The Mini How-To. Please translate from the source.
2) album messages, as explained below.
If you are willing to do the translation of either one or both
of these items, please contact me!
If you're feeling particularly ambitious, feel free to translate any
of the other Documentation sources as well, just let me know!
ITEM: Documentation Translation
The most important document to translate is the "Mini How-To".
Please translate from the text source.
Also be sure to let me know how you want to be credited,
by your name, name and email, or name and website.
And please include the proper spelling and capitalization of the
name of your language in your language. For example, "franais"
instead of "French"
I am open to suggestions for what charset to use. Current options are:
1) HTML characters such as [é]] (though they only work in browsers)
2) Unicode (UTF-8) such as [é] (only in browsers and some terminals)
3) ASCII code, where possible, such as [] (works in text editors, though
not currently in this page because it's set to unicode)
4) Language specific iso such as iso-8859-8-I for Hebrew.
Currently Unicode (utf-8) seems best for languages that aren't covered
by iso-8859-1, because it covers all languages and helps us deal with
incomplete translations (which would otherwise require multiple charsets,
which is a disaster). Any iso code that is a subset of utf-8 can be used.
If the main terminal software for a given language is in an iso charset
instead of utf, then that could be a good exception to use non-utf.
ITEM: Album messages
album handles all text messages using it's own language support
system, similar to the system used by the perl module Locale::Maketext.
(More info on the inspiration for this is in TPJ13)
An error message, for example, may look like this:
No themes found in [[some directory]].
With a specific example being:
No themes found in /www/var/themes.
In Dutch, this would be:
Geen thema gevonden in /www/var/themes.
The "variable" in this case is "/www/var/themes" and it obviously
isn't translated. In album, the actual error message looks like:
'No themes found in [_1].'
# Args: [_1] = $dir
The translation (in Dutch) looks like:
'No themes found in [_1].' => 'Geen thema gevonden in [_1].'
After translating, album will replace [_1] with the directory.
Sometimes we'll have multiple variables, and they may change places:
Some example errors:
Need to specify -medium with -just_medium option.
Need to specify -theme_url with -theme option.
In Dutch, the first would be:
Met de optie -just_medium moet -medium opgegeven worden.
The actual error with it's Dutch translation is:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet [_1] opgegeven worden'
# Args: [_1]='-medium' [_2]='-just_medium'
Note that the variables have changed places.
There is also a special operator for quantities, for example,
we may wish to translate:
'I have 42 images'
Where the number 42 may change. In English, it is adequate to say:
0 images, 1 image, 2 images, 3 images...
Whereas in Dutch we would have:
0 afbeeldingen, 1 afbeelding, 2 afbeeldingen, 3 afbeeldingen..
But other languages (such as many slavic languages) may have special
rules as to whether "image" should be pluralized based on whether the
quantity is mod 2, 3 or 4, and so on! The simplest case is covered
by the [quant] operator:
[quant,_1,image]
This is similar to "[_1] image" except that "image" will be pluralized
if [_1] is 0 or greater than 1:
0 images, 1 image, 2 images, 3 images...
Pluralization is simply adding an 's' - if this isn't adequate, we can
specify the plural form:
[quant,_1,afbeelding,afbeeldingen]
Which gives us the Dutch count above.
And if we need a special form for 0, we can specify that:
[quant,_1,directory,directories,no directories]
Which would create:
no directories, 1 directory, 2 directories, ...
There is also a shorthand for [quant] using '*', so these are the same:
[quant,_1,image]
[*,_1,image]
So now an example translation for a number of images:
'[*,_1,image]'
=> '[*,_1,afbeelding,afbeeldingen]',
If you have something more complicated then you can use perl code, I
can help you write this if you let me know how the translation should work:
'[*,_1,image]'
=> \&russian_quantity; # This is a sub defined elsewhere..
Since the translation strings are (generally) placed in single-quotes (')
and due to the special [bracket] codes, we need to quote these correctly.
Single-quotes in the string need to be preceded by a slash (\):
'I can\'t find any images'
And square brackets are quoted using (~):
'Problem with option ~[-medium~]'
Which unfortunately can get ugly if the thing inside the square brackets
is a variable:
'Problem with option ~[[_1]~]'
Just be careful and make sure all brackets are closed appropriately.
Furthermore, in almost all cases, the translation should have the
same variables as the original:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet' # <- Where did [_1] go?!?
Fortunately, most of the work is done for you. Language files are
saved in the -data_path (or -lang_path) where album keeps it's data.
They are essentially perl code, and they can be auto-generated by album:
% album -make_lang sw
Will create a new, empty language file called 'sw' (Swedish). Go ahead
and edit that file, adding translations as you can. It's okay to leave
translations blank, they just won't get used. Some of the more important
translations (such as the ones that go into HTML pages) are at the top
and should probably be done first.
You will need to pick a charset, this is tricky, as it should be based
on what charsets you think people will be likely to have available
in their terminal as well as in their browser.
If you want to build a new language file, using translations from
a previous file (for example, to update a language with whatever
new messages have been added to album), you should load the language first:
% album -lang sw -make_lang sw
Any translations in the current Swedish language file will be copied
over to the new file (though comments and other code will not be copied!)
For the really long lines of text, don't worry about adding any newline
characters (\n) except where they exist in the original. album will
do word wrap appropriately for the longer sections of text.
Please contact me when you are starting translation work so I can
be sure that we don't have two translators working on the same parts,
and be sure to send me updates of language files as the progress, even
incomplete language files are useful!
If you have any questions about how to read the syntax of the language
file, please let me know.
ITEM: Why am I still seeing English?
After choosing another language, you can still sometimes see English:
1) Option names are still in English. (-geometry is still -geometry)
2) The usage strings are not currently translated.
3) Plugin output is unlikely to be translated.
4) Language files aren't always complete, and will only translate what they know.
5) album may have new output that the language file doesn't know about yet.
6) Most themes are in English.
Fortunately the last one is the easiest to change, just edit the theme
and replace the HTML text portions with whatever language you like, or
create new graphics in a different language for icons with English.
If you create a new theme, I'd love to hear about it!
album-4.17/Docs/it/index.html 0000644 0000000 0000000 00000046405 12661460265 014565 0 ustar root root
MarginalHacks album - Documentation
album-4.17/Docs/it/conf 0000655 0000000 0000000 00000031623 12661457776 013453 0 ustar root root Table_Of_Contents = Table Of Contents
# Document conf file for 'make_faq'
#
New_Chunk = ITEM:
# Name of the short index, just links to the chapters
Short_Index = Short.html
# Name of the long index, links to chapters and chunks/questions
Long_Index = index.html
# Our list of text files (can use glob characters)
# Just make sure the filename ends with the section number.
Text_Files = txt_*
# Header
Header = "conf(my_doctype)
MarginalHacks album - $TOPIC - Documentation
conf(my_head_head)
SPACE_OUT($NUMBER -- $TOPIC)
conf(my_head_head2)
"
# Footer
Footer = "
"
# Header for short index
Short_Header = "conf(my_doctype)
MarginalHacks album - Documentation
conf(my_head_head)
SPACE_OUT(Documentation)
conf(my_head_head2)
Not all sections have been translated.
"
# Footer for short index
Short_Footer = conf(Footer)
Long_Header = conf(Short_Header)
Long_Footer = conf(Short_Footer)
##################################################
# Local variables for the conf file (used in conf(..) constructs)
##################################################
#
my_doctype = "
include_file(langhtml)
"
my_head_head = "
"
album-4.17/Docs/it/txt_5 0000655 0000000 0000000 00000010020 11076703643 013537 0 ustar root root Feature Requests, Bugs, Patches and Troubleshooting
ITEM: Feature Requests
If there's something you want added to album, first make sure
it doesn't already exist! Check the man page or the usage:
% man album% album -h
Also see -more and -usage options.
If you don't see it there, consider writing a patch or a plugin.
ITEM: Bug reports
Before you submit a bug, please make sure you have the most current release of album!
When submitting a bug, I need to know at least:
1) Your operating system
2) The exact problem and the exact error messages
I'd also like to know, if possible:
1) The exact album command you ran
2) The output from the command
And I generally also need the debug output of album:
% album -d
Finally, make sure that you've got the most current
version of album, and the most current themes as well.
ITEM: Writing Patches, Modifying album
If you want to modify album, you might want to check with me
first to make sure it's not already on my development plate.
If not, then consider writing it as a plugin instead of patching
the album source. This avoids adding complexity to album for
features that may not be globally used.
If it needs to go into album (for example, if it's a bug), then
please make sure to first download the most recent copy of album
first, then patch that and send me either a diff, a patch, or the
full script. If you comment off the changes you make that'd be great too.
ITEM: Known Bugs
v3.11: -clear_* and -no_* doesn't clear out parent directory options.
v3.10: Burning CDs doesn't quite work with theme absolute paths.
v3.00: Array and code options are saved backwards, for example:
"album -lang aa .. ; album -lang bb .." will still use language 'aa'
Also, in some cases array/code options in sub-albums will not
be ordered right the first time album adds them and you may
need to rerun album. For example:
"album -exif A photos/ ; album -exif B photos/sub"
Will have "B A" for the sub album, but "A B" after: "album photos/sub"
ITEM: PROBLEM: My index pages are too large!
I get many requests to break up the index pages after reaching a certain
threshold of images.
The problem is that this is hard to manage - unless the index pages are
treated just like sub-albums, then you now have three major components
on a page, more indexes, more albums, and thumbnails. And not only is
that cumbersome, but it would require updating all the themes.
Hopefully the next major release of album will do this, but until then
there is another, easier solution - just break the images up into
subdirectories before running album.
I have a tool that will move new images into subdirectories for you and
then runs album:
in_album
ITEM: ERROR: no delegate for this image format (./album)
You have the album script in your photo directory and it can't make
a thumbnail of itself! Either:
1) Move album out of the photo directory (suggested)
2) Run album with -known_images
ITEM: ERROR: no delegate for this image format (some_non_image_file)
Don't put non-images in your photo directory, or else run with -known_images.
ITEM: ERROR: no delegate for this image format (some.jpg)
ITEM: ERROR: identify: JPEG library is not available (some.jpg)
Your ImageMagick installation isn't complete and doesn't know how
to handle the given image type.
ITEM: ERROR: Can't get [some_image] size from -verbose output.
ImageMagick doesn't know the size of the image specified. Either:
1) Your ImageMagick installation isn't complete and can't handle the image type.
2) You are running album on a directory with non-images in it without
using the -known_images option.
If you're a gentoo linux user and you see this error, then run this command
as root (thanks Alex Pientka):
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
album-4.17/Docs/it/Section_3.html 0000644 0000000 0000000 00000075216 12661460265 015306 0 ustar root root
MarginalHacks album - Running album / Basic Options
- Documentation
A l b u m
T h r e e - - R u n n i n g a l b u m / B a s i c O p t i o n s
1: Basic execution
Create a directory with nothing but images in it. The album script and
other tools should not go here. Then run album specifying that directory:
% album /example/path/to/images/
Or, if you're in the /example/path/to directory:
% album images/
When it's done, you'll have a photo album inside that directory starting
with images/index.html.
If that path is in your web server, then you can view it with your
browser. If you can't find it, talk to your sysadmin.
2: Options
There are three types of options. Boolean options, string/num options
and array options. Boolean options can be turned off by prepending -no_:
% album -no_image_pages
String and number values are specified after a string option:
% album -type gif
% album -columns 5
Array options can be specified two ways, with one argument at a time:
% album -exif hi -exif there
Or multiple arguments using the '--' form:
% album --exif hi there --
You can remove specific array options with -no_<option>
and clear all the array options with -clear_<option>.
To clear out array options (say, from the previous album run):
% album -clear_exif -exif "new exif"
(The -clear_exif will clear any previous exif settings and then the
following -exif option will add a new exif comment)
And finally, you can remove specific array options with 'no_':
% album -no_exif hi
Which could remove the 'hi' exif value and leave the 'there' value intact.
Also see the section on Saving Options.
To see a brief usage:
% album -h
To see more options:
% album -more
And even more full list of options:
% album -usage=2
You can specify numbers higher than 2 to see even more options (up to about 100)
Plugins can also have options with their own usage.
3: Themes
Themes are an essential part of what makes album compelling.
You can customize the look of your photo album by downloading a
theme from MarginalHacks or even writing your own theme to match
your website.
To use a theme, download the theme .tar or .zip and unpack it.
Themes are found according to the -theme_path setting, which is
a list of places to look for themes. Those paths need to be somewhere
under the top of your web directory, but not inside a photo album
directory. It needs to be accessible from a web browser.
You can either move the theme into one of the theme_paths that album
is already using, or make a new one and specify it with the -theme_path
option. (-theme_path should point to the directory the theme is in,
not the actual theme directory itself)
Then call album with the -theme option, with or without -theme_path:
% album -theme Dominatrix6 my_photos/
% album -theme Dominatrix6 -theme_path /home/httpd/album/Themes/ my_photos/
You can also create your own themes pretty easily, this is covered
later in this documentation.
4: Sub-albums
Make directories inside your first directory and put images in that.
Run album again, and it will run through all the child directories
and create sub-albums of the first album.
If you make changes to just a sub-album, you can run album on that
and it will keep track of all the parent links.
If you don't want to traverse down the tree of directories, you
can limit it with the depth option. Example:
% album images/ -depth 1
Will only generate photo albums for the images directory.
If you have many sub-albums, and you want to add a new sub-album
without regenerating all the previous sub-albums, then you can use -add:
% album -add images/new_album/
Which will add the new_album to the HTML for 'images/' and then
generate the thumbs and HTML for everything inside 'images/new_album/'
5: Avoiding Thumbnail Regeneration
album tries to avoid unnecessary work. It only creates thumbnails if
they don't exist and haven't changed. This speeds up successive runs
of album.
This can cause a problem if you change the size or cropping of your
thumbnails, because album won't realize that the thumbnails have changed.
You can use the force option to force album to regenerate thumbnails:
% album -force images/
But you shouldn't need to use -force every time.
6: Cleaning Out The Thumbnails
If you remove images from an album then you'll have leftover thumbs and HTML.
You can remove them by running album once with the -clean option:
% album -clean images/7: Medium size images
When you click on an album thumbnail you're taken to an 'image_page.'
The image_page shows, by default, the full size image (as well as
navigation buttons and captions and such). When you click on the
image on the image_page, you'll be taken to the URL for just the full
size image.
If you want a medium size image on the image_page, use the -medium
option and specify a geometry for the medium size image. You can
specify any geometry that ImageMagick can use (see their man page
for more info). Some examples:
# An image that is half the full size
% album -medium 50%
# An image that fits inside 640x480 (maximum size)
% album -medium 640x480
# An image that is shrunk to fit inside 640x480
# (but won't be enlarged if it's smaller than 640x480)
% album -medium '640x480>'
You need the 'quotes' on the last example with most shells because
of the '>' character.
8: Captions
Images and thumbnails can have names and captions. There are a number
of ways to specify/change names and captions in your photo albums.
The name is linked to the image or image_page,
and the caption follows underneath.
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
One way to specify a caption is in a .txt file
with the same name as the image. For this example,
"Kodi_Cow.txt" could contain "Kodi takes down a cow!"
You can rename your images and specify captions in bulk
for an album directory with a captions.txt file.
Each line of the file should be an image or directory filename,
followed by a tab, followed by the new name. You can also
specify (separated by tabs), an optional caption and then an optional
image ALT tag. (To skip a field, use 'tab' 'space' 'tab')
Example:
001.gif My first photo
002.gif Mom and Dad My parents in the grand canyon
003.gif Ani DiFranco My fiancee Yowsers!
The images and directories will also be sorted in the order they are found
in the caption file. You can override this with '-sort date' and '-sort name'
If your editor doesn't handle tabs very well, then you can separate the
fields by double-colons, but only if the caption line doesn't contain any
tabs at all:
003.gif :: Ani DiFranco :: My fiancee :: Yowsers!
If you only want captions on image pages (not on album pages) use:
% album -no_album_captions
If you want web access to create/edit your captions, look at the
caption_edit.cgi CGI script (but be sure to limit access to the
script or anyone can change your captions!)
9: EXIF Captions
You can also specify captions that are based off of EXIF information
(Exchangeable Image File Format) which most digital cameras add to images.
First you need 'jhead' installed. You should be able to run jhead
on a JPG file and see the comments and information.
EXIF captions are added after the normal captions and are specified with -exif:
% album -exif "<br>File: %File name% taken with %Camera make%"
Any %tags% found will be replaced with EXIF information. If any %tags%
aren't found in the EXIF information, then that EXIF caption string is
thrown out. Because of this you can specify multiple -exif strings:
% album -exif "<br>File: %File name% " -exif "taken with %Camera make%"
This way if the 'Camera make' isn't found you can still get the 'File name'
caption.
Like any of the array style options you can use --exif as well:
% album --exif "<br>File: %File name% " "taken with %Camera make%" --
Note that, as above, you can include HTML in your EXIF tags:
% album -exif "<br>Aperture: %Aperture%"
To see the possible EXIF tags (Resolution, Date/Time, Aperture, etc..)
run a program like 'jhead' on an digital camera image.
You can also specify EXIF captions only for album or image pages, see
the -exif_album and -exif_image options.
10: Headers and Footers
In each album directory you can have text files header.txt and footer.txt
These will be copied verbatim into the header and footer of your album (if
it's supported by the theme).
11: Hiding Files/Directories
Any files that album does not recognize as image types are ignored.
To display these files, use -no_known_images. (-known_images is default)
You can mark an image as a non-image by creating an empty file with
the same name with .not_img added to the end.
You can ignore a file completely by creating an empty file with
the same name with .hide_album on the end.
You can avoid running album on a directory (but still include it in your
list of directories) by creating a file <dir>/.no_album
You can ignore directories completely by creating a file <dir>/.hide_album
The Windows version of album doesn't use dots for no_album, hide_album
and not_img because it's difficult to create .files in Windows.
12: Cropping Images
If your images are of a large variety of aspect ratios (i.e., other than
just landscape/portrait) or if your theme only allows one orientation,
then you can have your thumbnails cropped so they all fit the same geometry:
% album -crop
The default cropping is to crop the image to center. If you don't
like the centered-cropping method that the album uses to generate
thumbnails, you can give directives to album to specify where to crop
specific images. Just change the filename of the image so it has a
cropping directive before the filetype. You can direct album to crop
the image at the top, bottom, left or right. As an example, let's
say you have a portrait "Kodi.gif" that you want cropped on top for
the thumbnail. Rename the file to "Kodi.CROPtop.gif" and this will
be done for you (you might want to -clean out the old thumbnail).
The "CROP" string will be removed from the name that is printed in
the HTML.
The default geometry is 133x133. This way landscape images will
create 133x100 thumbnails and portrait images will create 100x133
thumbnails. If you are using cropping and you still want your
thumbnails to have that digital photo aspect ratio, then try 133x100:
% album -crop -geometry 133x100
Remember that if you change the -crop or -geometry settings on a
previously generated album, you will need to specify -force once
to regenerate all your thumbnails.
13: Video
album can generate snapshot thumbnails of many video formats if you
install ffmpeg
If you are running linux on an x86, then you can just grab the binary,
otherwise get the whole package from ffmpeg.org (it's an easy install).
14: Burning CDs (using file://)
If you are using album to burn CDs or you want to access your albums with
file://, then you don't want album to assume "index.html" as the default
index page since the browser probably won't. Furthermore, if you use
themes, you must use relative paths. You can't use -theme_url because
you don't know what the final URL will be. On Windows the theme path
could end up being "C:/Themes" or on UNIX or OSX it could be something
like "/mnt/cd/Themes" - it all depends on where the CD is mounted.
To deal with this, use the -burn option:
% album -burn ...
This requires that the paths from the album to the theme don't change.
The best way to do this is take the top directory that you're going to
burn and put the themes and the album in that directory, then specify
the full path to the theme. For example, create the directories:
myISO/Photos/
myISO/Themes/Blue
Then you can run:
% album -burn -theme myISO/Themes/Blue myISO/Photos
Then you can make a CD image from the myISO directory (or higher).
If you are using 'galbum' (the GUI front end) then you can't specify
the full path to the theme, so you'll need to make sure that the version
of the theme you want to burn is the first one found in the theme_path
(which is likely based off the data_path). In the above example you
could add 'myISO' to the top of the data_path, and it should
use the 'myISO/Themes/Blue' path for the Blue theme.
You can also look at shellrun for windows users, you can have it
automatically launch the album in a browser. (Or see winopen)
15: Indexing your entire album
To navigate an entire album on one page use the caption_index tool.
It uses the same options as album (though it ignores many
of them) so you can just replace your call to "album" with "caption_index"
The output is the HTML for a full album index.
See an example index
for one of my example photo albums16: Updating Albums With CGI
First you need to be able to upload the photo to the album directory.
I suggest using ftp for this. You could also write a javascript that
can upload files, if someone could show me how to do this I'd love to know.
Then you need to be able to remotely run album. To avoid abuse, I
suggest setting up a CGI script that touches a file (or they can just
ftp this file in), and then have a cron job that checks for that
file every few minutes, and if it finds it it removes it and runs album.
[unix only] (You will probably need to set $PATH or use absolute paths
in the script for convert)
If you want immediate gratification, you can run album from a CGI script
such as this one.
If your photos are not owned by the webserver user, then you
need to run through a setud script which you run from a CGI [unix only].
Put the setuid script in a secure place, change it's ownership to be the
same as the photos, and then run "chmod ug+s" on it. Here are example
setuid and CGI scripts. Be sure to edit them.
Also look at caption_edit.cgi which allows you (or others) to edit
captions/names/headers/footers through the web.
1: Methods
There are easy ways and complicated ways to create a custom theme,
depending on what you want to be able to do.
2: Editing current theme HTML
If you just want to slightly change the theme to match the output
of your site, it might make sense to edit a current theme.
In the theme directory there are two *.th files. album.th is
the template for album pages (the thumbnail pages) and image.th
is the template for image pages (where you can see medium or full
size images). The files are very similar to HTML except for
some embedded <: ePerl :> code. Even if you don't know perl or
ePerl you can still edit the HTML to make simple changes.
Good starting themes:
Any simmer_theme is going to be up to date and clean, such as "Blue" or
"Maste." If you only need 4 corner thumbnail borders then take a look
at "Eddie Bauer." If you want overlay/transparent borders, see FunLand.
If you want something demonstrating a minimal amount of code, try "simple"
but be warned that I haven't touched the theme in a long time.
3: The easy way, simmer_theme from graphics.
Most themes have the same basic form, show a bunch of thumbnails
for directories and then for images, with a graphic border, line and
background. If this is what you want, but you want to create new
graphics, then there is a tool that will build your themes for you.
If you create a directory with the images and a CREDIT file as well
as a Font or Style.css file, then simmer_theme will create theme for you.
Files:
Font/Style.css
This determines the fonts used by the theme. The "Font" file is the
older system, documented below. Create a Style.css file and define
styles for: body, title, main, credit and anything else you like.
See FunLand for a simple example.
Alternatively, use a font file. An example Font file is:
--------------------------------------------------
$TITLE_FONT = "size='4' color='#ffffff' face='Times New Roman,Georgia,Times'";
$MAIN_FONT = "face='Times New Roman,Georgia,Times'";
$CREDIT_FONT = "size='-1' face='Verdana' color='#ffffff'";
$BODY = "background='$PATH/bkgrnd.gif' link='#0099FF'">
--------------------------------------------------
CREDIT
The credit file is two lines and is used for the theme index at MarginalHacks.
If you're never submitting your theme to us, then you don't need this file.
(But please do!) If so, the two lines (and only two lines) are:
1) A short description of the theme (keep it all on one line)
2) Your name (can be inside a mailto: or href link)
Null.gif
Each simmer theme needs a spacer image, this is a 1x1 transparent gif.
You can just copy this from another simmer theme.
Optional image files:
Bar Images
The bar is composed of Bar_L.gif, Bar_R.gif and Bar_M.gif in the middle.
The middle is stretched. If you need a middle piece that isn't stretched, use:
Bar_L.gif, Bar_ML.gif, Bar_M.gif, Bar_MR.gif, Bar_R.gif
And then the Bar_ML.gif and Bar_MR.gif will be stretched. (See the
Craftsman theme for an example of this).
Locked.gif
A lock image for any directories that have .htaccess
Background image
If you want a background image, specify it in the Font file in the $BODY
section, as in the example above. The $PATH variable will be replaced
with the path to the theme files:
More.gif
When an album page has sub-albums to list, it first shows the 'More.gif'
image.
Next.gif, Prev.gif, Back.gif
For the next and previous arrows and the back button
Icon.gif
Shown at the top left by the parent albums, this is often just the text "Photos"
Border Images
There are many ways to slice up a border, from simple to complex, depending on
the complexity of the border and how much you want to be able to stretch it:
4 pieces Uses Bord_L.gif, Bord_R.gif, Bord_T.gif, Bord_B.gif
(The corners go with the left and right images)
4 piece borders usually don't stretch well so they don't work well on
image_pages. Generally you can cut the corners out of the left and
right images to make:
8 pieces Also includes Bord_TL.gif, Bord_TR.gif, Bord_BL.gif, Bord_BR.gif
8 piece borders allow you to stretch to handle most sized images
12 pieces Also includes Bord_LT.gif, Bord_RT.gif, Bord_LB.gif, Bord_RB.gif
12 pieces allow stretching of borders that have more complex corners (such
as Dominatrix6 or Ivy)
Overlay Borders Can use transparent images that can be partially
overlaying your thumbnail. See below.
Here's how the normal border pieces are laid out:
12 piece borders
TL T TR 8 piece borders 4 piece borders
LT RT TL T TR TTTTTTT
L IMG R L IMG R L IMG R
LB RB BL B BR BBBBBBB
BL B BR
Note that every row of images must be the same height, though the
widths do not have to line up. (i.e., height TL = height T = height TR)
(This is not true about overlay borders!)
Once you've created these files, you can run the simmer_theme tool
(an optional tool download at MarginalHacks.com) and your theme will
then be ready to use!
If you need different borders for the image pages, then use the same
filenames prefixed by 'I' - such as IBord_LT.gif, IBord_RT.gif,...
Overlay borders allow for really fantastic effects with image borders.
Currently there's no support for different overlay borders for images.
For using Overlay borders, create images:
Over_TL.png Over_T.png Over_TR.png
Over_L.png Over_R.png
Over_BL.png Over_B.png Over_BR.png
Then figure out how many pixels of the borders are padding (outside photo)
Then put those values in files: Over_T.pad Over_R.pad Over_B.pad Over_L.pad
See "Themes/FunLand" for a simple example
Multi-lingual Images
If your images have text, you can translate them into other languages
so that albums can be generated in other languages. For example, you
can create a Dutch "More.gif" image and put it in 'lang/nl/More.gif'
in the theme (nl is the language code for Dutch).
When the user runs album in Dutch (album -lang nl) then the theme
will use the Dutch image if found. Themes/Blue has a simple example.
The currently "translated" images are:
More, Back, Next, Prev and Icon
You can create an HTML table that shows the translations immediately
available to themes with -list_html_trans:
% album -list_html_trans > trans.html
Then view trans.html in a browser. Unfortunately different languages
have different charsets, and an HTML page can only have one. The
output is in utf-8, but you can edit the "charset=utf-8" to properly
view language characters in different charsets (such as hebrew).
If you need more words translated for themes, let me know, and if you
create any new language images for a theme, please send them to me!
4: From scratch, Theme API
This is a much heavier job - you need to have a very clear idea of
how you want album to place the images on your page. It might be
a good idea to start with modifying existing themes first to get
an idea of what most themes do. Also look at existing themes
for code examples (see suggestions above).
Themes are directories that contain at the minimum an 'album.th' file.
This is the album page theme template. Often they also contain an 'image.th'
which is the image theme template, and any graphics/css used by the theme.
Album pages contain thumbnails and image pages show full/medium sized images.
The .th files are ePerl, which is perl embedded inside of HTML. They
end up looking a great deal like the actual album and image HTML themselves.
To write a theme, you'll need to understand the ePerl syntax. You can
find more information from the actual ePerl tool available at MarginalHacks
(though this tool is not needed to use themes in album).
There are a plethora of support routines available, but often only
a fraction of these are necessary - it may help to look at other themes
to see how they are generally constructed.
Function table:
Required Functions
Meta() Must be called in the section of HTML
Credit() Gives credit ('this album created by..')
Must be called in the section of HTML
Body_Tag() Called inside the actual tag.
Paths and Options
Option($name) Get the value of an option/configuration setting
Version() Return the album version
Version_Num() Return the album version as just a number (i.e. "3.14")
Path($type) Returns path info for $type of:
album_name The name of this album
dir Current working album directory
album_file Full path to the album index.html
album_path The path of parent directories
theme Full path to the theme directory
img_theme Full path to the theme directory from image pages
page_post_url The ".html" to add onto image pages
parent_albums Array of parent albums (album_path split up)
Image_Page() 1 if we're generating an image page, 0 for album page.
Page_Type() Either 'image_page' or 'album_page'
Theme_Path() The filesystem path to the theme files
Theme_URL() The URL path to the theme files
Header and Footer
isHeader(), pHeader() Test for and print the header
isFooter(), pFooter() Same for the footer
Generally you loop through the images and directories using local variables:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
This will print the name of each image. Our object types are either 'pics'
for images or 'dirs' for the child directories. Here are the object functions:
Objects (type is either 'pics' (default) or 'dirs')
First($type) Get the first image or sub-album object.
Last($type) Last object
Next($obj) Given an object, return the next object
Next($obj,1) Same, loop past end to beginning.
Prev($obj), Prev($obj,1) Similar to Next()
num('pics') or just num() Total number of images in this album
num('dirs') Total number of children/sub-albums
Also:
num('parent_albums') Total number of parents leading up to this album.
Object lookup:
get_obj($num, $type, $loop)
Finds object by number ('pics' or 'dirs').
If $loop is set than the count will wrap around.
Object Properties
Each object (image or child albums) has properties.
Some properties are accessed by a single field:
Get($obj,$field) Get a single field of an object
Field Description
----- ----------
type What type of object? Either 'pics' or 'dirs'
is_movie Boolean: is this a movie?
name Name (cleaned and optionally from captions)
cap Image caption
capfile Optional caption file
alt Alt tag
num_pics [directories only, -dir_thumbs] Num of pics in directory
num_dirs [directories only, -dir_thumbs] Num of dirs in directory
Some properties are accessed by a field and subfield. For example,
each image has information for different sizes: full, medium and thumb
(though 'medium' is optional).
Get($obj,$size,$field) Get a property for a given size
Size Field Description
---- ----- ----------
$size x Width
$size y Height
$size file Filename (without path)
$size path Filename (full path)
$size filesize Filesize in bytes
full tag The tag (either 'image' or 'embed') - only for 'full'
We also have URL information which is access according to the
page it's coming 'from' and the image/page it's pointing 'to':
Get($obj,'URL',$from,$to) Get a URL for an object from -> to
Get($obj,'href',$from,$to) Same but wraps it in an 'href' string.
Get($obj,'link',$from,$to) Same but wraps the object name inside the href link.
From To Description
---- -- ----------
album_page image Image_URL from album_page
album_page thumb Thumbnail from album_page
image_page image Image_URL from image_page
image_page image_page This image page from another image page
image_page image_src The <img src> URL for the image page
image_page thumb Thumbnail from image_page
Directory objects also have:
From To Description
---- -- ----------
album_page dir URL to the directory from it's parent album page
Parent Albums
Parent_Album($num) Get a parent album string (including the href)
Parent_Albums() Return a list of the parent albums strings (including href)
Parent_Album($str) A join($str) call of Parent_Albums()
Back() The URL to go back or up one page.
Images
This_Image The image object for an image page
Image($img,$type) The <img> tags for type of medium,full,thumb
Image($num,$type) Same, but by image number
Name($img) The clean or captioned name for an image
Caption($img) The caption for an image
Child Albums
Name($alb)
Caption($img) The caption for an image
Convenience Routines
Pretty($str,$html,$lines) Pretty formats a name.
If $html then HTML is allowed (i.e., use 0 for <title> and the like)
Currently just puts prefix dates in a smaller font (i.e. '2004-12-03.Folder')
If $lines then multilines are allowed
Currently just follows dates with a 'br' line break.
New_Row($obj,$cols,$off) Should we start a new row after this object?
Use $off if the first object is offset from 1
Image_Array($src,$x,$y,$also,$alt)
Returns an <img> tag given $src, $x,...
Image_Ref($ref,$also,$alt)
Like Image_Array, but $ref can be a hash of
Image_Arrays keyed by language ('_' is default).
album picks the Image_Array by what languages are set.
Border($img,$type,$href,@border)
Border($str,$x,$y,@border)
Create the full bordered image.
See 'Borders' for more information.
If you're creating a theme from scratch, consider adding support for -slideshow.
The easiest way to do this is to cut/paste the "slideshow" code out of an
existing theme.
5: Submitting Themes
Have a custom theme? I'd love to see it, even if it's totally site-specific.
If you have a new theme you'd like to offer the public, feel free to send
it to me and/or a URL where I can see how it looks. Be sure to set the CREDIT
file properly and let me know if you are donating it to MarginalHacks for
everyone to use or if you want it under a specific license.
6: Converting v2.0 Themes to v3.0 Themes
album v2.0 introduced a theme interface which has been rewritten. Most
2.0 themes (especially those that don't use many of the global variables)
will still work, but the interface is deprecated and may disappear in
the near future.
It's not difficult to convert from v2.0 to v3.0 themes.
The v2.0 themes used global variables for many things. These are now
deprecated In v3.0 you should keep track of images and directories in
variables and use the 'iterators' that are supplied, for example:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Will loop through all the images and print their names.
The chart below shows you how to rewrite the old style calls which
used a global variable with the new style which uses a local variable,
but to use these calls you need to rewrite your loops as above.
Here is a conversion chart for helping convert v2.0 themes to v3.0:
# Global vars shouldn't be used
# ALL DEPRECATED - See new local variable loop methods above
$PARENT_ALBUM_CNT Rewrite with: Parent_Album($num) and Parent_Albums($join)
$CHILD_ALBUM_CNT Rewrite with: my $dir = First('dirs'); $dir=Next($dir);
$IMAGE_CNT Rewrite with: my $img = First('pics'); $pics=Next($pics);
@PARENT_ALBUMS Can instead use: @{Path('parent_albums')}
@CHILD_ALBUMS, @CHILD_ALBUM_NAMES, @CHILD_ALBUM_URLS, ...
# Old global variable modifiers:
# ALL DEPRECATED - See new local variable loop methods above
Next_Image(), Images_Left(), Image_Cnt(), Image_Prev(), Image_Next()
Set_Image_Prev(), Set_Image_Next(), Set_Image_This()
Next_Child_Album(), Child_Album_Cnt(), Child_Albums_Left()
# Paths and stuff
pAlbum_Name() Path('album_name')
Album_Filename() Path('album_file')
pFile($file) print read_file($file)
Get_Opt($option) Option($option)
Index() Option('index')
pParent_Album($str) print Parent_Album($str)
# Parent Albums
Parent_Albums_Left Deprecated, see '$PARENT_ALBUM_CNT' above
Parent_Album_Cnt Deprecated, see '$PARENT_ALBUM_CNT' above
Next_Parent_Album Deprecated, see '$PARENT_ALBUM_CNT' above
pJoin_Parent_Albums print Parent_Albums(\@_)
# Images, using variable '$img'
pImage() Use $img instead and:
print Get($img,'href','image');
print Get($img,'thumb') if Get($img,'thumb');
print Name($img), "</a>";
pImage_Src() print Image($img,'full')
Image_Src() Image($img,'full')
pImage_Thumb_Src() print Image($img,'thumb')
Image_Name() Name($img)
Image_Caption() Caption($img)
pImage_Caption() print Get($img,'Caption')
Image_Thumb() Get($img,'URL','thumb')
Image_Is_Pic() Get($img,'thumb')
Image_Alt() Get($img,'alt')
Image_Filesize() Get($img,'full','filesize')
Image_Path() Get($img,'full','path')
Image_Width() Get($img,'medium','x') || Get($img,'full','x')
Image_Height() Get($img,'medium','y') || Get($img,'full','y')
Image_Filename() Get($img,'full','file')
Image_Tag() Get($img,'full','tag')
Image_URL() Get($img,'URL','image')
Image_Page_URL() Get($img,'URL','image_page','image_page') || Back()
# Child album routines, using variable '$alb'
pChild_Album($nobr) print Get($alb,'href','dir');
my $name = Name($alb);
$name =~ s/<br>//g if $nobr;
print $name,"</a>";
Child_Album_Caption() Caption($alb,'dirs')
pChild_Album_Caption() print Child_Album_Caption($alb)
Child_Album_URL() Get($alb,'URL','dir')
Child_Album_Name() Name($alb)
# Unchanged
Meta() Meta()
Credit() Credit()
album-4.17/Docs/hu/txt_2 0000655 0000000 0000000 00000015133 11012410266 013530 0 ustar root root MINI HOW-TO
ITEM: Egyszerű album
Az album program telepítése után próbáljuk ki
a következő egyszerű példákat! Probléma esetén vegyük
igénybe a telepítési útmutató segítségét!
A sablonok (theme-ek) és a fotóalbum tárolásához hozzunk létre
egy könyvtárat, ebben a leírásban a /home/httpd/test könyvtárat
fogjuk használni. Olyan könyvtárat kell választanunk, amelyet a
web szerver is megtalál. Példánkban a http://myserver/test címet fogjuk
használni, itt éri el a web szerver a "test" könyvtárunkat.
Először hozzunk létre egy könyvtárat, és másoljuk bele a képeket!
Legyen ez a könyvtár a /home/httpd/test/Photos.
A képek neve a példában 'IMG_001.jpg', ..., 'IMG_004.jpg'.
A legegyszerűbb album létrehozásához adjuk ki a következő utasítást:
% album /home/httpd/test/Photos
Ezek után a a fényképalbumot egy web böngészővel a következő címen
érhetjük el:
http://myserver/test/Photos
ITEM: A fotók feliratozása
Készítsük el a /home/httpd/test/Photos/captions.txt fájlt a
következő tartalommal (használjuk a "tab" gombot a " [tab] "
helyén):
-- captions.txt ---------
IMG_001.jpg [tab] Az első kép neve
IMG_002.jpg [tab] Második kép
IMG_003.jpg [tab] Újabb kép [tab] micsoda felirat!
IMG_004.jpg [tab] Utolsó kép [tab] újabb felirat.
-------------------------
Ezután futtassuk újra az album programot:
% album /home/httpd/test/Photos
és íme, a feliratok megjelentek.
Most készítsük el a /home/httpd/test/Photos/header.txt fájlt,
benne tetszőleges szöveggel. Az album program futtatása után
a felirat megjelenik az oldal tetején.
ITEM: Képek elrejtése
Képek, fájlok vagy könyvtárak többféleképpen is elrejthetők. Most
a captions.txt fájl segítségével mutatjuk be képek elrejtését.
A "#" jelet írjuk be valamelyik sor elejére:
-- captions.txt ---------
IMG_001.jpg [tab] Az első kép neve
#IMG_002.jpg [tab] Második kép
IMG_003.jpg [tab] Újabb kép [tab] micsoda felirat!
IMG_004.jpg [tab] Utolsó kép [tab] újabb felirat.
-------------------------
Az album program futtatása után látható, hogy az IMG_002.jpg nevű
kép hiányzik. Ha ezt az album program első futtatása előtt csináltuk
volna, akkor a közepes és a kis méretű képeket (ikonokat) nem is
készítette volna el a program. Ezek a most már felesleges képek
utólag is eltávolíthatók a -clean kapcsoló használatával:
% album -clean /home/httpd/test/Photos
ITEM: Sablonok használata
Amennyiben a sablonok megfelelően telepítve vannak, és
theme_path a sablonok helyét jelzi, akkor a sablonok
használhatók a következőképpen:
% album -theme Blue /home/httpd/test/Photos
Ekkor a kész fotóalbum a Blue nevű sablont használja. Ha az
albumban meg nem jelenített képeket találunk, akkor valószínűleg
olyan könyvtárba lett telepítve a sablon, amelyet a böngészőprogram
nem ér el, a részletekért l. a telepítési útmutatót.
A program futáskor elmenti az alkalmazott beállításokat, így ha a
következő alkalommal futtatjuk a programot:
% album /home/httpd/test/Photos
még mindig a Blue sablont használja. A sablon kikapcsolásához a
következő parancsot használjuk:
% album -no_theme /home/httpd/test/Photos
ITEM: Közepes méretű képek
A teljes méretű fényképek rendszerint túl nagyok egy webes albumhoz,
ezért az album oldalakon közepes méretű képeket használunk:
% album -medium 33% /home/httpd/test/Photos
A teljes méretű képek nem vesznek el, alapesetben
a közepes méretű képre kattintva
tekinthetjük meg őket, vagy az
% album -just_medium /home/httpd/test/Photos
parancs alkalmazásával elérhetjük, hogy a teljes méretű képekre ne
helyezzen el linket a program (feltéve, hogy előtte a -medium kapcsolóval
hívtuk a programot valamikor).
ITEM: EXIF feliratok használata
Megadhatjuk például, hogy a fénykép készítésekor alkalmazott apertúra
belekerüljön a képek feliratába:
% album -exif "<br>apertúra=%Aperture%" /home/httpd/test/Photos
Ez a parancs csak azon képek feliratához írja hozzá az apertúrára vonatkozó információt,
amelyek exif információjában szerepel az "Aperture" kulcsszó (a "%" jelek közti
rész jelenik meg a feliratban). Az előző parancsban szereplő <br>
hatására az exif információ a kép feliratában új sorban jelenik meg.
Egyéb exif információ is elhelyezhető a feliratban, pl:
% album -exif "<br>fókusz: %FocalLength%" /home/httpd/test/Photos
Mivel az előző futtatáskor a program elmentette a beállításokat, most
mindkét exif információ megjelenik a képek feliratában: az apertúra és a
fókusztávolság is. Ha törölni akarjuk az apertúrára vonatkozó részt:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
A "-no_exif" kapcsolónak pontosan meg kell egyeznie a korábban megadott
-exif kapcsolónál megadott résszel, különben a program figyelmen kívül hagyja.
A program által elmentett konfigurációs állományt is szabadon meg lehet változtatni:
/home/httpd/test/Photos/album.conf
Itt is lehet törölni a kérdéses részt.
ITEM: További albumok hozzáadása
Tegyük fel, hogy a spanyolországi nyaralás során készült képeket a
/home/httpd/test/Photos/Spain/
könyvtárban helyeztük el. Futtassuk most az album programot az
összes képet tartalmazó könyvtárra:
% album /home/httpd/test/Photos
Ez a parancs elkészíti az albumot a Photos könyvtárban, majd készít egy linket a
Spain könyvtárra, és ugyanazon beállításokkal, sablonnal elkészíti az
albumot a Spain alkönyvtárban is.
Újabb utazást követően a képeket a következő könyvtárba tesszük:
/home/httpd/test/Photos/Italy/
Újra futtatva a programot az összes képet tartalmazó könyvtárra:
% album /home/httpd/test/Photos
Ez a parancs újra feldolgozza a Spain könyvtárat is, ami nem változott.
Az album program nem készít újabb HTML oldalakat vagy kis méretű
képeket, ha azokat már korábban elkészítette, de a feleslegesen feldolgozott
könyvtárak így is feleslegesen töltik az időt, különösen nagy albumok
esetén. Ennek elkerülésére megadhatjuk, hogy csak az új könyvtárat
dolgozza fel:
% album -add /home/httpd/test/Photos/Italy
Ez az eredeti albumhoz hozzáadja a linket az új albumhoz, és elkészíti
az Italy albumot.
ITEM: Fordította:
György Károlyi [http://www.me.bme.hu/~karolyi/indexe.html]
album-4.17/Docs/hu/Section_5.html 0000644 0000000 0000000 00000047523 12661460265 015310 0 ustar root root
MarginalHacks album - Feature Requests, Bugs, Patches and Troubleshooting
- Documentation
A l b u m
F i v e - - F e a t u r e R e q u e s t s , B u g s , P a t c h e s a n d T r o u b l e s h o o t i n g
1: Feature Requests
If there's something you want added to album, first make sure
it doesn't already exist! Check the man page or the usage:
% man album% album -h
Also see -more and -usage options.
If you don't see it there, consider writing a patch or a plugin.
2: Bug reports
Before you submit a bug, please make sure you have the most current release of album!
When submitting a bug, I need to know at least:
1) Your operating system
2) The exact problem and the exact error messages
I'd also like to know, if possible:
1) The exact album command you ran
2) The output from the command
And I generally also need the debug output of album:
% album -d
Finally, make sure that you've got the most current
version of album, and the most current themes as well.
3: Writing Patches, Modifying album
If you want to modify album, you might want to check with me
first to make sure it's not already on my development plate.
If not, then consider writing it as a plugin instead of patching
the album source. This avoids adding complexity to album for
features that may not be globally used.
If it needs to go into album (for example, if it's a bug), then
please make sure to first download the most recent copy of album
first, then patch that and send me either a diff, a patch, or the
full script. If you comment off the changes you make that'd be great too.
4: Known Bugs
v3.11: -clear_* and -no_* doesn't clear out parent directory options.
v3.10: Burning CDs doesn't quite work with theme absolute paths.
v3.00: Array and code options are saved backwards, for example:
"album -lang aa .. ; album -lang bb .." will still use language 'aa'
Also, in some cases array/code options in sub-albums will not
be ordered right the first time album adds them and you may
need to rerun album. For example:
"album -exif A photos/ ; album -exif B photos/sub"
Will have "B A" for the sub album, but "A B" after: "album photos/sub"
5: PROBLEM: My index pages are too large!
I get many requests to break up the index pages after reaching a certain
threshold of images.
The problem is that this is hard to manage - unless the index pages are
treated just like sub-albums, then you now have three major components
on a page, more indexes, more albums, and thumbnails. And not only is
that cumbersome, but it would require updating all the themes.
Hopefully the next major release of album will do this, but until then
there is another, easier solution - just break the images up into
subdirectories before running album.
I have a tool that will move new images into subdirectories for you and
then runs album:
in_album6:ERROR: no delegate for this image format (./album)
You have the album script in your photo directory and it can't make
a thumbnail of itself! Either:
1) Move album out of the photo directory (suggested)
2) Run album with -known_images
7:ERROR: no delegate for this image format (some_non_image_file)
Don't put non-images in your photo directory, or else run with -known_images.
8:ERROR: no delegate for this image format (some.jpg)9:ERROR: identify: JPEG library is not available (some.jpg)
Your ImageMagick installation isn't complete and doesn't know how
to handle the given image type.
10:ERROR: Can't get [some_image] size from -verbose output.
ImageMagick doesn't know the size of the image specified. Either:
1) Your ImageMagick installation isn't complete and can't handle the image type.
2) You are running album on a directory with non-images in it without
using the -known_images option.
If you're a gentoo linux user and you see this error, then run this command
as root (thanks Alex Pientka):
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
1: Configuration Files
Album behavior can be controlled through command-line options, such as:
% album -no_known_images% album -geometry 133x100% album -exif "File: %File name% " -exif "taken with %Camera make%"
But these options can also be specified in a configuration file:
# Example configuration file # comments are ignored
known_images 0 # known_images=0 is same as no_known_images
geometry 133x100
exif "File: %File name% "
exif "taken with %Camera make%"
The configuration file format is one option per line optionally followed
by whitespace and the option value. Boolean options can be set without
the option value or can be cleared/set with 0 and 1.
2: Location Of Configuration Files
album looks for configuration files in a few locations, in order:
/etc/album/conf System-wide settings
/etc/album.conf System-wide settings
$BASENAME/album.conf In the 'album' install directory
$HOME/.albumrc User specific settings
$HOME/.album.conf User specific settings
$DOT/album.conf User specific (I keep my dot files elsewhere)
$USERPROFILE/album.conf For Windows (C:\Documents and Settings\TheUser)
album also looks for album.conf files inside the photo album directories.
Sub-albums can also have album.conf which will alter the settings
from parent directories (this allows you to, for example, have a
different theme for part of your photo album). Any album.conf files
in your photo album directories will configure the album and any sub-albums
unless overridden by any album.conf settings found in a sub-album.
As an example, consider a conf for a photo album at 'images/album.conf':
theme Dominatrix6
columns 3
And another conf inside 'images/europe/album.conf':
theme Blue
crop
album will use the Dominatrix6 theme for the images/ album and all of
it's sub-albums except for the images/europe/ album which will use
the Blue theme. All of the images/ album and sub-albums will have
3 columns since that wasn't changed in the images/europe/ album, however
all of the thumbnails in images/europe/ and all of it's sub-albums
will be cropped due to the 'crop' configuration setting.
3: Saving Options
Whenever you run an album, the command-line options are saved in
an album.conf inside the photo album directory. If an album.conf
already exists it will be modified not overwritten, so it is safe
to edit this file in a text editor.
This makes it easy to make subsequent calls to album. If you
first generate an album with:
% album -crop -no_known_images -theme Dominatrix6 -sort date images/
Then the next time you call album you can just:
% album images/
This works for sub-albums as well:
% album images/africa/
Will also find all of the saved options.
Some 'one-time only' options are not saved for obvious reasons, such
as -add, -clean, -force, -depth, etc..
Running album multiple times on the same directories can
get confusing if you don't understand how options are saved.
Here are some examples.
Premises:
1) Command-line options are processed before conf options found
in the album directory.
2) Album should run the same the next time you call it if you
don't specify any options.
For example, consider running album twice on a directory:
% album -exif "comment 1" photos/spain% album photos/spain
The second time you run album you'll still get the "comment 1"
exif comment in your photos directory.
3) Album shouldn't end up with multiple copies of the same array
options if you keep calling it with the same command-line
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 1" photos/spain
The second time you run album you will NOT end up with multiple
copies of the "comment 1" exif comment.
However, please note that if you re-specify the same options
each time, album may run slower because it thinks it needs to
regenerate your html!
As an example, if you run:
% album -medium 640x640 photos/spain
(then later...)
% album -medium 640x640 photos/spain
Then the second time will unnecessarily regenerate all your
medium images. This is much slower.
It's better to specify command-line options only the first time
and let them get saved, such as:
% album -medium 640x640 photos/spain
(then later...)
% album photos/spain
Unfortunately these constraints mean that any new array options will
be put at the beginning of your list of -exif options.
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 2" photos/spain
The comments will actually be ordered "comment 2" then "comment 1"
To specify exact ordering, you may need to re-specify all options.
Either specify "comment 1" to put it back on top:
% album -exif "comment 1" photos/spain
Or just specify all the options in the order you want:
% album -exif "comment 1" -exif "comment 2" photos/spain
Sometimes it may be easier to merely edit the album.conf file directly
to make any changes.
Finally, this only allows us to accumulate options.
We can delete options using -no and -clear, see the section on Options,
these settings (or clearings) will also be saved from run to run.
1: Egyszerű album
Az album program telepítése után próbáljuk ki
a következő egyszerű példákat! Probléma esetén vegyük
igénybe a telepítési útmutató segítségét!
A sablonok (theme-ek) és a fotóalbum tárolásához hozzunk létre
egy könyvtárat, ebben a leírásban a /home/httpd/test könyvtárat
fogjuk használni. Olyan könyvtárat kell választanunk, amelyet a
web szerver is megtalál. Példánkban a http://myserver/test címet fogjuk
használni, itt éri el a web szerver a "test" könyvtárunkat.
Először hozzunk létre egy könyvtárat, és másoljuk bele a képeket!
Legyen ez a könyvtár a /home/httpd/test/Photos.
A képek neve a példában 'IMG_001.jpg', ..., 'IMG_004.jpg'.
A legegyszerűbb album létrehozásához adjuk ki a következő utasítást:
% album /home/httpd/test/Photos
Ezek után a a fényképalbumot egy web böngészővel a következő címen
érhetjük el:
http://myserver/test/Photos
2: A fotók feliratozása
Készítsük el a /home/httpd/test/Photos/captions.txt fájlt a
következő tartalommal (használjuk a "tab" gombot a " [tab] "
helyén):
-- captions.txt ---------
IMG_001.jpg [tab] Az első kép neve
IMG_002.jpg [tab] Második kép
IMG_003.jpg [tab] Újabb kép [tab] micsoda felirat!
IMG_004.jpg [tab] Utolsó kép [tab] újabb felirat.
-------------------------
Ezután futtassuk újra az album programot:
% album /home/httpd/test/Photos
és íme, a feliratok megjelentek.
Most készítsük el a /home/httpd/test/Photos/header.txt fájlt,
benne tetszőleges szöveggel. Az album program futtatása után
a felirat megjelenik az oldal tetején.
3: Képek elrejtése
Képek, fájlok vagy könyvtárak többféleképpen is elrejthetők. Most
a captions.txt fájl segítségével mutatjuk be képek elrejtését.
A "#" jelet írjuk be valamelyik sor elejére:
-- captions.txt ---------
IMG_001.jpg [tab] Az első kép neve
#IMG_002.jpg [tab] Második kép
IMG_003.jpg [tab] Újabb kép [tab] micsoda felirat!
IMG_004.jpg [tab] Utolsó kép [tab] újabb felirat.
-------------------------
Az album program futtatása után látható, hogy az IMG_002.jpg nevű
kép hiányzik. Ha ezt az album program első futtatása előtt csináltuk
volna, akkor a közepes és a kis méretű képeket (ikonokat) nem is
készítette volna el a program. Ezek a most már felesleges képek
utólag is eltávolíthatók a -clean kapcsoló használatával:
% album -clean /home/httpd/test/Photos4: Sablonok használata
Amennyiben a sablonok megfelelően telepítve vannak, és
theme_path a sablonok helyét jelzi, akkor a sablonok
használhatók a következőképpen:
% album -theme Blue /home/httpd/test/Photos
Ekkor a kész fotóalbum a Blue nevű sablont használja. Ha az
albumban meg nem jelenített képeket találunk, akkor valószínűleg
olyan könyvtárba lett telepítve a sablon, amelyet a böngészőprogram
nem ér el, a részletekért l. a telepítési útmutatót.
A program futáskor elmenti az alkalmazott beállításokat, így ha a
következő alkalommal futtatjuk a programot:
% album /home/httpd/test/Photos
még mindig a Blue sablont használja. A sablon kikapcsolásához a
következő parancsot használjuk:
% album -no_theme /home/httpd/test/Photos5: Közepes méretű képek
A teljes méretű fényképek rendszerint túl nagyok egy webes albumhoz,
ezért az album oldalakon közepes méretű képeket használunk:
% album -medium 33% /home/httpd/test/Photos
A teljes méretű képek nem vesznek el, alapesetben
a közepes méretű képre kattintva
tekinthetjük meg őket, vagy az
% album -just_medium /home/httpd/test/Photos
parancs alkalmazásával elérhetjük, hogy a teljes méretű képekre ne
helyezzen el linket a program (feltéve, hogy előtte a -medium kapcsolóval
hívtuk a programot valamikor).
6: EXIF feliratok használata
Megadhatjuk például, hogy a fénykép készítésekor alkalmazott apertúra
belekerüljön a képek feliratába:
% album -exif "<br>apertúra=%Aperture%" /home/httpd/test/Photos
Ez a parancs csak azon képek feliratához írja hozzá az apertúrára vonatkozó információt,
amelyek exif információjában szerepel az "Aperture" kulcsszó (a "%" jelek közti
rész jelenik meg a feliratban). Az előző parancsban szereplő <br>
hatására az exif információ a kép feliratában új sorban jelenik meg.
Egyéb exif információ is elhelyezhető a feliratban, pl:
% album -exif "<br>fókusz: %FocalLength%" /home/httpd/test/Photos
Mivel az előző futtatáskor a program elmentette a beállításokat, most
mindkét exif információ megjelenik a képek feliratában: az apertúra és a
fókusztávolság is. Ha törölni akarjuk az apertúrára vonatkozó részt:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
A "-no_exif" kapcsolónak pontosan meg kell egyeznie a korábban megadott
-exif kapcsolónál megadott résszel, különben a program figyelmen kívül hagyja.
A program által elmentett konfigurációs állományt is szabadon meg lehet változtatni:
/home/httpd/test/Photos/album.conf
Itt is lehet törölni a kérdéses részt.
7: További albumok hozzáadása
Tegyük fel, hogy a spanyolországi nyaralás során készült képeket a
/home/httpd/test/Photos/Spain/
könyvtárban helyeztük el. Futtassuk most az album programot az
összes képet tartalmazó könyvtárra:
% album /home/httpd/test/Photos
Ez a parancs elkészíti az albumot a Photos könyvtárban, majd készít egy linket a
Spain könyvtárra, és ugyanazon beállításokkal, sablonnal elkészíti az
albumot a Spain alkönyvtárban is.
Újabb utazást követően a képeket a következő könyvtárba tesszük:
/home/httpd/test/Photos/Italy/
Újra futtatva a programot az összes képet tartalmazó könyvtárra:
% album /home/httpd/test/Photos
Ez a parancs újra feldolgozza a Spain könyvtárat is, ami nem változott.
Az album program nem készít újabb HTML oldalakat vagy kis méretű
képeket, ha azokat már korábban elkészítette, de a feleslegesen feldolgozott
könyvtárak így is feleslegesen töltik az időt, különösen nagy albumok
esetén. Ennek elkerülésére megadhatjuk, hogy csak az új könyvtárat
dolgozza fel:
% album -add /home/httpd/test/Photos/Italy
Ez az eredeti albumhoz hozzáadja a linket az új albumhoz, és elkészíti
az Italy albumot.
8: Fordította:
György Károlyi [http://www.me.bme.hu/~karolyi/indexe.html]
1: Minimum Requirements
1) The album perl script
2) ImageMagick tools (specifically 'convert')
Put the 'album' script and the ImageMagick tools somewhere in your PATH,
or else call 'album' by it's full path (and specify the full path to
convert either in the album script or in the album configuration files.
2: Initial Configuration
The first time you run album it will ask you a few questions to
setup the configuration for you. If you're on UNIX/OSX, then you
can run the first time as root so that it sets up the global configuration
and themes for everyone instead of just the current user.
3: Optional Installation
3) Themes
4) ffmpeg (for movie thumbnails)
5) jhead (for reading EXIF info)
6) plugins
7) Various tools available at MarginalHacks.com
4: UNIX
Most UNIX distros come with ImageMagick and perl, so just download
the album script and themes (#1 and #3 above) and you're done.
To test your install, run the script on a directory with images:
% album /path/to/my/photos/5: Debian UNIX
album is in debian stable, though right now it's a bit stale.
I recommend getting the latest version from MarginalHacks.
You can save the .deb package, and then, as root, run:
% dpkg -i album.deb6: Macintosh OSX
It works fine on OSX, but you have to run it from a terminal window. Just
install the album script and ImageMagick tools, and type in the path to album,
any album options you want, and then the path to the directory with the
photos in them (all separated by spaces), such as:
% album -theme Blue /path/to/my/photos/7: Win95, Win98, Win2000/Win2k, WinNT, WinXP
(Windows 95, Windows 98, Windows 2000, Windows NT, Windows XP)
There are two methods to run perl scripts on Windows, either using ActivePerl
or Cygwin.
ActivePerl is simpler and allows you to run album from a DOS prompt,
though I've heard that it doesn't work with themes.
Cygwin is a bulkier but more robust package that gives you access to
a bunch of UNIX like utilities, and album is run from a bash (UNIX shell)
prompt.
Cygwin method
-------------
1) Install Cygwin
Choose packages: perl, ImageMagick, bash
Do not use the normal ImageMagick install! You must use the Cygwin ImageMagick packages!
2) Install album in bash path or call using absolute path:
bash% album /some/path/to/photos
3) If you want exif info in your captions, you need the Cygwin version of jheadActivePerl method
-----------------
1) Install ImageMagick for Windows
2) Install ActivePerl, Full install (no need for PPM profile)
Choose: "Add perl to PATH" and "Create Perl file extension association"
3) If Win98: Install tcap in path
4) Save album as album.pl in windows path
5) Use dos command prompt to run:
C:> album.pl C:\some\path\to\photosNote: Some versions of Windows (2000/NT at least) have their
own "convert.exe" in the c:\windows\system32 directory (an NTFS utility?).
If you have this, then you either need to edit your path variable,
or else just specify the full path to convert in your album script.
8: How do I edit the Windows path?Windows NT4 Users
Right Click on My Computer, select Properties.
Select Environment tab.
In System Variables box select Path.
In Value edit box add the new paths separated by semicolons
Press OK/Set, press OK again.
Windows 2000 Users
Right Click My Computer, select Properties.
Select Advanced tab.
Click Environment Variables.
In System Variables box select double-click Path
In Value edit box add the new paths separated by semicolons
Press OK/Set, press OK again.
Windows XP Users
Click My Computer, select Change a Setting.
Double click System.
Select Advanced tab.
Select Environment Variables.
In System Variables box select double-click Path
In Value edit box add the new paths separated by semicolons
Press OK.
9: Macintosh OS9
I don't have any plans to port this to OS9 - I don't know what
the state of shells and perl is for pre-OSX. If you have it working
on OS9, let me know.
album-4.17/Docs/hu/txt_4 0000655 0000000 0000000 00000000000 10313504407 017500 1album-4.17/Docs/it/txt_4 ustar root root album-4.17/Docs/hu/txt_3 0000655 0000000 0000000 00000000000 12475152364 017512 1album-4.17/Docs/it/txt_3 ustar root root album-4.17/Docs/hu/latin2.txt_2 0000644 0000000 0000000 00000014267 11010325161 014722 0 ustar root root MINI HOW-TO
ITEM: Egyszer album
Az album program teleptse utn prbljuk ki
a kvetkez egyszer pldkat! Problma esetn vegyk
ignybe a teleptsi tmutat segtsgt!
A sablonok (theme-ek) s a fotalbum trolshoz hozzunk ltre
egy knyvtrat, ebben a lersban a /home/httpd/test knyvtrat
fogjuk hasznlni. Olyan knyvtrat kell vlasztanunk, amelyet a
web szerver is megtall. Pldnkban a http://myserver/test cmet fogjuk
hasznlni, itt ri el a web szerver a "test" knyvtrunkat.
Elszr hozzunk ltre egy knyvtrat, s msoljuk bele a kpeket!
Legyen ez a knyvtr a /home/httpd/test/Photos.
A kpek neve a pldban 'IMG_001.jpg', ..., 'IMG_004.jpg'.
A legegyszerbb album ltrehozshoz adjuk ki a kvetkez utastst:
% album /home/httpd/test/Photos
Ezek utn a a fnykpalbumot egy web bngszvel a kvetkez cmen
rhetjk el:
http://myserver/test/Photos
ITEM: A fotk feliratozsa
Ksztsk el a /home/httpd/test/Photos/captions.txt fjlt a
kvetkez tartalommal (hasznljuk a "tab" gombot a " [tab] "
helyn):
-- captions.txt ---------
IMG_001.jpg [tab] Az els kp neve
IMG_002.jpg [tab] Msodik kp
IMG_003.jpg [tab] jabb kp [tab] micsoda felirat!
IMG_004.jpg [tab] Utols kp [tab] jabb felirat.
-------------------------
Ezutn futtassuk jra az album programot:
% album /home/httpd/test/Photos
s me, a feliratok megjelentek.
Most ksztsk el a /home/httpd/test/Photos/header.txt fjlt,
benne tetszleges szveggel. Az album program futtatsa utn
a felirat megjelenik az oldal tetejn.
ITEM: Kpek elrejtse
Kpek, fjlok vagy knyvtrak tbbflekppen is elrejthetk. Most
a captions.txt fjl segtsgvel mutatjuk be kpek elrejtst.
A "#" jelet rjuk be valamelyik sor elejre:
-- captions.txt ---------
IMG_001.jpg [tab] Az els kp neve
#IMG_002.jpg [tab] Msodik kp
IMG_003.jpg [tab] jabb kp [tab] micsoda felirat!
IMG_004.jpg [tab] Utols kp [tab] jabb felirat.
-------------------------
Az album program futtatsa utn lthat, hogy az IMG_002.jpg nev
kp hinyzik. Ha ezt az album program els futtatsa eltt csinltuk
volna, akkor a kzepes s a kis mret kpeket (ikonokat) nem is
ksztette volna el a program. Ezek a most mr felesleges kpek
utlag is eltvolthatk a -clean kapcsol hasznlatval:
% album -clean /home/httpd/test/Photos
ITEM: Sablonok hasznlata
Amennyiben a sablonok megfelelen teleptve vannak, s
theme_path a sablonok helyt jelzi, akkor a sablonok
hasznlhatk a kvetkezkppen:
% album -theme Blue /home/httpd/test/Photos
Ekkor a ksz fotalbum a Blue nev sablont hasznlja. Ha az
albumban meg nem jelentett kpeket tallunk, akkor valsznleg
olyan knyvtrba lett teleptve a sablon, amelyet a bngszprogram
nem r el, a rszletekrt l. a teleptsi tmutatt.
A program futskor elmenti az alkalmazott belltsokat, gy ha a
kvetkez alkalommal futtatjuk a programot:
% album /home/httpd/test/Photos
mg mindig a Blue sablont hasznlja. A sablon kikapcsolshoz a
kvetkez parancsot hasznljuk:
% album -no_theme /home/httpd/test/Photos
ITEM: Kzepes mret kpek
A teljes mret fnykpek rendszerint tl nagyok egy webes albumhoz,
ezrt az album oldalakon kzepes mret kpeket hasznlunk:
% album -medium 33% /home/httpd/test/Photos
A teljes mret kpek nem vesznek el, alapesetben
a kzepes mret kpre kattintva
tekinthetjk meg ket, vagy az
% album -just_medium /home/httpd/test/Photos
parancs alkalmazsval elrhetjk, hogy a teljes mret kpekre ne
helyezzen el linket a program (feltve, hogy eltte a -medium kapcsolval
hvtuk a programot valamikor).
ITEM: EXIF feliratok hasznlata
Megadhatjuk pldul, hogy a fnykp ksztsekor alkalmazott apertra
belekerljn a kpek feliratba:
% album -exif "<br>apertra=%Aperture%" /home/httpd/test/Photos
Ez a parancs csak azon kpek felirathoz rja hozz az apertrra vonatkoz informcit,
amelyek exif informcijban szerepel az "Aperture" kulcssz (a "%" jelek kzti
rsz jelenik meg a feliratban). Az elz parancsban szerepl <br>
hatsra az exif informci a kp feliratban j sorban jelenik meg.
Egyb exif informci is elhelyezhet a feliratban, pl:
% album -exif "<br>fkusz: %FocalLength%" /home/httpd/test/Photos
Mivel az elz futtatskor a program elmentette a belltsokat, most
mindkt exif informci megjelenik a kpek feliratban: az apertra s a
fkusztvolsg is. Ha trlni akarjuk az apertrra vonatkoz rszt:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
A "-no_exif" kapcsolnak pontosan meg kell egyeznie a korbban megadott
-exif kapcsolnl megadott rsszel, klnben a program figyelmen kvl hagyja.
A program ltal elmentett konfigurcis llomnyt is szabadon meg lehet vltoztatni:
/home/httpd/test/Photos/album.conf
Itt is lehet trlni a krdses rszt.
ITEM: Tovbbi albumok hozzadsa
Tegyk fel, hogy a spanyolorszgi nyarals sorn kszlt kpeket a
/home/httpd/test/Photos/Spain/
knyvtrban helyeztk el. Futtassuk most az album programot az
sszes kpet tartalmaz knyvtrra:
% album /home/httpd/test/Photos
Ez a parancs elkszti az albumot a Photos knyvtrban, majd kszt egy linket a
Spain knyvtrra, s ugyanazon belltsokkal, sablonnal elkszti az
albumot a Spain alknyvtrban is.
jabb utazst kveten a kpeket a kvetkez knyvtrba tesszk:
/home/httpd/test/Photos/Italy/
jra futtatva a programot az sszes kpet tartalmaz knyvtrra:
% album /home/httpd/test/Photos
Ez a parancs jra feldolgozza a Spain knyvtrat is, ami nem vltozott.
Az album program nem kszt jabb HTML oldalakat vagy kis mret
kpeket, ha azokat mr korbban elksztette, de a feleslegesen feldolgozott
knyvtrak gy is feleslegesen tltik az idt, klnsen nagy albumok
esetn. Ennek elkerlsre megadhatjuk, hogy csak az j knyvtrat
dolgozza fel:
% album -add /home/httpd/test/Photos/Italy
Ez az eredeti albumhoz hozzadja a linket az j albumhoz, s elkszti
az Italy albumot.
ITEM: Fordtotta:
Gyrgy Krolyi [http://www.me.bme.hu/~karolyi/indexe.html]
album-4.17/Docs/hu/utf8.txt_2 0000655 0000000 0000000 00000000000 11012410266 020355 1album-4.17/Docs/hu/txt_2 ustar root root album-4.17/Docs/hu/txt_6 0000655 0000000 0000000 00000000000 10670046152 017510 1album-4.17/Docs/it/txt_6 ustar root root album-4.17/Docs/hu/Section_7.html 0000644 0000000 0000000 00000061027 12661460265 015305 0 ustar root root
MarginalHacks album - Plugins, Usage, Creation,..
- Documentation
A l b u m
S e v e n - - P l u g i n s , U s a g e , C r e a t i o n , . .
1: What are Plugins?
Plugins are snippets of code that allow you to modify the behavior
of album. They can be as simple as a new way to create EXIF captions,
to something as complex as creating the album based on a database of
images instead of using the filesystem hierarchy.
2: Installing Plugins and plugin support
There are a number of plugins available with the standard installation of
album. If you are upgrading album with plugins from an earlier version
of album that did not have plugins (pre v3.10), you may need to once do:
% album -configure
You will not need to do this with future upgrades of album.
This will install the current plugins into one of the default
plugin directories - album will look for plugins in a number of
locations, the default locations are:
/etc/album/plugins/
/usr/share/album/plugins/
$HOME/.album/plugins/
In reality, these are 'plugins' directories found in the set of
locations specified by '--data_path' - hence the defaults are:
/etc/album/
/usr/share/album/
$HOME/.album/
You can specify a new location with --data_path and then add a 'plugins'
directory to that location, or use the --plugin_path option.
Plugins usually end with the ".alp" prefix, but you do not need
to specify this prefix when using plugins. For example, if you
have a plugin installed at:
/etc/album/plugins/utils/mv.alp
Then you would specify the plugin as: utils/mv3: Loading/Unloading Plugins
To list all the currently installed plugins:
% album -list_plugins
To show information about a specific plugin (using 'utils/mv' as an example):
% album -plugin_info utils/mv
Plugins will be saved in the configuration for a given album, so
they don't need to be respecified every time (excluding one-time
plugins such as 'utils/mv')
You can use -no_plugin and -clear_plugin to turn off plugins that have
been saved in an album configuration. As with normal album options,
-no_plugin will turn off a specific plugin, and -clear_plugin will
turn off all plugins. Any saved plugin options for that plugin will be
erased as well.
4: Plugin Options
A few plugins may be able to take command-line options, to view usage
for these plugins:
% album -plugin_usage utils/mv
But when specifying plugin options, you need to tell album which plugin
the option belongs to. Instead of specifying as a normal album option:
% album -some_option
You prefix the option with the plugin name followed by a colon:
% album -some_plugin:some_option
For example, you can specify the generated 'index' created by
the 'utils/capindex' plugin.
% album -plugin utils/capindex -utils/capindex:index blah.html
That's a bit unwieldy. You can shorten the name of the plugin as
long as it doesn't conflict with another plugin you've loaded (by
the same name):
% album -plugin utils/capindex -capindex:index
Obviously the other types of options (strings, numbers and arrays) are
possible and use the same convention. They are saved in album configuration
the same as normal album options.
One caveat: As mentioned, once we use a plugin on an album it is saved
in the configuration. If you want to add options to an album that is
already configured to use a plugin, you either need to mention the plugin
again, or else use the full name when specifying the options (otherwise
we won't know what the shortened option belongs to).
For example, consider an imaginary plugin:
% album -plugin some/example/thumbGen Photos/Spain
After that, let's say we want to use the thumbGen boolean option "fast".
This will not work:
% album -thumbGen:fast Photos/Spain
But either of these will work:
% album -plugin some/example/thumbGen -thumbGen:fast blah.html Photos/Spain% album -some/example/thumbGen:fast Photos/Spain5: Writing Plugins
Plugins are small perl modules that register "hooks" into the album code.
There are hooks for most of the album functionality, and the plugin hook
code can often either replace or supplement the album code. More hooks
may be added to future versions of album as needed.
You can see a list of all the hooks that album allows:
% album -list_hooks
And you can get specific information about a hook:
% album -hook_info <hook_name>
We can use album to generate our plugin framework for us:
% album -create_plugin
For this to work, you need to understand album hooks and album options.
We can also write the plugin by hand, it helps to use an already
written plugin as a base to work off of.
In our plugin we register the hook by calling the album::hook() function.
To call functions in the album code, we use the album namespace.
As an example, to register code for the clean_name hook our plugin calls:
album::hook($opt,'clean_name',\&my_clean);
Then whenever album does a clean_name it will also call the plugin
subroutine called my_clean (which we need to provide).
To write my_clean let's look at the clean_name hook info:
Args: ($opt, 'clean_name', $name, $iscaption)
Description: Clean a filename for printing.
The name is either the filename or comes from the caption file.
Returns: Clean name
The args that the my_clean subroutine get are specified on the first line.
Let's say we want to convert all names to uppercase. We could use:
sub my_clean {
my ($opt, $hookname, $name, $iscaption) = @_;
return uc($name);
}
Here's an explanation of the arguments:
$opt This is the handle to all of album's options.
We didn't use it here. Sometimes you'll need it if you
call any of albums internal functions. This is also true
if a $data argument is supplied.
$hookname In this case it will be 'clean_name'. This allows us
to register the same subroutine to handle different hooks.
$name This is the name we are going to clean.
$iscaption This tells us whether the name came from a caption file.
To understand any of the options after the $hookname you
may need to look at the corresponding code in album.
In this case we only needed to use the supplied $name, we called
the perl uppercase routine and returned that. The code is done, but now
we need to create the plugin framework.
Some hooks allow you to replace the album code. For example, you
could write plugin code that can generate thumbnails for pdf files
(using 'convert' is one way to do this). We can register code for
the 'thumbnail' hook, and just return 'undef' if we aren't looking
at a pdf file, but when we see a pdf file, we create a thumbnail
and then return that. When album gets back a thumbnail, then it
will use that and skip it's own thumbnail code.
Now let's finish writing our uppercase plugin. A plugin must do the following:
1) Supply a 'start_plugin' routine. This is where you will likely
register hooks and specify any command-line options for the plugin.
2) The 'start_plugin' routine must return the plugin info
hash, which needs the following keys defined:
author => The author name
href => A URL (or mailto, of course) for the author
version => Version number for this plugin
description => Text description of the plugin
3) End the plugin code by returning '1' (similar to a perl module).
Here is our example clean_name plugin code in a complete plugin:
sub start_plugin {
my ($opt) = @_;
album::hook($opt,'clean_name',\&my_clean);
return {
author => 'David Ljung Madison',
href => 'http://MarginalHacks.com/',
version => '1.0',
description => "Conver image names to uppercase",
};
}
sub my_clean {
return uc($name);
}
1;
Finally, we need to save this somewhere. Plugins are organized in the
plugin directory hierarchy, we could save this in a plugin directory as:
captions/formatting/NAME.alp
In fact, if you look in examples/formatting/NAME.alp you'll find that
there's a plugin already there that does essentially the same thing.
If you want your plugin to accept command-line options, use 'add_option.'
This must be done in the start_plugin code. Some examples:
album::add_option(1,"fast",album::OPTION_BOOL, usage=>"Do it fast");
album::add_option(1,"name", album::OPTION_STR, usage=>"Your name");
album::add_option(1,"colors",album::OPTION_ARR, usage=>"Color list");
For more info, see the 'add_option' code in album and see all of the uses
of it (at the top of album and in plugins that use 'add_option')
To read an option that the user may have set, we use option():
my $fast = album::option($opt, "fast");
If the user gave a bad value for an option, you can call usage():
album::usage("-colors array can only include values [red, green, blue]");
If your plugin needs to load modules that are not part of the
standard Perl distribution, please do this conditionally. For
an example of this, see plugins/extra/rss.alp.
You can also call any of the routines found in the album script
using the album:: namespace. Make sure you know what you are doing.
Some useful routines are:
album::add_head($opt,$data, "<meta name='add_this' content='to the <head>'>");
album::add_header($opt,$data, "<p>This gets added to the album header");
album::add_footer($opt,$data, "<p>This gets added to the album footer");
The best way to figure out how to write plugins is to look at other
plugins, possibly copying one that is similar to yours and working
off of that. Plugin development tools may be created in the future.
Again, album can help create the plugin framework for you:
% album -create_plugin
1: Using languages
(Requires album v4.0 or higher)
Album comes prepackaged with language files (we're in need of translation
help, see below!). The language files will alter most of album's output
messages, as well as any HTML output that isn't generated by the theme.
Altering any text in a theme to match your language is as simple as editing
the Theme files - there is an example of this with the "simple-Czech" theme.
To use a language, add the "lang" option to your main album.conf, or else
specify it the first time you generate an album (it will be saved with that
album afterwards).
Languages can be cleared like any code/array option with:
% album -clear_lang ...
You can specify multiple languages, which can matter if a language is
incomplete, but you'd like to default to another language than english.
So, for example, if you wanted Dutch as the primary language, with the
backup being Swedish Chef, you could do:
% album -lang swedish_chef -lang nl ...
If you specify a sublanguage (such as es-bo for Spanish, Bolivia), then
album will attempt 'es' first as a backup.
Note that because of a known bug, you should specify all the desired
languages at the same time instead of over multiple invocations of album.
To see what languages are available:
% album -list_langs
Sadly, most of the (real) languages are barely complete, but this
is a chance for people to help out by becoming a..
2: Translation Volunteers
The album project is in need of volunteers to do translations,
specifically of:
1) The Mini How-To. Please translate from the source.
2) album messages, as explained below.
If you are willing to do the translation of either one or both
of these items, please contact me!
If you're feeling particularly ambitious, feel free to translate any
of the other Documentation sources as well, just let me know!
3: Documentation Translation
The most important document to translate is the "Mini How-To".
Please translate from the text source.
Also be sure to let me know how you want to be credited,
by your name, name and email, or name and website.
And please include the proper spelling and capitalization of the
name of your language in your language. For example, "franais"
instead of "French"
I am open to suggestions for what charset to use. Current options are:
1) HTML characters such as [é]] (though they only work in browsers)
2) Unicode (UTF-8) such as [é] (only in browsers and some terminals)
3) ASCII code, where possible, such as [] (works in text editors, though
not currently in this page because it's set to unicode)
4) Language specific iso such as iso-8859-8-I for Hebrew.
Currently Unicode (utf-8) seems best for languages that aren't covered
by iso-8859-1, because it covers all languages and helps us deal with
incomplete translations (which would otherwise require multiple charsets,
which is a disaster). Any iso code that is a subset of utf-8 can be used.
If the main terminal software for a given language is in an iso charset
instead of utf, then that could be a good exception to use non-utf.
4: Album messages
album handles all text messages using it's own language support
system, similar to the system used by the perl module Locale::Maketext.
(More info on the inspiration for this is in TPJ13)
An error message, for example, may look like this:
No themes found in [[some directory]].
With a specific example being:
No themes found in /www/var/themes.
In Dutch, this would be:
Geen thema gevonden in /www/var/themes.
The "variable" in this case is "/www/var/themes" and it obviously
isn't translated. In album, the actual error message looks like:
'No themes found in [_1].'
# Args: [_1] = $dir
The translation (in Dutch) looks like:
'No themes found in [_1].' => 'Geen thema gevonden in [_1].'
After translating, album will replace [_1] with the directory.
Sometimes we'll have multiple variables, and they may change places:
Some example errors:
Need to specify -medium with -just_medium option.
Need to specify -theme_url with -theme option.
In Dutch, the first would be:
Met de optie -just_medium moet -medium opgegeven worden.
The actual error with it's Dutch translation is:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet [_1] opgegeven worden'
# Args: [_1]='-medium' [_2]='-just_medium'
Note that the variables have changed places.
There is also a special operator for quantities, for example,
we may wish to translate:
'I have 42 images'
Where the number 42 may change. In English, it is adequate to say:
0 images, 1 image, 2 images, 3 images...
Whereas in Dutch we would have:
0 afbeeldingen, 1 afbeelding, 2 afbeeldingen, 3 afbeeldingen..
But other languages (such as many slavic languages) may have special
rules as to whether "image" should be pluralized based on whether the
quantity is mod 2, 3 or 4, and so on! The simplest case is covered
by the [quant] operator:
[quant,_1,image]
This is similar to "[_1] image" except that "image" will be pluralized
if [_1] is 0 or greater than 1:
0 images, 1 image, 2 images, 3 images...
Pluralization is simply adding an 's' - if this isn't adequate, we can
specify the plural form:
[quant,_1,afbeelding,afbeeldingen]
Which gives us the Dutch count above.
And if we need a special form for 0, we can specify that:
[quant,_1,directory,directories,no directories]
Which would create:
no directories, 1 directory, 2 directories, ...
There is also a shorthand for [quant] using '*', so these are the same:
[quant,_1,image]
[*,_1,image]
So now an example translation for a number of images:
'[*,_1,image]'
=> '[*,_1,afbeelding,afbeeldingen]',
If you have something more complicated then you can use perl code, I
can help you write this if you let me know how the translation should work:
'[*,_1,image]'
=> \&russian_quantity; # This is a sub defined elsewhere..
Since the translation strings are (generally) placed in single-quotes (')
and due to the special [bracket] codes, we need to quote these correctly.
Single-quotes in the string need to be preceded by a slash (\):
'I can\'t find any images'
And square brackets are quoted using (~):
'Problem with option ~[-medium~]'
Which unfortunately can get ugly if the thing inside the square brackets
is a variable:
'Problem with option ~[[_1]~]'
Just be careful and make sure all brackets are closed appropriately.
Furthermore, in almost all cases, the translation should have the
same variables as the original:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet' # <- Where did [_1] go?!?
Fortunately, most of the work is done for you. Language files are
saved in the -data_path (or -lang_path) where album keeps it's data.
They are essentially perl code, and they can be auto-generated by album:
% album -make_lang sw
Will create a new, empty language file called 'sw' (Swedish). Go ahead
and edit that file, adding translations as you can. It's okay to leave
translations blank, they just won't get used. Some of the more important
translations (such as the ones that go into HTML pages) are at the top
and should probably be done first.
You will need to pick a charset, this is tricky, as it should be based
on what charsets you think people will be likely to have available
in their terminal as well as in their browser.
If you want to build a new language file, using translations from
a previous file (for example, to update a language with whatever
new messages have been added to album), you should load the language first:
% album -lang sw -make_lang sw
Any translations in the current Swedish language file will be copied
over to the new file (though comments and other code will not be copied!)
For the really long lines of text, don't worry about adding any newline
characters (\n) except where they exist in the original. album will
do word wrap appropriately for the longer sections of text.
Please contact me when you are starting translation work so I can
be sure that we don't have two translators working on the same parts,
and be sure to send me updates of language files as the progress, even
incomplete language files are useful!
If you have any questions about how to read the syntax of the language
file, please let me know.
5: Why am I still seeing English?
After choosing another language, you can still sometimes see English:
1) Option names are still in English. (-geometry is still -geometry)
2) The usage strings are not currently translated.
3) Plugin output is unlikely to be translated.
4) Language files aren't always complete, and will only translate what they know.
5) album may have new output that the language file doesn't know about yet.
6) Most themes are in English.
Fortunately the last one is the easiest to change, just edit the theme
and replace the HTML text portions with whatever language you like, or
create new graphics in a different language for icons with English.
If you create a new theme, I'd love to hear about it!
1: Basic execution
Create a directory with nothing but images in it. The album script and
other tools should not go here. Then run album specifying that directory:
% album /example/path/to/images/
Or, if you're in the /example/path/to directory:
% album images/
When it's done, you'll have a photo album inside that directory starting
with images/index.html.
If that path is in your web server, then you can view it with your
browser. If you can't find it, talk to your sysadmin.
2: Options
There are three types of options. Boolean options, string/num options
and array options. Boolean options can be turned off by prepending -no_:
% album -no_image_pages
String and number values are specified after a string option:
% album -type gif
% album -columns 5
Array options can be specified two ways, with one argument at a time:
% album -exif hi -exif there
Or multiple arguments using the '--' form:
% album --exif hi there --
You can remove specific array options with -no_<option>
and clear all the array options with -clear_<option>.
To clear out array options (say, from the previous album run):
% album -clear_exif -exif "new exif"
(The -clear_exif will clear any previous exif settings and then the
following -exif option will add a new exif comment)
And finally, you can remove specific array options with 'no_':
% album -no_exif hi
Which could remove the 'hi' exif value and leave the 'there' value intact.
Also see the section on Saving Options.
To see a brief usage:
% album -h
To see more options:
% album -more
And even more full list of options:
% album -usage=2
You can specify numbers higher than 2 to see even more options (up to about 100)
Plugins can also have options with their own usage.
3: Themes
Themes are an essential part of what makes album compelling.
You can customize the look of your photo album by downloading a
theme from MarginalHacks or even writing your own theme to match
your website.
To use a theme, download the theme .tar or .zip and unpack it.
Themes are found according to the -theme_path setting, which is
a list of places to look for themes. Those paths need to be somewhere
under the top of your web directory, but not inside a photo album
directory. It needs to be accessible from a web browser.
You can either move the theme into one of the theme_paths that album
is already using, or make a new one and specify it with the -theme_path
option. (-theme_path should point to the directory the theme is in,
not the actual theme directory itself)
Then call album with the -theme option, with or without -theme_path:
% album -theme Dominatrix6 my_photos/
% album -theme Dominatrix6 -theme_path /home/httpd/album/Themes/ my_photos/
You can also create your own themes pretty easily, this is covered
later in this documentation.
4: Sub-albums
Make directories inside your first directory and put images in that.
Run album again, and it will run through all the child directories
and create sub-albums of the first album.
If you make changes to just a sub-album, you can run album on that
and it will keep track of all the parent links.
If you don't want to traverse down the tree of directories, you
can limit it with the depth option. Example:
% album images/ -depth 1
Will only generate photo albums for the images directory.
If you have many sub-albums, and you want to add a new sub-album
without regenerating all the previous sub-albums, then you can use -add:
% album -add images/new_album/
Which will add the new_album to the HTML for 'images/' and then
generate the thumbs and HTML for everything inside 'images/new_album/'
5: Avoiding Thumbnail Regeneration
album tries to avoid unnecessary work. It only creates thumbnails if
they don't exist and haven't changed. This speeds up successive runs
of album.
This can cause a problem if you change the size or cropping of your
thumbnails, because album won't realize that the thumbnails have changed.
You can use the force option to force album to regenerate thumbnails:
% album -force images/
But you shouldn't need to use -force every time.
6: Cleaning Out The Thumbnails
If you remove images from an album then you'll have leftover thumbs and HTML.
You can remove them by running album once with the -clean option:
% album -clean images/7: Medium size images
When you click on an album thumbnail you're taken to an 'image_page.'
The image_page shows, by default, the full size image (as well as
navigation buttons and captions and such). When you click on the
image on the image_page, you'll be taken to the URL for just the full
size image.
If you want a medium size image on the image_page, use the -medium
option and specify a geometry for the medium size image. You can
specify any geometry that ImageMagick can use (see their man page
for more info). Some examples:
# An image that is half the full size
% album -medium 50%
# An image that fits inside 640x480 (maximum size)
% album -medium 640x480
# An image that is shrunk to fit inside 640x480
# (but won't be enlarged if it's smaller than 640x480)
% album -medium '640x480>'
You need the 'quotes' on the last example with most shells because
of the '>' character.
8: Captions
Images and thumbnails can have names and captions. There are a number
of ways to specify/change names and captions in your photo albums.
The name is linked to the image or image_page,
and the caption follows underneath.
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
One way to specify a caption is in a .txt file
with the same name as the image. For this example,
"Kodi_Cow.txt" could contain "Kodi takes down a cow!"
You can rename your images and specify captions in bulk
for an album directory with a captions.txt file.
Each line of the file should be an image or directory filename,
followed by a tab, followed by the new name. You can also
specify (separated by tabs), an optional caption and then an optional
image ALT tag. (To skip a field, use 'tab' 'space' 'tab')
Example:
001.gif My first photo
002.gif Mom and Dad My parents in the grand canyon
003.gif Ani DiFranco My fiancee Yowsers!
The images and directories will also be sorted in the order they are found
in the caption file. You can override this with '-sort date' and '-sort name'
If your editor doesn't handle tabs very well, then you can separate the
fields by double-colons, but only if the caption line doesn't contain any
tabs at all:
003.gif :: Ani DiFranco :: My fiancee :: Yowsers!
If you only want captions on image pages (not on album pages) use:
% album -no_album_captions
If you want web access to create/edit your captions, look at the
caption_edit.cgi CGI script (but be sure to limit access to the
script or anyone can change your captions!)
9: EXIF Captions
You can also specify captions that are based off of EXIF information
(Exchangeable Image File Format) which most digital cameras add to images.
First you need 'jhead' installed. You should be able to run jhead
on a JPG file and see the comments and information.
EXIF captions are added after the normal captions and are specified with -exif:
% album -exif "<br>File: %File name% taken with %Camera make%"
Any %tags% found will be replaced with EXIF information. If any %tags%
aren't found in the EXIF information, then that EXIF caption string is
thrown out. Because of this you can specify multiple -exif strings:
% album -exif "<br>File: %File name% " -exif "taken with %Camera make%"
This way if the 'Camera make' isn't found you can still get the 'File name'
caption.
Like any of the array style options you can use --exif as well:
% album --exif "<br>File: %File name% " "taken with %Camera make%" --
Note that, as above, you can include HTML in your EXIF tags:
% album -exif "<br>Aperture: %Aperture%"
To see the possible EXIF tags (Resolution, Date/Time, Aperture, etc..)
run a program like 'jhead' on an digital camera image.
You can also specify EXIF captions only for album or image pages, see
the -exif_album and -exif_image options.
10: Headers and Footers
In each album directory you can have text files header.txt and footer.txt
These will be copied verbatim into the header and footer of your album (if
it's supported by the theme).
11: Hiding Files/Directories
Any files that album does not recognize as image types are ignored.
To display these files, use -no_known_images. (-known_images is default)
You can mark an image as a non-image by creating an empty file with
the same name with .not_img added to the end.
You can ignore a file completely by creating an empty file with
the same name with .hide_album on the end.
You can avoid running album on a directory (but still include it in your
list of directories) by creating a file <dir>/.no_album
You can ignore directories completely by creating a file <dir>/.hide_album
The Windows version of album doesn't use dots for no_album, hide_album
and not_img because it's difficult to create .files in Windows.
12: Cropping Images
If your images are of a large variety of aspect ratios (i.e., other than
just landscape/portrait) or if your theme only allows one orientation,
then you can have your thumbnails cropped so they all fit the same geometry:
% album -crop
The default cropping is to crop the image to center. If you don't
like the centered-cropping method that the album uses to generate
thumbnails, you can give directives to album to specify where to crop
specific images. Just change the filename of the image so it has a
cropping directive before the filetype. You can direct album to crop
the image at the top, bottom, left or right. As an example, let's
say you have a portrait "Kodi.gif" that you want cropped on top for
the thumbnail. Rename the file to "Kodi.CROPtop.gif" and this will
be done for you (you might want to -clean out the old thumbnail).
The "CROP" string will be removed from the name that is printed in
the HTML.
The default geometry is 133x133. This way landscape images will
create 133x100 thumbnails and portrait images will create 100x133
thumbnails. If you are using cropping and you still want your
thumbnails to have that digital photo aspect ratio, then try 133x100:
% album -crop -geometry 133x100
Remember that if you change the -crop or -geometry settings on a
previously generated album, you will need to specify -force once
to regenerate all your thumbnails.
13: Video
album can generate snapshot thumbnails of many video formats if you
install ffmpeg
If you are running linux on an x86, then you can just grab the binary,
otherwise get the whole package from ffmpeg.org (it's an easy install).
14: Burning CDs (using file://)
If you are using album to burn CDs or you want to access your albums with
file://, then you don't want album to assume "index.html" as the default
index page since the browser probably won't. Furthermore, if you use
themes, you must use relative paths. You can't use -theme_url because
you don't know what the final URL will be. On Windows the theme path
could end up being "C:/Themes" or on UNIX or OSX it could be something
like "/mnt/cd/Themes" - it all depends on where the CD is mounted.
To deal with this, use the -burn option:
% album -burn ...
This requires that the paths from the album to the theme don't change.
The best way to do this is take the top directory that you're going to
burn and put the themes and the album in that directory, then specify
the full path to the theme. For example, create the directories:
myISO/Photos/
myISO/Themes/Blue
Then you can run:
% album -burn -theme myISO/Themes/Blue myISO/Photos
Then you can make a CD image from the myISO directory (or higher).
If you are using 'galbum' (the GUI front end) then you can't specify
the full path to the theme, so you'll need to make sure that the version
of the theme you want to burn is the first one found in the theme_path
(which is likely based off the data_path). In the above example you
could add 'myISO' to the top of the data_path, and it should
use the 'myISO/Themes/Blue' path for the Blue theme.
You can also look at shellrun for windows users, you can have it
automatically launch the album in a browser. (Or see winopen)
15: Indexing your entire album
To navigate an entire album on one page use the caption_index tool.
It uses the same options as album (though it ignores many
of them) so you can just replace your call to "album" with "caption_index"
The output is the HTML for a full album index.
See an example index
for one of my example photo albums16: Updating Albums With CGI
First you need to be able to upload the photo to the album directory.
I suggest using ftp for this. You could also write a javascript that
can upload files, if someone could show me how to do this I'd love to know.
Then you need to be able to remotely run album. To avoid abuse, I
suggest setting up a CGI script that touches a file (or they can just
ftp this file in), and then have a cron job that checks for that
file every few minutes, and if it finds it it removes it and runs album.
[unix only] (You will probably need to set $PATH or use absolute paths
in the script for convert)
If you want immediate gratification, you can run album from a CGI script
such as this one.
If your photos are not owned by the webserver user, then you
need to run through a setud script which you run from a CGI [unix only].
Put the setuid script in a secure place, change it's ownership to be the
same as the photos, and then run "chmod ug+s" on it. Here are example
setuid and CGI scripts. Be sure to edit them.
Also look at caption_edit.cgi which allows you (or others) to edit
captions/names/headers/footers through the web.
1: Methods
There are easy ways and complicated ways to create a custom theme,
depending on what you want to be able to do.
2: Editing current theme HTML
If you just want to slightly change the theme to match the output
of your site, it might make sense to edit a current theme.
In the theme directory there are two *.th files. album.th is
the template for album pages (the thumbnail pages) and image.th
is the template for image pages (where you can see medium or full
size images). The files are very similar to HTML except for
some embedded <: ePerl :> code. Even if you don't know perl or
ePerl you can still edit the HTML to make simple changes.
Good starting themes:
Any simmer_theme is going to be up to date and clean, such as "Blue" or
"Maste." If you only need 4 corner thumbnail borders then take a look
at "Eddie Bauer." If you want overlay/transparent borders, see FunLand.
If you want something demonstrating a minimal amount of code, try "simple"
but be warned that I haven't touched the theme in a long time.
3: The easy way, simmer_theme from graphics.
Most themes have the same basic form, show a bunch of thumbnails
for directories and then for images, with a graphic border, line and
background. If this is what you want, but you want to create new
graphics, then there is a tool that will build your themes for you.
If you create a directory with the images and a CREDIT file as well
as a Font or Style.css file, then simmer_theme will create theme for you.
Files:
Font/Style.css
This determines the fonts used by the theme. The "Font" file is the
older system, documented below. Create a Style.css file and define
styles for: body, title, main, credit and anything else you like.
See FunLand for a simple example.
Alternatively, use a font file. An example Font file is:
--------------------------------------------------
$TITLE_FONT = "size='4' color='#ffffff' face='Times New Roman,Georgia,Times'";
$MAIN_FONT = "face='Times New Roman,Georgia,Times'";
$CREDIT_FONT = "size='-1' face='Verdana' color='#ffffff'";
$BODY = "background='$PATH/bkgrnd.gif' link='#0099FF'">
--------------------------------------------------
CREDIT
The credit file is two lines and is used for the theme index at MarginalHacks.
If you're never submitting your theme to us, then you don't need this file.
(But please do!) If so, the two lines (and only two lines) are:
1) A short description of the theme (keep it all on one line)
2) Your name (can be inside a mailto: or href link)
Null.gif
Each simmer theme needs a spacer image, this is a 1x1 transparent gif.
You can just copy this from another simmer theme.
Optional image files:
Bar Images
The bar is composed of Bar_L.gif, Bar_R.gif and Bar_M.gif in the middle.
The middle is stretched. If you need a middle piece that isn't stretched, use:
Bar_L.gif, Bar_ML.gif, Bar_M.gif, Bar_MR.gif, Bar_R.gif
And then the Bar_ML.gif and Bar_MR.gif will be stretched. (See the
Craftsman theme for an example of this).
Locked.gif
A lock image for any directories that have .htaccess
Background image
If you want a background image, specify it in the Font file in the $BODY
section, as in the example above. The $PATH variable will be replaced
with the path to the theme files:
More.gif
When an album page has sub-albums to list, it first shows the 'More.gif'
image.
Next.gif, Prev.gif, Back.gif
For the next and previous arrows and the back button
Icon.gif
Shown at the top left by the parent albums, this is often just the text "Photos"
Border Images
There are many ways to slice up a border, from simple to complex, depending on
the complexity of the border and how much you want to be able to stretch it:
4 pieces Uses Bord_L.gif, Bord_R.gif, Bord_T.gif, Bord_B.gif
(The corners go with the left and right images)
4 piece borders usually don't stretch well so they don't work well on
image_pages. Generally you can cut the corners out of the left and
right images to make:
8 pieces Also includes Bord_TL.gif, Bord_TR.gif, Bord_BL.gif, Bord_BR.gif
8 piece borders allow you to stretch to handle most sized images
12 pieces Also includes Bord_LT.gif, Bord_RT.gif, Bord_LB.gif, Bord_RB.gif
12 pieces allow stretching of borders that have more complex corners (such
as Dominatrix6 or Ivy)
Overlay Borders Can use transparent images that can be partially
overlaying your thumbnail. See below.
Here's how the normal border pieces are laid out:
12 piece borders
TL T TR 8 piece borders 4 piece borders
LT RT TL T TR TTTTTTT
L IMG R L IMG R L IMG R
LB RB BL B BR BBBBBBB
BL B BR
Note that every row of images must be the same height, though the
widths do not have to line up. (i.e., height TL = height T = height TR)
(This is not true about overlay borders!)
Once you've created these files, you can run the simmer_theme tool
(an optional tool download at MarginalHacks.com) and your theme will
then be ready to use!
If you need different borders for the image pages, then use the same
filenames prefixed by 'I' - such as IBord_LT.gif, IBord_RT.gif,...
Overlay borders allow for really fantastic effects with image borders.
Currently there's no support for different overlay borders for images.
For using Overlay borders, create images:
Over_TL.png Over_T.png Over_TR.png
Over_L.png Over_R.png
Over_BL.png Over_B.png Over_BR.png
Then figure out how many pixels of the borders are padding (outside photo)
Then put those values in files: Over_T.pad Over_R.pad Over_B.pad Over_L.pad
See "Themes/FunLand" for a simple example
Multi-lingual Images
If your images have text, you can translate them into other languages
so that albums can be generated in other languages. For example, you
can create a Dutch "More.gif" image and put it in 'lang/nl/More.gif'
in the theme (nl is the language code for Dutch).
When the user runs album in Dutch (album -lang nl) then the theme
will use the Dutch image if found. Themes/Blue has a simple example.
The currently "translated" images are:
More, Back, Next, Prev and Icon
You can create an HTML table that shows the translations immediately
available to themes with -list_html_trans:
% album -list_html_trans > trans.html
Then view trans.html in a browser. Unfortunately different languages
have different charsets, and an HTML page can only have one. The
output is in utf-8, but you can edit the "charset=utf-8" to properly
view language characters in different charsets (such as hebrew).
If you need more words translated for themes, let me know, and if you
create any new language images for a theme, please send them to me!
4: From scratch, Theme API
This is a much heavier job - you need to have a very clear idea of
how you want album to place the images on your page. It might be
a good idea to start with modifying existing themes first to get
an idea of what most themes do. Also look at existing themes
for code examples (see suggestions above).
Themes are directories that contain at the minimum an 'album.th' file.
This is the album page theme template. Often they also contain an 'image.th'
which is the image theme template, and any graphics/css used by the theme.
Album pages contain thumbnails and image pages show full/medium sized images.
The .th files are ePerl, which is perl embedded inside of HTML. They
end up looking a great deal like the actual album and image HTML themselves.
To write a theme, you'll need to understand the ePerl syntax. You can
find more information from the actual ePerl tool available at MarginalHacks
(though this tool is not needed to use themes in album).
There are a plethora of support routines available, but often only
a fraction of these are necessary - it may help to look at other themes
to see how they are generally constructed.
Function table:
Required Functions
Meta() Must be called in the section of HTML
Credit() Gives credit ('this album created by..')
Must be called in the section of HTML
Body_Tag() Called inside the actual tag.
Paths and Options
Option($name) Get the value of an option/configuration setting
Version() Return the album version
Version_Num() Return the album version as just a number (i.e. "3.14")
Path($type) Returns path info for $type of:
album_name The name of this album
dir Current working album directory
album_file Full path to the album index.html
album_path The path of parent directories
theme Full path to the theme directory
img_theme Full path to the theme directory from image pages
page_post_url The ".html" to add onto image pages
parent_albums Array of parent albums (album_path split up)
Image_Page() 1 if we're generating an image page, 0 for album page.
Page_Type() Either 'image_page' or 'album_page'
Theme_Path() The filesystem path to the theme files
Theme_URL() The URL path to the theme files
Header and Footer
isHeader(), pHeader() Test for and print the header
isFooter(), pFooter() Same for the footer
Generally you loop through the images and directories using local variables:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
This will print the name of each image. Our object types are either 'pics'
for images or 'dirs' for the child directories. Here are the object functions:
Objects (type is either 'pics' (default) or 'dirs')
First($type) Get the first image or sub-album object.
Last($type) Last object
Next($obj) Given an object, return the next object
Next($obj,1) Same, loop past end to beginning.
Prev($obj), Prev($obj,1) Similar to Next()
num('pics') or just num() Total number of images in this album
num('dirs') Total number of children/sub-albums
Also:
num('parent_albums') Total number of parents leading up to this album.
Object lookup:
get_obj($num, $type, $loop)
Finds object by number ('pics' or 'dirs').
If $loop is set than the count will wrap around.
Object Properties
Each object (image or child albums) has properties.
Some properties are accessed by a single field:
Get($obj,$field) Get a single field of an object
Field Description
----- ----------
type What type of object? Either 'pics' or 'dirs'
is_movie Boolean: is this a movie?
name Name (cleaned and optionally from captions)
cap Image caption
capfile Optional caption file
alt Alt tag
num_pics [directories only, -dir_thumbs] Num of pics in directory
num_dirs [directories only, -dir_thumbs] Num of dirs in directory
Some properties are accessed by a field and subfield. For example,
each image has information for different sizes: full, medium and thumb
(though 'medium' is optional).
Get($obj,$size,$field) Get a property for a given size
Size Field Description
---- ----- ----------
$size x Width
$size y Height
$size file Filename (without path)
$size path Filename (full path)
$size filesize Filesize in bytes
full tag The tag (either 'image' or 'embed') - only for 'full'
We also have URL information which is access according to the
page it's coming 'from' and the image/page it's pointing 'to':
Get($obj,'URL',$from,$to) Get a URL for an object from -> to
Get($obj,'href',$from,$to) Same but wraps it in an 'href' string.
Get($obj,'link',$from,$to) Same but wraps the object name inside the href link.
From To Description
---- -- ----------
album_page image Image_URL from album_page
album_page thumb Thumbnail from album_page
image_page image Image_URL from image_page
image_page image_page This image page from another image page
image_page image_src The <img src> URL for the image page
image_page thumb Thumbnail from image_page
Directory objects also have:
From To Description
---- -- ----------
album_page dir URL to the directory from it's parent album page
Parent Albums
Parent_Album($num) Get a parent album string (including the href)
Parent_Albums() Return a list of the parent albums strings (including href)
Parent_Album($str) A join($str) call of Parent_Albums()
Back() The URL to go back or up one page.
Images
This_Image The image object for an image page
Image($img,$type) The <img> tags for type of medium,full,thumb
Image($num,$type) Same, but by image number
Name($img) The clean or captioned name for an image
Caption($img) The caption for an image
Child Albums
Name($alb)
Caption($img) The caption for an image
Convenience Routines
Pretty($str,$html,$lines) Pretty formats a name.
If $html then HTML is allowed (i.e., use 0 for <title> and the like)
Currently just puts prefix dates in a smaller font (i.e. '2004-12-03.Folder')
If $lines then multilines are allowed
Currently just follows dates with a 'br' line break.
New_Row($obj,$cols,$off) Should we start a new row after this object?
Use $off if the first object is offset from 1
Image_Array($src,$x,$y,$also,$alt)
Returns an <img> tag given $src, $x,...
Image_Ref($ref,$also,$alt)
Like Image_Array, but $ref can be a hash of
Image_Arrays keyed by language ('_' is default).
album picks the Image_Array by what languages are set.
Border($img,$type,$href,@border)
Border($str,$x,$y,@border)
Create the full bordered image.
See 'Borders' for more information.
If you're creating a theme from scratch, consider adding support for -slideshow.
The easiest way to do this is to cut/paste the "slideshow" code out of an
existing theme.
5: Submitting Themes
Have a custom theme? I'd love to see it, even if it's totally site-specific.
If you have a new theme you'd like to offer the public, feel free to send
it to me and/or a URL where I can see how it looks. Be sure to set the CREDIT
file properly and let me know if you are donating it to MarginalHacks for
everyone to use or if you want it under a specific license.
6: Converting v2.0 Themes to v3.0 Themes
album v2.0 introduced a theme interface which has been rewritten. Most
2.0 themes (especially those that don't use many of the global variables)
will still work, but the interface is deprecated and may disappear in
the near future.
It's not difficult to convert from v2.0 to v3.0 themes.
The v2.0 themes used global variables for many things. These are now
deprecated In v3.0 you should keep track of images and directories in
variables and use the 'iterators' that are supplied, for example:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Will loop through all the images and print their names.
The chart below shows you how to rewrite the old style calls which
used a global variable with the new style which uses a local variable,
but to use these calls you need to rewrite your loops as above.
Here is a conversion chart for helping convert v2.0 themes to v3.0:
# Global vars shouldn't be used
# ALL DEPRECATED - See new local variable loop methods above
$PARENT_ALBUM_CNT Rewrite with: Parent_Album($num) and Parent_Albums($join)
$CHILD_ALBUM_CNT Rewrite with: my $dir = First('dirs'); $dir=Next($dir);
$IMAGE_CNT Rewrite with: my $img = First('pics'); $pics=Next($pics);
@PARENT_ALBUMS Can instead use: @{Path('parent_albums')}
@CHILD_ALBUMS, @CHILD_ALBUM_NAMES, @CHILD_ALBUM_URLS, ...
# Old global variable modifiers:
# ALL DEPRECATED - See new local variable loop methods above
Next_Image(), Images_Left(), Image_Cnt(), Image_Prev(), Image_Next()
Set_Image_Prev(), Set_Image_Next(), Set_Image_This()
Next_Child_Album(), Child_Album_Cnt(), Child_Albums_Left()
# Paths and stuff
pAlbum_Name() Path('album_name')
Album_Filename() Path('album_file')
pFile($file) print read_file($file)
Get_Opt($option) Option($option)
Index() Option('index')
pParent_Album($str) print Parent_Album($str)
# Parent Albums
Parent_Albums_Left Deprecated, see '$PARENT_ALBUM_CNT' above
Parent_Album_Cnt Deprecated, see '$PARENT_ALBUM_CNT' above
Next_Parent_Album Deprecated, see '$PARENT_ALBUM_CNT' above
pJoin_Parent_Albums print Parent_Albums(\@_)
# Images, using variable '$img'
pImage() Use $img instead and:
print Get($img,'href','image');
print Get($img,'thumb') if Get($img,'thumb');
print Name($img), "</a>";
pImage_Src() print Image($img,'full')
Image_Src() Image($img,'full')
pImage_Thumb_Src() print Image($img,'thumb')
Image_Name() Name($img)
Image_Caption() Caption($img)
pImage_Caption() print Get($img,'Caption')
Image_Thumb() Get($img,'URL','thumb')
Image_Is_Pic() Get($img,'thumb')
Image_Alt() Get($img,'alt')
Image_Filesize() Get($img,'full','filesize')
Image_Path() Get($img,'full','path')
Image_Width() Get($img,'medium','x') || Get($img,'full','x')
Image_Height() Get($img,'medium','y') || Get($img,'full','y')
Image_Filename() Get($img,'full','file')
Image_Tag() Get($img,'full','tag')
Image_URL() Get($img,'URL','image')
Image_Page_URL() Get($img,'URL','image_page','image_page') || Back()
# Child album routines, using variable '$alb'
pChild_Album($nobr) print Get($alb,'href','dir');
my $name = Name($alb);
$name =~ s/<br>//g if $nobr;
print $name,"</a>";
Child_Album_Caption() Caption($alb,'dirs')
pChild_Album_Caption() print Child_Album_Caption($alb)
Child_Album_URL() Get($alb,'URL','dir')
Child_Album_Name() Name($alb)
# Unchanged
Meta() Meta()
Credit() Credit()
album-4.17/Docs/es/txt_2 0000644 0000000 0000000 00000013143 11076761657 013547 0 ustar root root MINI MANUAL
ITEM: Álbum sencillo
Después de instalar 'album' correctamente, se podrán hacer unos
casos sencillos. Si se produce algún error o tiene problemas en
esta sección, vea el manual de instalación.
Necesita un directorio de web para agregar temas y su álbum de fotos.
En este manual se usará /home/httpd/test. Es necesario que este
directorio sea visible por un servidor de web. En este ejemplo se
usará este URL:
http://myserver/test/
Cambie sus comandos/URLs debidamente.
Primero cree un directorio y agregue algunas imágenes. Lo llamaremos:
/home/http/test/Photos
Y agregaremos unas imágenes llamadas 'IMG_001.jpg' hasta 'IMG_004.jpg'
Para un caso sencillo, simplemente ejecute 'album':
% album /home/httpd/test/Photos
Ahora puede ver el álbum en un navegador de web en una dirección como:
http://myserver/test/Photos
ITEM: Agregar pies de foto
Cree un archivo /home/httpd/test/Photos/captions.txt con los
siguientes contenidos (use la tecla de tabulación donde vea " [tab] ")
-- captions.txt ---------
IMG_001.jpg [tab] Nombre de la primera imagen
IMG_002.jpg [tab] Segunda imagen
IMG_003.jpg [tab] Otra imagen [tab] con pie de foto!
IMG_004.jpg [tab] Última imagen [tab] con otro pie de foto.
-------------------------
Y ejectue 'album' de nuevo:
% album /home/httpd/test/Photos
Y verá cambiar los pies de foto.
Ahora cree un archivo con texto en: /home/httpd/test/Photos/header.txt
Y ejecute 'album' de nuevo. Verá ese texto en la parte superior de la página.
ITEM: Esconder fotos
Hay un par de maneras para esconder fotos/archivos/directorios, pero
usaremos el archivo de pies de foto. Intente comentar una imagen con
'#' en captions.txt:
-- captions.txt ---------
IMG_001.jpg [tab] Nombre de la primera imagen
#IMG_002.jpg [tab] Segunda imagen
IMG_003.jpg [tab] Otra imagen [tab] con pie de foto!
IMG_004.jpg [tab] Última imagen [tab] con otro pie de foto.
-------------------------
Ejecute 'album' de nuevo, y verá que el IMG_002.jpg está escondido.
Si esto se hubiera hecho al ejecutar 'album' por primera vez, no se
habrían generado ni fotos tamaño mediano ni las miniaturas. Si
gusta, los puede eliminar con '-clean':
% album -clean /home/httpd/test/Photos
ITEM: Usando un tema
Si los temas fueron correctamente instalado y están en su
'theme_path', entonces podrá usar un tema con su álbum:
% album -theme Blue /home/httpd/test/Photos
Ahora el álbum de fotos deberá estar usando el tema "Blue". Si el
albúm contiene imágenes rotas, entonces el tema no se ha instalado
en un directorio de web accesible, vea el manual de instalación.
'Album' guarda las opciones que utiliza, entonces la próxima vez que ejecute 'album':
% album /home/httpd/test/Photos
Seguirá usando el tema Blue. Para dejar de usar un tema, puede:
% album -no_theme /home/httpd/test/Photos
ITEM: Imágenes medianas
Imágenes de máxima resolución normalmente son demasiada grandes
para un álbum en la red, entonces usaremos imágenes medianss en las
páginas de imágenes:
% album -medium 33% /home/httpd/test/Photos
Todavía puede acceder a las imágenes de tamaño completo al hacer
clic en la imagen mediana, o:
% album -just_medium /home/httpd/test/Photos
Mantendrá la imagen de resolución máxima sin enlace (suponiendo
que se había ejecutado la opción -medium en algún momento).
ITEM: Agregar pies de foto EXIF
Vamos a agregar información de apertura a los pies de foto de cada imagen:
% album -exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
Esto sólo agregará información de apertura a cualquier imagen que
tiene la etiqueta EXIF 'Aperture' especificada (la parte entre los
símbolos '%'). También agregamos la etiqueta <br> para que la
información aparezca en un nuevo renglón.
Podemos agregar más información EXIF:
% album -exif "<br>focal: %FocalLength%" /home/httpd/test/Photos
Ya que 'album' guardó las opciones antes, ahora obtenemos ambas
etiquetas EXIF para cualquier imagen que especifica 'Aperture' y
'FocalLength'. Vamos a eliminar apertura:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
La opción '-no_exif' tiene que corresponder exactamente a la cadena
de caracteres anterior o será ignorada. También se puede editar el
archivo de configuración que creó 'album':
/home/httpd/test/Photos/album.conf
Y borrar la opción ahí.
ITEM: Agregando más álbumes
Supongamos que hacemos un viaje a España. Tomamos algunas fotos y las ponemos en:
/home/httpd/test/Photos/Spain/
Ahora ejecute 'album' de nuevo al nivel superior:
% album /home/httpd/test/Photos
Esto arreglará 'Photos' para vincularlo a España y ejecutará
'album' para Spain/ también, con los mismos parámetros/temas ,
etc...
Ahora vayamos de viaje de nuevo, y creamos:
/home/httpd/test/Photos/Italy/
Podemos ejecutar 'album' al nivel superior:
% album /home/httpd/test/Photos
Pero esto escanearía de nuevo el directorio de España, el cual no ha cambiado.
'Album' normalmente no generará HTML o miniaturas de fotos si no se
necesita, pero todavía puede gastar tiempo, especialmente cuando los
álbumes sean más grandes.
Entonces podemos decirle que solo agregue el nuevo directorio:
% album -add /home/httpd/test/Photos/Italy
Esto arreglará el índice de nivel superior (en 'Photos') y
generará el álbum de Italia.
ITEM: Traducido por:
Stewart Goodman (goodman.stewart gmail com)
album-4.17/Docs/es/Section_5.html 0000644 0000000 0000000 00000047523 12661460265 015303 0 ustar root root
MarginalHacks album - Feature Requests, Bugs, Patches and Troubleshooting
- Documentation
A l b u m
F i v e - - F e a t u r e R e q u e s t s , B u g s , P a t c h e s a n d T r o u b l e s h o o t i n g
1: Feature Requests
If there's something you want added to album, first make sure
it doesn't already exist! Check the man page or the usage:
% man album% album -h
Also see -more and -usage options.
If you don't see it there, consider writing a patch or a plugin.
2: Bug reports
Before you submit a bug, please make sure you have the most current release of album!
When submitting a bug, I need to know at least:
1) Your operating system
2) The exact problem and the exact error messages
I'd also like to know, if possible:
1) The exact album command you ran
2) The output from the command
And I generally also need the debug output of album:
% album -d
Finally, make sure that you've got the most current
version of album, and the most current themes as well.
3: Writing Patches, Modifying album
If you want to modify album, you might want to check with me
first to make sure it's not already on my development plate.
If not, then consider writing it as a plugin instead of patching
the album source. This avoids adding complexity to album for
features that may not be globally used.
If it needs to go into album (for example, if it's a bug), then
please make sure to first download the most recent copy of album
first, then patch that and send me either a diff, a patch, or the
full script. If you comment off the changes you make that'd be great too.
4: Known Bugs
v3.11: -clear_* and -no_* doesn't clear out parent directory options.
v3.10: Burning CDs doesn't quite work with theme absolute paths.
v3.00: Array and code options are saved backwards, for example:
"album -lang aa .. ; album -lang bb .." will still use language 'aa'
Also, in some cases array/code options in sub-albums will not
be ordered right the first time album adds them and you may
need to rerun album. For example:
"album -exif A photos/ ; album -exif B photos/sub"
Will have "B A" for the sub album, but "A B" after: "album photos/sub"
5: PROBLEM: My index pages are too large!
I get many requests to break up the index pages after reaching a certain
threshold of images.
The problem is that this is hard to manage - unless the index pages are
treated just like sub-albums, then you now have three major components
on a page, more indexes, more albums, and thumbnails. And not only is
that cumbersome, but it would require updating all the themes.
Hopefully the next major release of album will do this, but until then
there is another, easier solution - just break the images up into
subdirectories before running album.
I have a tool that will move new images into subdirectories for you and
then runs album:
in_album6:ERROR: no delegate for this image format (./album)
You have the album script in your photo directory and it can't make
a thumbnail of itself! Either:
1) Move album out of the photo directory (suggested)
2) Run album with -known_images
7:ERROR: no delegate for this image format (some_non_image_file)
Don't put non-images in your photo directory, or else run with -known_images.
8:ERROR: no delegate for this image format (some.jpg)9:ERROR: identify: JPEG library is not available (some.jpg)
Your ImageMagick installation isn't complete and doesn't know how
to handle the given image type.
10:ERROR: Can't get [some_image] size from -verbose output.
ImageMagick doesn't know the size of the image specified. Either:
1) Your ImageMagick installation isn't complete and can't handle the image type.
2) You are running album on a directory with non-images in it without
using the -known_images option.
If you're a gentoo linux user and you see this error, then run this command
as root (thanks Alex Pientka):
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
album-4.17/Docs/es/txt_1 0000644 0000000 0000000 00000012713 11077033173 013532 0 ustar root root Instalación
ITEM: Requisítos mínimos
1) El script en perl de album
2) Herramientas de ImageMagick (específicamente 'convert')
Ponga el script de 'album' y las herramientas de ImageMagick en alguna parte de su PATH,
o ejecute 'album' con su ruta completa (y especifique la ruta completa de 'convert'
ya sea en el script de 'album' o en los archivos de configuración en el álbum).
ITEM: Configuración inicial
La primera vez que ejecute el script de 'album' le pedirá algunas preguntas
para configurarlo. Si está usando UNIX/OSX, entonces puede ejecutarlo la primera
vez como 'root' para que haga la configuración global y los temas para todos
en vez del usuario actual.
ITEM: Instalación opcional
3) Temas
4) ffmpeg (para crear miniaturas de las imágenes)
5) jhead (para leer información EXIF)
6) plugins
7) Varias herramientas disponibles en MarginalHacks.com
ITEM: UNIX
Casi todas las distribuciones de UNIX incluyen ImageMagick y perl, entonces solo descargue
el script de 'album' y los temas (#1 and #3 más arriba) y es todo.
Para probar que se haya instalado correctamente, ejecute el script en un directorio con imágenes:
% album /path/to/my/photos/
ITEM: Debian UNIX
'album' se encuentra en debian estable, sin embargo por el momento está un poco viejo.
Recomiendo descargar la versión más reciente en MarginalHacks.
Puede guardar el paquete .deb, y luego, como root, ejecute:
% dpkg -i album.deb
ITEM: Macintosh OSX
Funciona muy bien en OSX, pero debe ser ejecutado a través de una terminal. Solamente
instale el script de 'album' y las herramientas de ImageMagick, y teclee la ruta de 'album',
cualquier opción que quiera, y luego la ruta del directorio con las imágenes
(separados por espacios), por ejemplo:
% album -theme Blue /path/to/my/photos/
ITEM: Win95, Win98, Win2000/Win2k, WinNT, WinXP
(Windows 95, Windows 98, Windows 2000, Windows NT, Windows XP)
Hay dos métodos para ejecutar scripts de perl en Windows: usando ActivePerl
o Cygwin.
ActivePerl es más simple y permite la ejecución de 'album' a través de una terminal de DOS,
sin embargo me han dicho que no funciona con temas.
Cygwin es más voluminoso pero también un paquete más robusto que da acceso
a muchas herramientas como en UNIX, y 'album' es ejecutado en una terminal bash (UNIX shell).
Método Cygwin
-------------
1) Instale Cygwin
Escoja los paquetes: perl, ImageMagick, bash
¡No utilice la instalación inicial ImageMagick! ¡Debe usar los paquetes de Cygwin de ImageMagick!
2) Instale album en una ruta bash o ejecútelo usando una ruta absoluta:
bash% album /some/path/to/photos
3) Si quere indormación exif en los pies de foto, necesita la versión de Cygwin jheadMétodo ActivePerl
-----------------
1) Instale ImageMagick para Windows
2) Instale ActivePerl, instalación completa (no se necesita un perfil para PPM)
Escoja: "Add perl to PATH" y "Create Perl file extension association"
3) En Win98: Instale tcap en la ruta
4) Guarde 'album' como album.pl en la ruta de Windows
5) Use una terminal de DOS para ejecutar:
C:> album.pl C:\some\path\to\photosAtención: Algunas versiones de Windows (por lo menos 2000/NT) tienen su
propio "convert.exe" en el directorio c:\windows\system32 (¿una utilidad para NTFS?).
Si lo tiene, entonces necesito editar el variable de la ruta,
or solamente especifique la ruta absoluta de 'convert' en el script de 'album'.
ITEM: ¿Cómo edito la ruta de Windows?
Usuarios de Windows NT4
Oprima el botón derecho en "My Computer", seleccione "Properties".
Seleccione la pestaña "Environment".
En "System Variables" seleccione "Path".
En "Value" agregue las rutas nuevas separados por puntos y coma
Oprima "OK/Set", oprima "OK" de nuevo.
Usuarios de Windows 2000
Oprima el botón derecho en "My Computer", seleccione "Properties".
Seleccione la pestaña "Advanced".
Oprima "Environment Variables".
En "System Variables" oprima dos veces en "Path"
En "Value" agregue las rutas nuevas separados por puntos y coma
Oprima "OK/Set", oprima "OK" de nuevo.
Windows XP Users
Abra "My Computer" y seleccione "Change a Setting".
Oprima dos veces "System".
Seleccione la pestaña "Advanced".
Seleccione "Environment Variables".
En "System Variables" oprima dos veces en "Path"
En "Value" agregue las rutas nuevas separados por puntos y coma
Oprima "OK".
ITEM: Macintosh OS9
No tengo planes de transferir 'album' a OS9 - no se en que estado están
las consolas y perl en pre-OSX. Si logra hacer que funcione
en OS9, avíseme.
ITEM: Traducido por:
Stewart Goodman (goodman.stewart gmail com)
album-4.17/Docs/es/flag.png 0000644 0000000 0000000 00000000507 11072326530 014162 0 ustar root root PNG
IHDR m?h bKGD tIME5 IDAT8픱N`[~J@f(|'F߀Ę &P0g×sOw #
h`H*`
'3T@ ;n,~gAWi>oc#a0uuX\{LrMQuU b=1s6¢7Je# /MarginalHacks album - Configuration Files
- Documentation
A l b u m
F o u r - - C o n f i g u r a t i o n F i l e s
1: Configuration Files
Album behavior can be controlled through command-line options, such as:
% album -no_known_images% album -geometry 133x100% album -exif "File: %File name% " -exif "taken with %Camera make%"
But these options can also be specified in a configuration file:
# Example configuration file # comments are ignored
known_images 0 # known_images=0 is same as no_known_images
geometry 133x100
exif "File: %File name% "
exif "taken with %Camera make%"
The configuration file format is one option per line optionally followed
by whitespace and the option value. Boolean options can be set without
the option value or can be cleared/set with 0 and 1.
2: Location Of Configuration Files
album looks for configuration files in a few locations, in order:
/etc/album/conf System-wide settings
/etc/album.conf System-wide settings
$BASENAME/album.conf In the 'album' install directory
$HOME/.albumrc User specific settings
$HOME/.album.conf User specific settings
$DOT/album.conf User specific (I keep my dot files elsewhere)
$USERPROFILE/album.conf For Windows (C:\Documents and Settings\TheUser)
album also looks for album.conf files inside the photo album directories.
Sub-albums can also have album.conf which will alter the settings
from parent directories (this allows you to, for example, have a
different theme for part of your photo album). Any album.conf files
in your photo album directories will configure the album and any sub-albums
unless overridden by any album.conf settings found in a sub-album.
As an example, consider a conf for a photo album at 'images/album.conf':
theme Dominatrix6
columns 3
And another conf inside 'images/europe/album.conf':
theme Blue
crop
album will use the Dominatrix6 theme for the images/ album and all of
it's sub-albums except for the images/europe/ album which will use
the Blue theme. All of the images/ album and sub-albums will have
3 columns since that wasn't changed in the images/europe/ album, however
all of the thumbnails in images/europe/ and all of it's sub-albums
will be cropped due to the 'crop' configuration setting.
3: Saving Options
Whenever you run an album, the command-line options are saved in
an album.conf inside the photo album directory. If an album.conf
already exists it will be modified not overwritten, so it is safe
to edit this file in a text editor.
This makes it easy to make subsequent calls to album. If you
first generate an album with:
% album -crop -no_known_images -theme Dominatrix6 -sort date images/
Then the next time you call album you can just:
% album images/
This works for sub-albums as well:
% album images/africa/
Will also find all of the saved options.
Some 'one-time only' options are not saved for obvious reasons, such
as -add, -clean, -force, -depth, etc..
Running album multiple times on the same directories can
get confusing if you don't understand how options are saved.
Here are some examples.
Premises:
1) Command-line options are processed before conf options found
in the album directory.
2) Album should run the same the next time you call it if you
don't specify any options.
For example, consider running album twice on a directory:
% album -exif "comment 1" photos/spain% album photos/spain
The second time you run album you'll still get the "comment 1"
exif comment in your photos directory.
3) Album shouldn't end up with multiple copies of the same array
options if you keep calling it with the same command-line
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 1" photos/spain
The second time you run album you will NOT end up with multiple
copies of the "comment 1" exif comment.
However, please note that if you re-specify the same options
each time, album may run slower because it thinks it needs to
regenerate your html!
As an example, if you run:
% album -medium 640x640 photos/spain
(then later...)
% album -medium 640x640 photos/spain
Then the second time will unnecessarily regenerate all your
medium images. This is much slower.
It's better to specify command-line options only the first time
and let them get saved, such as:
% album -medium 640x640 photos/spain
(then later...)
% album photos/spain
Unfortunately these constraints mean that any new array options will
be put at the beginning of your list of -exif options.
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 2" photos/spain
The comments will actually be ordered "comment 2" then "comment 1"
To specify exact ordering, you may need to re-specify all options.
Either specify "comment 1" to put it back on top:
% album -exif "comment 1" photos/spain
Or just specify all the options in the order you want:
% album -exif "comment 1" -exif "comment 2" photos/spain
Sometimes it may be easier to merely edit the album.conf file directly
to make any changes.
Finally, this only allows us to accumulate options.
We can delete options using -no and -clear, see the section on Options,
these settings (or clearings) will also be saved from run to run.
1: Álbum sencillo
Después de instalar 'album' correctamente, se podrán hacer unos
casos sencillos. Si se produce algún error o tiene problemas en
esta sección, vea el manual de instalación.
Necesita un directorio de web para agregar temas y su álbum de fotos.
En este manual se usará /home/httpd/test. Es necesario que este
directorio sea visible por un servidor de web. En este ejemplo se
usará este URL:
http://myserver/test/
Cambie sus comandos/URLs debidamente.
Primero cree un directorio y agregue algunas imágenes. Lo llamaremos:
/home/http/test/Photos
Y agregaremos unas imágenes llamadas 'IMG_001.jpg' hasta 'IMG_004.jpg'
Para un caso sencillo, simplemente ejecute 'album':
% album /home/httpd/test/Photos
Ahora puede ver el álbum en un navegador de web en una dirección como:
http://myserver/test/Photos
2: Agregar pies de foto
Cree un archivo /home/httpd/test/Photos/captions.txt con los
siguientes contenidos (use la tecla de tabulación donde vea " [tab] ")
-- captions.txt ---------
IMG_001.jpg [tab] Nombre de la primera imagen
IMG_002.jpg [tab] Segunda imagen
IMG_003.jpg [tab] Otra imagen [tab] con pie de foto!
IMG_004.jpg [tab] Última imagen [tab] con otro pie de foto.
-------------------------
Y ejectue 'album' de nuevo:
% album /home/httpd/test/Photos
Y verá cambiar los pies de foto.
Ahora cree un archivo con texto en: /home/httpd/test/Photos/header.txt
Y ejecute 'album' de nuevo. Verá ese texto en la parte superior de la página.
3: Esconder fotos
Hay un par de maneras para esconder fotos/archivos/directorios, pero
usaremos el archivo de pies de foto. Intente comentar una imagen con
'#' en captions.txt:
-- captions.txt ---------
IMG_001.jpg [tab] Nombre de la primera imagen
#IMG_002.jpg [tab] Segunda imagen
IMG_003.jpg [tab] Otra imagen [tab] con pie de foto!
IMG_004.jpg [tab] Última imagen [tab] con otro pie de foto.
-------------------------
Ejecute 'album' de nuevo, y verá que el IMG_002.jpg está escondido.
Si esto se hubiera hecho al ejecutar 'album' por primera vez, no se
habrían generado ni fotos tamaño mediano ni las miniaturas. Si
gusta, los puede eliminar con '-clean':
% album -clean /home/httpd/test/Photos4: Usando un tema
Si los temas fueron correctamente instalado y están en su
'theme_path', entonces podrá usar un tema con su álbum:
% album -theme Blue /home/httpd/test/Photos
Ahora el álbum de fotos deberá estar usando el tema "Blue". Si el
albúm contiene imágenes rotas, entonces el tema no se ha instalado
en un directorio de web accesible, vea el manual de instalación.
'Album' guarda las opciones que utiliza, entonces la próxima vez que ejecute 'album':
% album /home/httpd/test/Photos
Seguirá usando el tema Blue. Para dejar de usar un tema, puede:
% album -no_theme /home/httpd/test/Photos5: Imágenes medianas
Imágenes de máxima resolución normalmente son demasiada grandes
para un álbum en la red, entonces usaremos imágenes medianss en las
páginas de imágenes:
% album -medium 33% /home/httpd/test/Photos
Todavía puede acceder a las imágenes de tamaño completo al hacer
clic en la imagen mediana, o:
% album -just_medium /home/httpd/test/Photos
Mantendrá la imagen de resolución máxima sin enlace (suponiendo
que se había ejecutado la opción -medium en algún momento).
6: Agregar pies de foto EXIF
Vamos a agregar información de apertura a los pies de foto de cada imagen:
% album -exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
Esto sólo agregará información de apertura a cualquier imagen que
tiene la etiqueta EXIF 'Aperture' especificada (la parte entre los
símbolos '%'). También agregamos la etiqueta <br> para que la
información aparezca en un nuevo renglón.
Podemos agregar más información EXIF:
% album -exif "<br>focal: %FocalLength%" /home/httpd/test/Photos
Ya que 'album' guardó las opciones antes, ahora obtenemos ambas
etiquetas EXIF para cualquier imagen que especifica 'Aperture' y
'FocalLength'. Vamos a eliminar apertura:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
La opción '-no_exif' tiene que corresponder exactamente a la cadena
de caracteres anterior o será ignorada. También se puede editar el
archivo de configuración que creó 'album':
/home/httpd/test/Photos/album.conf
Y borrar la opción ahí.
7: Agregando más álbumes
Supongamos que hacemos un viaje a España. Tomamos algunas fotos y las ponemos en:
/home/httpd/test/Photos/Spain/
Ahora ejecute 'album' de nuevo al nivel superior:
% album /home/httpd/test/Photos
Esto arreglará 'Photos' para vincularlo a España y ejecutará
'album' para Spain/ también, con los mismos parámetros/temas ,
etc...
Ahora vayamos de viaje de nuevo, y creamos:
/home/httpd/test/Photos/Italy/
Podemos ejecutar 'album' al nivel superior:
% album /home/httpd/test/Photos
Pero esto escanearía de nuevo el directorio de España, el cual no ha cambiado.
'Album' normalmente no generará HTML o miniaturas de fotos si no se
necesita, pero todavía puede gastar tiempo, especialmente cuando los
álbumes sean más grandes.
Entonces podemos decirle que solo agregue el nuevo directorio:
% album -add /home/httpd/test/Photos/Italy
Esto arreglará el índice de nivel superior (en 'Photos') y
generará el álbum de Italia.
8: Traducido por:
Stewart Goodman (goodman.stewart gmail com)
1: Requisítos mínimos
1) El script en perl de album
2) Herramientas de ImageMagick (específicamente 'convert')
Ponga el script de 'album' y las herramientas de ImageMagick en alguna parte de su PATH,
o ejecute 'album' con su ruta completa (y especifique la ruta completa de 'convert'
ya sea en el script de 'album' o en los archivos de configuración en el álbum).
2: Configuración inicial
La primera vez que ejecute el script de 'album' le pedirá algunas preguntas
para configurarlo. Si está usando UNIX/OSX, entonces puede ejecutarlo la primera
vez como 'root' para que haga la configuración global y los temas para todos
en vez del usuario actual.
3: Instalación opcional
3) Temas
4) ffmpeg (para crear miniaturas de las imágenes)
5) jhead (para leer información EXIF)
6) plugins
7) Varias herramientas disponibles en MarginalHacks.com
4: UNIX
Casi todas las distribuciones de UNIX incluyen ImageMagick y perl, entonces solo descargue
el script de 'album' y los temas (#1 and #3 más arriba) y es todo.
Para probar que se haya instalado correctamente, ejecute el script en un directorio con imágenes:
% album /path/to/my/photos/5: Debian UNIX
'album' se encuentra en debian estable, sin embargo por el momento está un poco viejo.
Recomiendo descargar la versión más reciente en MarginalHacks.
Puede guardar el paquete .deb, y luego, como root, ejecute:
% dpkg -i album.deb6: Macintosh OSX
Funciona muy bien en OSX, pero debe ser ejecutado a través de una terminal. Solamente
instale el script de 'album' y las herramientas de ImageMagick, y teclee la ruta de 'album',
cualquier opción que quiera, y luego la ruta del directorio con las imágenes
(separados por espacios), por ejemplo:
% album -theme Blue /path/to/my/photos/7: Win95, Win98, Win2000/Win2k, WinNT, WinXP
(Windows 95, Windows 98, Windows 2000, Windows NT, Windows XP)
Hay dos métodos para ejecutar scripts de perl en Windows: usando ActivePerl
o Cygwin.
ActivePerl es más simple y permite la ejecución de 'album' a través de una terminal de DOS,
sin embargo me han dicho que no funciona con temas.
Cygwin es más voluminoso pero también un paquete más robusto que da acceso
a muchas herramientas como en UNIX, y 'album' es ejecutado en una terminal bash (UNIX shell).
Método Cygwin
-------------
1) Instale Cygwin
Escoja los paquetes: perl, ImageMagick, bash
¡No utilice la instalación inicial ImageMagick! ¡Debe usar los paquetes de Cygwin de ImageMagick!
2) Instale album en una ruta bash o ejecútelo usando una ruta absoluta:
bash% album /some/path/to/photos
3) Si quere indormación exif en los pies de foto, necesita la versión de Cygwin jheadMétodo ActivePerl
-----------------
1) Instale ImageMagick para Windows
2) Instale ActivePerl, instalación completa (no se necesita un perfil para PPM)
Escoja: "Add perl to PATH" y "Create Perl file extension association"
3) En Win98: Instale tcap en la ruta
4) Guarde 'album' como album.pl en la ruta de Windows
5) Use una terminal de DOS para ejecutar:
C:> album.pl C:\some\path\to\photosAtención: Algunas versiones de Windows (por lo menos 2000/NT) tienen su
propio "convert.exe" en el directorio c:\windows\system32 (¿una utilidad para NTFS?).
Si lo tiene, entonces necesito editar el variable de la ruta,
or solamente especifique la ruta absoluta de 'convert' en el script de 'album'.
8: ¿Cómo edito la ruta de Windows?Usuarios de Windows NT4
Oprima el botón derecho en "My Computer", seleccione "Properties".
Seleccione la pestaña "Environment".
En "System Variables" seleccione "Path".
En "Value" agregue las rutas nuevas separados por puntos y coma
Oprima "OK/Set", oprima "OK" de nuevo.
Usuarios de Windows 2000
Oprima el botón derecho en "My Computer", seleccione "Properties".
Seleccione la pestaña "Advanced".
Oprima "Environment Variables".
En "System Variables" oprima dos veces en "Path"
En "Value" agregue las rutas nuevas separados por puntos y coma
Oprima "OK/Set", oprima "OK" de nuevo.
Windows XP Users
Abra "My Computer" y seleccione "Change a Setting".
Oprima dos veces "System".
Seleccione la pestaña "Advanced".
Seleccione "Environment Variables".
En "System Variables" oprima dos veces en "Path"
En "Value" agregue las rutas nuevas separados por puntos y coma
Oprima "OK".
9: Macintosh OS9
No tengo planes de transferir 'album' a OS9 - no se en que estado están
las consolas y perl en pre-OSX. Si logra hacer que funcione
en OS9, avíseme.
10: Traducido por:
Stewart Goodman (goodman.stewart gmail com)
1: What are Plugins?
Plugins are snippets of code that allow you to modify the behavior
of album. They can be as simple as a new way to create EXIF captions,
to something as complex as creating the album based on a database of
images instead of using the filesystem hierarchy.
2: Installing Plugins and plugin support
There are a number of plugins available with the standard installation of
album. If you are upgrading album with plugins from an earlier version
of album that did not have plugins (pre v3.10), you may need to once do:
% album -configure
You will not need to do this with future upgrades of album.
This will install the current plugins into one of the default
plugin directories - album will look for plugins in a number of
locations, the default locations are:
/etc/album/plugins/
/usr/share/album/plugins/
$HOME/.album/plugins/
In reality, these are 'plugins' directories found in the set of
locations specified by '--data_path' - hence the defaults are:
/etc/album/
/usr/share/album/
$HOME/.album/
You can specify a new location with --data_path and then add a 'plugins'
directory to that location, or use the --plugin_path option.
Plugins usually end with the ".alp" prefix, but you do not need
to specify this prefix when using plugins. For example, if you
have a plugin installed at:
/etc/album/plugins/utils/mv.alp
Then you would specify the plugin as: utils/mv3: Loading/Unloading Plugins
To list all the currently installed plugins:
% album -list_plugins
To show information about a specific plugin (using 'utils/mv' as an example):
% album -plugin_info utils/mv
Plugins will be saved in the configuration for a given album, so
they don't need to be respecified every time (excluding one-time
plugins such as 'utils/mv')
You can use -no_plugin and -clear_plugin to turn off plugins that have
been saved in an album configuration. As with normal album options,
-no_plugin will turn off a specific plugin, and -clear_plugin will
turn off all plugins. Any saved plugin options for that plugin will be
erased as well.
4: Plugin Options
A few plugins may be able to take command-line options, to view usage
for these plugins:
% album -plugin_usage utils/mv
But when specifying plugin options, you need to tell album which plugin
the option belongs to. Instead of specifying as a normal album option:
% album -some_option
You prefix the option with the plugin name followed by a colon:
% album -some_plugin:some_option
For example, you can specify the generated 'index' created by
the 'utils/capindex' plugin.
% album -plugin utils/capindex -utils/capindex:index blah.html
That's a bit unwieldy. You can shorten the name of the plugin as
long as it doesn't conflict with another plugin you've loaded (by
the same name):
% album -plugin utils/capindex -capindex:index
Obviously the other types of options (strings, numbers and arrays) are
possible and use the same convention. They are saved in album configuration
the same as normal album options.
One caveat: As mentioned, once we use a plugin on an album it is saved
in the configuration. If you want to add options to an album that is
already configured to use a plugin, you either need to mention the plugin
again, or else use the full name when specifying the options (otherwise
we won't know what the shortened option belongs to).
For example, consider an imaginary plugin:
% album -plugin some/example/thumbGen Photos/Spain
After that, let's say we want to use the thumbGen boolean option "fast".
This will not work:
% album -thumbGen:fast Photos/Spain
But either of these will work:
% album -plugin some/example/thumbGen -thumbGen:fast blah.html Photos/Spain% album -some/example/thumbGen:fast Photos/Spain5: Writing Plugins
Plugins are small perl modules that register "hooks" into the album code.
There are hooks for most of the album functionality, and the plugin hook
code can often either replace or supplement the album code. More hooks
may be added to future versions of album as needed.
You can see a list of all the hooks that album allows:
% album -list_hooks
And you can get specific information about a hook:
% album -hook_info <hook_name>
We can use album to generate our plugin framework for us:
% album -create_plugin
For this to work, you need to understand album hooks and album options.
We can also write the plugin by hand, it helps to use an already
written plugin as a base to work off of.
In our plugin we register the hook by calling the album::hook() function.
To call functions in the album code, we use the album namespace.
As an example, to register code for the clean_name hook our plugin calls:
album::hook($opt,'clean_name',\&my_clean);
Then whenever album does a clean_name it will also call the plugin
subroutine called my_clean (which we need to provide).
To write my_clean let's look at the clean_name hook info:
Args: ($opt, 'clean_name', $name, $iscaption)
Description: Clean a filename for printing.
The name is either the filename or comes from the caption file.
Returns: Clean name
The args that the my_clean subroutine get are specified on the first line.
Let's say we want to convert all names to uppercase. We could use:
sub my_clean {
my ($opt, $hookname, $name, $iscaption) = @_;
return uc($name);
}
Here's an explanation of the arguments:
$opt This is the handle to all of album's options.
We didn't use it here. Sometimes you'll need it if you
call any of albums internal functions. This is also true
if a $data argument is supplied.
$hookname In this case it will be 'clean_name'. This allows us
to register the same subroutine to handle different hooks.
$name This is the name we are going to clean.
$iscaption This tells us whether the name came from a caption file.
To understand any of the options after the $hookname you
may need to look at the corresponding code in album.
In this case we only needed to use the supplied $name, we called
the perl uppercase routine and returned that. The code is done, but now
we need to create the plugin framework.
Some hooks allow you to replace the album code. For example, you
could write plugin code that can generate thumbnails for pdf files
(using 'convert' is one way to do this). We can register code for
the 'thumbnail' hook, and just return 'undef' if we aren't looking
at a pdf file, but when we see a pdf file, we create a thumbnail
and then return that. When album gets back a thumbnail, then it
will use that and skip it's own thumbnail code.
Now let's finish writing our uppercase plugin. A plugin must do the following:
1) Supply a 'start_plugin' routine. This is where you will likely
register hooks and specify any command-line options for the plugin.
2) The 'start_plugin' routine must return the plugin info
hash, which needs the following keys defined:
author => The author name
href => A URL (or mailto, of course) for the author
version => Version number for this plugin
description => Text description of the plugin
3) End the plugin code by returning '1' (similar to a perl module).
Here is our example clean_name plugin code in a complete plugin:
sub start_plugin {
my ($opt) = @_;
album::hook($opt,'clean_name',\&my_clean);
return {
author => 'David Ljung Madison',
href => 'http://MarginalHacks.com/',
version => '1.0',
description => "Conver image names to uppercase",
};
}
sub my_clean {
return uc($name);
}
1;
Finally, we need to save this somewhere. Plugins are organized in the
plugin directory hierarchy, we could save this in a plugin directory as:
captions/formatting/NAME.alp
In fact, if you look in examples/formatting/NAME.alp you'll find that
there's a plugin already there that does essentially the same thing.
If you want your plugin to accept command-line options, use 'add_option.'
This must be done in the start_plugin code. Some examples:
album::add_option(1,"fast",album::OPTION_BOOL, usage=>"Do it fast");
album::add_option(1,"name", album::OPTION_STR, usage=>"Your name");
album::add_option(1,"colors",album::OPTION_ARR, usage=>"Color list");
For more info, see the 'add_option' code in album and see all of the uses
of it (at the top of album and in plugins that use 'add_option')
To read an option that the user may have set, we use option():
my $fast = album::option($opt, "fast");
If the user gave a bad value for an option, you can call usage():
album::usage("-colors array can only include values [red, green, blue]");
If your plugin needs to load modules that are not part of the
standard Perl distribution, please do this conditionally. For
an example of this, see plugins/extra/rss.alp.
You can also call any of the routines found in the album script
using the album:: namespace. Make sure you know what you are doing.
Some useful routines are:
album::add_head($opt,$data, "<meta name='add_this' content='to the <head>'>");
album::add_header($opt,$data, "<p>This gets added to the album header");
album::add_footer($opt,$data, "<p>This gets added to the album footer");
The best way to figure out how to write plugins is to look at other
plugins, possibly copying one that is similar to yours and working
off of that. Plugin development tools may be created in the future.
Again, album can help create the plugin framework for you:
% album -create_plugin
1: Using languages
(Requires album v4.0 or higher)
Album comes prepackaged with language files (we're in need of translation
help, see below!). The language files will alter most of album's output
messages, as well as any HTML output that isn't generated by the theme.
Altering any text in a theme to match your language is as simple as editing
the Theme files - there is an example of this with the "simple-Czech" theme.
To use a language, add the "lang" option to your main album.conf, or else
specify it the first time you generate an album (it will be saved with that
album afterwards).
Languages can be cleared like any code/array option with:
% album -clear_lang ...
You can specify multiple languages, which can matter if a language is
incomplete, but you'd like to default to another language than english.
So, for example, if you wanted Dutch as the primary language, with the
backup being Swedish Chef, you could do:
% album -lang swedish_chef -lang nl ...
If you specify a sublanguage (such as es-bo for Spanish, Bolivia), then
album will attempt 'es' first as a backup.
Note that because of a known bug, you should specify all the desired
languages at the same time instead of over multiple invocations of album.
To see what languages are available:
% album -list_langs
Sadly, most of the (real) languages are barely complete, but this
is a chance for people to help out by becoming a..
2: Translation Volunteers
The album project is in need of volunteers to do translations,
specifically of:
1) The Mini How-To. Please translate from the source.
2) album messages, as explained below.
If you are willing to do the translation of either one or both
of these items, please contact me!
If you're feeling particularly ambitious, feel free to translate any
of the other Documentation sources as well, just let me know!
3: Documentation Translation
The most important document to translate is the "Mini How-To".
Please translate from the text source.
Also be sure to let me know how you want to be credited,
by your name, name and email, or name and website.
And please include the proper spelling and capitalization of the
name of your language in your language. For example, "franais"
instead of "French"
I am open to suggestions for what charset to use. Current options are:
1) HTML characters such as [é]] (though they only work in browsers)
2) Unicode (UTF-8) such as [é] (only in browsers and some terminals)
3) ASCII code, where possible, such as [] (works in text editors, though
not currently in this page because it's set to unicode)
4) Language specific iso such as iso-8859-8-I for Hebrew.
Currently Unicode (utf-8) seems best for languages that aren't covered
by iso-8859-1, because it covers all languages and helps us deal with
incomplete translations (which would otherwise require multiple charsets,
which is a disaster). Any iso code that is a subset of utf-8 can be used.
If the main terminal software for a given language is in an iso charset
instead of utf, then that could be a good exception to use non-utf.
4: Album messages
album handles all text messages using it's own language support
system, similar to the system used by the perl module Locale::Maketext.
(More info on the inspiration for this is in TPJ13)
An error message, for example, may look like this:
No themes found in [[some directory]].
With a specific example being:
No themes found in /www/var/themes.
In Dutch, this would be:
Geen thema gevonden in /www/var/themes.
The "variable" in this case is "/www/var/themes" and it obviously
isn't translated. In album, the actual error message looks like:
'No themes found in [_1].'
# Args: [_1] = $dir
The translation (in Dutch) looks like:
'No themes found in [_1].' => 'Geen thema gevonden in [_1].'
After translating, album will replace [_1] with the directory.
Sometimes we'll have multiple variables, and they may change places:
Some example errors:
Need to specify -medium with -just_medium option.
Need to specify -theme_url with -theme option.
In Dutch, the first would be:
Met de optie -just_medium moet -medium opgegeven worden.
The actual error with it's Dutch translation is:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet [_1] opgegeven worden'
# Args: [_1]='-medium' [_2]='-just_medium'
Note that the variables have changed places.
There is also a special operator for quantities, for example,
we may wish to translate:
'I have 42 images'
Where the number 42 may change. In English, it is adequate to say:
0 images, 1 image, 2 images, 3 images...
Whereas in Dutch we would have:
0 afbeeldingen, 1 afbeelding, 2 afbeeldingen, 3 afbeeldingen..
But other languages (such as many slavic languages) may have special
rules as to whether "image" should be pluralized based on whether the
quantity is mod 2, 3 or 4, and so on! The simplest case is covered
by the [quant] operator:
[quant,_1,image]
This is similar to "[_1] image" except that "image" will be pluralized
if [_1] is 0 or greater than 1:
0 images, 1 image, 2 images, 3 images...
Pluralization is simply adding an 's' - if this isn't adequate, we can
specify the plural form:
[quant,_1,afbeelding,afbeeldingen]
Which gives us the Dutch count above.
And if we need a special form for 0, we can specify that:
[quant,_1,directory,directories,no directories]
Which would create:
no directories, 1 directory, 2 directories, ...
There is also a shorthand for [quant] using '*', so these are the same:
[quant,_1,image]
[*,_1,image]
So now an example translation for a number of images:
'[*,_1,image]'
=> '[*,_1,afbeelding,afbeeldingen]',
If you have something more complicated then you can use perl code, I
can help you write this if you let me know how the translation should work:
'[*,_1,image]'
=> \&russian_quantity; # This is a sub defined elsewhere..
Since the translation strings are (generally) placed in single-quotes (')
and due to the special [bracket] codes, we need to quote these correctly.
Single-quotes in the string need to be preceded by a slash (\):
'I can\'t find any images'
And square brackets are quoted using (~):
'Problem with option ~[-medium~]'
Which unfortunately can get ugly if the thing inside the square brackets
is a variable:
'Problem with option ~[[_1]~]'
Just be careful and make sure all brackets are closed appropriately.
Furthermore, in almost all cases, the translation should have the
same variables as the original:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet' # <- Where did [_1] go?!?
Fortunately, most of the work is done for you. Language files are
saved in the -data_path (or -lang_path) where album keeps it's data.
They are essentially perl code, and they can be auto-generated by album:
% album -make_lang sw
Will create a new, empty language file called 'sw' (Swedish). Go ahead
and edit that file, adding translations as you can. It's okay to leave
translations blank, they just won't get used. Some of the more important
translations (such as the ones that go into HTML pages) are at the top
and should probably be done first.
You will need to pick a charset, this is tricky, as it should be based
on what charsets you think people will be likely to have available
in their terminal as well as in their browser.
If you want to build a new language file, using translations from
a previous file (for example, to update a language with whatever
new messages have been added to album), you should load the language first:
% album -lang sw -make_lang sw
Any translations in the current Swedish language file will be copied
over to the new file (though comments and other code will not be copied!)
For the really long lines of text, don't worry about adding any newline
characters (\n) except where they exist in the original. album will
do word wrap appropriately for the longer sections of text.
Please contact me when you are starting translation work so I can
be sure that we don't have two translators working on the same parts,
and be sure to send me updates of language files as the progress, even
incomplete language files are useful!
If you have any questions about how to read the syntax of the language
file, please let me know.
5: Why am I still seeing English?
After choosing another language, you can still sometimes see English:
1) Option names are still in English. (-geometry is still -geometry)
2) The usage strings are not currently translated.
3) Plugin output is unlikely to be translated.
4) Language files aren't always complete, and will only translate what they know.
5) album may have new output that the language file doesn't know about yet.
6) Most themes are in English.
Fortunately the last one is the easiest to change, just edit the theme
and replace the HTML text portions with whatever language you like, or
create new graphics in a different language for icons with English.
If you create a new theme, I'd love to hear about it!
album-4.17/Docs/es/conf 0000655 0000000 0000000 00000000000 12661457776 017271 1album-4.17/Docs/it/conf ustar root root album-4.17/Docs/es/broken.txt_2 0000644 0000000 0000000 00000026065 11072326104 015011 0 ustar root root M I N I M A N U A L
< s p a n l a n g = " e s " >
I T E M : l b u m s e n c i l l o
D e s p u s d e i n s t a l a r ' a l b u m ' c o r r e c t a m e n t e , s e p o d r n h a c e r u n o s c a s o s s e n c i l l o s . S i s e p r o d u c e a l g n e r r o r o t i e n e p r o b l e m a s e n e s t a s e c c i n , v e a e l m a n u a l d e i n s t a l a c i n .
N e c e s i t a u n d i r e c t o r i o d e w e b p a r a a g r e g a r t e m a s y s u l b u m d e f o t o s .
E n e s t e m a n u a l s e u s a r / h o m e / h t t p d / t e s t . E s n e c e s a r i o q u e e s t e d i r e c t o r i o s e a v i s i b l e p o r u n s e r v i d o r d e w e b . E n e s t e e j e m p l o s e u s a r e s t e U R L :
h t t p : / / m y s e r v e r / t e s t /
C a m b i e s u s c o m a n d o s / U R L s d e b i d a m e n t e .
P r i m e r o c r e e u n d i r e c t o r i o y a g r e g u e a l g u n a s i m g e n e s . L o l l a m a r e m o s :
/ h o m e / h t t p / t e s t / P h o t o s
Y a g r e g a r e m o s u n a s i m g e n e s l l a m a d a s ' I M G _ 0 0 1 . j p g ' h a s t a ' I M G _ 0 0 4 . j p g '
P a r a u n c a s o s e n c i l l o , s i m p l e m e n t e e j e c u t e ' a l b u m ' :
< c o d e > % a l b u m / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
A h o r a p u e d e v e r e l l b u m e n u n n a v e g a d o r d e w e b e n u n a d i r e c c i n c o m o :
h t t p : / / m y s e r v e r / t e s t / P h o t o s
I T E M : A g r e g a r p i e s d e f o t o
C r e e u n a r c h i v o / h o m e / h t t p d / t e s t / P h o t o s / c a p t i o n s . t x t c o n l o s s i g u i e n t e s c o n t e n i d o s ( u s e l a t e c l a d e t a b u l a c i n d o n d e v e a " [ t a b ] " )
- - c a p t i o n s . t x t - - - - - - - - -
I M G _ 0 0 1 . j p g [ t a b ] N o m b r e d e l a p r i m e r a i m a g e n
I M G _ 0 0 2 . j p g [ t a b ] S e g u n d a i m a g e n
I M G _ 0 0 3 . j p g [ t a b ] O t r a i m a g e n [ t a b ] c o n p i e d e f o t o !
I M G _ 0 0 4 . j p g [ t a b ] l t i m a i m a g e n [ t a b ] c o n o t r o p i e d e f o t o .
- - - - - - - - - - - - - - - - - - - - - - - - -
Y e j e c t u e ' a l b u m ' d e n u e v o :
< c o d e > % a l b u m / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
Y v e r c a m b i a r l o s p i e s d e f o t o .
A h o r a c r e e u n a r c h i v o c o n t e x t o e n : / h o m e / h t t p d / t e s t / P h o t o s / h e a d e r . t x t
Y e j e c u t e ' a l b u m ' d e n u e v o . V e r e s e t e x t o e n l a p a r t e s u p e r i o r d e l a p g i n a .
I T E M : E s c o n d e r f o t o s
H a y u n p a r d e m a n e r a s p a r a e s c o n d e r f o t o s / a r c h i v o s / d i r e c t o r i o s , p e r o u s a r e m o s e l a r c h i v o d e p i e s d e f o t o . I n t e n t e c o m e n t a r u n a i m a g e n c o n ' # ' e n c a p t i o n s . t x t :
- - c a p t i o n s . t x t - - - - - - - - -
I M G _ 0 0 1 . j p g [ t a b ] N o m b r e d e l a p r i m e r a i m a g e n
# I M G _ 0 0 2 . j p g [ t a b ] S e g u n d a i m a g e n
I M G _ 0 0 3 . j p g [ t a b ] O t r a i m a g e n [ t a b ] c o n p i e d e f o t o !
I M G _ 0 0 4 . j p g [ t a b ] l t i m a i m a g e n [ t a b ] c o n o t r o p i e d e f o t o .
- - - - - - - - - - - - - - - - - - - - - - - - -
E j e c u t e ' a l b u m ' d e n u e v o , y v e r q u e e l I M G _ 0 0 2 . j p g e s t e s c o n d i d o .
S i e s t o s e h u b i e r a h e c h o a l e j e c u t a r ' a l b u m ' p o r p r i m e r a v e z , n o s e h a b r a n g e n e r a d o n i f o t o s t a m a o m e d i a n o n i l a s m i n i a t u r a s . S i g u s t a , l o s p u e d e e l i m i n a r c o n ' - c l e a n ' :
< c o d e > % a l b u m - c l e a n / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
I T E M : U s a n d o u n t e m a
S i l o s t e m a s f u e r o n c o r r e c t a m e n t e i n s t a l a d o y e s t n e n s u ' t h e m e _ p a t h ' , e n t o n c e s p o d r u s a r u n t e m a c o n s u l b u m :
< c o d e > % a l b u m - t h e m e B l u e / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
A h o r a e l l b u m d e f o t o s d e b e r e s t a r u s a n d o e l t e m a " B l u e " . S i e l a l b m c o n t i e n e i m g e n e s r o t a s , e n t o n c e s e l t e m a n o s e h a i n s t a l a d o e n u n d i r e c t o r i o d e w e b a c c e s i b l e , v e a e l m a n u a l d e i n s t a l a c i n .
' A l b u m ' g u a r d a l a s o p c i o n e s q u e u t i l i z a , e n t o n c e s l a p r x i m a v e z q u e e j e c u t e ' a l b u m ' :
< c o d e > % a l b u m / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
S e g u i r u s a n d o e l t e m a B l u e . P a r a d e j a r d e u s a r u n t e m a , p u e d e :
< c o d e > % a l b u m - n o _ t h e m e / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
I T E M : I m g e n e s m e d i a n a s
I m g e n e s d e m x i m a r e s o l u c i n n o r m a l m e n t e s o n d e m a s i a d a g r a n d e s p a r a u n l b u m e n l a r e d , e n t o n c e s u s a r e m o s i m g e n e s m e d i a n s s e n l a s p g i n a s d e i m g e n e s :
< c o d e > % a l b u m - m e d i u m 3 3 % / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
T o d a v a p u e d e a c c e d e r a l a s i m g e n e s d e t a m a o c o m p l e t o a l h a c e r c l i c e n l a i m a g e n m e d i a n a , o :
< c o d e > % a l b u m - j u s t _ m e d i u m / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
M a n t e n d r l a i m a g e n d e r e s o l u c i n m x i m a s i n e n l a c e ( s u p o n i e n d o q u e s e h a b a e j e c u t a d o l a o p c i n - m e d i u m e n a l g n m o m e n t o ) .
I T E M : A g r e g a r p i e s d e f o t o E X I F
V a m o s a a g r e g a r i n f o r m a c i n d e a p e r t u r a a l o s p i e s d e f o t o d e c a d a i m a g e n :
< c o d e > % a l b u m - e x i f " & l t ; b r & g t ; a p e r t u r e = % A p e r t u r e % " / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
E s t o s l o a g r e g a r i n f o r m a c i n d e a p e r t u r a a c u a l q u i e r i m a g e n q u e t i e n e l a e t i q u e t a E X I F ' A p e r t u r e ' e s p e c i f i c a d a ( l a p a r t e e n t r e l o s s m b o l o s ' % ' ) . T a m b i n a g r e g a m o s l a e t i q u e t a & l t ; b r & g t ; p a r a q u e l a i n f o r m a c i n a p a r e z c a e n u n n u e v o r e n g l n .
P o d e m o s a g r e g a r m s i n f o r m a c i n E X I F :
< c o d e > % a l b u m - e x i f " & l t ; b r & g t ; f o c a l : % F o c a l L e n g t h % " / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
Y a q u e ' a l b u m ' g u a r d l a s o p c i o n e s a n t e s , a h o r a o b t e n e m o s a m b a s e t i q u e t a s E X I F p a r a c u a l q u i e r i m a g e n q u e e s p e c i f i c a ' A p e r t u r e ' y ' F o c a l L e n g t h ' . V a m o s a e l i m i n a r a p e r t u r a :
< c o d e > % a l b u m - n o _ e x i f " & l t ; b r & g t ; a p e r t u r e = % A p e r t u r e % " / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
L a o p c i n ' - n o _ e x i f ' t i e n e q u e c o r r e s p o n d e r e x a c t a m e n t e a l a c a d e n a d e c a r a c t e r e s a n t e r i o r o s e r i g n o r a d a . T a m b i n s e p u e d e e d i t a r e l a r c h i v o d e c o n f i g u r a c i n q u e c r e ' a l b u m ' :
/ h o m e / h t t p d / t e s t / P h o t o s / a l b u m . c o n f
Y b o r r a r l a o p c i n a h .
I T E M : A g r e g a n d o m s l b u m e s
S u p o n g a m o s q u e h a c e m o s u n v i a j e a E s p a a . T o m a m o s a l g u n a s f o t o s y l a s p o n e m o s e n :
/ h o m e / h t t p d / t e s t / P h o t o s / S p a i n /
A h o r a e j e c u t e ' a l b u m ' d e n u e v o a l n i v e l s u p e r i o r :
< c o d e > % a l b u m / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
E s t o a r r e g l a r ' P h o t o s ' p a r a v i n c u l a r l o a E s p a a y e j e c u t a r ' a l b u m ' p a r a S p a i n / t a m b i n , c o n l o s m i s m o s p a r m e t r o s / t e m a s , e t c . . .
A h o r a v a y a m o s d e v i a j e d e n u e v o , y c r e a m o s :
/ h o m e / h t t p d / t e s t / P h o t o s / I t a l y /
P o d e m o s e j e c u t a r ' a l b u m ' a l n i v e l s u p e r i o r :
< c o d e > % a l b u m / h o m e / h t t p d / t e s t / P h o t o s < / c o d e >
P e r o e s t o e s c a n e a r a d e n u e v o e l d i r e c t o r i o d e E s p a a , e l c u a l n o h a c a m b i a d o .
' A l b u m ' n o r m a l m e n t e n o g e n e r a r H T M L o m i n i a t u r a s d e f o t o s s i n o s e n e c e s i t a , p e r o t o d a v a p u e d e g a s t a r t i e m p o , e s p e c i a l m e n t e c u a n d o l o s l b u m e s s e a n m s g r a n d e s .
E n t o n c e s p o d e m o s d e c i r l e q u e s o l o a g r e g u e e l n u e v o d i r e c t o r i o :
< c o d e > % a l b u m - a d d / h o m e / h t t p d / t e s t / P h o t o s / I t a l y < / c o d e >
E s t o a r r e g l a r e l n d i c e d e n i v e l s u p e r i o r ( e n ' P h o t o s ' ) y g e n e r a r e l l b u m d e I t a l i a .
I T E M : T r a d u c i d o p o r :
S t e w a r t G o o d m a n
< / s p a n > album-4.17/Docs/es/txt_5 0000655 0000000 0000000 00000000000 11076703643 017507 1album-4.17/Docs/it/txt_5 ustar root root album-4.17/Docs/es/Section_3.html 0000644 0000000 0000000 00000075216 12661460265 015301 0 ustar root root
MarginalHacks album - Running album / Basic Options
- Documentation
A l b u m
T h r e e - - R u n n i n g a l b u m / B a s i c O p t i o n s
1: Basic execution
Create a directory with nothing but images in it. The album script and
other tools should not go here. Then run album specifying that directory:
% album /example/path/to/images/
Or, if you're in the /example/path/to directory:
% album images/
When it's done, you'll have a photo album inside that directory starting
with images/index.html.
If that path is in your web server, then you can view it with your
browser. If you can't find it, talk to your sysadmin.
2: Options
There are three types of options. Boolean options, string/num options
and array options. Boolean options can be turned off by prepending -no_:
% album -no_image_pages
String and number values are specified after a string option:
% album -type gif
% album -columns 5
Array options can be specified two ways, with one argument at a time:
% album -exif hi -exif there
Or multiple arguments using the '--' form:
% album --exif hi there --
You can remove specific array options with -no_<option>
and clear all the array options with -clear_<option>.
To clear out array options (say, from the previous album run):
% album -clear_exif -exif "new exif"
(The -clear_exif will clear any previous exif settings and then the
following -exif option will add a new exif comment)
And finally, you can remove specific array options with 'no_':
% album -no_exif hi
Which could remove the 'hi' exif value and leave the 'there' value intact.
Also see the section on Saving Options.
To see a brief usage:
% album -h
To see more options:
% album -more
And even more full list of options:
% album -usage=2
You can specify numbers higher than 2 to see even more options (up to about 100)
Plugins can also have options with their own usage.
3: Themes
Themes are an essential part of what makes album compelling.
You can customize the look of your photo album by downloading a
theme from MarginalHacks or even writing your own theme to match
your website.
To use a theme, download the theme .tar or .zip and unpack it.
Themes are found according to the -theme_path setting, which is
a list of places to look for themes. Those paths need to be somewhere
under the top of your web directory, but not inside a photo album
directory. It needs to be accessible from a web browser.
You can either move the theme into one of the theme_paths that album
is already using, or make a new one and specify it with the -theme_path
option. (-theme_path should point to the directory the theme is in,
not the actual theme directory itself)
Then call album with the -theme option, with or without -theme_path:
% album -theme Dominatrix6 my_photos/
% album -theme Dominatrix6 -theme_path /home/httpd/album/Themes/ my_photos/
You can also create your own themes pretty easily, this is covered
later in this documentation.
4: Sub-albums
Make directories inside your first directory and put images in that.
Run album again, and it will run through all the child directories
and create sub-albums of the first album.
If you make changes to just a sub-album, you can run album on that
and it will keep track of all the parent links.
If you don't want to traverse down the tree of directories, you
can limit it with the depth option. Example:
% album images/ -depth 1
Will only generate photo albums for the images directory.
If you have many sub-albums, and you want to add a new sub-album
without regenerating all the previous sub-albums, then you can use -add:
% album -add images/new_album/
Which will add the new_album to the HTML for 'images/' and then
generate the thumbs and HTML for everything inside 'images/new_album/'
5: Avoiding Thumbnail Regeneration
album tries to avoid unnecessary work. It only creates thumbnails if
they don't exist and haven't changed. This speeds up successive runs
of album.
This can cause a problem if you change the size or cropping of your
thumbnails, because album won't realize that the thumbnails have changed.
You can use the force option to force album to regenerate thumbnails:
% album -force images/
But you shouldn't need to use -force every time.
6: Cleaning Out The Thumbnails
If you remove images from an album then you'll have leftover thumbs and HTML.
You can remove them by running album once with the -clean option:
% album -clean images/7: Medium size images
When you click on an album thumbnail you're taken to an 'image_page.'
The image_page shows, by default, the full size image (as well as
navigation buttons and captions and such). When you click on the
image on the image_page, you'll be taken to the URL for just the full
size image.
If you want a medium size image on the image_page, use the -medium
option and specify a geometry for the medium size image. You can
specify any geometry that ImageMagick can use (see their man page
for more info). Some examples:
# An image that is half the full size
% album -medium 50%
# An image that fits inside 640x480 (maximum size)
% album -medium 640x480
# An image that is shrunk to fit inside 640x480
# (but won't be enlarged if it's smaller than 640x480)
% album -medium '640x480>'
You need the 'quotes' on the last example with most shells because
of the '>' character.
8: Captions
Images and thumbnails can have names and captions. There are a number
of ways to specify/change names and captions in your photo albums.
The name is linked to the image or image_page,
and the caption follows underneath.
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
One way to specify a caption is in a .txt file
with the same name as the image. For this example,
"Kodi_Cow.txt" could contain "Kodi takes down a cow!"
You can rename your images and specify captions in bulk
for an album directory with a captions.txt file.
Each line of the file should be an image or directory filename,
followed by a tab, followed by the new name. You can also
specify (separated by tabs), an optional caption and then an optional
image ALT tag. (To skip a field, use 'tab' 'space' 'tab')
Example:
001.gif My first photo
002.gif Mom and Dad My parents in the grand canyon
003.gif Ani DiFranco My fiancee Yowsers!
The images and directories will also be sorted in the order they are found
in the caption file. You can override this with '-sort date' and '-sort name'
If your editor doesn't handle tabs very well, then you can separate the
fields by double-colons, but only if the caption line doesn't contain any
tabs at all:
003.gif :: Ani DiFranco :: My fiancee :: Yowsers!
If you only want captions on image pages (not on album pages) use:
% album -no_album_captions
If you want web access to create/edit your captions, look at the
caption_edit.cgi CGI script (but be sure to limit access to the
script or anyone can change your captions!)
9: EXIF Captions
You can also specify captions that are based off of EXIF information
(Exchangeable Image File Format) which most digital cameras add to images.
First you need 'jhead' installed. You should be able to run jhead
on a JPG file and see the comments and information.
EXIF captions are added after the normal captions and are specified with -exif:
% album -exif "<br>File: %File name% taken with %Camera make%"
Any %tags% found will be replaced with EXIF information. If any %tags%
aren't found in the EXIF information, then that EXIF caption string is
thrown out. Because of this you can specify multiple -exif strings:
% album -exif "<br>File: %File name% " -exif "taken with %Camera make%"
This way if the 'Camera make' isn't found you can still get the 'File name'
caption.
Like any of the array style options you can use --exif as well:
% album --exif "<br>File: %File name% " "taken with %Camera make%" --
Note that, as above, you can include HTML in your EXIF tags:
% album -exif "<br>Aperture: %Aperture%"
To see the possible EXIF tags (Resolution, Date/Time, Aperture, etc..)
run a program like 'jhead' on an digital camera image.
You can also specify EXIF captions only for album or image pages, see
the -exif_album and -exif_image options.
10: Headers and Footers
In each album directory you can have text files header.txt and footer.txt
These will be copied verbatim into the header and footer of your album (if
it's supported by the theme).
11: Hiding Files/Directories
Any files that album does not recognize as image types are ignored.
To display these files, use -no_known_images. (-known_images is default)
You can mark an image as a non-image by creating an empty file with
the same name with .not_img added to the end.
You can ignore a file completely by creating an empty file with
the same name with .hide_album on the end.
You can avoid running album on a directory (but still include it in your
list of directories) by creating a file <dir>/.no_album
You can ignore directories completely by creating a file <dir>/.hide_album
The Windows version of album doesn't use dots for no_album, hide_album
and not_img because it's difficult to create .files in Windows.
12: Cropping Images
If your images are of a large variety of aspect ratios (i.e., other than
just landscape/portrait) or if your theme only allows one orientation,
then you can have your thumbnails cropped so they all fit the same geometry:
% album -crop
The default cropping is to crop the image to center. If you don't
like the centered-cropping method that the album uses to generate
thumbnails, you can give directives to album to specify where to crop
specific images. Just change the filename of the image so it has a
cropping directive before the filetype. You can direct album to crop
the image at the top, bottom, left or right. As an example, let's
say you have a portrait "Kodi.gif" that you want cropped on top for
the thumbnail. Rename the file to "Kodi.CROPtop.gif" and this will
be done for you (you might want to -clean out the old thumbnail).
The "CROP" string will be removed from the name that is printed in
the HTML.
The default geometry is 133x133. This way landscape images will
create 133x100 thumbnails and portrait images will create 100x133
thumbnails. If you are using cropping and you still want your
thumbnails to have that digital photo aspect ratio, then try 133x100:
% album -crop -geometry 133x100
Remember that if you change the -crop or -geometry settings on a
previously generated album, you will need to specify -force once
to regenerate all your thumbnails.
13: Video
album can generate snapshot thumbnails of many video formats if you
install ffmpeg
If you are running linux on an x86, then you can just grab the binary,
otherwise get the whole package from ffmpeg.org (it's an easy install).
14: Burning CDs (using file://)
If you are using album to burn CDs or you want to access your albums with
file://, then you don't want album to assume "index.html" as the default
index page since the browser probably won't. Furthermore, if you use
themes, you must use relative paths. You can't use -theme_url because
you don't know what the final URL will be. On Windows the theme path
could end up being "C:/Themes" or on UNIX or OSX it could be something
like "/mnt/cd/Themes" - it all depends on where the CD is mounted.
To deal with this, use the -burn option:
% album -burn ...
This requires that the paths from the album to the theme don't change.
The best way to do this is take the top directory that you're going to
burn and put the themes and the album in that directory, then specify
the full path to the theme. For example, create the directories:
myISO/Photos/
myISO/Themes/Blue
Then you can run:
% album -burn -theme myISO/Themes/Blue myISO/Photos
Then you can make a CD image from the myISO directory (or higher).
If you are using 'galbum' (the GUI front end) then you can't specify
the full path to the theme, so you'll need to make sure that the version
of the theme you want to burn is the first one found in the theme_path
(which is likely based off the data_path). In the above example you
could add 'myISO' to the top of the data_path, and it should
use the 'myISO/Themes/Blue' path for the Blue theme.
You can also look at shellrun for windows users, you can have it
automatically launch the album in a browser. (Or see winopen)
15: Indexing your entire album
To navigate an entire album on one page use the caption_index tool.
It uses the same options as album (though it ignores many
of them) so you can just replace your call to "album" with "caption_index"
The output is the HTML for a full album index.
See an example index
for one of my example photo albums16: Updating Albums With CGI
First you need to be able to upload the photo to the album directory.
I suggest using ftp for this. You could also write a javascript that
can upload files, if someone could show me how to do this I'd love to know.
Then you need to be able to remotely run album. To avoid abuse, I
suggest setting up a CGI script that touches a file (or they can just
ftp this file in), and then have a cron job that checks for that
file every few minutes, and if it finds it it removes it and runs album.
[unix only] (You will probably need to set $PATH or use absolute paths
in the script for convert)
If you want immediate gratification, you can run album from a CGI script
such as this one.
If your photos are not owned by the webserver user, then you
need to run through a setud script which you run from a CGI [unix only].
Put the setuid script in a secure place, change it's ownership to be the
same as the photos, and then run "chmod ug+s" on it. Here are example
setuid and CGI scripts. Be sure to edit them.
Also look at caption_edit.cgi which allows you (or others) to edit
captions/names/headers/footers through the web.
1: Methods
There are easy ways and complicated ways to create a custom theme,
depending on what you want to be able to do.
2: Editing current theme HTML
If you just want to slightly change the theme to match the output
of your site, it might make sense to edit a current theme.
In the theme directory there are two *.th files. album.th is
the template for album pages (the thumbnail pages) and image.th
is the template for image pages (where you can see medium or full
size images). The files are very similar to HTML except for
some embedded <: ePerl :> code. Even if you don't know perl or
ePerl you can still edit the HTML to make simple changes.
Good starting themes:
Any simmer_theme is going to be up to date and clean, such as "Blue" or
"Maste." If you only need 4 corner thumbnail borders then take a look
at "Eddie Bauer." If you want overlay/transparent borders, see FunLand.
If you want something demonstrating a minimal amount of code, try "simple"
but be warned that I haven't touched the theme in a long time.
3: The easy way, simmer_theme from graphics.
Most themes have the same basic form, show a bunch of thumbnails
for directories and then for images, with a graphic border, line and
background. If this is what you want, but you want to create new
graphics, then there is a tool that will build your themes for you.
If you create a directory with the images and a CREDIT file as well
as a Font or Style.css file, then simmer_theme will create theme for you.
Files:
Font/Style.css
This determines the fonts used by the theme. The "Font" file is the
older system, documented below. Create a Style.css file and define
styles for: body, title, main, credit and anything else you like.
See FunLand for a simple example.
Alternatively, use a font file. An example Font file is:
--------------------------------------------------
$TITLE_FONT = "size='4' color='#ffffff' face='Times New Roman,Georgia,Times'";
$MAIN_FONT = "face='Times New Roman,Georgia,Times'";
$CREDIT_FONT = "size='-1' face='Verdana' color='#ffffff'";
$BODY = "background='$PATH/bkgrnd.gif' link='#0099FF'">
--------------------------------------------------
CREDIT
The credit file is two lines and is used for the theme index at MarginalHacks.
If you're never submitting your theme to us, then you don't need this file.
(But please do!) If so, the two lines (and only two lines) are:
1) A short description of the theme (keep it all on one line)
2) Your name (can be inside a mailto: or href link)
Null.gif
Each simmer theme needs a spacer image, this is a 1x1 transparent gif.
You can just copy this from another simmer theme.
Optional image files:
Bar Images
The bar is composed of Bar_L.gif, Bar_R.gif and Bar_M.gif in the middle.
The middle is stretched. If you need a middle piece that isn't stretched, use:
Bar_L.gif, Bar_ML.gif, Bar_M.gif, Bar_MR.gif, Bar_R.gif
And then the Bar_ML.gif and Bar_MR.gif will be stretched. (See the
Craftsman theme for an example of this).
Locked.gif
A lock image for any directories that have .htaccess
Background image
If you want a background image, specify it in the Font file in the $BODY
section, as in the example above. The $PATH variable will be replaced
with the path to the theme files:
More.gif
When an album page has sub-albums to list, it first shows the 'More.gif'
image.
Next.gif, Prev.gif, Back.gif
For the next and previous arrows and the back button
Icon.gif
Shown at the top left by the parent albums, this is often just the text "Photos"
Border Images
There are many ways to slice up a border, from simple to complex, depending on
the complexity of the border and how much you want to be able to stretch it:
4 pieces Uses Bord_L.gif, Bord_R.gif, Bord_T.gif, Bord_B.gif
(The corners go with the left and right images)
4 piece borders usually don't stretch well so they don't work well on
image_pages. Generally you can cut the corners out of the left and
right images to make:
8 pieces Also includes Bord_TL.gif, Bord_TR.gif, Bord_BL.gif, Bord_BR.gif
8 piece borders allow you to stretch to handle most sized images
12 pieces Also includes Bord_LT.gif, Bord_RT.gif, Bord_LB.gif, Bord_RB.gif
12 pieces allow stretching of borders that have more complex corners (such
as Dominatrix6 or Ivy)
Overlay Borders Can use transparent images that can be partially
overlaying your thumbnail. See below.
Here's how the normal border pieces are laid out:
12 piece borders
TL T TR 8 piece borders 4 piece borders
LT RT TL T TR TTTTTTT
L IMG R L IMG R L IMG R
LB RB BL B BR BBBBBBB
BL B BR
Note that every row of images must be the same height, though the
widths do not have to line up. (i.e., height TL = height T = height TR)
(This is not true about overlay borders!)
Once you've created these files, you can run the simmer_theme tool
(an optional tool download at MarginalHacks.com) and your theme will
then be ready to use!
If you need different borders for the image pages, then use the same
filenames prefixed by 'I' - such as IBord_LT.gif, IBord_RT.gif,...
Overlay borders allow for really fantastic effects with image borders.
Currently there's no support for different overlay borders for images.
For using Overlay borders, create images:
Over_TL.png Over_T.png Over_TR.png
Over_L.png Over_R.png
Over_BL.png Over_B.png Over_BR.png
Then figure out how many pixels of the borders are padding (outside photo)
Then put those values in files: Over_T.pad Over_R.pad Over_B.pad Over_L.pad
See "Themes/FunLand" for a simple example
Multi-lingual Images
If your images have text, you can translate them into other languages
so that albums can be generated in other languages. For example, you
can create a Dutch "More.gif" image and put it in 'lang/nl/More.gif'
in the theme (nl is the language code for Dutch).
When the user runs album in Dutch (album -lang nl) then the theme
will use the Dutch image if found. Themes/Blue has a simple example.
The currently "translated" images are:
More, Back, Next, Prev and Icon
You can create an HTML table that shows the translations immediately
available to themes with -list_html_trans:
% album -list_html_trans > trans.html
Then view trans.html in a browser. Unfortunately different languages
have different charsets, and an HTML page can only have one. The
output is in utf-8, but you can edit the "charset=utf-8" to properly
view language characters in different charsets (such as hebrew).
If you need more words translated for themes, let me know, and if you
create any new language images for a theme, please send them to me!
4: From scratch, Theme API
This is a much heavier job - you need to have a very clear idea of
how you want album to place the images on your page. It might be
a good idea to start with modifying existing themes first to get
an idea of what most themes do. Also look at existing themes
for code examples (see suggestions above).
Themes are directories that contain at the minimum an 'album.th' file.
This is the album page theme template. Often they also contain an 'image.th'
which is the image theme template, and any graphics/css used by the theme.
Album pages contain thumbnails and image pages show full/medium sized images.
The .th files are ePerl, which is perl embedded inside of HTML. They
end up looking a great deal like the actual album and image HTML themselves.
To write a theme, you'll need to understand the ePerl syntax. You can
find more information from the actual ePerl tool available at MarginalHacks
(though this tool is not needed to use themes in album).
There are a plethora of support routines available, but often only
a fraction of these are necessary - it may help to look at other themes
to see how they are generally constructed.
Function table:
Required Functions
Meta() Must be called in the section of HTML
Credit() Gives credit ('this album created by..')
Must be called in the section of HTML
Body_Tag() Called inside the actual tag.
Paths and Options
Option($name) Get the value of an option/configuration setting
Version() Return the album version
Version_Num() Return the album version as just a number (i.e. "3.14")
Path($type) Returns path info for $type of:
album_name The name of this album
dir Current working album directory
album_file Full path to the album index.html
album_path The path of parent directories
theme Full path to the theme directory
img_theme Full path to the theme directory from image pages
page_post_url The ".html" to add onto image pages
parent_albums Array of parent albums (album_path split up)
Image_Page() 1 if we're generating an image page, 0 for album page.
Page_Type() Either 'image_page' or 'album_page'
Theme_Path() The filesystem path to the theme files
Theme_URL() The URL path to the theme files
Header and Footer
isHeader(), pHeader() Test for and print the header
isFooter(), pFooter() Same for the footer
Generally you loop through the images and directories using local variables:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
This will print the name of each image. Our object types are either 'pics'
for images or 'dirs' for the child directories. Here are the object functions:
Objects (type is either 'pics' (default) or 'dirs')
First($type) Get the first image or sub-album object.
Last($type) Last object
Next($obj) Given an object, return the next object
Next($obj,1) Same, loop past end to beginning.
Prev($obj), Prev($obj,1) Similar to Next()
num('pics') or just num() Total number of images in this album
num('dirs') Total number of children/sub-albums
Also:
num('parent_albums') Total number of parents leading up to this album.
Object lookup:
get_obj($num, $type, $loop)
Finds object by number ('pics' or 'dirs').
If $loop is set than the count will wrap around.
Object Properties
Each object (image or child albums) has properties.
Some properties are accessed by a single field:
Get($obj,$field) Get a single field of an object
Field Description
----- ----------
type What type of object? Either 'pics' or 'dirs'
is_movie Boolean: is this a movie?
name Name (cleaned and optionally from captions)
cap Image caption
capfile Optional caption file
alt Alt tag
num_pics [directories only, -dir_thumbs] Num of pics in directory
num_dirs [directories only, -dir_thumbs] Num of dirs in directory
Some properties are accessed by a field and subfield. For example,
each image has information for different sizes: full, medium and thumb
(though 'medium' is optional).
Get($obj,$size,$field) Get a property for a given size
Size Field Description
---- ----- ----------
$size x Width
$size y Height
$size file Filename (without path)
$size path Filename (full path)
$size filesize Filesize in bytes
full tag The tag (either 'image' or 'embed') - only for 'full'
We also have URL information which is access according to the
page it's coming 'from' and the image/page it's pointing 'to':
Get($obj,'URL',$from,$to) Get a URL for an object from -> to
Get($obj,'href',$from,$to) Same but wraps it in an 'href' string.
Get($obj,'link',$from,$to) Same but wraps the object name inside the href link.
From To Description
---- -- ----------
album_page image Image_URL from album_page
album_page thumb Thumbnail from album_page
image_page image Image_URL from image_page
image_page image_page This image page from another image page
image_page image_src The <img src> URL for the image page
image_page thumb Thumbnail from image_page
Directory objects also have:
From To Description
---- -- ----------
album_page dir URL to the directory from it's parent album page
Parent Albums
Parent_Album($num) Get a parent album string (including the href)
Parent_Albums() Return a list of the parent albums strings (including href)
Parent_Album($str) A join($str) call of Parent_Albums()
Back() The URL to go back or up one page.
Images
This_Image The image object for an image page
Image($img,$type) The <img> tags for type of medium,full,thumb
Image($num,$type) Same, but by image number
Name($img) The clean or captioned name for an image
Caption($img) The caption for an image
Child Albums
Name($alb)
Caption($img) The caption for an image
Convenience Routines
Pretty($str,$html,$lines) Pretty formats a name.
If $html then HTML is allowed (i.e., use 0 for <title> and the like)
Currently just puts prefix dates in a smaller font (i.e. '2004-12-03.Folder')
If $lines then multilines are allowed
Currently just follows dates with a 'br' line break.
New_Row($obj,$cols,$off) Should we start a new row after this object?
Use $off if the first object is offset from 1
Image_Array($src,$x,$y,$also,$alt)
Returns an <img> tag given $src, $x,...
Image_Ref($ref,$also,$alt)
Like Image_Array, but $ref can be a hash of
Image_Arrays keyed by language ('_' is default).
album picks the Image_Array by what languages are set.
Border($img,$type,$href,@border)
Border($str,$x,$y,@border)
Create the full bordered image.
See 'Borders' for more information.
If you're creating a theme from scratch, consider adding support for -slideshow.
The easiest way to do this is to cut/paste the "slideshow" code out of an
existing theme.
5: Submitting Themes
Have a custom theme? I'd love to see it, even if it's totally site-specific.
If you have a new theme you'd like to offer the public, feel free to send
it to me and/or a URL where I can see how it looks. Be sure to set the CREDIT
file properly and let me know if you are donating it to MarginalHacks for
everyone to use or if you want it under a specific license.
6: Converting v2.0 Themes to v3.0 Themes
album v2.0 introduced a theme interface which has been rewritten. Most
2.0 themes (especially those that don't use many of the global variables)
will still work, but the interface is deprecated and may disappear in
the near future.
It's not difficult to convert from v2.0 to v3.0 themes.
The v2.0 themes used global variables for many things. These are now
deprecated In v3.0 you should keep track of images and directories in
variables and use the 'iterators' that are supplied, for example:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Will loop through all the images and print their names.
The chart below shows you how to rewrite the old style calls which
used a global variable with the new style which uses a local variable,
but to use these calls you need to rewrite your loops as above.
Here is a conversion chart for helping convert v2.0 themes to v3.0:
# Global vars shouldn't be used
# ALL DEPRECATED - See new local variable loop methods above
$PARENT_ALBUM_CNT Rewrite with: Parent_Album($num) and Parent_Albums($join)
$CHILD_ALBUM_CNT Rewrite with: my $dir = First('dirs'); $dir=Next($dir);
$IMAGE_CNT Rewrite with: my $img = First('pics'); $pics=Next($pics);
@PARENT_ALBUMS Can instead use: @{Path('parent_albums')}
@CHILD_ALBUMS, @CHILD_ALBUM_NAMES, @CHILD_ALBUM_URLS, ...
# Old global variable modifiers:
# ALL DEPRECATED - See new local variable loop methods above
Next_Image(), Images_Left(), Image_Cnt(), Image_Prev(), Image_Next()
Set_Image_Prev(), Set_Image_Next(), Set_Image_This()
Next_Child_Album(), Child_Album_Cnt(), Child_Albums_Left()
# Paths and stuff
pAlbum_Name() Path('album_name')
Album_Filename() Path('album_file')
pFile($file) print read_file($file)
Get_Opt($option) Option($option)
Index() Option('index')
pParent_Album($str) print Parent_Album($str)
# Parent Albums
Parent_Albums_Left Deprecated, see '$PARENT_ALBUM_CNT' above
Parent_Album_Cnt Deprecated, see '$PARENT_ALBUM_CNT' above
Next_Parent_Album Deprecated, see '$PARENT_ALBUM_CNT' above
pJoin_Parent_Albums print Parent_Albums(\@_)
# Images, using variable '$img'
pImage() Use $img instead and:
print Get($img,'href','image');
print Get($img,'thumb') if Get($img,'thumb');
print Name($img), "</a>";
pImage_Src() print Image($img,'full')
Image_Src() Image($img,'full')
pImage_Thumb_Src() print Image($img,'thumb')
Image_Name() Name($img)
Image_Caption() Caption($img)
pImage_Caption() print Get($img,'Caption')
Image_Thumb() Get($img,'URL','thumb')
Image_Is_Pic() Get($img,'thumb')
Image_Alt() Get($img,'alt')
Image_Filesize() Get($img,'full','filesize')
Image_Path() Get($img,'full','path')
Image_Width() Get($img,'medium','x') || Get($img,'full','x')
Image_Height() Get($img,'medium','y') || Get($img,'full','y')
Image_Filename() Get($img,'full','file')
Image_Tag() Get($img,'full','tag')
Image_URL() Get($img,'URL','image')
Image_Page_URL() Get($img,'URL','image_page','image_page') || Back()
# Child album routines, using variable '$alb'
pChild_Album($nobr) print Get($alb,'href','dir');
my $name = Name($alb);
$name =~ s/<br>//g if $nobr;
print $name,"</a>";
Child_Album_Caption() Caption($alb,'dirs')
pChild_Album_Caption() print Child_Album_Caption($alb)
Child_Album_URL() Get($alb,'URL','dir')
Child_Album_Name() Name($alb)
# Unchanged
Meta() Meta()
Credit() Credit()
album-4.17/Docs/txt_2 0000644 0000000 0000000 00000011761 10541443315 013124 0 ustar root root MINI HOW-TO
ITEM: Simple album
Presuming you've already installed album properly, we can do some
simple cases. If you have any errors or problems here, see the
installation docs.
You need a web directory to put themes and your photo album.
We'll use /home/httpd/test in this documentation. This needs
to be viewable by a webserver. In this example we'll use the URL:
http://myserver/test/
Adjust your commands/URLs appropriately
First create a directory and put some images in it. We'll call this:
/home/httpd/test/Photos
And we'll add some images called 'IMG_001.jpg' through 'IMG_004.jpg'
Now for the simple case, just run album:
% album /home/httpd/test/Photos
Now you can view the album in a web browser at something like:
http://myserver/test/Photos
ITEM: Add captions
Create a file /home/httpd/test/Photos/captions.txt with the following
contents (use the 'tab' key where you see " [tab] ")
-- captions.txt ---------
IMG_001.jpg [tab] First image name
IMG_002.jpg [tab] Second image
IMG_003.jpg [tab] Another image [tab] with a caption!
IMG_004.jpg [tab] Last image [tab] with another caption.
-------------------------
And run album again:
% album /home/httpd/test/Photos
And you'll see the captions change.
Now create a file with text in: /home/httpd/test/Photos/header.txt
And run album again. You'll see that text at the top of the page.
ITEM: Hiding Photos
There are a few ways to hide photos/files/directories, but we'll use
the captions file. Try commenting out an image with '#' in captions.txt:
-- captions.txt ---------
IMG_001.jpg [tab] First image name
#IMG_002.jpg [tab] Second image
IMG_003.jpg [tab] Another image [tab] with a caption!
IMG_004.jpg [tab] Last image [tab] with another caption.
-------------------------
Run album again, and you'll see that IMG_002.jpg is now missing.
If we had done this before running album the first time, we wouldn't
have ever generated the medium or thumbnail images. If you like,
you can remove them now with -clean:
% album -clean /home/httpd/test/Photos
ITEM: Using A Theme
If themes were installed properly and are in your theme_path then
you should be able to use a theme with your album:
% album -theme Blue /home/httpd/test/Photos
The photo album should now be using the Blue theme. If it has
a bunch of broken images, then your theme probably hasn't been
installed into a web-accessible directory, see the Installation docs.
Album saves the options you specify, so the next time you run album:
% album /home/httpd/test/Photos
You'll still be using the Blue theme. To turn off a theme, you can:
% album -no_theme /home/httpd/test/Photos
ITEM: Medium images
Full resolution images are usually too big for a web album, so
we'll use medium images on the image pages:
% album -medium 33% /home/httpd/test/Photos
You can still access the full size images by clicking on the medium image, or:
% album -just_medium /home/httpd/test/Photos
Will keep the full size image from being linked in (presuming we'd
run with the -medium option at some point)
ITEM: Adding some EXIF captions
Let's add aperture info to the captions of each image.
% album -exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
This will only add aperture information for any images that have specified
the 'Aperture' exif tag (the part between the '%' signs). We also put
a <br> tag in there so the exif info is on a new line.
We can add more exif info:
% album -exif "<br>focal: %FocalLength%" /home/httpd/test/Photos
Because album saved our options before, we now get both EXIF tags for any
images that specify Aperture and FocalLength. Let's remove aperture:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
The '-no_exif' option has to match the previous exif string exactly or
it will be ignored. You can also edit the config file that album created:
/home/httpd/test/Photos/album.conf
And remove it there.
ITEM: Adding more albums
Let's say we go on a trip to spain. We take some photos and put them in:
/home/httpd/test/Photos/Spain/
Now run album again on the top level:
% album /home/httpd/test/Photos
This will fixup Photos so it now links to spain and will run album
on Spain/ as well, with the same settings/theme, etc..
Now let's go on another trip, and we create:
/home/httpd/test/Photos/Italy/
We could run album on the top level:
% album /home/httpd/test/Photos
But that would rescan the Spain directory which hasn't changed.
Album usually won't generate any HTML or thumbnails unless it needs to,
but it can still waste time, especially as our albums get bigger.
So we can tell it to just add the new directory:
% album -add /home/httpd/test/Photos/Italy
This will fix the top index (in Photos) and generate the Italy album.
ITEM: Translated by:
David Ljung Madison [http://GetDave.com/]
album-4.17/Docs/fr/ 0000755 0000000 0000000 00000000000 12661460265 012552 5 ustar root root album-4.17/Docs/fr/old.txt_3 0000644 0000000 0000000 00000044623 10543111460 014307 0 ustar root root Utiliser album / Options de base
ITEM: Exécution basique
Créez un répertoire contenant uniquement des images. Le script album et
les autres outils ne doivent pas se trouver dans ce répertoire. Lancez
la commande album en précisant ce répertoire :
% album /exemple/chemin/vers/les/images
Ou, si vous êtes déjà dans le répertoire exemple/chemin/vers/les/images :
% album images/
Quand l'opération est terminée, vous aurez un album photo à l'intérieur
de ce répertoire avec comme fichier d'entrée index.html.
Si ce chemin fait partie de votre serveur web, alors vous pourrez
visualiser votre album photos à partir de votre navigateur. Si vous
ne le trouvez pas, contactez votre administrateur système.
ITEM: Options
Il y a trois types d'options: options booléennes (vrai / faux), options
acceptant des chaînes de caractères ou des numéros et options acceptant
plusieurs arguments. Les options booléennes peuvent être désactivées en
les préfixant avec -no_ :
% album -no_image_pages
Les chaînes de caractères et les nombres sont entrés après une option :
% album -type gif
% album -columns 5
Les options acceptant plusieurs arguments peuvent être utilisées de
deux manières. La première avec un argument à la fois :
% album -exif hi -exif there
ou avec plusieurs arguments en utilisant la syntaxe '--' :
% album --exif hi there --
Vous pouvez supprimer une valeur particulière d'une option à plusieurs
arguments avec -no_<option> suivi du nom de l'argument et effacer
tous les arguments d'une telle option avec -clear_<option>.
Pour effacer tous les arguments d'une option acceptant plusieurs arguments
(provenant par exemple d'une précédente utilisation de la commande album) :
% album -clear_exif -exif "new exif"
(l'option -clear_exif effacera les anciens arguments de l'option exif puis
l'option -exif suivante permettra d'ajouter un nouveau commentaire dans
la section exif).
Et pour terminer, vous pouvez supprimer un argument particulier d'une option
à plusieurs arguments avec 'no_' :
% album -no_exif hi
supprimera la valeur 'hi' et laissera intacte la valeur 'there' de l'option
exif.
Voir également la section sur Sauvegarde des options.
ITEM: Thèmes
Les thèmes sont une composante essentielle qui rend album attrayant. Vous
pouvez particulariser le look de votre album photo en téléchargeant un
thème depuis le site MarginalHacks ou même écrire votre propre thème en
phase avec votre site web.
Pour utiliser un thème, téléchargez l'archive correspondante du thème au
format .tar ou .zip et installez-là.
Les thèmes sont spécifiés grâce à l'option -theme_path qui permet d'indiquer
les endroits où sont stockées les thèmes. Ces chemins sont nécessairement
quelque part sous la racine du répertoire de votre site web mais pas à
l'intérieur même de votre album photo. De plus, ces chemins doivent être
accessible depuis un navigateur.
Vous pouvez rajouter un thème dans l'un des chemins spécifié par l'option
theme_path et utilisé par album ou créer un nouveau thème et indiquer son
chemin d'accès avec cette option (le répertoire indiqué par l'option
-theme_path est celui où se trouve le thème et pas le répertoire du thème
lui-même).
Par la suite, appelez album avec l'option -theme accompagnée ou non de
-theme_path:
% album -theme Dominatrix6 mes_photos/
% album -theme Dominatrix6 -theme_path /home/httpd/album/Themes/ mes_photos/
Vous pouvez également créer vos propres thèmes très facilement. Ce sujet est
abordé un peu plus loin dans cette documentation.
ITEM: Sous-albums
Créez des répertoires dans votre répertoire créé précedemment et mettez-y
des images. Lancez une nouvell fois album : vos sous-répertoires seront
explorés et donneront naissance à des sous-albums du premier album.
Si vous apportez des modifications dans un seul sous-album, vous pouvez
exécuter album uniquement sur ce sous-album ; les liens avec l'album
parent seront conservés.
Si vous ne souhaitez pas descendre dans l'arborescence des répertoires,
vous pouvez limiter la profondeur du niveau d'exploration avec l'option
-depth. Exemple :
% album images/ -depth 1
Cette commande ne générera qu'un album photo pour les images du
répertoire courant.
Si vous avez plusieurs sous-albums et que vous voulez ajouter un nouveau
sous-album sans regénérer les autres, alors utilisez l'option -add :
% album -add images/nouvel_album/
Ceci ajoutera nouvel_album à la page HTML pour 'images/' et créera
ensuite les vignettes et les pages HTML pour toutes les données contenues
dans 'images/nouvel_album'.
ITEM: Eviter la regénération des vignettes
album essaie d'éviter au maximum le travail inutile. Il ne crée seulement
des vignettes que si elles n'existent pas et n'ont pas été modifiées. Ceci
permet d'accélérer les traitements successifs d'album.
Cependant, cela peut provoquer un problème si vous changez la taille ou
recadrer vos vignettes car album ne réalisera pas que ces dernières ont
changées. Pour forcer la regénération des vignettes, utilisez l'option
-force :
% album -force images/
Mais vous ne devriez pas avoir besoin d'utiliser l'option -force à chaque
fois.
ITEM: Nettoyer les vignettes
Si vous supprimez une image de votre album, alors vous laisserez des
vignettes et des pages HTML. Pour les supprimer, lancer album avec
l'option -clean :
% album -clean images/
ITEM: Taille d'images moyenne
Quand vous cliquez sur la vignette d'un album, vous êtes dirigés vers
une page spécifique à cette image. Par défaut, cette page affiche l'image
en taille réelle ainsi que les boutons de navigation, les légendes et
tout le toutim. Quand vous cliquez sur l'image de cette page, l'URL
pointe alors uniquement sur l'image en taille réelle.
Si vous voulez avoir une image de taille réduite sur la page affichant
cette image, utilisez l'option -medium en précisant la géométrie que vous
souhaitez obtenir. Vous pouvez utiliser toutes les géométries supportées
par ImageMagick (voir la page man de cet outil pour de plus amples détails).
Par exemple :
# Une image faisant la moitié de la taille réelle
% album -medium 50%
# Une image qui s'insère dans 640x480 (taille maximale)
% album -medium 640x480
# Une image qui est réduite pour s'insérer dans 640x480
# (mais qui ne sera pas élargie si elle est déjà plus petite que 640x480)
% album -medium '640x480>'
Les caractères de 'quotation' du dernier exemple seront obligatoires sur
la plupart des systèmes à cause de la présence du caractère '>'.
ITEM: Légendes
Les images et les vignettes peuvent avoir des noms et des légendes. Il y a
plusieurs moyens de préciser / changer les noms et les légendes dans vos
albums photo.
Le nom est
lié à l'image ou à la page qui l'héberge et la légende suit juste en dessous.
Le nom par défaut est le fichier nettoyé :
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
Un moyen de préciser une légende est d'utiliser un fichier texte avec le
même nom que l'image mais l'extension .txt. Par exemple,
"Kodi_Cow.txt" pourrait contenir "Kodi takes down a cow! ("Kodi
maîtrise une vache !")
Vous pouvez renommer vos images et spécifier toutes les légendes d'un
répertoire avec un fichier captions.txt.
Chaque ligne du fichier doit être le nom d'une image ou d'un
répertoire, suivi par une tabulation, suivi par le nouveau
nom. Vous pouvez aussi spécifier (séparé par une tabulation), une légende
optionnelle puis un tag ALT, optionnel également, pour l'image. Pour sauter
un champ, utilisez 'tabulation' 'espace' 'tabulation'.
Exemple :
001.gif Ma première photo
002.gif Maman et Papa dans le grand canyon
003.gif Ani DiFranco ma fiancée Whaou !
Les images et les répertoires sont listés dans l'ordre dans lequel ils
sont trouvés dans le fichier de légende. Vous pouvez modifier ce tri avec
les options '-sort date' et '-sort name'.
Si votre éditeur de texte ne gère pas très bien les tabulations, vous
pouvez séparer les champs par un double deux-points mais .b/seulement
si votre légende ne contient aucune tabulation :
003.gif :: Ani DiFranco :: Ma fiancée :: Whaou !
Si vous ne souhaitez avoir des légendes que sur les pages contenant les
images (et pas sur les pages affichant les albums), utilisez :
% album -no_album_captions
Si vous voulez créer ou éditer vos légendes depuis un accès web, regardez
le script CGI caption_edit.cgi (mais soyez sûr de limiter l'accès à ce
script sinon n'importe qui pourra modifier vos légendes).
ITEM: Légendes EXIF
Vous pouvez également préciser des légendes extraites des informations
EXIF (Exchangeable Image File Format) ajoutées aux images par la plupart
des appareils photo numériques.
Mais tout d'abord, vous avez besoin d'installer 'jhead'. Vous pouvez,
par exemple, lancer jhead sur un fichier au format jpeg (.jpg ou .jpeg)
et ainsi voir les commentaires et informations affichés.
Les légendes EXIF sont ajoutés à la suite des légendes normales et sont
spécifiés à l'aide de l'option -exif :
% album -exif "<br>Fichier: %File name% pris avec %Camera make%"
Tous les %tags% trouvés seront remplacées par les informations EXIF
correspondantes. Si des %tags% ne sont pas trouvés dans les informations
EXIF, alors la légende EXIF est ignorée. A cause de ce comportement, vous
pouvez multiplier les arguments passés à l'option -exif :
% album -exif "<br>Fichier: %File name% " -exif "pris %Camera make%"
De la sorte, si le tag 'Camera make' n'est pas trouvé, vous pourrez toujours
avoir la légende relative au tag 'File name'.
De la même façon que pour toutes les options acceptant plusieurs arguments,
vous pouvez utiliser la syntaxe --exif :
% album --exif "<br>Fichier: %File name% " "pris avec %Camera make%" --
Comme montré dans l'exemple, il est possible d'inclure des balises HTML dans
vos légendes EXIF :
% album -exif "<br>Ouverture: %Aperture%"
Afin de voir la liste des tags EXIF possible (Résolution, Date / Heure,
Ouverture, etc...), utilisez un programme comme 'jhead' sur une image issue
d'un appareil photo numérique.
Vous pouvez également préciser des légendes EXIF uniquement pour les albums
ou les pages affichant une image. Voir les options -exif_album et
-exif_image.
ITEM: En-têtes et pieds-de-page
Dans chaque répertoire abritant un album, vous pouvez avoir des fichiers texte
header.txt and footer.txt.
Ces fichiers seront copiés tels quels dans l'en-tête et le pied-de-page
de votre album (si cette fonctionnalité est supportée par votre thème).
ITEM: Masquer des Fichiers / des Répertoires
Chaque fichier non reconnu par album comme étant une image est ignoré.
Pour afficher ces fichiers, utilisez l'option -no_known_images (l'option
par défaut est -known_images).
Vous pouvez marquer une image comme n'étant pas une image en éditant un
fichier vide avec le même et l'extension .not_img ajoutée à la fin.
Vous pouvez ignorer complètement un fichier en créant un fichier vide avec
le même nom et l'extension .hide_album ajoutée à la fin.
Vous pouvez éviter de parcourir un répertoire complet (bien qu'étant
toujours inclus dans la liste de vos répertoires) en créant un fichier
<dir>/.no_album.
Vous pouvez ignorer complètement des répertoires créant un fichier
<dir>/.hide_album
La version pour Windows d'album n'utilise pas le . pour no_album,
hide_album et not_img car il est difficile de créer des
.fichiers dans Windows.
ITEM: Recadrer les images
Si vos images comportent un large éventail de ratios (c'est-à-dire autres
que les traditionnels ratios portrait / paysage) ou si votre thème ne
supporte qu'une seule orientation, alors vos vignettes peuvent être
recadrées afin qu'elles partagent toutes la même géométrie :
% album -crop
Le recadrage par défaut est de recadrer l'image au centre. Si vous n'aimez
pas le recadrage central utilisé par album pour générer les vignettes, vous
pouvez donner des directives à album afin de spécifier où recadrer des
images spécifiques. Pour cela, il suffit de changer le nom du fichier
contenant l'image pour qu'il ait la directive de recadrage juste avant
l'extension. Vous pouvez ainsi demander à album de recadrer l'image en haut,
en bas, à droite ou à gauche. Par exemple, supposons que nous ayons un
portrait "Kodi.gif" que vous voulez recadrer au sommet de votre vignette.
Renommez le fichier en "Kodi.CROPtop.gif" et c'est tout (vous pouvez
évenutellement utiliser l'option -clean pour supprimer l'ancienne
vignette). La chaîne de caractères précisant le recadrage sera supprimée
du nom affiché dans votre navigateur.
La géométrie par défaut est 133x133. De cette façon, les images en position
paysage auront des vignettes au format 133x100 et les images en position
portrait auront des vignettes au format 100x133. Si vous utilisez le
recadrage et souhaitez que vos vignettes aient toujours le même ratio que
les photos numériques; alors essayez 133x100 :
% album -crop -geometry 133x100
Souvenez-vous que si vous recadrez ou changez la géométrie d'un album
précédemment généré, vous devrez utiliser l'option -force une fois afin
de regénérer complètement toutes vos vignettes.
ITEM: Film vidéo
album peut générer des vignettes issues de prise instantanée pour de
nombreux formats vidéo si vous installez ffmpeg.
Si vous êtes sur un système linux sur une architecture x86, vous n'avez qu'à
télécharger le fichier exécutable, ou autrement, télécharger le
paquetage complet depuis ffmpeg.org (c'est très facile d'installation).
ITEM: Graver des CDs (en utilisant file://)
Si vous utilisez album pour graver des CDs ou si vous souhaitez accèder
à vos albums depuis votre navigateur avec le protocole file://, alors
vous ne voulez pas qu'album suppose que le fichier "index.html" soit
la page principale puisque votre navigateur ne le saura probablement pas.
De plus, si vous utilisez des thèmes, vous devez utiliser des
chemins d'accès relatifs. Vous ne pouvez pas utiliser l'option
-theme_url car vous ne savez pas où sera l'URL final. Sur Windows, le
chemin d'accès aux thèmes pourrait être "C:/Themes" ou sous UNIX ou OSX,
il pourrait être quelque chose comme "/mnt/cd/Themes", tout dépendant
de la façon dont le CD a été monté.
Pour résoudre ces cas de figure, utilisez l'option -burn :
% album -burn ...
Ceci implique que les chemins d'accès de l'album vers les thèmes ne
change pas. Le meilleur moyen de faire ceci consiste à prendre le
répertoire racine que vous allez graver et d'y mettre vos thèmes et votre
album puis de spécifier le chemin complet vers le thème. Par exemple,
créez les répertoires :
monISO/Photos/
monISO/Themes/Blue
Puis vous lancez :
% album -burn -theme monISO/Themes/Blue monISO/Photos
Ensuite, vous pouvez créer une image ISO depuis le répertoire mon ISO (ou
plus haut).
Les utilisateurs Windows peuvent également jeter un oeil sur shellrun
qui permet de lancer automatiquement l'album dans le navigateur. (Ou
voyez aussi winopen).
ITEM: Indexer entièrement votre album
Pour naviguer sur un album entièrement compris sur une page, utilisez l'outil
caption_index.
Il utilise les mêmes options qu'album (bien qu'il en ignore la plupart) de
telle sorte que vous pouvez remplacer l'appel à "album" par "caption_index".
La sortie est la page HTML de l'index de l'album complet.
Regardez l'index d'exemple réalisé à partir d'un de mes albums photo d'exemple
ITEM: Mettre à jour des albums avec CGI
Premièrement, vous avez besoin de charger vos photos dans le répertoire
de l'album. Je vous suggère d'utiliser ftp pour faire cette manipulation.
Vous pouvez aussi écrire un script java qui chargerait les fichiers. Si
quelqu'un pouvait me montrer comment faire, j'apprécierais beaucoup.
Ensuite, vous avez besoin de pouvoir exécuter album à distance. Pour éviter
les abus, je vous conseille de mettre en place un script CGI qui crée
un fichier bidon (ou qui transfère ce fichier via ftp) et d'avoir un
cron job (process tournant en arrière plan) qui teste régulièrement
à quelques minutes d'intervalle si ce fichier est présent et, s'il l'est,
de le supprimer et de lancer album. Cette méthode ne fonctionne que sous
unix et vous aurez sûrement besoin de modifier votre variable
d'environnement $PATH ou d'utiliser des chemins absolus dans le script
pour la conversion).
Si vous souhaitez une gratification immédiate, vous pouvez lancer album
depuis un script CGI comme celui-ci.
Si l'utilisateur du serveur web n'est pas le propriétaire des photos, vous
aurez besoin d'utiliser un script setuid via CGI [toujours pour unix
seulement].
Mettez ce script setuid dans un emplacement protégé, changez son propriétaire
pour qu'il soit le même que celui de vos photos et lancez la commande
"chmod ug+s" sur le script. Vous trouverez ici des exemples de scripts
setui et CGI. N'oubliez pas de les éditer.
Regardez également caption_edit.cgi
qui vous permet (ou une autre personne) d'éditer les légendes / noms /
en-têtes / pieds-de-pages à travers le web.
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/new_txt_7 0000644 0000000 0000000 00000031425 12236171405 014411 0 ustar root root Modules Plug-in : utilisation, cration...
ITEM: Qu'est-ce qu'un module plug-in ?
Les modules plug-in sont des bouts de code qui vous permettent de modifier le
comportement d'album. Ils peuvent tre aussi simples que la faon de crer des
lgendes EXIF ou quelque chose d'aussi compliqu que crer un album partir
d'une base de donnes d'images plutt que d'utiliser une hirarchie dans un
systme de fichiers.
ITEM: Installation d'un module plug-in et son support
Il y a un certain nombre de modules plug-in disponibles avec l'installation
standard d'album. Si vous souhaitez mettre jour album avec les modules
plug-in d'une prcdente version d'album qui ne dispose pas de modules plug-in
(pr v3.10), vous aurez besoin de faire une fois :
% album -configure
Vous n'aurez pas besoin de refaire cette commande lors des futures mises
jour d'album.
Cette commande installera les modules plug-in actuels dans un des rpertoires
par dfaut des modules plug-in. album cherchera les modules plug-in dans un
certain nombre d'endroits. Ceux par dfaut sont :
/etc/album/plugins/
/usr/share/album/plugins/
$HOME/.album/plugins/
En ralit, ces rpertoires 'plug-in' sont ceux trouvs dans les endroits
spcifis par l'option '--data_path' dont les noms par dfaut sont :
/etc/album/
/usr/share/album/
$HOME/.album/
Vous pouvez spcifier un nouveau rpertoire avec l'option '--data_path' et
ajouter un rpertoire 'plugins' ce niveau ou utiliser l'option
'--plugin_path'.
Les modules plug-in se terminent en gnral par l'extension ".alp" mais vous
n'avez pas besoin de spcifier cette extension lorsque vous les utilisez. Par
exemple, si vous avez un module install ici :
/etc/album/plugins/utils/mv.alp
alors vous l'appellerez ainsi : utils/mv
ITEM: Chargement / dchargement des modules plug-in
Pour lister tous les modules plug-in actuellement installs, taper :
% album -list_plugins
Pour montrer des informations relatives des modules spcifiques (en
utilisant 'utils/mv' comme exemple) :
% album -plugin_info utils/mv
Les modules plug-in seront sauvs dans le fichier de configuration pour un
album donn ainsi vous n'avez pas besoin de les respcifier chaque fois,
l'exclusion des modules plug-in qui s'excutent une seule fois comme par
exemple 'utils/mv' ('mv' = 'move' : correspond un dplacement de fichiers
donc ne peut tre excute qu'une seule fois pour un jeu de fichiers donn).
Vous pouvez utiliser les options -no_plugin et -clear_plugin pour dsactiver
les modules plug-in qui ont t sauvs dans le fichier de configuration de
l'album courant. De la mme faon que les
options standard d'album, -no_plugin dsactivera un module plug-in
spcifique alors que -clear_plugin dsactivera l'ensemble des modules
plug-in. Toutes les options attaches ces modules seront galement
effaces.
ITEM: Options des modules plug-in
Quelques modules plug-in acceptent des options en ligne de commande. Pour
visualiser comment les utiliser, taper :
% album -plugin_usage utils/mv
Cependant, quand vous spcifiez une option pour un module plug-in, vous devez
indiquer album quel module plug-in l'option correspond. A la place de la
syntaxe utilise pour les options standards d'album :
% album -une_option
vous devez prfixer l'option avec le nom du module plug-in suivi de
deux-points :
% album -un_plugin:une_option
Par exemple, vous pouvez spcifier le nom de l'index cr par le module
plug-in 'utils/capindex'.
% album -plugin utils/capindex -utils/capindex:index blah.html
C'est peu pratique. Vous pouvez raccourcir le nom du module plug-in tant qu'il
ne rentre pas en conflit avec un autre module plug-in dj charg et ayant le
mme nom :
% album -plugin utils/capindex -capindex:index blah.html
Evidemment, les autres types d'options (chanes de caractres, nombres et
tableaux) sont accepts et utilisent la mme convention. Ces options sont
sauvegardes dans le fichier de configuration de l'album de la mme faon que
les options standard.
Avertissement : comme mentionn, une fois que nous utilisons un module plug-in
sur un album, il est sauvegard dans le fichier de configuration. Si vous
voulez ajouter d'autres options un album dj configur pour utiliser un
module plug-in, vous devez soit mentionner le module plug-in ou soit utiliser
le nom complet du module quand vous spcifiez les options (autrement, album ne
saura pas qui appartient l'option raccourcie).
Par exemple, considrons un module plug-in imaginaire :
% album -plugin un/exemple/vignetteGen Photos/Espagne
Aprs a, supposons que nous voulons utiliser la variable boolenne "rapide" du
module vignetteGen.
Ceci ne fonctionnera pas :
% album -vignetteGen:rapide Photos/Espagne
Mais l'une de ces solutions fonctionnera :
% album -plugin un/exemple/vignetteGen -vignetteGen:rapide blah.html Photos/Espagne% album -un/exemple/vignetteGen:rapide Photos/Espagne
ITEM: Ecrire des modules plug-in
Les modules plug-in sont de petits modules crits en perl qui s'appellent via
des fonctions particulires ('hooks') du code d'album.
Il y a de telles fonctions pour la plupart des fonctionnalits d'album et le
code du module plug-in peut souvent soit remplacer soit complter le code
d'album. Davantage de ces fonctions pourraient tre rajoutes dans les futures
versions d'album si besoin.
Vous pouvez afficher la liste de toutes ces fonctions autorises par album :
% album -list_hooks
Et vous pouvez obtenir des informations spcifiques pour chacune de ces
fonctions :
% album -hook_info <hook_name>
Nous pouvons utiliser album pour gnrer notre place un cadre pour nos
modules plug-in :
% album -create_plugin
Pour effectuer cette tche, vous avez besoin de comprendre les fonctions
'hooks' dans album et les options d'album.
Nous pouvons aussi crire un module plug-in la main. Pour cela, utiliser comme
base de travail un module plug-in dj crit facilite le travail.
Dans notre module plug-in, nous enregistrons notre fonction 'hook' en appelant
la fonction album::hook(). Pour appeler des fonctions dans le code d'album,
nous utilisons l'espace de nommage album.
Par exemple, pour enregistrer le code pour la fonction 'hook'
clean_name, notre module plug-in appelle :
album::hook($opt,'clean_name',\&my_clean);
Ainsi, quand album appelle la fonction clean_name, il appellera
galement la sous-routine appele my_clean de notre module
plug-in (sous-routine que nous devons fournir).
Pour crire cette sous-routine my_clean, regardons les
informations de la fonction 'hook' clean_name :
Args: ($opt, 'clean_name', $name, $iscaption)
Description: Nettoyer un nom de fichier pour affichage.
Le nom est soit un nom de fichier soit il provient d'un fichier de lgendes.
Retourne: le nom nettoy
Les arguments que la sous-routine my_clean reoit sont spcifis
sur la premire ligne. Supposons qu'on veuille convertir tous les noms en
majuscules. Nous devrions utiliser :
sub my_clean {
my ($opt, $hookname, $name, $iscaption) = @_;
return uc($name);
}
Voici une explication sur les arguments :
$opt Ceci est le descripteur de toutes les options d'album.
Nous ne nous en servons pas ici. Vous pourrez en avoir parfois
besoin si vous appelez les fonctions internes d'album. Ceci est
galement valable si l'argument $data est fourni.
$hookname Dans notre cas, ce sera 'clean_name'. Ceci nous permet
d'enregistrer la mme sous-routine pour grer diffrentes
fonctions 'hooks'.
$name Ceci est le nom que nous allons nettoyer.
$iscaption Ceci nous indique si le nom provient d'un fichier de
lgendes.
Pour comprendre n'importe quelles options aprs la variable
$hookname, vous aurez peut-tre besoin de jeter un oeil sur
le code correspondant dans album.
Dans notre cas, nous avons seulement besoin d'utiliser la variable
$name fournie, nous appelons la routine perl de mise en majuscule et
nous retournons son rsultat. Le code est ainsi termin mais nous avons besoin
maintenant de crer un environnement pour notre module plug-in.
Des fonctions 'hooks' vous permettent de remplacer le code d'album. Par
exemple, vous pourriez crire du code pour un module plug-in qui gnre des
vignettes pour les fichiers au format pdf (utiliser l'outil 'convert' est un
desmoyens de le faire). Nous pouvons enregistrer du code pour la fonction
'hook' relative aux vignettes et simplement retourner 'undef' si nous ne
sommes pas en train de regarder un fichier pdf. Mais quand nous voyons un
fichier pdf, nous crons alors une vignette que nous retournons. Quand album
rcuprera une vignette, alors il utilisera celle-ci et sautera l'excution
de son propre code relatif aux vignettes.
Maintenant, terminons d'crire notre module plug-in de mise en majuscules. Un
module plug-in doit comporter les lments suivants :
1) Fournir une routine de dmarrage appele 'start_plugin'. Celle-ci
fera srement l'enregistrement des fonctions 'hooks' et spcifiera les
options en ligne de commande pour le module.
2) La routine 'start_plugin' doit retourne la table de hachage
des informations du module, laquelle table a besoin d'avoir les cls
suivantes dfinies :
author => Le nom de l'auteur
href => Une adresse internet (ou une adresse lectronique) de
l'auteur
version => Le numro de version du module plug-in
description => Un texte de description du module plug-in
3) Terminer le code du module en retournant '1' (similaire un module perl).
Voici notre exemple de code plug-in clean_name dans son module
complet :
sub start_plugin {
my ($opt) = @_;
album::hook($opt,'clean_name',\&my_clean);
return {
author => 'David Ljung Madison',
href => 'http://MarginalHacks.com/',
version => '1.0',
description => "Conversion des noms des images en majuscules",
};
}
sub my_clean {
return uc($name);
}
1;
Finalement, nous avons besoin de le sauvegarder quelque part. Les modules
plug-in tant organiss dans une hirarchie de rpertoires pour modules
plug-in, nous pourrions le sauver dans un rpertoire de module comme :
captions/formatting/NAME.alp
En fait, si vous regardez dans examples/formatting/NAME.alp, vous
trouverez qu'il y a dj un module plug-in qui fait essentiellement la mme
chose.
Si vous souhaitez que votre module accepte des options en ligne de commande,
utilisez 'add_option'. Ceci doit tre ralis dans le code de la
routine 'start_plugin'. Quelques exemples :
album::add_option(1,"fast",album::OPTION_BOOL, usage=>"Fais le rapidement");
album::add_option(1,"name", album::OPTION_STR, usage=>"Votre nom");
album::add_option(1,"colors",album::OPTION_ARR, usage=>"Liste des couleurs");
Pour de plus amples informations, regardez le code de la routine 'add_option'
dans album et jetez un oeil dans les autres routines qui l'utilisent (au dbut
du code d'album et dans les modules plug-in qui utilisent 'add_option').
Pour lire une option qu'un utilisateur pourrait avoir utilise, nous utilisons
la fonction option() :
my $fast = album::option($opt, "fast");
Si l'utilisateur fournit une mauvaise valeur pour une option, vous pouvez
appeler la fonction usage() :
album::usage("-colors array can only include values [red, green, blue]");
Si votre module plug-in a besoin de charger des modules perl qui ne font pas
partie de la distribution standard de Perl, faites-le de faon
conditionnelle. Pour avoir un example, regardez le module plug-in
plugins/extra/rss.alp.
Vous pouvez galement appeler n'importe quelle routines trouves dans le script
album en utilisant l'espace de nommage album::. Soyez sr de ce que vous
faites. Quelques routines utiles :
album::add_head($opt,$data, "<meta name='ajoute_ceci' content=' <head>'>");
album::add_header($opt,$data, "<p>Ceci est ajout l'en-tte de l'album");
album::add_footer($opt,$data, "<p>Ceci est ajout au pied de page de l'album");
Le meilleur moyen de savoir comment crire des modules plug-in est de regarder
d'autres modules plug-in, si possible en en copiant un ralisant une tache
similaire et en travaillant partir de a. Des outils de dveloppement pour
les modules plug-in pourraient tre crer l'avenir.
Une fois de plus, album peut vous aider crer un environnement pour vos
modules plug-in :
% album -create_plugin
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/Section_6.html 0000644 0000000 0000000 00000114340 12661460265 015274 0 ustar root root
MarginalHacks album - Création de thèmes
- Documentation
1: Métodes
Il y a des moyens faciles et d'autres compliqués pour créer un thème sur
mesure en fonction de ce que vous voulez faire.
2: Editer le code HTML d'un thème existant
Si vous voulez juste modifier légèrement un thème afin qu'il corresponde à
l'environnement de votre site, il semble opportun d'éditer un thème existant.
Dans le répertoire du thème, il y a deux fichiers avec l'extension
th. album.th est le patron pour les pages de l'album (les pages des vignettes)
et image.th est le patron pour les pages des images (où vous voyez les images
moyennement réduites ou en pleine taille). Ces fichiers sont très similaire à
du code HTML excepté quelques rajouts de code <: ePerl :>. Même si vous ne
connaissez ni Perl ni ePerl, vous pouvez néanmoins éditer le code HTML pour y
apporter des changements basiques.
Des thèmes pour bien démarrer :
N'importe quel thème dans simmer_theme peut servir comme "Blue" ou "Maste". Si
vous avez seulement besoin de 4 bordures aux coins de vos vignettes, alors
jetez un oeil sur "Eddie Bauer". Si vous voulez des bordures transparentes ou
qui se recouvrent, regardez "FunLand".
Si vous voulez quelque chose avec un minimum de code, essayez "simple" mais
attention, je n'ai pas mis à jour ce thème depuis un bon bout de temps.
3: Le moyen facile : simmer_theme pour les graphiques
La plupart des thèmes ont un même format basique, montrent une série de
vignettes pour des répertoires puis pour des images avec une bordure et une
ligne graphiques ainsi qu'un fond d'écran. Si c'est ce que vous voulez mais
que vous souhaitez créer de nouveaux graphiques, il y a un outil qui vous
permettra de construire des thèmes.
Si vous créez un répertoire avec des images et un fichier CREDIT ainsi qu'un
fichier Font ou Style.css, alors l'utilitaire simmer_theme vous permettra de
réaliser des thèmes.
Fichiers :
Font/Style.css
Ce fichier détermine les fontes utilisées par le thème. Le fichier "Font" est
le plus ancien système, décrit ci-dessous. Créez un fichier Style.css et
définissez des styles pour : body (le corps), title (le titre), main (la page
principale), credit (le crédit) et tout ce que vous voulez.
Regardez FunLand pour un exemple basique.
Autrement, utilisez un fichier Font. Un exemple de fichier Font est :
--------------------------------------------------
$TITLE_FONT = "size='4' color='#ffffff' face='Times New Roman,Georgia,Times'";
$MAIN_FONT = "face='Times New Roman,Georgia,Times'";
$CREDIT_FONT = "size='-1' face='Verdana' color='#ffffff'";
$BODY = "background='$PATH/bkgrnd.gif' link='#0099FF'">
--------------------------------------------------
CREDIT
Le fichier de crédit comporte deux lignes et est utilisé pour l'index des
thèmes à MarginalHacks. Si vous ne nous soumettez jamais votre thème, alors
vous n'avez pas besoin de ce fichier (mais faites-le s'il vous plaît !). En
tout cas, les deux lignes (et seulement deux lignes) sont :
1) une courte description du thème (à faire tenir sur une seule ligne),
2) Votre nom (qui peut être à l'intérieur d'un mailto: ou d'un lien internet).
Null.gif
Chaque thème créé par simmer a besoin d'une image "espace" c'est-à-dire une
image au format gif transparent de dimensions 1x1. Vous pouvez simplement la
copier depuis un autre thème créé par simmer.
Fichiers d'images optionnels :
Images de la barre
La barre est composée de Bar_L.gif (à gauche), Bar_R.gif (à droite) et
Bar_M.gif au milieu. L'image de la barre du milieu est étirée. Si vous avez
besoin d'une barre centrale qui ne soit pas étirée, utilisez :
Bar_L.gif, Bar_ML.gif, Bar_M.gif, Bar_MR.gif, Bar_R.gif
Dans ce cas, Bar_ML.gif et Bar_MR.gif ne seront pas étirées (voir le thème
Craftsman pour un exemple de cette technique).
Locked.gif
Une image de cadenas pour tous les répertoires ayant un fichier nommé
.htaccess.
Images de fond
Si vous voulez une image en fond d'écran, spécifiez-la dans le fichier Font
dans la section $BODY comme dans l'exemple ci-dessus. La valeur de la variable
$PATH sera remplacée par le chemin d'accès aux fichiers du thème.
More.gif
Quand une page d'album comporte plusieurs sous-albums à lister, l'image
'More.gif' est affichée en premier.
Next.gif, Prev.gif, Back.gif
Ces images sont respectivement utilisées pour les boutons des flèches arrière
et avant et pour le bouton pour remonter dans la hiérarchie des albums.
Icon.gif
Cette image, affichée dans le coin supérieur gauche des albums parents, est
souvent le texte "Photos" seulement.
Images des bordures
Il y a plusieurs méthodes pour découper une bordure, de la plus simple à la
plus complexe, l'ensemble dépendant de la complexité de la bordure et du
nombre de sections que vous voulez pouvoir étirer :
4 morceaux Utilisez Bord_L.gif, Bord_R.gif, Bord_T.gif, Bord_B.gif
(les coins vont avec les images droites et gauches)
Les bordures en 4 morceaux ne s'étirent en général pas très bien et de
fait ne fonctionnent pas bien sur les pages d'images. En général, vous
pouvez couper les coins des images droites et gauches pour faire :
8 morceaux Incluez aussi Bord_TL.gif, Bord_TR.gif, Bord_BL.gif,
Bord_BR.gif
Les bordures en 8 morceaux vous permettent généralement d'étirer et de
gérer la plupart des images recadrées.
12 morceaux Incluez aussi Bord_LT.gif, Bord_RT.gif, Bord_LB.gif,
Bord_RB.gif
12 morceaux permettent d'étirer des bordures ayant des coins plus
complexes comme par exemple les thèmes Dominatrix ou Ivy.
Bordures chevauchantes Peuvent utiliser des images transparentes qui
peuvent partiellement chevaucher vos vignettes. Voir ci-dessous.
Voici comment des morceaux pour des bordures normales sont disposés :
bordure à 12 morceaux
TL T TR bordure à 8 morceaux bordure à 4 morceaux
LT RT TL T TR TTTTTTT
L IMG R L IMG R L IMG R
LB RB BL B BR BBBBBBB
BL B BR
Notez que chaque rangée d'images doit avoir la même hauteur, alors que ce
n'est pas le cas pour la largeur (c'est-à-dire hauteur TL = hauteur T =
hauteur TR).
Ceci n'est pas totalement vrai pour les bordures qui se chevauchent !
Une fois que vous avez créé ces fichiers, vous pouvez lancer l'utilitaire
simmer_theme (un outil téléchargeable depuis MarginalHacks.com) et votre thème
deviendra prêt à être utilisé !
Si vous avez besoin de bordures différentes pour les pages d'images, alors
utilisez les mêmes noms de fichiers maix en les préfixant par 'I' comme par
exemple IBord_LT.gif, IBord_RT.gif,...
Les bordures chevauchantes autorisent des effets réellement fantastiques avec
les bordures des images. Actuellement, il n'y a pas de support pour des
bordures chevauchantes différentes pour les images.
Pour utiliser les bordures chevauchantes, créez les images :
Over_TL.png Over_T.png Over_TR.png
Over_L.png Over_R.png
Over_BL.png Over_B.png Over_BR.png
Puis, déterminez combien de pixels des bordures vont déborder (en dehors de la
photo). Mettez ces valeurs dans des fichiers: Over_T.pad Over_R.pad Over_B.pad
Over_L.pad.
Voir le thème "Themes/FunLand" pour un exemple simple.
Images polyglottes
Si vos images comportent du texte, vous pouvez les traduire dans d'autres
langues et, ainsi, vos albums pourront être générés dans d'autres
langages. Par exemple, vous pouvez créer une image "More.gif" hollandaise et
mettre ce fichier dans le répertoire 'lang/nl' de votre thème (nl est le code
de langage pour le hollandais).
Quand l'utilisateur lancera album en hollandais (album -lang nl) alors le
thème utilisera les images hollandaises s'il les trouve. Le thème "Themes/Blue"
comporte un tel exemple simple. Les images actuellement traduites sont :
More, Back, Next, Prev and Icon
Vous pouvez créer une page HTML qui donne la liste des traductions
immédiatement disponibles dans les thèmes avec l'option -list_html_trans :
% album -list_html_trans > trans.html
Puis, visualisez le fichier trans.html dans un navigateur. Malheureusement,
plusieurs langages ont des tables d'encodage des caractères différents et une
page HTML n'en dispose que d'une seule. La table d'encodage est utf-8 mais
vous pouvez éditer la ligne "charset=utf-8" pour visualiser correctement les
différents caractères utilisés dans les langages en fonction des différentes
tables d'encodage (comme par exemple l'hébreu).
Si vous avez besoin de plus de mots traduits pour les thèmes, faites-le moi
savoir et si vous créez des images dans une nouvelle langue pour un thème,
envoyez-les moi s'il vous plaît !
4: Partir de zéro : l'API des thèmes
Ceci est une autre paire de manches : vous avez besoin d'avoir une idée
vraiment très claire de la façon dont vous voulez qu'album positionne vos
images sur votre page. Ce serait peut-être une bonne idée de commencer en
premier par modifier des thèmes existants afin de cerner ce que la plupart des
thèmes fait. Regardez également les thèmes existants pour des exemples de code
(voir les suggestions ci-dessus).
Les thèmes sont des répertoires qui contiennent au minimum un fichier
'album.th'. Ceci est le patron du thème pour les pages de l'album. Souvent,
les répertoires contiennent aussi un fichier 'image.th' qui est un patron du
thème pour les images ainsi que des fichiers graphiques / css utilisés par le
thème. Les pages de l'album contiennent les vignettes et les pages des images
montrent les images pleine page ou recadrées.
Les fichiers .th sont en ePerl qui est du perl encapsulé à l'intérieur
d'HTML. Ils finissent par ressembler à ce que sera l'album et les images HTML
eux-mêmes.
Pour écrire un thème, vous aurez besoin de connaître la syntaxe ePerl. Vous
pouvez trouver plus d'information sur l'outil ePerl en général à MarginalHacks
(bien que cet outil ne soit pas nécessaire pour l'utilisation des thèmes dans album).
Il y a une pléthore de routines de support disponibles mais souvent une
fraction d'entre elles seulement est nécessaire (cela peut aider de regarder
les autres thèmes afin de voir comment ils sont construits en général).
Table des fonctions:
Fonctions nécessaires
Meta() Doit être appelée depuis la section du HTML
Credit() Affiche le crédit ('cet album a été créé par..')
Doit être appelée depuis la section du HTML
Body_Tag() Appelée depuis l'intérieur du tag .
Chemins et options
Option($name) Retourne la valeur d'une option / configuration
Version() Retourne la version d'album
Version_Num() Retourne le numéro de la version d'album en chiffres
uniquement (c'est-à-dire. "3.14")
Path($type) Retourne l'information du chemin pour le $type de :
album_name Nom de l'album
dir Répertoire courant de travail d'album
album_file Chemin complet au fichier d'album index.html
album_path Chemin des répertoires parent
theme Chemin complet du répertoire du thème
img_theme Chemin complet du répertoire du thème depuis les pages des images
page_post_url Le ".html" à ajouter sur les pages des images
parent_albums Tableau des albums parents (segmentation par album_path)
Image_Page() 1 si on est en train de générer une page d'image, 0 si c'est une page de vignettes
Page_Type() Soit 'image_page' ou 'album_page'
Theme_Path() Le chemin d'accès (via le système de fichiers) aux fichiers du thème
Theme_URL() Le chemin d'accès (via une URL) aux fichiers du thème
En-tête et pied-de-page
isHeader(), pHeader() Test pour et afficher l'en-tête
isFooter(), pFooter() La même chose pour le pied-de-page
En général, vous bouclez à travers les images et les répertoires en utilisant
des variables locales :
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Ceci affichera le nom de chaque image. Nos types d'objets sont soit 'pics'
pour les images soit 'dirs' pour les répertoires-enfants. Ici se trouvent les
fonctions relatives aux objets :
Objets (le type est soit 'pics' (défaut) soit 'dirs')
First($type) Renvoie comme objet la première image ou le premier sous-album.
Last($type) Renvoie le dernier objet
Next($obj) Etant donné un objet, renvoie l'objet suivant
Next($obj,1) La même chose mais retourne au début une fois la fin atteinte
Prev($obj), Prev($obj,1) Similaire à Next()
num('pics') ou juste num() Nombre total d'images de cet album
num('dirs') Nombre total de sous-albums
Egalement :
num('parent_albums') Nombre total d'albums parents conduisant à cet album
Consultation d'objet :
get_obj($num, $type, $loop)
Trouve un objet à partir de son numéro (type 'pics' ou 'dirs').
Si la variable $loop est positionnée alors le
compteur rebouclera au début lors de la recherche
Propriétés des objets
Chaque objet (image ou sous-album) possède des propriétés.
L'accès à certaines propriétés se fait par un simple champ :
Get($obj,$field) Retourne un simple champ pour un objet donné
Champ Description
----- ----------
type Quel type d'objet ? Soit 'pics' soit 'dirs'
is_movie Booléen: est-ce que c'est un film ?
name Nom (nettoyé et optionnel pour les légendes)
cap Légende de l'image
capfile Fichier optionnel des légendes
alt Etiquette (tag) alt
num_pics [répertoires seulement, -dir_thumbs] Nombre d'images dans le répertoire
num_dirs [répertoires seulement, -dir_thumbs] Nombre de sous-répertoire dans le répertoire
L'accès à des propriétés se fait via un champ et un sous-champ. Par exemple,
chaque image comporte une information sur ses différentes tailles : plein
écran, moyenne et vignette (bien que la taille moyenne soit optionnelle).
Get($obj,$size,$field) Retourne la propriété de l'image pour une taille donnéee
Taille Champ Description
------ ----- ----------
$size x Largeur
$size y Hauteur
$size file Nom du fichier (sans le chemin)
$size path Nom du fichier (chemin complete)
$size filesize Taille du fichier en octets
full tag L'étiquette (tag) (soit 'image' soit 'embed') - seulement pour 'full'
Il y a aussi des informations relatives aux URL dont l'accès se fait en
fonction de la page d'où on vient ('from' / depuis) et l'image ou la page vers
lequel on va ('to' / vers) :
Get($obj,'URL',$from,$to) Renvoie un URL pour un objet 'depuis -> 'vers
Get($obj,'href',$from,$to) Idem mais utilise une chaîne de caractères avec 'href'
Get($obj,'link',$from,$to) Idem mais met le nom de l'objet à l'intérieur d'un lien href
Depuis Vers Description
------ ---- ----------
album_page image Image_URL vers album_page
album_page thumb Thumbnail vers album_page
image_page image Image_URL vers image_page
image_page image_page Cette page d'image vers une autre page d'image
image_page image_src L'URL d'<img src> pour la page d'image
image_page thumb Page des vignettes depuis la page d'image
Les objets répertoires ont aussi :
Depuis Vers Description
------ ---- ----------
album_page dir URL vers le répertoire depuis la page de son album-parent
Albums parent
Parent_Album($num) Renvoie en chaîne de caractères le nom de l'album parent (incluant le href)
Parent_Albums() Retourne une liste de chaînes de caractères des albums parents (incluant le href)
Parent_Album($str) Crée la chaîne de caractères $str à partir de l'appel à la fonction Parent_Albums()
Back() L'URL pour revenir en arrière ou remonter d'une page
Images
This_Image L'objet image pour une page d'image
Image($img,$type) Les étiquettes d'<img> pour les types 'medium', 'full' et 'thumb'
Image($num,$type) Idem mais avec le numéro de l'image
Name($img) Le nom nettoyé ou légendé pour une image
Caption($img) La légende pour une image
Albums enfants
Name($alb) Le nom du sous-album
Caption($img) La légende pour une image
Quelques routines utiles
Pretty($str,$html,$lines) Formate un nom.
Si la variable $html est définie alors le code HTML est autorisé
(c'est-à-dire utilise 0 pour <title> et associés). Actuellement,
préfixe seulement avec la date dans une taille de caractères plus petite
(c'est-à-dire '2004-12-03.Folder').
Si la variable $lines est définie alors le multiligne est
autorisé. Actuellement, suis seulement la date avec un retour à la ligne 'br'.
New_Row($obj,$cols,$off) Devons-nous commencer une nouvelle ligne après cet objet ?
Utiliser la variable $off si l'offset du premier objet démarre à partir de 1
Image_Array($src,$x,$y,$also,$alt)
Retourne un tag HTML <img> à partir de $src, $x,...
Image_Ref($ref,$also,$alt)
Identique à Image_Array, mais la variable $ref peut
être une table de hachage de Image_Arrays indexée par
le langage (par défaut, '_').
album choisit l'Image_Array en fonction de la définition des langages.
Border($img,$type,$href,@border)
Border($str,$x,$y,@border)
Crée une image entière entourée de bordures. Voir
'Bordures' pour de plus amples détails.
Si vous créez un thème à partir de zéro, considérez l'ajout du support pour
l'option -slideshow. Le moyen le plus facile de réaliser cette opération est
de copier / coller le code "slideshow" d'un thème existant.
5: Soumettre des thèmes
Vous avez personnalisé un thème ? Je serais ravi de le voir même s'il est
totalement spécifique à votre site internet.
Si vous avez un nouveau thème que vous souhaiteriez rendre publique,
envoyez-le moi ou envoyez une adresse URL où je puisse le voir. N'oubliez pas
de mettre le fichier CREDIT à jour et faites-moi savoir si vous donnez ce
thème à MarginalHacks pour une utilisation libre ou si vous souhaitez le
mettre sous une license particulière.
6: Conversion des thèmes v2.0 aux thèmes v3.0
La version v2.0 d'album a introduit une interface de thèmes qui a été réécrite
dans la version v3.0 d'album. La plupart des thèmes de la version 2.0 (plus
spécialement ceux qui n'utilisent pas la plupart des variables globales)
fonctionneront toujours mais l'interface est obsolète et pourrait disparaître
dans un futur proche.
La conversion des thèmes de la version 2.0 à la version 3.0 n'est pas bien
difficile.
Les thèmes de la version 2.0 utilisent des variables globales pour tout un tas
de choses. Celles-ci sont maintenant obsolètes. Dans la version 3.0, vous
devez conserver une trace des images et des répertoires dans des variables et
utiliser des 'itérateurs' qui sont fournis. Par exemple :
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Ceci parcourra toutes les images et affichera leur nom.
Le tableau ci-dessous vous montre comment réécrire des appels codés avec
l'ancien style utilisant une variable globale en des appels codés avec le
nouveau style qui utilise une variable locale. Cependant pour utiliser ces
appels, vous devez modifier vos boucles comme ci-dessus.
Voici un tableau de conversion pour aider au passage des thèmes de la version
2.0 à la version 3.0 :
# Les variables globales ne doivent plus être utilisées
# OBSOLETE - Voir les nouvelles méthodes d'itérations avec variables locales
# ci-dessus
$PARENT_ALBUM_CNT Réécrire avec : Parent_Album($num) et Parent_Albums($join)
$CHILD_ALBUM_CNT Réécrire avec : my $dir = First('dirs'); $dir=Next($dir);
$IMAGE_CNT Réécrire avec : my $img = First('pics'); $pics=Next($pics);
@PARENT_ALBUMS Utiliser à la place : @{Path('parent_albums')}
@CHILD_ALBUMS, @CHILD_ALBUM_NAMES, @CHILD_ALBUM_URLS, ...
# Anciennes méthodes modifiant les variables globales
# OBSOLETE - Voir les nouvelles méthodes d'itérations avec variables locales
# ci-dessus
Next_Image(), Images_Left(), Image_Cnt(), Image_Prev(), Image_Next()
Set_Image_Prev(), Set_Image_Next(), Set_Image_This()
Next_Child_Album(), Child_Album_Cnt(), Child_Albums_Left()
# chemins et autres
pAlbum_Name() Path('album_name')
Album_Filename() Path('album_file')
pFile($file) print read_file($file)
Get_Opt($option) Option($option)
Index() Option('index')
pParent_Album($str) print Parent_Album($str)
# Albums parents
Parent_Albums_Left Obsolète, voir '$PARENT_ALBUM_CNT' ci-dessus
Parent_Album_Cnt Obsolète, voir '$PARENT_ALBUM_CNT' ci-dessus
Next_Parent_Album Obsolète, voir '$PARENT_ALBUM_CNT' ci-dessus
pJoin_Parent_Albums print Parent_Albums(\@_)
# Images, utilisant la variable '$img'
pImage() Utiliser $img à la place et :
print Get($img,'href','image');
print Get($img,'thumb') if Get($img,'thumb');
print Name($img), "</a>";
pImage_Src() print Image($img,'full')
Image_Src() Image($img,'full')
pImage_Thumb_Src() print Image($img,'thumb')
Image_Name() Name($img)
Image_Caption() Caption($img)
pImage_Caption() print Get($img,'Caption')
Image_Thumb() Get($img,'URL','thumb')
Image_Is_Pic() Get($img,'thumb')
Image_Alt() Get($img,'alt')
Image_Filesize() Get($img,'full','filesize')
Image_Path() Get($img,'full','path')
Image_Width() Get($img,'medium','x') || Get($img,'full','x')
Image_Height() Get($img,'medium','y') || Get($img,'full','y')
Image_Filename() Get($img,'full','file')
Image_Tag() Get($img,'full','tag')
Image_URL() Get($img,'URL','image')
Image_Page_URL() Get($img,'URL','image_page','image_page') || Back()
# Routines pour les albums enfant utilisant la variable '$alb'
pChild_Album($nobr) print Get($alb,'href','dir');
my $name = Name($alb);
$name =~ s/<br>//g if $nobr;
print $name,"</a>";
Child_Album_Caption() Caption($alb,'dirs')
pChild_Album_Caption() print Child_Album_Caption($alb)
Child_Album_URL() Get($alb,'URL','dir')
Child_Album_Name() Name($alb)
# Inchangé
Meta() Meta()
Credit() Credit()
7: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/old.txt_6 0000644 0000000 0000000 00000056476 10671126726 014340 0 ustar root root Création de thèmes
ITEM: Métodes
Il y a des moyens faciles et d'autres compliqués pour créer un thème sur
mesure en fonction de ce que vous voulez faire.
ITEM: Editer le code HTML d'un thème existant
Si vous voulez juste modifier légèrement un thème afin qu'il corresponde à
l'environnement de votre site, il semble opportun d'éditer un thème existant.
Dans le répertoire du thème, il y a deux fichiers avec l'extension
th. album.th est le patron pour les pages de l'album (les pages des vignettes)
et image.th est le patron pour les pages des images (où vous voyez les images
moyennement réduites ou en pleine taille). Ces fichiers sont très similaire à
du code HTML excepté quelques rajouts de code <: ePerl :>. Même si vous ne
connaissez ni Perl ni ePerl, vous pouvez néanmoins éditer le code HTML pour y
apporter des changements basiques.
Des thèmes pour bien démarrer :
N'importe quel thème dans simmer_theme peut servir comme "Blue" ou "Maste". Si
vous avez seulement besoin de 4 bordures aux coins de vos vignettes, alors
jetez un oeil sur "Eddie Bauer". Si vous voulez des bordures transparentes ou
qui se recouvrent, regardez "FunLand".
Si vous voulez quelque chose avec un minimum de code, essayez "simple" mais
attention, je n'ai pas mis à jour ce thème depuis un bon bout de temps.
ITEM: Le moyen facile : simmer_theme pour les graphiques
La plupart des thèmes ont un même format basique, montrent une série de
vignettes pour des répertoires puis pour des images avec une bordure et une
ligne graphiques ainsi qu'un fond d'écran. Si c'est ce que vous voulez mais
que vous souhaitez créer de nouveaux graphiques, il y a un outil qui vous
permettra de construire des thèmes.
Si vous créez un répertoire avec des images et un fichier CREDIT ainsi q'un
fichier Font ou Style.css, alors l'utilitaire simmer_theme vous permettra de
réaliser des thèmes.
Fichiers :
Font/Style.css
Ce fichier détermine les fontes utilisées par le thème. Le fichier "Font" est
le plus ancien système. Par exemple :
--------------------------------------------------
$TITLE_FONT = "size='4' color='#ffffff' face='Times New Roman,Georgia,Times'";
$MAIN_FONT = "face='Times New Roman,Georgia,Times'";
$CREDIT_FONT = "size='-1' face='Verdana' color='#ffffff'";
$BODY = "background='$PATH/bkgrnd.gif' link='#0099FF'">
--------------------------------------------------
Sinon, créez le fichier Style.css, puis définissez des styles pour : le corps,
le titre, la page principale, le crédit et toute autre chose que vous voulez.
Regardez FunLand comme exemple simple.
CREDIT
Le fichier de crédit comporte deux lignes et est utilisé pour l'index des
thèmes à MarginalHacks. Si vous ne nous soumettez jamais votre thème, alors
vous n'avez pas besoin de ce fichier (mais faites-le s'il vous plaît !). En
tout cas, les deux lignes (et seulement deux lignes) sont :
1) une courte description du thème (à faire tenir sur une seule ligne),
2) Votre nom (qui peut être à l'intérieur d'un mailto: ou d'un lien internet).
Null.gif
Chaque thème créé par simmer a besoin d'une image "espace" c'est-à-dire une
image au format gif transparent de dimensions 1x1. Vous pouvez simplement la
copier depuis un autre thème créé par simmer.
Fichiers d'images optionnels :
Images de la barre
La barre est composée de Bar_L.gif (à gauche), Bar_R.gif (à droite) et
Bar_M.gif au milieu. L'image de la barre du milieu est étirée. Si vous avez
besoin d'une barre centrale qui ne soit pas étirée, utilisez :
Bar_L.gif, Bar_ML.gif, Bar_M.gif, Bar_MR.gif, Bar_R.gif
Dans ce cas, Bar_ML.gif et Bar_MR.gif ne seront pas étirées (voir le thème
"Craftsman" pour un exemple de cette technique).
Locked.gif
Une image de cadenas pour tous les répertoires ayant un fichier nommé
.htaccess.
Images de fond
Si vous voulez une image en fond d'écran, spécifiez-la dans le fichier Font
dans la section $BODY comme dans l'exemple ci-dessus. La valeur de la variable
$PATH sera remplacée par le chemin d'accès aux fichiers du thème.
More.gif
Quand une page d'album comporte plusieurs sous-albums à lister, l'image
'More.gif' est affichée en premier.
Next.gif, Prev.gif, Back.gif
Ces images sont respectivement utilisées pour les boutons des flèches arrière
et avant et pour le bouton pour remonter dans la hiérarchie des albums.
Icon.gif
Cette image, affichée dans le coin supérieur gauche des albums parents, est
souvent le texte "Photos" seulement.
Images des bordures
Il y a plusieurs méthodes pour découper une bordure, de la plus simple à la
plus complexe, l'ensemble dépendant de la complexité de la bordure et du
nombre de sections que vous voulez pouvoir étirer :
4 morceaux Utilisez Bord_L.gif, Bord_R.gif, Bord_T.gif, Bord_B.gif
(les coins vont avec les images droites et gauches)
Les bordures en 4 morceaux ne s'étirent en général pas très bien et de
fait ne fonctionnent pas bien sur les pages d'images. En général, vous
pouvez couper les coins des images droites et gauches pour faire :
8 morceaux Incluez aussi Bord_TL.gif, Bord_TR.gif, Bord_BL.gif,
Bord_BR.gif
Les bordures en 8 morceaux vous permettez généralement d'étirer et de
gérer la plupart des images recadrées.
12 morceaux Incluez aussi Bord_LT.gif, Bord_RT.gif, Bord_LB.gif,
Bord_RB.gif
12 morceaux permettent d'étirer des bordures ayant des coins plus
complexes comme par exemple les thèmes Dominatrix ou Ivy.
Bordures chevauchantes Peuvent utiliser des images transparentes qui
peuvent partiellement chevaucher vos vignettes. Voir ci-dessous.
Voici comment des morceaux pour des bordures normales sont disposés :
bordure à 12 morceaux
TL T TR bordure à 8 morceaux bordure à 4 morceaux
LT RT TL T TR TTTTTTT
L IMG R L IMG R L IMG R
LB RB BL B BR BBBBBBB
BL B BR
Notez que chaque rangée d'images doit avoir la même hauteur, alors que ce
n'est pas le cas pour la largeur (c'est-à-dire hauteur TL = hauteur T =
hauteur TR).
Ceci n'est pas totalement vrai pour les bordures qui se chevauchent !
Une fois que vous avez créé ces fichiers, vous pouvez lancer l'utilitaire
simmer_theme (un outil téléchargeable depuis MarginalHacks.com) et votre thème
deviendra prêt à être utilisé !
Si vous avez besoin de bordures différentes pour les pages d'images, alors
utilisez les mêmes noms de fichiers maix en les préfixant par 'I' comme par
exemple IBord_LT.gif, IBord_RT.gif,...
Les bordures chevauchantes autorisent des effets réellement fantastiques avec
les bordures des images. Actuellement, il n'y a pas de support pour des
bordures chevauchantes différentes pour les images.
Pour utiliser les bordures chevauchantes, créez les images :
Over_TL.png Over_T.png Over_TR.png
Over_L.png Over_R.png
Over_BL.png Over_B.png Over_BR.png
Puis, déterminez combien de pixels des bordures vont déborder (en dehors de la
photo). Mettez ces valeurs dans des fichiers: Over_T.pad Over_R.pad Over_B.pad
Over_L.pad.
Voir le thème "FunLand" pour un exemple simple.
Images polyglottes
Si vos images comportent du texte, vous pouvez les traduire dans d'autres
langues et, ainsi, vos albums pourront être générés dans d'autres
langages. Par exemple, vous pouvez créer une image "More.gif" hollandaise et
mettre ce fichier dans le répertoire 'lang/nl' de votre thème (nl est le code
de langage pour le hollandais).
Quand l'utilisateur lancera album en hollandais (album -lang nl) alors le
thème utilisera les images hollandaises s'il les trouve. Le thème "Blue"
comporte un tel exemple simple. Les images actuellement traduites sont :
More, Back, Next, Prev and Icon
Vous pouvez créer une page HTML qui donne la liste des traductions
immédiatement disponibles dans les thèmes avec l'option -list_html_trans :
% album -list_html_trans > trans.html
Puis, visualisez le fichier trans.html dans un navigateur. Malheureusement,
plusieurs langages ont des tables d'encodage des caractères différents et une
page HTML n'en dispose que d'une seule. La table d'encodage est utf-u mais
vous pouvez éditer la ligne "charset=utf-8" pour visualiser correctement les
différents caractères utilisés dans les langages en fonction des différentes
tables d'encodage (comme par exemple l'hébreu).
Si vous avez besoin de plus de mots traduits pour les thèmes, faites-le moi
savoir et si vous créez des images dans une nouvelle langue pour un thème,
envoyez-les moi s'il vous plaît !
ITEM: Partir de zéro : l'API des thèmes
Ceci est une autre paire de manches : vous avez besoin d'avoir une idée
vraiment très claire de la façon dont vous voulez qu'album positionne vos
images sur votre page. Ce serait peut-être une bonne idée de commencer en
premier par modifier des thèmes existants afin de cerner ce que la plupart des
thèmes fait. Regardez également les thèmes existants pour des exemples de code
(voir les suggestions ci-dessus).
Les thèmes sont des répertoires qui contiennent au minimum un fichier
'album.th'. Ceci est le patron du thème pour les pages de l'album. Souvent,
les répertoires contiennent aussi un fichier 'image.th' qui est un patron du
thème pour les images ainsi que des fichiers graphiques / css utilisés par le
thème. Les pages de l'album contiennent les vignettes et les pages des images
montrent les images pleine page ou recadrées.
Les fichiers .th sont en ePerl qui est du perl encapsulé à l'intérieur
d'HTML. Ils finissent par ressembler à ce que sera l'album et les images HTML
eux-mêmes.
Pour écrire un thème, vous aurez besoin de connaître la syntaxe ePerl. Vous
pouvez trouver plus d'information sur l'outil ePerl en général à MarginalHacks
(bien que cet outil ne soit pas nécessaire pour l'utilisation des thèmes dans album).
Il y a une pléthore de routines de support disponibles mais souvent une
fraction d'entre elles seulement est nécessaire (cela peut aider de regarder
les autres thèmes afin de voir comment ils sont construits en général).
Table des fonctions:
Fonctions nécessaires
Meta() Doit être appelée depuis la section du HTML
Credit() Affiche le crédit ('cet album a été créé par..')
Doit être appelée depuis la section du HTML
Body_Tag() Appelée depuis l'intérieur du tag .
Chemins et options
Option($name) Retourne la valeur d'une option / configuration
Version() Retourne la version d'album
Version_Num() Retourne le numéro de la version d'album en chiffres
uniquement (c'est-à-dire. "3.14")
Path($type) Retourne l'information du chemin pour le $type de :
album_name Nom de l'album
dir Répertoire courant de travail d'album
album_file Chemin complet au fichier d'album index.html
album_path Chemin des répertoires parent
theme Chemin complet du répertoire du thème
img_theme Chemin complet du répertoire du thème depuis les
pages des images
page_post_url Le ".html" à ajouter sur les pages des images
parent_albums Tableau des albums parents (segmentation par album_path)
Image_Page() 1 si on est en train de générer une page d'image, 0
si c'est une page de vignettes
Page_Type() Soit 'image_page' ou 'album_page'
Theme_Path() Le chemin d'accès (via le système de fichiers) aux fichiers du thème
Theme_URL() Le chemin d'accès (via une URL) aux fichiers du thème
En-tête et pied-de-page
isHeader(), pHeader() Test pour et afficher l'en-tête
isFooter(), pFooter() La même chose pour le pied-de-page
En général, vous bouclez à travers les images et les répertoires en utilisant
des variables locales :
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Ceci affichera le nom de chaque image. Nos types d'objets sont soit 'pics'
pour les images soit 'dirs' pour les répertoires-enfants. Ici se trouvent les
fonctions relatives aux objets :
Objets (le type est soit 'pics' (défaut) soit 'dirs')
First($type) Renvoie comme objet la première image ou le premier sous-album.
Last($type) Renvoie le dernier objet
Next($obj) Etant donné un objet, renvoie l'objet suivant
Next($obj,1) La même chose mais retourne au début une fois la fin atteinte
Prev($obj), Prev($obj,1) Similaire à Next()
num('pics') ou juste num() Nombre total d'images de cet album
num('dirs') Nombre total de sous-albums
Egalement:
num('parent_albums') Nombre total d'albums parents conduisant à cet album
Consultation d'objet :
get_obj($num, $type, $loop)
Trouve un objet à partir de son numéro (type 'pics' ou 'dirs').
Si la variable $loop est positionnée alors le
compteur rebouclera au début lors de la recherche
Propriétés des objets
Chaque objet (image ou sous-album) possède des propriétés.
L'accès à certaines propriétés se fait par un simple champ :
Get($obj,$field) Retourne un simple champ pour un objet donné
Champ Description
----- ----------
type Quel type d'objet ? Soit 'pics' soit 'dirs'
is_movie Booléen: est-ce que c'est un film ?
name Nom (nettoyé et optionnel pour les légendes)
cap Légende de l'image
capfile Fichier optionnel des légendes
alt Etiquette (tag) alt
num_pics [répertoires seulement, -dir_thumbs] Nombre d'images
dans le répertoire
num_dirs [répertoires seulement, -dir_thumbs] Nombre de
sous-répertoire dans le répertoire
L'accès à des propriétés se fait via un champ et un sous-champ. Par exemple,
chaque image comporte une information sur ses différentes tailles : plein
écran, moyenne et vignette (bien que la taille moyenne soit optionnelle).
Get($obj,$size,$field) Retourne la propriété de l'image pour une taille donnéee
Taille Champ Description
------ ----- ----------
$size x Largeur
$size y Hauteur
$size file Nom du fichier (sans le chemin)
$size path Nom du fichier (chemin complete)
$size filesize Taille du fichier en octets
full tag L'étiquette (tag) (soit 'image' soit 'embed') -
seulement pour 'full'
Il y a aussi des informations relatives aux URL dont l'accès se fait en
fonction de la page d'où on vient ('from' / depuis) et l'image ou la page vers lequel
on va ('to' / vers) :
Get($obj,'URL',$from,$to) Renvoie un URL pour un objet 'depuis -> 'vers
Get($obj,'href',$from,$to) Idem mais utilise une chaîne de caractères avec 'href'
Get($obj,'link',$from,$to) Idem mais met le nom de l'objet à l'intérieur d'un
lien href
Depuis Vers Description
------ ---- ----------
album_page image Image_URL vers album_page
album_page thumb Thumbnail vers album_page
image_page image Image_URL vers image_page
image_page image_page Cette page d'image vers une autre page d'image
image_page image_src L'URL d'<img src> pour la page d'image
image_page thumb Page des vignettes depuis la page d'image
Les objets répertoires ont aussi :
Depuis Vers Description
------ ---- ----------
album_page dir URL vers le répertoire depuis la page de son album-parent
Albums parent
Parent_Album($num) Renvoie en chaîne de caractères le nom de l'album
parent (incluant le href)
Parent_Albums() Retourne une liste de chaînes de caractères des
albums parents (incluant le href)
Parent_Album($str) Crée la chaîne de caractères $str à partir de
l'appel à la fonction Parent_Albums()
Back() L'URL pour revenir en arrière ou remonter d'une page
Images
This_Image L'objet image pour une page d'image
Image($img,$type) Les étiquettes d'<img> pour les types 'medium',
'full' et 'thumb'
Image($num,$type) Idem mais avec le numéro de l'image
Name($img) Le nom nettoyé ou légendé pour une image
Caption($img) La légende pour une image
Albums enfants
Name($alb) Le nom du sous-album
Caption($img) La légende pour une image
Quelques routines utiles
Pretty($str,$html,$lines) Formate un nom.
Si la variable $html est définie alors le code HTML est autorisé
(c'est-à-dire utilise 0 pour et associés). Actuellement, préfixe
seulement avec la date dans une taille de caractères plus petite
(c'est-à-dire '2004-12-03.Folder').
Si la variable $line est définie alors le multiligne est
autorisé. Actuellement, suis seulement la date avec un retour à la ligne 'br'.
New_Row($obj,$cols,$off) Devons-nous commencer une nouvelle ligne après cet
objet ?
Utiliser la variable $off si l'offset du premier
objet démarre à partir de 1
Image_Array($src,$x,$y,$also,$alt)
Retourne un tag HTML <img> à partir de $src, $x,...
Image_Ref($ref,$also,$alt)
Identique à Image_Array, mais la variable $ref peut
être une table de hachage de Image_Arrays indexée par
le langage (par défaut, '_').
album choisit l'Image_Array en fonction de la
définition des langages.
Border($img,$type,$href,@border)
Border($str,$x,$y,@border)
Crée une image entière entourée de bordures. Voir
'Bordures' pour de plus amples détails.
Si vous créez un thème à partir de zéro, considérez l'ajout du support pour
l'option -slideshow. Le moyen le plus facile de réaliser cette opération est
de copier / coller le code "slideshow" d'un thème existant.
ITEM: Soumettre des thèmes
Vous avez personnalisé un thème ? Je serais ravi de le voir même s'il est
totalement spécifique à votre site internet.
si vous avez un nouveau thème que vous souhaiteriez rendre publique,
envoyez-le moi ou envoyez une adresse URL où je puisse le voir. N'oubliez pas
de mettre le fichier CREDIT à jour et faites-moi savoir si vous donnez ce
thème à MarginalHacks pour une utilisation libre ou si vous souhaitez le
mettre sous une license particulière.
ITEM: Conversion des thèmes v2.0 aux thèmes v3.0
La version v2.0 d'album a introduit une interface de thèmes qui a été réécrite
dans la version v3.0 d'album. La plupart des thèmes de la version 2.0 (plus
spécialement ceux qui n'utilisent pas la plupart des variables globales)
fonctionneront toujours mais l'interface est obsolète et pourrait disparaître
dans un futur proche.
La conversion des thèmes de la version 2.0 à la version 3.0 n'est pas bien
difficile.
Les thèmes de la version 2.0 utilisent des variables globales pour tout un tas
de choses. Celles-ci sont maintenant obsolètes. Dans la version 3.0, vous
devez conserver une trace des images et des répertoires dans des variables et
utiliser des 'itérateurs' qui sont fournis. Par exemple :
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Ceci parcourra toutes les images et affichera leur nom.
Le tableau ci-dessous vous montre comment réécrire des appels codés avec
l'ancien style utilisant une variable globale en des appels codés avec le
nouveau style qui utilise une variable locale. Cependant pour utiliser ces
appels, vous devez modifier vos boucles comme ci-dessus.
Voici une tableau de conversion pour aider au passage des thèmes de la version
2.0 à la version 3.0 :
# Les variables globales ne doivent plus être utilisées
# OBSOLETE - Voir les nouvelles méthodes d'itérations avec variables locales
# ci-dessus
$PARENT_ALBUM_CNT Réécrire avec : Parent_Album($num) et Parent_Albums($join)
$CHILD_ALBUM_CNT Réécrire avec : my $dir = First('dirs'); $dir=Next($dir);
$IMAGE_CNT Réécrire avec : my $img = First('pics'); $pics=Next($pics);
@PARENT_ALBUMS Utiliser à la place : @{Path('parent_albums')}
@CHILD_ALBUMS, @CHILD_ALBUM_NAMES, @CHILD_ALBUM_URLS, ...
# Anciennes méthodes modifiant les variables globales
# OBSOLETE - Voir les nouvelles méthodes d'itérations avec variables locales
# ci-dessus
Next_Image(), Images_Left(), Image_Cnt(), Image_Prev(), Image_Next()
Set_Image_Prev(), Set_Image_Next(), Set_Image_This()
Next_Child_Album(), Child_Album_Cnt(), Child_Albums_Left()
# chemins et autres
pAlbum_Name() Path('album_name')
Album_Filename() Path('album_file')
pFile($file) print read_file($file)
Get_Opt($option) Option($option)
Index() Option('index')
pParent_Album($str) print Parent_Album($str)
# Albums parents
Parent_Albums_Left Obsolète, voir '$PARENT_ALBUM_CNT' ci-dessus
Parent_Album_Cnt Obsolète, voir '$PARENT_ALBUM_CNT' ci-dessus
Next_Parent_Album Obsolète, voir '$PARENT_ALBUM_CNT' ci-dessus
pJoin_Parent_Albums print Parent_Albums(\@_)
# Images, utilisant la variable '$img'
pImage() Utiliser $img à la place et :
print Get($img,'href','image');
print Get($img,'thumb') if Get($img,'thumb');
print Name($img), "</a>";
pImage_Src() print Image($img,'full')
Image_Src() Image($img,'full')
pImage_Thumb_Src() print Image($img,'thumb')
Image_Name() Name($img)
Image_Caption() Caption($img)
pImage_Caption() print Get($img,'Caption')
Image_Thumb() Get($img,'URL','thumb')
Image_Is_Pic() Get($img,'thumb')
Image_Alt() Get($img,'alt')
Image_Filesize() Get($img,'full','filesize')
Image_Path() Get($img,'full','path')
Image_Width() Get($img,'medium','x') || Get($img,'full','x')
Image_Height() Get($img,'medium','y') || Get($img,'full','y')
Image_Filename() Get($img,'full','file')
Image_Tag() Get($img,'full','tag')
Image_URL() Get($img,'URL','image')
Image_Page_URL() Get($img,'URL','image_page','image_page') || Back()
# Routines pour les albums enfant utilisant la variable '$alb'
pChild_Album($nobr) print Get($alb,'href','dir');
my $name = Name($alb);
$name =~ s/<br>//g if $nobr;
print $name,"</a>";
Child_Album_Caption() Caption($alb,'dirs')
pChild_Album_Caption() print Child_Album_Caption($alb)
Child_Album_URL() Get($alb,'URL','dir')
Child_Album_Name() Name($alb)
# Inchangé
Meta() Meta()
Credit() Credit()
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
</span>
album-4.17/Docs/fr/new_txt_6 0000644 0000000 0000000 00000055655 12236174041 014422 0 ustar root root Cration de thmes
<span lang="fr">
ITEM: Mtodes
Il y a des moyens faciles et d'autres compliqus pour crer un thme sur
mesure en fonction de ce que vous voulez faire.
ITEM: Editer le code HTML d'un thme existant
Si vous voulez juste modifier lgrement un thme afin qu'il corresponde
l'environnement de votre site, il semble opportun d'diter un thme existant.
Dans le rpertoire du thme, il y a deux fichiers avec l'extension
th. album.th est le patron pour les pages de l'album (les pages des vignettes)
et image.th est le patron pour les pages des images (o vous voyez les images
moyennement rduites ou en pleine taille). Ces fichiers sont trs similaire
du code HTML except quelques rajouts de code <: ePerl :>. Mme si vous ne
connaissez ni Perl ni ePerl, vous pouvez nanmoins diter le code HTML pour y
apporter des changements basiques.
Des thmes pour bien dmarrer :
N'importe quel thme dans simmer_theme peut servir comme "Blue" ou "Maste". Si
vous avez seulement besoin de 4 bordures aux coins de vos vignettes, alors
jetez un oeil sur "Eddie Bauer". Si vous voulez des bordures transparentes ou
qui se recouvrent, regardez "FunLand".
Si vous voulez quelque chose avec un minimum de code, essayez "simple" mais
attention, je n'ai pas mis jour ce thme depuis un bon bout de temps.
ITEM: Le moyen facile : simmer_theme pour les graphiques
La plupart des thmes ont un mme format basique, montrent une srie de
vignettes pour des rpertoires puis pour des images avec une bordure et une
ligne graphiques ainsi qu'un fond d'cran. Si c'est ce que vous voulez mais
que vous souhaitez crer de nouveaux graphiques, il y a un outil qui vous
permettra de construire des thmes.
Si vous crez un rpertoire avec des images et un fichier CREDIT ainsi qu'un
fichier Font ou Style.css, alors l'utilitaire simmer_theme vous permettra de
raliser des thmes.
Fichiers :
<b>Font/Style.css</b>
Ce fichier dtermine les fontes utilises par le thme. Le fichier "Font" est
le plus ancien systme, dcrit ci-dessous. Crez un fichier Style.css et
dfinissez des styles pour : body (le corps), title (le titre), main (la page
principale), credit (le crdit) et tout ce que vous voulez.
Regardez FunLand pour un exemple basique.
Autrement, utilisez un fichier Font. Un exemple de fichier Font est :
--------------------------------------------------
$TITLE_FONT = "size='4' color='#ffffff' face='Times New Roman,Georgia,Times'";
$MAIN_FONT = "face='Times New Roman,Georgia,Times'";
$CREDIT_FONT = "size='-1' face='Verdana' color='#ffffff'";
$BODY = "background='$PATH/bkgrnd.gif' link='#0099FF'">
--------------------------------------------------
<b>CREDIT</b>
Le fichier de crdit comporte deux lignes et est utilis pour l'index des
thmes MarginalHacks. Si vous ne nous soumettez jamais votre thme, alors
vous n'avez pas besoin de ce fichier (mais faites-le s'il vous plat !). En
tout cas, les deux lignes (et seulement deux lignes) sont :
1) une courte description du thme ( faire tenir sur une seule ligne),
2) Votre nom (qui peut tre l'intrieur d'un mailto: ou d'un lien internet).
<b>Null.gif</b>
Chaque thme cr par simmer a besoin d'une image "espace" c'est--dire une
image au format gif transparent de dimensions 1x1. Vous pouvez simplement la
copier depuis un autre thme cr par simmer.
Fichiers d'images optionnels :
<b>Images de la barre</b>
La barre est compose de Bar_L.gif ( gauche), Bar_R.gif ( droite) et
Bar_M.gif au milieu. L'image de la barre du milieu est tire. Si vous avez
besoin d'une barre centrale qui ne soit pas tire, utilisez :
Bar_L.gif, Bar_ML.gif, Bar_M.gif, Bar_MR.gif, Bar_R.gif
Dans ce cas, Bar_ML.gif et Bar_MR.gif ne seront pas tires (voir le thme
Craftsman pour un exemple de cette technique).
<b>Locked.gif</b>
Une image de cadenas pour tous les rpertoires ayant un fichier nomm
.htaccess.
<b>Images de fond</b>
Si vous voulez une image en fond d'cran, spcifiez-la dans le fichier Font
dans la section $BODY comme dans l'exemple ci-dessus. La valeur de la variable
$PATH sera remplace par le chemin d'accs aux fichiers du thme.
<b>More.gif</b>
Quand une page d'album comporte plusieurs sous-albums lister, l'image
'More.gif' est affiche en premier.
<b>Next.gif, Prev.gif, Back.gif</b>
Ces images sont respectivement utilises pour les boutons des flches arrire
et avant et pour le bouton pour remonter dans la hirarchie des albums.
<b>Icon.gif</b>
Cette image, affiche dans le coin suprieur gauche des albums parents, est
souvent le texte "Photos" seulement.
<b>Images des bordures</b>
Il y a plusieurs mthodes pour dcouper une bordure, de la plus simple la
plus complexe, l'ensemble dpendant de la complexit de la bordure et du
nombre de sections que vous voulez pouvoir tirer :
<b>4 morceaux</b> Utilisez Bord_L.gif, Bord_R.gif, Bord_T.gif, Bord_B.gif
(les coins vont avec les images droites et gauches)
Les bordures en 4 morceaux ne s'tirent en gnral pas trs bien et de
fait ne fonctionnent pas bien sur les pages d'images. En gnral, vous
pouvez couper les coins des images droites et gauches pour faire :
<b>8 morceaux</b> Incluez aussi Bord_TL.gif, Bord_TR.gif, Bord_BL.gif,
Bord_BR.gif
Les bordures en 8 morceaux vous permettent gnralement d'tirer et de
grer la plupart des images recadres.
<b>12 morceaux</b> Incluez aussi Bord_LT.gif, Bord_RT.gif, Bord_LB.gif,
Bord_RB.gif
12 morceaux permettent d'tirer des bordures ayant des coins plus
complexes comme par exemple les thmes Dominatrix ou Ivy.
<b>Bordures chevauchantes</b> Peuvent utiliser des images transparentes qui
peuvent partiellement chevaucher vos vignettes. Voir ci-dessous.
Voici comment des morceaux pour des bordures normales sont disposs :
bordure 12 morceaux
TL T TR bordure 8 morceaux bordure 4 morceaux
LT RT TL T TR TTTTTTT
L IMG R L IMG R L IMG R
LB RB BL B BR BBBBBBB
BL B BR
Notez que chaque range d'images doit avoir la mme hauteur, alors que ce
<b>n'est pas</b> le cas pour la largeur (c'est--dire hauteur TL = hauteur T =
hauteur TR).
Ceci n'est pas totalement vrai pour les bordures qui se chevauchent !
Une fois que vous avez cr ces fichiers, vous pouvez lancer l'utilitaire
simmer_theme (un outil tlchargeable depuis MarginalHacks.com) et votre thme
deviendra prt tre utilis !
Si vous avez besoin de bordures diffrentes pour les pages d'images, alors
utilisez les mmes noms de fichiers maix en les prfixant par 'I' comme par
exemple IBord_LT.gif, IBord_RT.gif,...
Les bordures chevauchantes autorisent des effets rellement fantastiques avec
les bordures des images. Actuellement, il n'y a pas de support pour des
bordures chevauchantes diffrentes pour les images.
Pour utiliser les bordures chevauchantes, crez les images :
Over_TL.png Over_T.png Over_TR.png
Over_L.png Over_R.png
Over_BL.png Over_B.png Over_BR.png
Puis, dterminez combien de pixels des bordures vont dborder (en dehors de la
photo). Mettez ces valeurs dans des fichiers: Over_T.pad Over_R.pad Over_B.pad
Over_L.pad.
Voir le thme "Themes/FunLand" pour un exemple simple.
<b>Images polyglottes</b>
Si vos images comportent du texte, vous pouvez les traduire dans d'autres
langues et, ainsi, vos albums pourront tre gnrs dans d'autres
langages. Par exemple, vous pouvez crer une image "More.gif" hollandaise et
mettre ce fichier dans le rpertoire 'lang/nl' de votre thme (nl est le code
de langage pour le hollandais).
Quand l'utilisateur lancera album en hollandais (album -lang nl) alors le
thme utilisera les images hollandaises s'il les trouve. Le thme "Themes/Blue"
comporte un tel exemple simple. Les images actuellement traduites sont :
More, Back, Next, Prev and Icon
Vous pouvez crer une page HTML qui donne la liste des traductions
immdiatement disponibles dans les thmes avec l'option -list_html_trans :
<code>% album -list_html_trans > trans.html</code>
Puis, visualisez le fichier trans.html dans un navigateur. Malheureusement,
plusieurs langages ont des tables d'encodage des caractres diffrents et une
page HTML n'en dispose que d'une seule. La table d'encodage est utf-8 mais
vous pouvez diter la ligne "charset=utf-8" pour visualiser correctement les
diffrents caractres utiliss dans les langages en fonction des diffrentes
tables d'encodage (comme par exemple l'hbreu).
Si vous avez besoin de plus de mots traduits pour les thmes, faites-le moi
savoir et si vous crez des images dans une nouvelle langue pour un thme,
envoyez-les moi s'il vous plat !
ITEM: Partir de zro : l'API des thmes
Ceci est une autre paire de manches : vous avez besoin d'avoir une ide
vraiment trs claire de la faon dont vous voulez qu'album positionne vos
images sur votre page. Ce serait peut-tre une bonne ide de commencer en
premier par modifier des thmes existants afin de cerner ce que la plupart des
thmes fait. Regardez galement les thmes existants pour des exemples de code
(voir les suggestions ci-dessus).
Les thmes sont des rpertoires qui contiennent au minimum un fichier
'album.th'. Ceci est le patron du thme pour les pages de l'album. Souvent,
les rpertoires contiennent aussi un fichier 'image.th' qui est un patron du
thme pour les images ainsi que des fichiers graphiques / css utiliss par le
thme. Les pages de l'album contiennent les vignettes et les pages des images
montrent les images pleine page ou recadres.
Les fichiers .th sont en ePerl qui est du perl encapsul l'intrieur
d'HTML. Ils finissent par ressembler ce que sera l'album et les images HTML
eux-mmes.
Pour crire un thme, vous aurez besoin de connatre la syntaxe ePerl. Vous
pouvez trouver plus d'information sur l'outil ePerl en gnral MarginalHacks
(bien que cet outil ne soit pas ncessaire pour l'utilisation des thmes dans album).
Il y a une plthore de routines de support disponibles mais souvent une
fraction d'entre elles seulement est ncessaire (cela peut aider de regarder
les autres thmes afin de voir comment ils sont construits en gnral).
Table des fonctions:
<b>Fonctions ncessaires</b>
Meta() Doit tre appele depuis la section <head> du HTML
Credit() Affiche le crdit ('cet album a t cr par..')
Doit tre appele depuis la section <body> du HTML
Body_Tag() Appele depuis l'intrieur du tag <body>.
<b>Chemins et options</b>
Option($name) Retourne la valeur d'une option / configuration
Version() Retourne la version d'album
Version_Num() Retourne le numro de la version d'album en chiffres
uniquement (c'est--dire. "3.14")
Path($type) Retourne l'information du chemin pour le $type de :
album_name Nom de l'album
dir Rpertoire courant de travail d'album
album_file Chemin complet au fichier d'album index.html
album_path Chemin des rpertoires parent
theme Chemin complet du rpertoire du thme
img_theme Chemin complet du rpertoire du thme depuis les pages des images
page_post_url Le ".html" ajouter sur les pages des images
parent_albums Tableau des albums parents (segmentation par album_path)
Image_Page() 1 si on est en train de gnrer une page d'image, 0 si c'est une page de vignettes
Page_Type() Soit 'image_page' ou 'album_page'
Theme_Path() Le chemin d'accs (via le systme de fichiers) aux fichiers du thme
Theme_URL() Le chemin d'accs (via une URL) aux fichiers du thme
<b>En-tte et pied-de-page</b>
isHeader(), pHeader() Test pour et afficher l'en-tte
isFooter(), pFooter() La mme chose pour le pied-de-page
En gnral, vous bouclez travers les images et les rpertoires en utilisant
des variables locales :
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Ceci affichera le nom de chaque image. Nos types d'objets sont soit 'pics'
pour les images soit 'dirs' pour les rpertoires-enfants. Ici se trouvent les
fonctions relatives aux objets :
<b>Objets</b> (le type est soit 'pics' (dfaut) soit 'dirs')
First($type) Renvoie comme objet la premire image ou le premier sous-album.
Last($type) Renvoie le dernier objet
Next($obj) Etant donn un objet, renvoie l'objet suivant
Next($obj,1) La mme chose mais retourne au dbut une fois la fin atteinte
Prev($obj), Prev($obj,1) Similaire Next()
num('pics') ou juste num() Nombre total d'images de cet album
num('dirs') Nombre total de sous-albums
Egalement :
num('parent_albums') Nombre total d'albums parents conduisant cet album
Consultation d'objet :
get_obj($num, $type, $loop)
Trouve un objet partir de son numro (type 'pics' ou 'dirs').
Si la variable $loop est positionne alors le
compteur rebouclera au dbut lors de la recherche
<b>Proprits des objets</b>
Chaque objet (image ou sous-album) possde des proprits.
L'accs certaines proprits se fait par un simple champ :
Get($obj,$field) Retourne un simple champ pour un objet donn
Champ Description
----- ----------
type Quel type d'objet ? Soit 'pics' soit 'dirs'
is_movie Boolen: est-ce que c'est un film ?
name Nom (nettoy et optionnel pour les lgendes)
cap Lgende de l'image
capfile Fichier optionnel des lgendes
alt Etiquette (tag) alt
num_pics [rpertoires seulement, -dir_thumbs] Nombre d'images dans le rpertoire
num_dirs [rpertoires seulement, -dir_thumbs] Nombre de sous-rpertoire dans le rpertoire
L'accs des proprits se fait via un champ et un sous-champ. Par exemple,
chaque image comporte une information sur ses diffrentes tailles : plein
cran, moyenne et vignette (bien que la taille moyenne soit optionnelle).
Get($obj,$size,$field) Retourne la proprit de l'image pour une taille donnee
Taille Champ Description
------ ----- ----------
$size x Largeur
$size y Hauteur
$size file Nom du fichier (sans le chemin)
$size path Nom du fichier (chemin complete)
$size filesize Taille du fichier en octets
full tag L'tiquette (tag) (soit 'image' soit 'embed') - seulement pour 'full'
Il y a aussi des informations relatives aux URL dont l'accs se fait en
fonction de la page d'o on vient ('from' / depuis) et l'image ou la page vers
lequel on va ('to' / vers) :
Get($obj,'URL',$from,$to) Renvoie un URL pour un objet 'depuis -> 'vers
Get($obj,'href',$from,$to) Idem mais utilise une chane de caractres avec 'href'
Get($obj,'link',$from,$to) Idem mais met le nom de l'objet l'intrieur d'un lien href
Depuis Vers Description
------ ---- ----------
album_page image Image_URL vers album_page
album_page thumb Thumbnail vers album_page
image_page image Image_URL vers image_page
image_page image_page Cette page d'image vers une autre page d'image
image_page image_src L'URL d'<img src> pour la page d'image
image_page thumb Page des vignettes depuis la page d'image
Les objets rpertoires ont aussi :
Depuis Vers Description
------ ---- ----------
album_page dir URL vers le rpertoire depuis la page de son album-parent
<b>Albums parent</b>
Parent_Album($num) Renvoie en chane de caractres le nom de l'album parent (incluant le href)
Parent_Albums() Retourne une liste de chanes de caractres des albums parents (incluant le href)
Parent_Album($str) Cre la chane de caractres $str partir de l'appel la fonction Parent_Albums()
Back() L'URL pour revenir en arrire ou remonter d'une page
<b>Images</b>
This_Image L'objet image pour une page d'image
Image($img,$type) Les tiquettes d'<img> pour les types 'medium', 'full' et 'thumb'
Image($num,$type) Idem mais avec le numro de l'image
Name($img) Le nom nettoy ou lgend pour une image
Caption($img) La lgende pour une image
<b>Albums enfants</b>
Name($alb) Le nom du sous-album
Caption($img) La lgende pour une image
<b>Quelques routines utiles</b>
Pretty($str,$html,$lines) Formate un nom.
Si la variable $html est dfinie alors le code HTML est autoris
(c'est--dire utilise 0 pour <title> et associs). Actuellement,
prfixe seulement avec la date dans une taille de caractres plus petite
(c'est--dire '2004-12-03.Folder').
Si la variable $lines est dfinie alors le multiligne est
autoris. Actuellement, suis seulement la date avec un retour la ligne 'br'.
New_Row($obj,$cols,$off) Devons-nous commencer une nouvelle ligne aprs cet objet ?
Utiliser la variable $off si l'offset du premier objet dmarre partir de 1
Image_Array($src,$x,$y,$also,$alt)
Retourne un tag HTML <img> partir de $src, $x,...
Image_Ref($ref,$also,$alt)
Identique Image_Array, mais la variable $ref peut
tre une table de hachage de Image_Arrays indexe par
le langage (par dfaut, '_').
album choisit l'Image_Array en fonction de la dfinition des langages.
Border($img,$type,$href,@border)
Border($str,$x,$y,@border)
Cre une image entire entoure de bordures. Voir
'Bordures' pour de plus amples dtails.
Si vous crez un thme partir de zro, considrez l'ajout du support pour
l'option -slideshow. Le moyen le plus facile de raliser cette opration est
de copier / coller le code "slideshow" d'un thme existant.
ITEM: Soumettre des thmes
Vous avez personnalis un thme ? Je serais ravi de le voir mme s'il est
totalement spcifique votre site internet.
Si vous avez un nouveau thme que vous souhaiteriez rendre publique,
envoyez-le moi ou envoyez une adresse URL o je puisse le voir. N'oubliez pas
de mettre le fichier CREDIT jour et faites-moi savoir si vous donnez ce
thme MarginalHacks pour une utilisation libre ou si vous souhaitez le
mettre sous une license particulire.
ITEM: Conversion des thmes v2.0 aux thmes v3.0
La version v2.0 d'album a introduit une interface de thmes qui a t rcrite
dans la version v3.0 d'album. La plupart des thmes de la version 2.0 (plus
spcialement ceux qui n'utilisent pas la plupart des variables globales)
fonctionneront toujours mais l'interface est obsolte et pourrait disparatre
dans un futur proche.
La conversion des thmes de la version 2.0 la version 3.0 n'est pas bien
difficile.
Les thmes de la version 2.0 utilisent des variables globales pour tout un tas
de choses. Celles-ci sont maintenant obsoltes. Dans la version 3.0, vous
devez conserver une trace des images et des rpertoires dans des variables et
utiliser des 'itrateurs' qui sont fournis. Par exemple :
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Ceci parcourra toutes les images et affichera leur nom.
Le tableau ci-dessous vous montre comment rcrire des appels cods avec
l'ancien style utilisant une variable globale en des appels cods avec le
nouveau style qui utilise une variable locale. Cependant pour utiliser ces
appels, vous devez modifier vos boucles comme ci-dessus.
Voici un tableau de conversion pour aider au passage des thmes de la version
2.0 la version 3.0 :
# Les variables globales ne doivent plus tre utilises
# OBSOLETE - Voir les nouvelles mthodes d'itrations avec variables locales
# ci-dessus
$PARENT_ALBUM_CNT Rcrire avec : Parent_Album($num) et Parent_Albums($join)
$CHILD_ALBUM_CNT Rcrire avec : my $dir = First('dirs'); $dir=Next($dir);
$IMAGE_CNT Rcrire avec : my $img = First('pics'); $pics=Next($pics);
@PARENT_ALBUMS Utiliser la place : @{Path('parent_albums')}
@CHILD_ALBUMS, @CHILD_ALBUM_NAMES, @CHILD_ALBUM_URLS, ...
# Anciennes mthodes modifiant les variables globales
# OBSOLETE - Voir les nouvelles mthodes d'itrations avec variables locales
# ci-dessus
Next_Image(), Images_Left(), Image_Cnt(), Image_Prev(), Image_Next()
Set_Image_Prev(), Set_Image_Next(), Set_Image_This()
Next_Child_Album(), Child_Album_Cnt(), Child_Albums_Left()
# chemins et autres
pAlbum_Name() Path('album_name')
Album_Filename() Path('album_file')
pFile($file) print read_file($file)
Get_Opt($option) Option($option)
Index() Option('index')
pParent_Album($str) print Parent_Album($str)
# Albums parents
Parent_Albums_Left Obsolte, voir '$PARENT_ALBUM_CNT' ci-dessus
Parent_Album_Cnt Obsolte, voir '$PARENT_ALBUM_CNT' ci-dessus
Next_Parent_Album Obsolte, voir '$PARENT_ALBUM_CNT' ci-dessus
pJoin_Parent_Albums print Parent_Albums(\@_)
# Images, utilisant la variable '$img'
pImage() Utiliser $img la place et :
print Get($img,'href','image');
print Get($img,'thumb') if Get($img,'thumb');
print Name($img), "</a>";
pImage_Src() print Image($img,'full')
Image_Src() Image($img,'full')
pImage_Thumb_Src() print Image($img,'thumb')
Image_Name() Name($img)
Image_Caption() Caption($img)
pImage_Caption() print Get($img,'Caption')
Image_Thumb() Get($img,'URL','thumb')
Image_Is_Pic() Get($img,'thumb')
Image_Alt() Get($img,'alt')
Image_Filesize() Get($img,'full','filesize')
Image_Path() Get($img,'full','path')
Image_Width() Get($img,'medium','x') || Get($img,'full','x')
Image_Height() Get($img,'medium','y') || Get($img,'full','y')
Image_Filename() Get($img,'full','file')
Image_Tag() Get($img,'full','tag')
Image_URL() Get($img,'URL','image')
Image_Page_URL() Get($img,'URL','image_page','image_page') || Back()
# Routines pour les albums enfant utilisant la variable '$alb'
pChild_Album($nobr) print Get($alb,'href','dir');
my $name = Name($alb);
$name =~ s/<br>//g if $nobr;
print $name,"</a>";
Child_Album_Caption() Caption($alb,'dirs')
pChild_Album_Caption() print Child_Album_Caption($alb)
Child_Album_URL() Get($alb,'URL','dir')
Child_Album_Name() Name($alb)
# Inchang
Meta() Meta()
Credit() Credit()
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
</span>
album-4.17/Docs/fr/Section_9.html 0000644 0000000 0000000 00000034667 10417666207 015315 0 ustar root root
<!DOCTYPE HTML PUBLIC '-//W3C//DTD HTML 4.01 Transitional//EN'>
<html>
<head>
<title>MarginalHacks album Documentation
1: Simple album
En supposant que vous avez d=C3=A9j=C3=A0 installer album correctement, nou=
s pouvons r=C3=A9aliser quelques manipulations basiques. Si vous rencontrez=
une erreur ou un quelconque probl=C3=A8me ici, regardez les documents d'in=
stallation.
Vous avez besoin d'un r=C3=A9pertoire accessible depuis le web o=C3=B9 mett=
re vos th=C3=A8mes et votre album photos. Nous utiliserons /home/httpd/test=
dans ce document. Ce r=C3=A9pertoire a besoin d'=C3=AAtre accessible par l=
e serveur web. Dans cet exemple, nous utiliserons l'URL suivante :
http://myserver/test
Adaptez vos commandes / URLs en fonction de vos besoins.
Premi=C3=A8rement, cr=C3=A9ez un r=C3=A9pertoire et mettez-y des images ded=
ans. Nous l'appellerons ainsi :
/home/httpd/test/Photos
Puis nous ajouterons quelques images d=C3=A9nomm=C3=A9es 'IMG_001.jpg' =C3=
=A0 'IMG_004.jpg'.
Maintenant, pour ce test basique, lan=C3=A7ons simplement album:
% album /home/httpd/test/Photos
Maintenant, vous pouvez visualiser l'album cr=C3=A9=C3=A9 via un navigateur=
=C3=A0 l'adresse :
http://myserver/test/Photos
2: Ajouter des l=C3=A9gendes
Cr=C3=A9ez un fichier /home/httpd/test/Photos/captions.txt avec le contenu =
suivants (utilisez la touche 'tab' si vous voyez " [tab] ") :
=2D- captions.txt ---------
IMG_001.jpg [tab] Nom de la première image
IMG_002.jpg [tab] Deuxième image
IMG_003.jpg [tab] Encore une image [tab] avec une légende!
IMG_004.jpg [tab] Dernière image [tab] avec une autre l&eacu=
te;gende.
=2D------------------------
Puis lancer de nouveau la commande album :
% album /home/httpd/test/Photos
Vous verrez que la l=C3=A9gende a =C3=A9t=C3=A9 modif=C3=A9e.
Maintenant, cr=C3=A9ez un fichier avec du texte dedans : /home/httpd/test/P=
hotos/header.txt
Et relancez la commande album une fois de plus. Vous verrz alors le texte d=
u fichier affich=C3=A9e au sommet de la page.
3: Masquer des photos
Il y a quelques moyens de masquer des photos / des fichiers / des r=C3=A9pe=
rtoires mais nous allons utiliser le fichier des l=C3=A9gendes. Essayez de =
placer un commentaire avec le caract=C3=A8re '#' devant le nom d'une image =
dans captions.txt:
=2D- captions.txt ---------
IMG_001.jpg [tab] Nom de la première image
#IMG_002.jpg [tab] Deuxième image
IMG_003.jpg [tab] Encore une image [tab] avec une légende!
IMG_004.jpg [tab] Dernière image [tab] avec une autre l&eacu=
te;gende.
=2D------------------------
Relancez la commande album et vous verrez que l'image IMG_002.jpg a mainten=
ant disparu.
Si vous aviez proc=C3=A9d=C3=A9 de la sorte la premi=C3=A8re fois, vous n'a=
uriez g=C3=A9n=C3=A9r=C3=A9 ni l'image de taille r=C3=A9duite ni la vignett=
e correspondante. Si vous le souhaitez, vous pouvez les supprimer en utilis=
ant l'option -clean :
% album -clean /home/httpd/test/Photos
4: Utiliser un th=C3=A8me
Si les th=C3=A8mes ont =C3=A9t=C3=A9 correctement install=C3=A9s and sont a=
ccessibles via them_path (chemin d'acc=C3=A8s aux th=C3=A8mes), alors vous =
pouvez utiliser un th=C3=A8me lors de la g=C3=A9n=C3=A9ration de votre albu=
m :
% album -theme Blue /home/httpd/test/Photos
L'album photo courant devrait =C3=AAtre maintenant bas=C3=A9 sur le th=C3=
=A8me Blue (bleu). S'il y a tout un tas de liens cass=C3=A9s ou d'images qu=
i n'apparaissent pas, il y a de forte chance pour que votre th=C3=A8me n'ai=
t pas =C3=A9t=C3=A9 install=C3=A9 dans un r=C3=A9pertoire accessible depuis=
le web ; voir les documents d'installation.
Album sauvegarde les options que vous lui indiquez. Ainsi, la prochaine foi=
s que vous lancerez la commande album :
% album /home/httpd/test/Photos
vous utiliserez toujours le th=C3=A8me Blue. Pour d=C3=A9sactiver un th=C3=
=A8me, tapez :
% album -no_theme /home/httpd/test/Photos
5: Images r=C3=A9duites
Les images de pleine taille sont en g=C3=A9n=C3=A9rale d'une taille trop im=
posante pour un album photo sur le web. C'est pourquoi nous utiliserons des=
images r=C3=A9duites sur les pages web g=C3=A9n=C3=A9r=C3=A9es :
% album -medium 33% /home/httpd/test/Photos
Cependant, vous avez toujours acc=C3=A8s aux images pleine taille en cliqua=
nt simplement sur les images r=C3=A9duites.
La commande :
% album -just_medium /home/httpd/test/Photos
emp=C3=AAchera la liaison entre les images de taille r=C3=A9duite et les im=
ages pleine taille, en pr=C3=A9sumant que nous avons lanc=C3=A9 pr=C3=A9c=
=C3=A9demment une commande avec l'option -medium.
6: Ajouter des l=C3=A9gendes EXIF
Ajoutons la valeur du diaphragme dans les l=C3=A9gendes de chaque image.
% album -exif " diaphragme=3D%Aperture%" /home/httpd/test/Photos
Cette commande ajoutera seulement la valeur du diaphragme pour les images q=
ui disposent de la balise exif (le symbole entre les caract=C3=A8res '%') '=
Aperture' signifiant diaphragme en fran=C3=A7ais ! Nous avons =C3=A9galemen=
t ajout=C3=A9 la balise qui permet d'ajouter cette information exif su=
r une nouvelle ligne.
Nous pouvons rajouter d'autres informations exif :
% album -exif " focale: %FocalLength%" /home/httpd/test/Photos
Parce que album sauvegarde vos pr=C3=A9c=C3=A9dentes options, nous disposon=
s maintenant de deux balises exif pour toutes les images sp=C3=A9cifiant =
=C3=A0 la fois le diaphragme et la focale.
Supprimons le diaphragme :
% album -no_exif " diaphragme=3D%Aperture%" /home/httpd/test/Photos
La cha=C3=AEne de caract=C3=A8res suivant l'option '-no_exif' a besoin de c=
orrespondre exactement =C3=A0 celle entr=C3=A9e pr=C3=A9c=C3=A9demment avec=
l'option '-exif' sinon elle sera ignor=C3=A9e. Vous pouvez =C3=A9galement =
=C3=A9diter le fichier de configuration qu'album a cr=C3=A9=C3=A9 ici :
/home/httpd/test/Photos/album.conf
Puis supprimez l'option en question.
7: Ajouter d'autres albums
Imaginons que vous faites un voyage en Espagne. Vous prenez des photos et l=
es mettez dans le r=C3=A9pertoire :
/home/httpd/test/Photos/Espagne/
Maintenant, ex=C3=A9cutez la commande album depuis le r=C3=A9pertoire princ=
ipal :
% album /home/httpd/test/Photos
Cette commande modifiera l'album principal Photos qui sera reli=C3=A9 =C3=
=A0 Espagne puis elle lancera =C3=A9galement la commande album sur le r=C3=
=A9pertoire Espagne avec les m=C3=AAmes caract=C3=A9ristiques / th=C3=A8me,=
etc.
Maintenant, faisons un autre voyage en Italie et cr=C3=A9ons le r=C3=A9pert=
oire :
/home/httpd/test/Photos/Italie/
=09
Nous pourrions lancer la commande depuis le r=C3=A9pertoire principal :
% album /home/httpd/test/Photos
Mais ceci rescannerait le r=C3=A9pertoire Espagne qui n'a pas chang=C3=A9. =
Album ne g=C3=A9n=C3=A9rera aucune page HTML ni vignette =C3=A0 moins qu'il=
ait le besoin de la faire. Cependant, il peut perdre du temps, plus partic=
uli=C3=A8rement si vos albums photos deviennent de plus en plus volumineux.=
Aussi, vous pouvez juste demander d'ajouter le nouveau r=C3=A9pertoire :
% album -add /home/httpd/test/Photos/Italie
Cette commande modifiera l'index de la premi=C3=A8re page (dans Photos) et =
g=C3=A9n=C3=A9rera l'album correspond au r=C3=A9pertorie Italie.
--Boundary-00=_RABPE4wDiedqZVJ--
album-4.17/Docs/fr/txt_2 0000644 0000000 0000000 00000015337 12236405003 013531 0 ustar root root MINI HOW-TO
ITEM: Simple album
En supposant que vous avez déjà installé album correctement, nous pouvons
réaliser quelques manipulations basiques. Si vous rencontrez une erreur ou
un quelconque problème ici, regardez les documents d'installation.
Vous avez besoin d'un répertoire accessible depuis le web où mettre vos
thèmes et votre album photos. Nous utiliserons /home/httpd/test dans ce
document. Ce répertoire a besoin d'être accessible par le serveur web. Dans
cet exemple, nous utiliserons l'URL suivante :
http://myserver/test
Adaptez vos commandes / URLs en fonction de vos besoins.
Premièrement, créez un répertoire et mettez-y des images dedans. Nous
l'appellerons ainsi :
/home/httpd/test/Photos
Puis nous ajouterons quelques images dénommées 'IMG_001.jpg' à 'IMG_004.jpg'.
Maintenant, pour ce test basique, lançons simplement album:
% album /home/httpd/test/Photos
Maintenant, vous pouvez visualiser l'album créé via un navigateur à l'adresse :
http://myserver/test/Photos
ITEM: Ajouter des légendes
Créez un fichier /home/httpd/test/Photos/captions.txt avec le contenu
suivants (utilisez la touche 'tab' si vous voyez " [tab] ") :
-- captions.txt ---------
IMG_001.jpg [tab] Nom de la première image
IMG_002.jpg [tab] Deuxième image
IMG_003.jpg [tab] Encore une image [tab] avec une légende!
IMG_004.jpg [tab] Dernière image [tab] avec une autre légende.
-------------------------
Puis lancer de nouveau la commande album :
% album /home/httpd/test/Photos
Vous verrez que la légende a été modifée.
Maintenant, créez un fichier avec du texte dedans :
/home/httpd/test/Photos/header.txt
Et relancez la commande album une fois de plus. Vous verrez alors le texte
du fichier affichée au sommet de la page.
ITEM: Masquer des photos
Il y a quelques moyens de masquer des photos / des fichiers / des répertoires
mais nous allons utiliser le fichier des légendes. Essayez de placer un
commentaire avec le caractère '#' devant le nom d'une image dans captions.txt:
-- captions.txt ---------
IMG_001.jpg [tab] Nom de la première image
#IMG_002.jpg [tab] Deuxième image
IMG_003.jpg [tab] Encore une image [tab] avec une légende!
IMG_004.jpg [tab] Dernière image [tab] avec une autre légende.
-------------------------
Relancez la commande album et vous verrez que l'image IMG_002.jpg a maintenant
disparu.
Si vous aviez procédé de la sorte la première fois, vous n'auriez généré ni
l'image de taille réduite ni la vignette correspondante. Si vous le souhaitez,
vous pouvez les supprimer en utilisant l'option -clean :
% album -clean /home/httpd/test/Photos
ITEM: Utiliser un thème
Si les thèmes ont été correctement installés and sont accessibles via
them_path (chemin d'accès aux thèmes), alors vous pouvez utiliser un thème
lors de la génération de votre album :
% album -theme Blue /home/httpd/test/Photos
L'album photo courant devrait être maintenant basé sur le thème Blue (bleu).
S'il y a tout un tas de liens cassés ou d'images qui n'apparaissent pas, il
y a de forte chance pour que votre thème n'ait pas été installé dans un
répertoire accessible depuis le web ; voir les documents d'installation.
Album sauvegarde les options que vous lui indiquez. Ainsi, la prochaine fois
que vous lancerez la commande album :
% album /home/httpd/test/Photos
vous utiliserez toujours le thème Blue. Pour désactiver un thème, tapez :
% album -no_theme /home/httpd/test/Photos
ITEM: Images réduites
Les images de pleine taille sont en générale d'une taille trop imposante pour
un album photo sur le web. C'est pourquoi nous utiliserons des images réduites
sur les pages web générées :
% album -medium 33% /home/httpd/test/Photos
Cependant, vous avez toujours accès aux images pleine taille en cliquant
simplement sur les images réduites.
La commande :
% album -just_medium /home/httpd/test/Photos
empêchera la liaison entre les images de taille réduite et les images pleine
taille, en présumant que nous avons lancé précédemment une commande avec
l'option -medium.
ITEM: Ajouter des légendes EXIF
Ajoutons la valeur du diaphragme dans les légendes de chaque image.
% album -exif "<br>diaphragme=%Aperture%" /home/httpd/test/Photos
Cette commande ajoutera seulement la valeur du diaphragme pour les images qui
disposent de la balise exif (le symbole entre les caractères '%') 'Aperture'
signifiant diaphragme en français ! Nous avons également ajouté la balise
<br> qui permet d'ajouter cette information exif sur une nouvelle ligne.
Nous pouvons rajouter d'autres informations exif :
% album -exif "<br>focale: %FocalLength%" /home/httpd/test/Photos
Parce que album sauvegarde vos précédentes options, nous disposons maintenant
de deux balises exif pour toutes les images spécifiant à la fois le diaphragme
et la focale.
Supprimons le diaphragme :
% album -no_exif "<br>diaphragme=%Aperture%" /home/httpd/test/Photos
La chaîne de caractères suivant l'option '-no_exif' a besoin de correspondre
exactement à celle entrée précédemment avec l'option '-exif' sinon elle sera
ignorée. Vous pouvez également éditer le fichier de configuration qu'album a
créé ici :
/home/httpd/test/Photos/album.conf
Puis supprimez l'option en question.
ITEM: Ajouter d'autres albums
Imaginons que vous faites un voyage en Espagne. Vous prenez des photos et les
mettez dans le répertoire :
/home/httpd/test/Photos/Espagne/
Maintenant, exécutez la commande album depuis le répertoire principal :
% album /home/httpd/test/Photos
Cette commande modifiera l'album principal Photos qui sera relié à Espagne
puis elle lancera également la commande album sur le répertoire Espagne avec
les mêmes caractéristiques / thème, etc.
Maintenant, faisons un autre voyage en Italie et créons le répertoire :
/home/httpd/test/Photos/Italie/
Nous pourrions lancer la commande depuis le répertoire principal :
% album /home/httpd/test/Photos
Mais ceci rescannerait le répertoire Espagne qui n'a pas changé. Album ne
générera aucune page HTML ni vignette à moins qu'il ait le besoin de la
faire. Cependant, il peut perdre du temps, plus particulièrement si vos
albums photos deviennent de plus en plus volumineux. Aussi, vous pouvez
juste demander d'ajouter le nouveau répertoire :
% album -add /home/httpd/test/Photos/Italie
Cette commande modifiera l'index de la première page (dans Photos) et
générera l'album correspond au répertorie Italie.
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/old.txt_1 0000644 0000000 0000000 00000014447 10671126741 014320 0 ustar root root Installation
ITEM: Configuration minimale
1) Le script Perl album
2) Les outils ImageMagick (et
plus particulièrement 'convert')
Mettez le script 'album' et les outils ImageMagick dans un répertoire
accessible via votre variable d'environnement PATH ou appelez 'album' avec son
chemin d'accès complet (en spécifiant également le chemin d'accès complet à
'convert' soit dans le script 'album' soit dans les fichiers de configuration
du script).
ITEM: Configuration initiale
La première fois que vous lancerez 'album', celui-ci vous posera quelques
questions pour initialiser votre configuration.
Si votre machine tourne sous Unix / OSX, alors passez en mode administrateur
('root') et vous pourrez ainsi initialiser la configuration globale et les
thèmes pour l'ensemble des utilisateurs et pas seulement l'utilisateur
courant.
ITEM: Installation optionnelle
1) Themes
2) ffmpeg (pour les
vignettes de films)
3) jhead (pour
lire les informations EXIF)
4) des plugins
5) de nombreux outils disponible sur
MarginalHacks.com
ITEM: Unix
La plupart des distributions Unix sont fournies avec ImageMagick et
perl. Ainsi vous n'avez qu'à charger le script 'album' et les thèmes (voir les
points #1 et #3 ci-dessus) et c'est tout.
Pour tester votre installation, lancez le script dans un répertoire contenant
des images :
% album /path/to/my/photos/
ITEM: Debian Unix
Le script 'album' fait partie de la branche stable de la distribution Debian,
même si en ce moment...
Je recommande de télécharger la dernière version sur MarginalHacks. Sauvez le
paquetage .deb et, en mode administrateur (root), tapez :
% dpkg -i album.deb
ITEM: Macintosh OSX
Ceci marche bien également sur OSX mais vous devez utiliser une fenêtre de
programmation (console). Installez seulement le script 'album' et les outils
ImageMagick puis tapez, depuis l'endroit où se trouve le script, le nom du
script suivi des
options du script que vous souhaitez et enfin le chemin d'accès au répertoire
où sont vos photos (le tout séparé par des espaces) comme par exemple :
% album -theme Blue /path/to/my/photos/
ITEM: Win95, Win98, Win2000/Win2k, WinNT, WinXP
(Windows 95, Windows 98, Windows 2000, Windows NT, Windows XP)
Il y a deux façons pour exécuter un script perl depuis Windows : soit en
utilisant ActivePerl ou Cygwin.
ActivePerl est plus simple et vous permet de lancer 'album' depuis le prompt
du DOS. Cygwin est un paquetage plus hermétique pour le profane mais plus
robuste qui vous donne accès à tout un tas d'utilitaires "à la sauce Unix" :
le script 'album' est lancé depuis un prompt bash (environnement Unix).
Méthode via Cygwin
------------------
1) Installer Cygwin
Choisir les paquetages : perl, ImageMagick, bash
Ne pas utiliser directement l'installation normale d'ImageMagick !!! Vous devez
absolument utiliser les paquetages d'ImageMagick pour Cygwin !
2) Installer 'album' dans le répertoire du bask ou l'appeler en utilisant un
chemin d'accès complet :
bash% album /some/path/to/photos
3) Si vous voulez afficher les informations exif dans vos légendes, vous avez
besoin de la version Cygwin de jhead.
Méthode via ActivePerl
----------------------
1) Installer ImageMagick pour Windows
2) Installer ActivePerl, installation complète ou Full install (pas besoin
d'un profil PPM)
Choisir : "Ajouter perl à PATH" ("Add perl to PATH") et "Créer une
association avec les fichiers d'extension perl" ("Create Perl file extension association")
3) Pour Win98 : installer tcap dans le chemin d'accès général
4) Sauvegarder le script 'album' sous le nom 'album.pl' dans le chemin d'accès
général de Windows
5) Utiliser une commande DOS pour taper :
C:> album.pl C:\some\path\to\photosNote : certains versions de Windows (2000/NT au-moins) disposent de leur
propre programme "convert.exe" localisé dans le répertoire c:\windows\system32
directory (un utilitaire NTFS ?).
Si vous avez un tel programme, alors vous avez besoin d'éditer votre variable
d'environnement PATH ou de spécifier complètement le chemin d'accès à
'convert' (celui d'ImageMagick) dans le script 'album'.
ITEM: Comment puis-je éditer la variable d'environnement PATH sous Windows ?
Utilisateurs de Windows NT4
Cliquer avec le bouton droit de la souris sur "Mon ordinateur" et
sélectionner Propriétés.
Sélectionner l'onglet "Environnement".
Dans la fenêtre "Variables du système", sélectionner la variable "Path".
Dans la fenêtre d'édition de la valeur de cette variable, ajouter les
nouveaux chemins d'accès séparés par des points virgules.
Presser le bouton "Ok / Mettre à jour" puis presser de nouveau "Ok"
Utilisateurs de Windows 2000
Cliquer avec le bouton droit de la souris sur "Mon ordinateur" et
sélectionner "Propriétés".
Sélectionner l'onglet "Réglages avancés".
Cliquer sur les "variables d'environnement".
Dans la fenêtre de sélection des variables d'environnement, double-cliquer
sur la variable "Path".
Dans la fenêtre d'édition de la valeur de cette variable, ajouter les
nouveaux chemins d'accès séparés par des points virgules.
Presser le bouton "Ok / Mettre à jour" puis presser de nouveau "Ok"
Utilisateurs Windows XP
Cliquer sur "Mon ordinateur" et sélectionner "Changer les propriétés".
Double-cliquer sur "Système".
Sélectionner l'onglet "Réglages avancés".
Cliquer sur les "variables d'environnement".
Dans la fenêtre de sélection des variables d'environnement, double-cliquer
sur la variable "Path".
Dans la fenêtre d'édition de la valeur de cette variable, ajouter les
nouveaux chemins d'accès séparés par des points virgules.
Presser le bouton "Ok"
ITEM: Macintosh OS9
Je n'ai pas de plans pour réaliser un portage sur OS9 (je ne connais pas quels
sont les états des shells ni de perl pour les versions antérieures à OSX). If
vous avez réussi à faire tourner 'album' sur OS9, faites-le moi savoir.
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/Section_5.html 0000644 0000000 0000000 00000053643 12661460265 015303 0 ustar root root
MarginalHacks album - Demande d'ajout de fonctionnalités, bogues, correctifs et dépannage
- Documentation
A l b u m
F i v e - - D e m a n d e d ' a j o u t d e f o n c t i o n n a l i t s , b o g u e s , c o r r e c t i f s e t d p a n n a g e
1: Demande d'ajout de fonctionnalités
S'il y a quelque chose que vous souhaitez voir ajouter à album, vérifiez tout
d'abord que cette fonctionnalité n'existe pas déjà. Consultez la page d'aide ou
l'aide en ligne :
% man album% album -h
Regardez aussi les options -more et -usage.
Si vous ne voyez rien ici, vous pouvez vous lancer dans l'écriture d'un
correctif ou d'un module plug-in.
2: Rapports de bogues
Avant de soumettre un bogue, vérifiez que vous disposez de la dernière version
d'album s'il vous plaît !
Quand vous soumettez un bogue, j'ai besoin de savoir au-moins :
1) Votre système d'exploitation
2) La description fidèle de votre problème et les messages d'erreur affichés
J'aimerais également savoir, si c'est possible :
1) La commande exacte que vous avez lancée avec album
2) La sortie affichée à l'écran par cette commande
Et en général j'ai aussi besoin de la sortie affichée par album en mode
déboguage :
% album -d
Enfin, soyez sûr d'avoir la dernière version d'album ainsi que pour les thèmes.
3: Ecrire des correctifs, modifier album
Si vous voulez modifier le script album, vous devriez d'abord me contacter
afin de voir si cela ne fait pas partie de mon plan de développement.
Si non, alors vous devriez considérer la rédaction d'un module plug-in plutôt
que de modifier le code source d'album. Ceci évite de rajouter de la
complexité à album pour des fonctionnalités qui pourraient avoir une
utilisation limitée.
Si ces modifications concernent le script album (par exemple s'il s'agit d'un
bogue), alors téléchargez d'abord
la dernière version d'album, puis corrigez-la et envoyez-moi soit la
différence entre la version originale et votre version corrigée, soit un
correctif ou encore le script album complet. Si vous mettez des commentaires à
propos des changements que vous apportez, cela serait vachement bien aussi.
4: Bogues connus
v3.11: -clear_* et -no_* n'effacent pas les options du répertoire parent.
v3.10: Graver un CD ne fonctionne pas tout à fait avec des chemins d'accès
absolus pour les répertoires abritant les thèmes.
v3.00: Les options à plusieurs arguments ou de code sont sauvegardées à
rebours. Par exemple :
"album -lang aa .. ; album -lang bb .." utilisera encore la langue 'aa'.
Aussi, dans certains cas, les options à plusieurs arguments ou de code
présentes dans des sous-albums ne seront pas ordonnées dans le bon
ordre lors du premier appel à album et vous aurez besoin de relancer
album. Par exemple :
"album -exif A photos/ ; album -exif B photos/sub"
donnera "B A" pour l'album photo sub puis "A B" après l'appel à "album
photos/sub"
5: PROBLEME : Mes pages d'index sont trop grandes !
Je reçois beaucoup de requêtes me demandant de couper les pages d'index dès
qu'on dépasse un certain nombre d'images.
Le problème est que c'est difficile à gérer à moins que les pages d'index soient
vues commes des sous-albums. Et dans ce cas, vous auriez alors sur une même
page trois composantes majeures, plus des indexes, des albums et des
vignettes. Et non seulement ceci est encombrant mais cela nécessiterait aussi de
mettre à jour l'ensemble des thèmes.
J'espère que la prochaine version majeure d'album pourra faire cela mais, en
attendant, la solution la plus facile à mettre en oeuvre est de séparer les
images à l'intérieur de sous-répertoires avant de lancer album.
J'ai un outil qui transférera les nouvelles images dans des sous-répertoires
puis lancera album :
in_album6:ERREUR : no delegate for this image format (./album)
[NdT : le message signifie : aucun outil pour traiter ce format d'image (./album)]
Le script album se trouve dans votre répertoire de photos et il ne peut pas
créer une vignette de lui-même ! Au choix :
1) Déplacer le script album en dehors de votre répertoire de photos
(recommandé)
2) Lancer album avec l'option -known_images
7:ERREUR : no delegate for this image format (some_non_image_file)
[NdT : le message signifie : aucun outil pour ce format d'image
(fichier_qui_n_est_pas_une_image)]
Ne mettez pas des fichiers qui ne soient pas des images dans votre répertoire
de photos ou alors lancez album avec l'option -known_images
8:ERREUR : no delegate for this image format (some.jpg)9:ERREUR : identify: JPEG library is not available (some.jpg)
[NdT : les deux messages signifient :
- aucun outil pour ce format d'image (fichier.jpg)
- identify (nom d'un utilitaire) : la librairie JPEG n'est pas disponible (fichier.jpg)]
Votre installation de la suite ImageMagick n'est pas complète et ne sait pas
comment gérer le format de l'image donnée.
10:ERREUR : Can't get [some_image] size from -verbose output.
[NdT : le message signigie : impossible d'obtenir la taille de [une_image] à partir
de la sortie affichée via l'option -verbose]
ImageMagick ne connaît pas la taille de l'image spécifiée.
1) Soit votre installation d'ImageMagick est incomplète et le type de l'image
ne peut pas être géré
2) Soit vous exécutez album sans l'option -known_images sur un répertoire qui
contient des fichiers qui ne sont pas des images
Si vous êtes un utilisateur de gentoo linux et que
vous voyez cette erreur, alors lancez cette commande depuis le compte
administrateur ou "root" (merci à Alex Pientka) :
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
11: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/txt_1 0000644 0000000 0000000 00000015327 12236405003 013527 0 ustar root root Installation
ITEM: Configuration minimale
1) Le script Perl album
2) Les outils ImageMagick (et
plus particulièrement 'convert')
Mettez le script 'album' et les outils ImageMagick dans un répertoire
accessible via votre variable d'environnement PATH ou appelez 'album' avec son
chemin d'accès complet (en spécifiant également le chemin d'accès complet à
'convert' soit dans le script 'album' soit dans les fichiers de configuration
du script).
ITEM: Configuration initiale
La première fois que vous lancerez 'album', celui-ci vous posera quelques
questions pour initialiser votre configuration.
Si votre machine tourne sous Unix / OSX, alors passez en mode administrateur
('root') et vous pourrez ainsi initialiser la configuration globale et les
thèmes pour l'ensemble des utilisateurs et pas seulement l'utilisateur
courant.
ITEM: Installation optionnelle
3) Themes
4) ffmpeg (pour les
vignettes de films)
5) jhead (pour
lire les informations EXIF)
6) des plugins
7) de nombreux outils disponible sur
MarginalHacks.com
ITEM: Unix
La plupart des distributions Unix sont fournies avec ImageMagick et
perl. Ainsi vous n'avez qu'à charger le script 'album' et les thèmes (voir les
points #1 et #3 ci-dessus) et c'est tout.
Pour tester votre installation, lancez le script dans un répertoire contenant
des images :
% album /path/to/my/photos/
ITEM: Debian Unix
Le script 'album' fait partie de la branche stable de la distribution Debian,
même si en ce moment...
Je recommande de télécharger la dernière version sur MarginalHacks. Sauvez le
paquetage .deb et, en mode administrateur (root), tapez :
% dpkg -i album.deb
ITEM: Macintosh OSX
Ceci marche bien également sur OSX mais vous devez utiliser une fenêtre de
programmation (console). Installez seulement le script 'album' et les outils
ImageMagick puis tapez, depuis l'endroit où se trouve le script, le nom du
script suivi des options du script que vous souhaitez et enfin le chemin d'accès
au répertoire où sont vos photos (le tout séparé par des espaces) comme par
exemple :
% album -theme Blue /path/to/my/photos/
ITEM: Win95, Win98, Win2000/Win2k, WinNT, WinXP
(Windows 95, Windows 98, Windows 2000, Windows NT, Windows XP)
Il y a deux façons pour exécuter un script perl depuis Windows : soit en
utilisant ActivePerl ou Cygwin.
ActivePerl est plus simple et vous permet de lancer 'album' depuis le prompt
du DOS. Cygwin est un paquetage plus hermétique pour le profane mais plus
robuste qui vous donne accès à tout un tas d'utilitaires "à la sauce Unix" :
le script 'album' est lancé depuis un prompt bash (environnement Unix).
Méthode via Cygwin
------------------
1) Installer Cygwin
Choisir les paquetages : perl, ImageMagick, bash
Ne pas utiliser directement l'installation normale d'ImageMagick !!! Vous devez
absolument utiliser les paquetages d'ImageMagick pour Cygwin !
2) Installer album dans le
répertoire du bash ou l'appeler en utilisant un chemin d'accès complet :
bash% album /some/path/to/photos
3) Si vous voulez afficher les informations exif dans vos légendes, vous avez
besoin de la version Cygwin de jhead.
Méthode via ActivePerl
----------------------
1) Installer ImageMagick pour
Windows
2) Installer ActivePerl,
installation complète ou Full install (pas besoin d'un profil PPM)
Choisir : "Ajouter perl à PATH" ("Add perl to PATH") et "Créer une
association avec les fichiers d'extension perl" ("Create Perl file extension association")
3) Pour Win98 : installer tcap
dans le chemin d'accès général
4) Sauvegarder le script 'album' sous le nom 'album.pl' dans le chemin d'accès
général de Windows
5) Utiliser une commande DOS pour taper :
C:> album.pl C:\some\path\to\photosNote : certains versions de Windows (2000/NT au-moins) disposent de leur
propre programme "convert.exe" localisé dans le répertoire c:\windows\system32
directory (un utilitaire NTFS ?).
Si vous avez un tel programme, alors vous avez besoin d'éditer votre variable
d'environnement PATH ou de spécifier complètement le chemin d'accès à
'convert' (celui d'ImageMagick) dans le script 'album'.
ITEM: Comment puis-je éditer la variable d'environnement PATH sous Windows ?
Utilisateurs de Windows NT4
Cliquer avec le bouton droit de la souris sur "Mon ordinateur" et
sélectionner Propriétés.
Sélectionner l'onglet "Environnement".
Dans la fenêtre "Variables du système", sélectionner la variable "Path".
Dans la fenêtre d'édition de la valeur de cette variable, ajouter les
nouveaux chemins d'accès séparés par des points virgules.
Presser le bouton "Ok / Mettre à jour" puis presser de nouveau "Ok"
Utilisateurs de Windows 2000
Cliquer avec le bouton droit de la souris sur "Mon ordinateur" et
sélectionner "Propriétés".
Sélectionner l'onglet "Réglages avancés".
Cliquer sur les "variables d'environnement".
Dans la fenêtre de sélection des variables d'environnement, double-cliquer
sur la variable "Path".
Dans la fenêtre d'édition de la valeur de cette variable, ajouter les
nouveaux chemins d'accès séparés par des points virgules.
Presser le bouton "Ok / Mettre à jour" puis presser de nouveau "Ok"
Utilisateurs Windows XP
Cliquer sur "Mon ordinateur" et sélectionner "Changer les propriétés".
Double-cliquer sur "Système".
Sélectionner l'onglet "Réglages avancés".
Cliquer sur les "variables d'environnement".
Dans la fenêtre de sélection des variables d'environnement, double-cliquer
sur la variable "Path".
Dans la fenêtre d'édition de la valeur de cette variable, ajouter les
nouveaux chemins d'accès séparés par des points virgules.
Presser le bouton "Ok"
ITEM: Macintosh OS9
Je n'ai pas de plans pour réaliser un portage sur OS9 (je ne connais pas quels
sont les états des shells ni de perl pour les versions antérieures à OSX). If
vous avez réussi à faire tourner 'album' sur OS9, faites-le moi savoir.
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/flag.png 0000644 0000000 0000000 00000000227 10417117563 014167 0 ustar root root PNG
IHDR m?h bKGD tIME
#ywL 9IDAT8cdP π\6ᘦ6W {ZߍU `QG
5x@
"b/ IENDB` album-4.17/Docs/fr/new_txt_5 0000644 0000000 0000000 00000013222 12236174743 014412 0 ustar root root Demande d'ajout de fonctionnalits, bogues, correctifs et dpannage
ITEM: Demande d'ajout de fonctionnalits
S'il y a quelque chose que vous souhaitez voir ajouter album, vrifiez tout
d'abord que cette fonctionnalit n'existe pas dj. Consultez la page d'aide ou
l'aide en ligne :
% man album% album -h
Regardez aussi les options -more et -usage.
Si vous ne voyez rien ici, vous pouvez vous lancer dans l'criture d'un
correctif ou d'un module plug-in.
ITEM: Rapports de bogues
Avant de soumettre un bogue, vrifiez que vous disposez de la dernire version
d'album s'il vous plat !
Quand vous soumettez un bogue, j'ai besoin de savoir au-moins :
1) Votre systme d'exploitation
2) La description fidle de votre problme et les messages d'erreur affichs
J'aimerais galement savoir, si c'est possible :
1) La commande exacte que vous avez lance avec album
2) La sortie affiche l'cran par cette commande
Et en gnral j'ai aussi besoin de la sortie affiche par album en mode
dboguage :
% album -d
Enfin, soyez sr d'avoir la dernire version d'album ainsi que pour les thmes.
ITEM: Ecrire des correctifs, modifier album
Si vous voulez modifier le script album, vous devriez d'abord me contacter
afin de voir si cela ne fait pas partie de mon plan de dveloppement.
Si non, alors vous devriez considrer la rdaction d'un module plug-in plutt
que de modifier le code source d'album. Ceci vite de rajouter de la
complexit album pour des fonctionnalits qui pourraient avoir une
utilisation limite.
Si ces modifications concernent le script album (par exemple s'il s'agit d'un
bogue), alors tlchargez d'abord
la dernire version d'album, puis corrigez-la et envoyez-moi soit la
diffrence entre la version originale et votre version corrige, soit un
correctif ou encore le script album complet. Si vous mettez des commentaires
propos des changements que vous apportez, cela serait vachement bien aussi.
ITEM: Bogues connus
v3.11: -clear_* et -no_* n'effacent pas les options du rpertoire parent.
v3.10: Graver un CD ne fonctionne pas tout fait avec des chemins d'accs
absolus pour les rpertoires abritant les thmes.
v3.00: Les options plusieurs arguments ou de code sont sauvegardes
rebours. Par exemple :
"album -lang aa .. ; album -lang bb .." utilisera encore la langue 'aa'.
Aussi, dans certains cas, les options plusieurs arguments ou de code
prsentes dans des sous-albums ne seront pas ordonnes dans le bon
ordre lors du premier appel album et vous aurez besoin de relancer
album. Par exemple :
"album -exif A photos/ ; album -exif B photos/sub"
donnera "B A" pour l'album photo sub puis "A B" aprs l'appel "album
photos/sub"
ITEM: PROBLEME : Mes pages d'index sont trop grandes !
Je reois beaucoup de requtes me demandant de couper les pages d'index ds
qu'on dpasse un certain nombre d'images.
Le problme est que c'est difficile grer moins que les pages d'index soient
vues commes des sous-albums. Et dans ce cas, vous auriez alors sur une mme
page trois composantes majeures, plus des indexes, des albums et des
vignettes. Et non seulement ceci est encombrant mais cela ncessiterait aussi de
mettre jour l'ensemble des thmes.
J'espre que la prochaine version majeure d'album pourra faire cela mais, en
attendant, la solution la plus facile mettre en oeuvre est de sparer les
images l'intrieur de sous-rpertoires avant de lancer album.
J'ai un outil qui transfrera les nouvelles images dans des sous-rpertoires
puis lancera album :
in_album
ITEM: ERREUR : no delegate for this image format (./album)
[NdT : le message signifie : aucun outil pour traiter ce format d'image (./album)]
Le script album se trouve dans votre rpertoire de photos et il ne peut pas
crer une vignette de lui-mme ! Au choix :
1) Dplacer le script album en dehors de votre rpertoire de photos
(recommand)
2) Lancer album avec l'option -known_images
ITEM: ERREUR : no delegate for this image format (some_non_image_file)
[NdT : le message signifie : aucun outil pour ce format d'image
(fichier_qui_n_est_pas_une_image)]
Ne mettez pas des fichiers qui ne soient pas des images dans votre rpertoire
de photos ou alors lancez album avec l'option -known_images
ITEM: ERREUR : no delegate for this image format (some.jpg)
ITEM: ERREUR : identify: JPEG library is not available (some.jpg)
[NdT : les deux messages signifient :
- aucun outil pour ce format d'image (fichier.jpg)
- identify (nom d'un utilitaire) : la librairie JPEG n'est pas disponible (fichier.jpg)]
Votre installation de la suite ImageMagick n'est pas complte et ne sait pas
comment grer le format de l'image donne.
ITEM: ERREUR : Can't get [some_image] size from -verbose output.
[NdT : le message signigie : impossible d'obtenir la taille de [une_image] partir
de la sortie affiche via l'option -verbose]
ImageMagick ne connat pas la taille de l'image spcifie.
1) Soit votre installation d'ImageMagick est incomplte et le type de l'image
ne peut pas tre gr
2) Soit vous excutez album sans l'option -known_images sur un rpertoire qui
contient des fichiers qui ne sont pas des images
Si vous tes un utilisateur de gentoo linux et que
vous voyez cette erreur, alors lancez cette commande depuis le compte
administrateur ou "root" (merci Alex Pientka) :
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/old.txt_5 0000644 0000000 0000000 00000013371 11076703662 014322 0 ustar root root Demande d'ajout de fonctionnalités, bogues, correctifs et dépannage
ITEM: Demande d'ajout de fonctionnalités
S'il y a quelque chose que vous souhaitez voir ajouter à album, vérifiez tout
d'abord que cette fonctionnalité n'existe pas déjà. Consultez la page d'aide ou
l'aide en ligne :
% man album% album -h
Regardez aussi les options -more et -usage.
Si vous ne voyez rien ici, vous pouvez vous lancer dans l'écriture d'un
correctif ou d'un module plug-in.
ITEM: Rapports de bogues
Avant de soumettre un bogue, vérifiez que vous disposez de la dernière version
d'album s'il vous plaît !
Quand vous soumettez un bogue, j'ai besoin de savoir au-moins :
1) Votre système d'exploitation
2) La description fidèle de votre problème et les messages d'erreur affichés
J'aimerais également savoir, si c'est possible :
1) La commande exacte que vous avez lancée avec album
2) La sortie affichée à l'écran par cette commande
Et en général j'ai aussi besoin de la sortie affichée par album en mode
déboguage :
% album -d
Enfin, soyez sûr d'avoir la dernière version d'album ainsi que pour les thèmes.
ITEM: Ecrire des correctifs, modifier album
Si vous voulez modifier le script album, vous devriez d'abord me contacter
afin de voir si cela ne fait pas partie de mon plan de développement.
Si non, alors vous devriez considérer la rédaction d'un module plug-in plutôt
que de modifier le code source d'album. Ceci évite de rajouter de la
complexité à album pour des fonctionnalités qui pourraient avoir une
utilisation limitée.
Si ces modifications concernent le script album (par exemple s'il s'agit d'un
bogue), alors téléchargez d'abord
la dernière version d'album, puis corrigez la et envoyez-moi soit la
différence entre la version originale et votre version corrigée, soit un
correctif ou encore le script album complet. Si vous mettez des commentaires à
propos des changements que vous apportez, cela serait vachement bien aussi.
ITEM: Bogues connus
v3.11: -clear_* et -no_* n'effacent pas les options du répertoire parent.
v3.10: Graver un CD ne fonctionne pas tout à fait avec des chemins d'accès
absolus pour les répertoires abritant les thèmes.
v3.00: Les options à plusieurs arguments ou de code sont sauvegardées à
rebours. Par exemple :
"album -lang aa .. ; album -lang bb .." utilisera encore la langue 'aa'.
Aussi, dans certains cas, les options à plusieurs arguments ou de code
présentes dans des sous-albums ne seront pas ordonnées dans le bon
ordre lors du premier appel à album et vous aurez besoin de relancer
album. Par exemple :
"album -exif A photos/ ; album -exif B photos/sub"
donnera "B A" pour l'album photo sub puis "A B" après l'appel à "album
photos/sub"
ITEM: PROBLEME : Mes pages d'index sont trop grandes !
Je reçois beaucoup de requêtes me demandant de couper les pages d'index dès
qu'on dépasse un certain nombre d'images.
Le problème est que c'est difficile à gérer à moins que les pages d'index soient
vues commes des sous-albums. Et dans ce cas, vous auriez alors sur une même
page trois composantes majeures, plus d'index, plus d'albums et plus de
vignettes. Et non seulement ceci est encombrant mais cela nécessiterait aussi
de mettre à jour l'ensemble des thèmes.
J'espère que la prochaine version majeure d'album pourra faire cela mais, en
attendant, la solution la plus facile à mettre en oeuvre est de séparer les
images à l'intérieur de sous-répertoires avant de lancer album.
J'ai un outil qui transférera les nouvelles images dans des sous-répertoires
puis lancera album :
in_album
ITEM: ERREUR : no delegate for this image format (./album)
[NdT : le message signifie : aucun outil pour traiter ce format d'image (./album)]
Le script album se trouve dans votre répertoire de photos et il ne peut pas
créer une vignette de lui-même ! Au choix :
1) Déplacer le script album en dehors de votre répertoire de photos
(recommandé)
2) Lancer album avec l'option -known_images
ITEM: ERREUR : no delegate for this image format (some_non_image_file)
[NdT : le message signifie : aucun outil pour ce format d'image
(fichier_qui_n_est_pas_une_image)]
Ne mettez pas des fichiers qui ne soient pas des images dans votre répertoire
de photos ou alors lancez album avec l'option -known_images
ITEM: ERREUR : no delegate for this image format (some.jpg)
ITEM: ERREUR : identify: JPEG library is not available (some.jpg)
[NdT : les deux messages signifient :
- aucun outil pour ce format d'image (fichier.jpg)
- identify (nom d'un utilitaire) : la librairie JPEG n'est pas disponible (fichier.jpg)]
Votre installation de la suite ImageMagick n'est pas complète et ne sait pas
comment gérer le format de l'image donnée.
ITEM: ERREUR : Can't get [some_image] size from -verbose output.
[NdT : le message signigie : impossible d'obtenir la taille de [une_image] à partir
de la sortie affichée via l'option -verbose]
ImageMagick ne connaît pas la taille de l'image spécifiée.
1) Soit votre installation d'ImageMagick est incomplète et le type de l'image
ne peut pas être géré
2) Soit vous exécutez album sans l'option -known_images sur un répertoire qui
contient des fichiers qui ne sont pas des images
Si vous êtes un utilisateur de gentoo linux et que
vous voyez cette erreur, alors lancez cette commande depuis le compte
administrateur ou "root" (merci à Alex Pientka) :
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/Section_4.html 0000644 0000000 0000000 00000053571 12661460265 015302 0 ustar root root
MarginalHacks album - Fichiers de configuration
- Documentation
A l b u m
F o u r - - F i c h i e r s d e c o n f i g u r a t i o n
1: Fichiers de configuration
Le comportement du script album peut être controlé via des options en ligne
de commande comme :
% album -no_known_images% album -geometry 133x100% album -exif "Fichier : %File name% " -exif "pris avec %Camera make%"
Mais ces options peuvent aussi être définies dans un fichier de configuration :
# Exemple de fichier de configuration # les commentaires sont ignorés
known_images 0 # known_images=0 est la même chose que no_known_images
geometry 133x100
exif "Fichier : %File name% "
exif "pris avec %Camera make%"
Le format du fichier de configuration est d'une option par ligne
éventuellement suivie par des espaces et la valeur de l'option. Les options
booléennes peuvent être initialisées sans valeur ou bien être positionnées
avec 0 et 1.
2: Localisation des fichiers de configuration
album recherche les fichiers de configuration dans quelques endroits ; dans
l'ordre :
/etc/album/conf Configuration valable pour l'ensemble du système
/etc/album.conf Configuration valable pour l'ensemble du système
$BASENAME/album.conf Dans le répertoire d'installation d'album
$HOME/.albumrc Configuration dépendante de l'utilisateur
$HOME/.album.conf Configuration dépendante de l'utilisateur
$DOT/album.conf Configuration dépendante de l'utilisateur (je conserver mes fichiers "point" alleurs)
$USERPROFILE/album.conf Pour Windows (C:\Documents et Settings\Utilisateur)
album regarde également des fichiers album.conf à l'intérieur même des
répertoires de l'album photo courant.
Les sous-albums photos peuvent aussi disposer d'un fichier album.conf qui
modifiera la configuration de base des répertoires parent (ceci vous permet,
par exemple, d'avoir plusieurs thèmes pour des parties différentes de votre
album photo).
N'importe quel fichier album.conf dans le répertoire de votre album photo
configurera l'album et tous les sous-albums à moins qu'un autre fichier de
configuration album.conf ne soit trouvé dans un sous-album.
Par exemple, considérons la configuration pour un album photo situé dans le
répertoire 'images/album.conf' :
theme Dominatrix6
columns 3
Une autre configuration est trouvée dans le répertoire
'images/europe/album.conf' :
theme Blue
crop
album utilisera le thème Dominatrix6 pour l'album photo du répertoire images/
et tous ses sous-albums excepté pour le sous-album images/europe/ qui
disposera du thème Blue. Toutes les images de l'album photo du répertoire
images/ seront sur 3 colonnes y compris dans le sous-album images/europe/ car
ce paramètre y est inchangé. Cependant, toutes les vignettes du sous-album
images/europe/ seront recadrées du fait de la présence de l'option 'crop' dans
le fichier de configuration.
3: Sauvegarde des options
Dès que vous lancez le script album, les options en ligne de commande sont
sauvegardées dans un fichier album.conf situé à l'intérieur du répertoire de
votre album photo. Si un tel fichier existe déjà, il sera modifié et non
remplacé ce qui permet d'éditer très facilement ce fichier via un éditeur de texte.
Ceci facilite l'usage ultérieur du script album. Par exemple, si vous générez
pour la première fois un album photo avec :
% album -crop -no_known_images -theme Dominatrix6 -sort date images/
Alors la prochaine fois que vous appellerez album, vous aurez juste besoin de
taper :
% album images/
Ceci fonctionne également pour les sous-albums photo :
% album images/africa/
trouvera aussi toutes les options sauvegardées.
Quelques options à l'usage limité comme -add (ajouter un nouveau sous-album),
-clean (effacer les fichiers inutiles), -force (forcer la regénération d'un
album photo), -depth (préciser la profondeur c'est-à-dire le nombre de niveaux
de sous-albums sur laquelle s'applique la commande), etc... ne sont pas
sauvegardées pour des raisons évidentes.
Lancer plusieurs fois album dans le même répertoire peut devenir confus si
vous ne comprenez pas comment les options sont sauvegardées.
Voici quelques exemples.
Introduction :
1) Les options en ligne de commande sont traités avant les options du fichier
de configuration trouvé dans le répertoire de l'album photo.
2) album utilisera les mêmes options la prochaine fois que vous le lancez si
vous ne spécifiez aucune option.
Par exemple, si on suppose qu'on lance deux fois album dans un répertoire :
% album -exif "commentaire 1" photos/espagne% album photos/espagne
La deuxième fois que vous utiliserez album, vous aurez toujours le
commentaire exif "commentaire 1" pour l'album photo de ce répertoire.
3) album ne finira pas avec de multiples copies d'une même option acceptant
plusieurs arguments si vous continuez à l'appeler avec la même ligne de
commande.
Par exemple :
% album -exif "commentaire 1" photos/espagne% album -exif "commentaire 1" photos/espagne
La deuxième fois que vous lancez album, vous n'aurez pas à la fin plusieurs
copies du commentaire exif "commentaire 1" dans vos photos.
Cependant, veuillez noter que si vous re-préciser à chaque fois les
mêmes options, album pourrait être plus lent à s'exécuter car il pensera
qu'il a besoin de regénérer vos fichiers html !
Ainsi par exemple, si vous lancez :
% album -medium 640x640 photos/espagne
(puis plus tard...)
% album -medium 640x640 photos/espagne
Alors la seconde fois regénérera inutilement toutes vos photos de taille
moyenne ("medium"). Ceci est beaucoup lent.
Il est donc préférable de spécifier les options en ligne de commande
seulement la première fois, puis d'utiliser ensuite la sauvegarde qui en a été
faite comme ici :
% album -medium 640x640 photos/espagne
(puis plus tard...)
% album photos/espagne
Malheureusement, ces contraintes signifient que, pour toutes les options
acceptant plusieurs arguments, les dernières valeurs entrées se retrouveront
en début de liste comme sur l'exemple ci-dessous avec l'option -exif.
% album -exif "commentaire 1" photos/espagne% album -exif "commentaire 2" photos/espagne
Les commentaires seront en fait ordonnés ainsi : "commentaire 2" puis
"commentaire 1".
Pour préciser l'ordre exact, vous aurez besoin de re-spécifier toutes les
options :
Soit en spécifiant de nouveau "commentaire 1" pour le remettre en première
position dans la liste.
% album -exif "commentaire 1" photos/espagne
Ou juste en spécifiant toutes les options dans l'ordre que vous souhaitez :
% album -exif "commentaire 1" -exif "commentaire 2" photos/espagne
Quelques fois, il peut être plus facile d'éditer directement le fichier
album.conf afin d'y apporter les modifications souhaitées.
Finalement, ceci nous permet seulement d'accumuler les options.
On peut effacer les options en utiliser -no et -clear (voir la section
correspondante Options), ces
modifications étant également sauvegardées d'une utilisation à une autre.
4: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/new_txt_3 0000644 0000000 0000000 00000044662 12236177303 014417 0 ustar root root Utiliser album / Options de base
ITEM: Excution basique
Crez un rpertoire contenant uniquement des images. Le script album et
les autres outils ne doivent pas se trouver dans ce rpertoire. Lancez
la commande album en prcisant ce rpertoire :
% album /exemple/chemin/vers/les/images
Ou, si vous tes dj dans le rpertoire exemple/chemin/vers/les/images :
% album images/
Quand l'opration est termine, vous aurez un album photo l'intrieur
de ce rpertoire avec comme fichier d'entre index.html.
Si ce chemin fait partie de votre serveur web, alors vous pourrez
visualiser votre album photos partir de votre navigateur. Si vous
ne le trouvez pas, contactez votre administrateur systme.
ITEM: Options
Il y a trois types d'options: options boolennes (vrai / faux), options
acceptant des chanes de caractres ou des numros et options acceptant
plusieurs arguments. Les options boolennes peuvent tre dsactives en
les prfixant avec -no_ :
% album -no_image_pages
Les chanes de caractres et les nombres sont entrs aprs une option :
% album -type gif
% album -columns 5
Les options acceptant plusieurs arguments peuvent tre utilises de
deux manires. La premire avec un argument la fois :
% album -exif hi -exif there
ou avec plusieurs arguments en utilisant la syntaxe '--' :
% album --exif hi there --
Vous pouvez supprimer une valeur particulire d'une option plusieurs
arguments avec -no_<option> suivi du nom de l'argument et effacer
tous les arguments d'une telle option avec -clear_<option>.
Pour effacer tous les arguments d'une option acceptant plusieurs arguments
(provenant par exemple d'une prcdente utilisation de la commande album) :
% album -clear_exif -exif "new exif"
(l'option -clear_exif effacera les anciens arguments de l'option exif puis
l'option -exif suivante permettra d'ajouter un nouveau commentaire dans
la section exif).
Et pour terminer, vous pouvez supprimer un argument particulier d'une option
plusieurs arguments avec 'no_' :
% album -no_exif hi
supprimera la valeur 'hi' et laissera intacte la valeur 'there' de l'option
exif.
Voir galement la section sur Sauvegarde des options.
Pour voir une courte page d'aide :
% album -h
Pour voir davantage d'options :
% album -more
Et pour avoir encore plus d'options :
% album -usage=2
Vous pouvez spcifier un nombre plus grand que 2 pour voir encore davantage
d'options (jusqu' 100).
Les modules de plug-in peuvent aussi disposer d'options pour leur propre
usage.
ITEM: Thmes
Les thmes sont une composante essentielle qui rend album attrayant. Vous
pouvez particulariser le look de votre album photo en tlchargeant un
thme depuis le site MarginalHacks ou mme crire votre propre thme en
phase avec votre site web.
Pour utiliser un thme, tlchargez l'archive correspondante du thme au
format .tar ou .zip et installez-l.
Les thmes sont spcifis grce l'option -theme_path qui permet d'indiquer
les endroits o sont stockes les thmes. Ces chemins sont ncessairement
quelque part sous la racine du rpertoire de votre site web mais pas
l'intrieur mme de votre album photo. De plus, ces chemins doivent tre
accessible depuis un navigateur.
Vous pouvez rajouter un thme dans l'un des chemins spcifi par l'option
theme_path et utilis par album ou crer un nouveau thme et indiquer son
chemin d'accs avec cette option (le rpertoire indiqu par l'option
-theme_path est celui o se trouve le thme et pas le rpertoire du thme
lui-mme).
Par la suite, appelez album avec l'option -theme accompagne ou non de
-theme_path:
% album -theme Dominatrix6 mes_photos/
% album -theme Dominatrix6 -theme_path /home/httpd/album/Themes/ mes_photos/
Vous pouvez galement crer vos propres thmes trs facilement. Ce sujet est
abord un peu plus loin dans cette documentation.
ITEM: Sous-albums
Crez des rpertoires dans votre rpertoire cr prcedemment et mettez-y
des images. Lancez une nouvell fois album : vos sous-rpertoires seront
explors et donneront naissance des sous-albums du premier album.
Si vous apportez des modifications dans un seul sous-album, vous pouvez
excuter album uniquement sur ce sous-album ; les liens avec l'album
parent seront conservs.
Si vous ne souhaitez pas descendre dans l'arborescence des rpertoires,
vous pouvez limiter la profondeur du niveau d'exploration avec l'option
-depth. Exemple :
% album images/ -depth 1
Cette commande ne gnrera qu'un album photo pour les images du
rpertoire courant.
Si vous avez plusieurs sous-albums et que vous voulez ajouter un nouveau
sous-album sans regnrer les autres, alors utilisez l'option -add :
% album -add images/nouvel_album/
Ceci ajoutera nouvel_album la page HTML pour 'images/' et crera
ensuite les vignettes et les pages HTML pour toutes les donnes contenues
dans 'images/nouvel_album'.
ITEM: Eviter la regnration des vignettes
album essaie d'viter au maximum le travail inutile. Il ne cre seulement
des vignettes que si elles n'existent pas et n'ont pas t modifies. Ceci
permet d'acclrer les traitements successifs d'album.
Cependant, cela peut provoquer un problme si vous changez la taille ou
recadrez vos vignettes car album ne ralisera pas que ces dernires ont
changes. Pour forcer la regnration des vignettes, utilisez l'option
-force :
% album -force images/
Mais vous ne devriez pas avoir besoin d'utiliser l'option -force chaque
fois.
ITEM: Nettoyer les vignettes
Si vous supprimez une image de votre album, alors vous laisserez des
vignettes et des pages HTML. Pour les supprimer, lancer album avec
l'option -clean :
% album -clean images/
ITEM: Taille d'images moyenne
Quand vous cliquez sur la vignette d'un album, vous tes dirigs vers
une page spcifique cette image. Par dfaut, cette page affiche l'image
en taille relle ainsi que les boutons de navigation, les lgendes et
tout le toutim. Quand vous cliquez sur l'image de cette page, l'URL
pointe alors uniquement sur l'image en taille relle.
Si vous voulez avoir une image de taille rduite sur la page affichant
cette image, utilisez l'option -medium en prcisant la gomtrie que vous
souhaitez obtenir. Vous pouvez utiliser toutes les gomtries supportes
par ImageMagick (voir la page man de cet outil pour de plus amples dtails).
Par exemple :
# Une image faisant la moiti de la taille relle
% album -medium 50%
# Une image qui s'insre dans 640x480 (taille maximale)
% album -medium 640x480
# Une image qui est rduite pour s'insrer dans 640x480
# (mais qui ne sera pas largie si elle est dj plus petite que 640x480)
% album -medium '640x480>'
Les caractres de 'quotation' du dernier exemple seront obligatoires sur
la plupart des systmes cause de la prsence du caractre '>'.
ITEM: Lgendes
Les images et les vignettes peuvent avoir des noms et des lgendes. Il y a
plusieurs moyens de prciser / changer les noms et les lgendes dans vos
albums photo.
Le nom est
li l'image ou la page qui l'hberge et la lgende suit juste en dessous.
Le nom par dfaut est le fichier nettoy :
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
Un moyen de prciser une lgende est d'utiliser un fichier texte avec le
mme nom que l'image mais l'extension .txt. Par exemple,
"Kodi_Cow.txt" pourrait contenir "Kodi takes down a cow! ("Kodi
matrise une vache !")
Vous pouvez renommer vos images et spcifier toutes les lgendes d'un
rpertoire avec un fichier captions.txt.
Chaque ligne du fichier doit tre le nom d'une image ou d'un
rpertoire, suivi par une tabulation, suivi par le nouveau
nom. Vous pouvez aussi spcifier (spar par une tabulation), une lgende
optionnelle puis un tag ALT, optionnel galement, pour l'image. Pour sauter
un champ, utilisez 'tabulation' 'espace' 'tabulation'.
Exemple :
001.gif Ma premire photo
002.gif Maman et Papa dans le grand canyon
003.gif Ani DiFranco ma fiance Whaou !
Les images et les rpertoires sont lists dans l'ordre dans lequel ils
sont trouvs dans le fichier de lgende. Vous pouvez modifier ce tri avec
les options '-sort date' et '-sort name'.
Si votre diteur de texte ne gre pas trs bien les tabulations, vous
pouvez sparer les champs par un double deux-points mais .b/seulement
si votre lgende ne contient aucune tabulation :
003.gif :: Ani DiFranco :: Ma fiance :: Whaou !
Si vous ne souhaitez avoir des lgendes que sur les pages contenant les
images (et pas sur les pages affichant les albums), utilisez :
% album -no_album_captions
Si vous voulez crer ou diter vos lgendes depuis un accs web, regardez
le script CGI caption_edit.cgi (mais soyez sr de limiter l'accs ce
script sinon n'importe qui pourra modifier vos lgendes).
ITEM: Lgendes EXIF
Vous pouvez galement prciser des lgendes extraites des informations
EXIF (Exchangeable Image File Format) ajoutes aux images par la plupart
des appareils photo numriques.
Mais tout d'abord, vous avez besoin d'installer 'jhead'. Vous pouvez,
par exemple, lancer jhead sur un fichier au format jpeg (.jpg ou .jpeg)
et ainsi voir les commentaires et informations affichs.
Les lgendes EXIF sont ajouts la suite des lgendes normales et sont
spcifis l'aide de l'option -exif :
% album -exif "<br>Fichier: %File name% pris avec %Camera make%"
Tous les %tags% trouvs seront remplaces par les informations EXIF
correspondantes. Si des %tags% ne sont pas trouvs dans les informations
EXIF, alors la lgende EXIF est ignore. A cause de ce comportement, vous
pouvez multiplier les arguments passs l'option -exif :
% album -exif "<br>Fichier: %File name% " -exif "pris %Camera make%"
De la sorte, si le tag 'Camera make' n'est pas trouv, vous pourrez toujours
avoir la lgende relative au tag 'File name'.
De la mme faon que pour toutes les options acceptant plusieurs arguments,
vous pouvez utiliser la syntaxe --exif :
% album --exif "<br>Fichier: %File name% " "pris avec %Camera make%" --
Comme montr dans l'exemple, il est possible d'inclure des balises HTML dans
vos lgendes EXIF :
% album -exif "<br>Ouverture: %Aperture%"
Afin de voir la liste des tags EXIF possible (Rsolution, Date / Heure,
Ouverture, etc...), utilisez un programme comme 'jhead' sur une image issue
d'un appareil photo numrique.
Vous pouvez galement prciser des lgendes EXIF uniquement pour les albums
ou les pages affichant une image. Voir les options -exif_album et
-exif_image.
ITEM: En-ttes et pieds-de-page
Dans chaque rpertoire abritant un album, vous pouvez avoir des fichiers texte
header.txt and footer.txt.
Ces fichiers seront copis tels quels dans l'en-tte et le pied-de-page
de votre album (si cette fonctionnalit est supporte par votre thme).
ITEM: Masquer des Fichiers / des Rpertoires
Chaque fichier non reconnu par album comme tant une image est ignor.
Pour afficher ces fichiers, utilisez l'option -no_known_images (l'option
par dfaut est -known_images).
Vous pouvez marquer une image comme n'tant pas une image en ditant un
fichier vide avec le mme et l'extension .not_img ajoute la fin.
Vous pouvez ignorer compltement un fichier en crant un fichier vide avec
le mme nom et l'extension .hide_album ajoute la fin.
Vous pouvez viter de parcourir un rpertoire complet (bien qu'tant
toujours inclus dans la liste de vos rpertoires) en crant un fichier
<dir>/.no_album.
Vous pouvez ignorer compltement des rpertoires crant un fichier
<dir>/.hide_album
La version pour Windows d'album n'utilise pas le . pour no_album,
hide_album et not_img car il est difficile de crer des
.fichiers dans Windows.
ITEM: Recadrer les images
Si vos images comportent un large ventail de ratios (c'est--dire autres
que les traditionnels ratios portrait / paysage) ou si votre thme ne
supporte qu'une seule orientation, alors vos vignettes peuvent tre
recadres afin qu'elles partagent toutes la mme gomtrie :
% album -crop
Le recadrage par dfaut est de recadrer l'image au centre. Si vous n'aimez
pas le recadrage central utilis par album pour gnrer les vignettes, vous
pouvez donner des directives album afin de spcifier o recadrer des
images spcifiques. Pour cela, il suffit de changer le nom du fichier
contenant l'image pour qu'il ait la directive de recadrage juste avant
l'extension. Vous pouvez ainsi demander album de recadrer l'image en haut,
en bas, droite ou gauche. Par exemple, supposons que nous ayons un
portrait "Kodi.gif" que vous voulez recadrer au sommet de votre vignette.
Renommez le fichier en "Kodi.CROPtop.gif" et c'est tout (vous pouvez
venutellement utiliser l'option -clean pour supprimer l'ancienne
vignette). La chane de caractres prcisant le recadrage sera supprime
du nom affich dans votre navigateur.
La gomtrie par dfaut est 133x133. De cette faon, les images en position
paysage auront des vignettes au format 133x100 et les images en position
portrait auront des vignettes au format 100x133. Si vous utilisez le
recadrage et souhaitez que vos vignettes aient toujours le mme ratio que
les photos numriques; alors essayez 133x100 :
% album -crop -geometry 133x100
Souvenez-vous que si vous recadrez ou changez la gomtrie d'un album
prcdemment gnr, vous devrez utiliser l'option -force une fois afin
de regnrer compltement toutes vos vignettes.
ITEM: Film vido
album peut gnrer des vignettes issues de prise instantane pour de
nombreux formats vido si vous installez ffmpeg.
Si vous tes sur un systme linux sur une architecture x86, vous n'avez qu'
tlcharger le fichier excutable, ou autrement, tlcharger le
paquetage complet depuis ffmpeg.org (c'est trs facile d'installation).
ITEM: Graver des CDs (en utilisant file://)
Si vous utilisez album pour graver des CDs ou si vous souhaitez accder
vos albums depuis votre navigateur avec le protocole file://, alors
vous ne voulez pas qu'album suppose que le fichier "index.html" soit
la page principale puisque votre navigateur ne le saura probablement pas.
De plus, si vous utilisez des thmes, vous devez utiliser des
chemins d'accs relatifs. Vous ne pouvez pas utiliser l'option
-theme_url car vous ne savez pas o sera l'URL final. Sur Windows, le
chemin d'accs aux thmes pourrait tre "C:/Themes" ou sous UNIX ou OSX,
il pourrait tre quelque chose comme "/mnt/cd/Themes", tout dpendant
de la faon dont le CD a t mont.
Pour rsoudre ces cas de figure, utilisez l'option -burn :
% album -burn ...
Ceci implique que les chemins d'accs de l'album vers les thmes ne
change pas. Le meilleur moyen de faire ceci consiste prendre le
rpertoire racine que vous allez graver et d'y mettre vos thmes et votre
album puis de spcifier le chemin complet vers le thme. Par exemple,
crez les rpertoires :
monISO/Photos/
monISO/Themes/Blue
Puis vous lancez :
% album -burn -theme monISO/Themes/Blue monISO/Photos
Ensuite, vous pouvez crer une image ISO depuis le rpertoire mon ISO (ou
plus haut).
Les utilisateurs Windows peuvent galement jeter un oeil sur shellrun
qui permet de lancer automatiquement l'album dans le navigateur. (Ou
voyez aussi winopen).
ITEM: Indexer entirement votre album
Pour naviguer sur un album entirement compris sur une page, utilisez l'outil
caption_index.
Il utilise les mmes options qu'album (bien qu'il en ignore la plupart) de
telle sorte que vous pouvez remplacer l'appel "album" par "caption_index".
La sortie est la page HTML de l'index de l'album complet.
Regardez l'index d'exemple ralis partir d'un de mes albums photo d'exemple
ITEM: Mettre jour des albums avec CGI
Premirement, vous avez besoin de charger vos photos dans le rpertoire
de l'album. Je vous suggre d'utiliser ftp pour faire cette manipulation.
Vous pouvez aussi crire un script java qui chargerait les fichiers. Si
quelqu'un pouvait me montrer comment faire, j'apprcierais beaucoup.
Ensuite, vous avez besoin de pouvoir excuter album distance. Pour viter
les abus, je vous conseille de mettre en place un script CGI qui cre
un fichier bidon (ou qui transfre ce fichier via ftp) et d'avoir un
cron job (process tournant en arrire plan) qui teste rgulirement
quelques minutes d'intervalle si ce fichier est prsent et, s'il l'est,
de le supprimer et de lancer album. Cette mthode ne fonctionne que sous
unix et vous aurez srement besoin de modifier votre variable
d'environnement $PATH ou d'utiliser des chemins absolus dans le script
pour la conversion).
Si vous souhaitez une gratification immdiate, vous pouvez lancer album
depuis un script CGI comme celui-ci.
Si l'utilisateur du serveur web n'est pas le propritaire des photos, vous
aurez besoin d'utiliser un script setuid via CGI [toujours pour unix
seulement].
Mettez ce script setuid dans un emplacement protg, changez son propritaire
pour qu'il soit le mme que celui de vos photos et lancez la commande
"chmod ug+s" sur le script. Vous trouverez ici des exemples de scripts
setui et CGI. N'oubliez pas de les diter.
Regardez galement caption_edit.cgi
qui vous permet (ou une autre personne) d'diter les lgendes / noms /
en-ttes / pieds-de-pages travers le web.
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/old.txt_2 0000644 0000000 0000000 00000015335 10543110710 014301 0 ustar root root MINI HOW-TO
ITEM: Simple album
En supposant que vous avez déjà installé album correctement, nous pouvons
réaliser quelques manipulations basiques. Si vous rencontrez une erreur ou
un quelconque problème ici, regardez les documents d'installation.
Vous avez besoin d'un répertoire accessible depuis le web où mettre vos
thèmes et votre album photos. Nous utiliserons /home/httpd/test dans ce
document. Ce répertoire a besoin d'être accessible par le serveur web. Dans
cet exemple, nous utiliserons l'URL suivante :
http://myserver/test
Adaptez vos commandes / URLs en fonction de vos besoins.
Premièrement, créez un répertoire et mettez-y des images dedans. Nous
l'appellerons ainsi :
/home/httpd/test/Photos
Puis nous ajouterons quelques images dénommées 'IMG_001.jpg' à 'IMG_004.jpg'.
Maintenant, pour ce test basique, lançons simplement album:
% album /home/httpd/test/Photos
Maintenant, vous pouvez visualiser l'album créé via un navigateur à l'adresse :
http://myserver/test/Photos
ITEM: Ajouter des légendes
Créez un fichier /home/httpd/test/Photos/captions.txt avec le contenu
suivants (utilisez la touche 'tab' si vous voyez " [tab] ") :
-- captions.txt ---------
IMG_001.jpg [tab] Nom de la première image
IMG_002.jpg [tab] Deuxième image
IMG_003.jpg [tab] Encore une image [tab] avec une légende!
IMG_004.jpg [tab] Dernière image [tab] avec une autre légende.
-------------------------
Puis lancer de nouveau la commande album :
% album /home/httpd/test/Photos
Vous verrez que la légende a été modifée.
Maintenant, créez un fichier avec du texte dedans :
/home/httpd/test/Photos/header.txt
Et relancez la commande album une fois de plus. Vous verrz alors le texte
du fichier affichée au sommet de la page.
ITEM: Masquer des photos
Il y a quelques moyens de masquer des photos / des fichiers / des répertoires
mais nous allons utiliser le fichier des légendes. Essayez de placer un
commentaire avec le caractère '#' devant le nom d'une image dans captions.txt:
-- captions.txt ---------
IMG_001.jpg [tab] Nom de la première image
#IMG_002.jpg [tab] Deuxième image
IMG_003.jpg [tab] Encore une image [tab] avec une légende!
IMG_004.jpg [tab] Dernière image [tab] avec une autre légende.
-------------------------
Relancez la commande album et vous verrez que l'image IMG_002.jpg a maintenant
disparu.
Si vous aviez procédé de la sorte la première fois, vous n'auriez généré ni
l'image de taille réduite ni la vignette correspondante. Si vous le souhaitez,
vous pouvez les supprimer en utilisant l'option -clean :
% album -clean /home/httpd/test/Photos
ITEM: Utiliser un thème
Si les thèmes ont été correctement installés and sont accessibles via
them_path (chemin d'accès aux thèmes), alors vous pouvez utiliser un thème
lors de la génération de votre album :
% album -theme Blue /home/httpd/test/Photos
L'album photo courant devrait être maintenant basé sur le thème Blue (bleu).
S'il y a tout un tas de liens cassés ou d'images qui n'apparaissent pas, il
y a de forte chance pour que votre thème n'ait pas été installé dans un
répertoire accessible depuis le web ; voir les documents d'installation.
Album sauvegarde les options que vous lui indiquez. Ainsi, la prochaine fois
que vous lancerez la commande album :
% album /home/httpd/test/Photos
vous utiliserez toujours le thème Blue. Pour désactiver un thème, tapez :
% album -no_theme /home/httpd/test/Photos
ITEM: Images réduites
Les images de pleine taille sont en générale d'une taille trop imposante pour
un album photo sur le web. C'est pourquoi nous utiliserons des images réduites
sur les pages web générées :
% album -medium 33% /home/httpd/test/Photos
Cependant, vous avez toujours accès aux images pleine taille en cliquant
simplement sur les images réduites.
La commande :
% album -just_medium /home/httpd/test/Photos
empêchera la liaison entre les images de taille réduite et les images pleine
taille, en présumant que nous avons lancé précédemment une commande avec
l'option -medium.
ITEM: Ajouter des légendes EXIF
Ajoutons la valeur du diaphragme dans les légendes de chaque image.
% album -exif "<br>diaphragme=%Aperture%" /home/httpd/test/Photos
Cette commande ajoutera seulement la valeur du diaphragme pour les images qui
disposent de la balise exif (le symbole entre les caractères '%') 'Aperture'
signifiant diaphragme en français ! Nous avons également ajouté la balise
<br> qui permet d'ajouter cette information exif sur une nouvelle ligne.
Nous pouvons rajouter d'autres informations exif :
% album -exif "<br>focale: %FocalLength%" /home/httpd/test/Photos
Parce que album sauvegarde vos précédentes options, nous disposons maintenant
de deux balises exif pour toutes les images spécifiant à la fois le diaphragme
et la focale.
Supprimons le diaphragme :
% album -no_exif "<br>diaphragme=%Aperture%" /home/httpd/test/Photos
La chaîne de caractères suivant l'option '-no_exif' a besoin de correspondre
exactement à celle entrée précédemment avec l'option '-exif' sinon elle sera
ignorée. Vous pouvez également éditer le fichier de configuration qu'album a
créé ici :
/home/httpd/test/Photos/album.conf
Puis supprimez l'option en question.
ITEM: Ajouter d'autres albums
Imaginons que vous faites un voyage en Espagne. Vous prenez des photos et les
mettez dans le répertoire :
/home/httpd/test/Photos/Espagne/
Maintenant, exécutez la commande album depuis le répertoire principal :
% album /home/httpd/test/Photos
Cette commande modifiera l'album principal Photos qui sera relié à Espagne
puis elle lancera également la commande album sur le répertoire Espagne avec
les mêmes caractéristiques / thème, etc.
Maintenant, faisons un autre voyage en Italie et créons le répertoire :
/home/httpd/test/Photos/Italie/
Nous pourrions lancer la commande depuis le répertoire principal :
% album /home/httpd/test/Photos
Mais ceci rescannerait le répertoire Espagne qui n'a pas changé. Album ne
générera aucune page HTML ni vignette à moins qu'il ait le besoin de la
faire. Cependant, il peut perdre du temps, plus particulièrement si vos
albums photos deviennent de plus en plus volumineux. Aussi, vous pouvez
juste demander d'ajouter le nouveau répertoire :
% album -add /home/httpd/test/Photos/Italie
Cette commande modifiera l'index de la première page (dans Photos) et
générera l'album correspond au répertorie Italie.
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/Section_2.html 0000644 0000000 0000000 00000052703 12661460265 015274 0 ustar root root
MarginalHacks album - MINI HOW-TO
- Documentation
1: Simple album
En supposant que vous avez déjà installé album correctement, nous pouvons
réaliser quelques manipulations basiques. Si vous rencontrez une erreur ou
un quelconque problème ici, regardez les documents d'installation.
Vous avez besoin d'un répertoire accessible depuis le web où mettre vos
thèmes et votre album photos. Nous utiliserons /home/httpd/test dans ce
document. Ce répertoire a besoin d'être accessible par le serveur web. Dans
cet exemple, nous utiliserons l'URL suivante :
http://myserver/test
Adaptez vos commandes / URLs en fonction de vos besoins.
Premièrement, créez un répertoire et mettez-y des images dedans. Nous
l'appellerons ainsi :
/home/httpd/test/Photos
Puis nous ajouterons quelques images dénommées 'IMG_001.jpg' à 'IMG_004.jpg'.
Maintenant, pour ce test basique, lançons simplement album:
% album /home/httpd/test/Photos
Maintenant, vous pouvez visualiser l'album créé via un navigateur à l'adresse :
http://myserver/test/Photos
2: Ajouter des légendes
Créez un fichier /home/httpd/test/Photos/captions.txt avec le contenu
suivants (utilisez la touche 'tab' si vous voyez " [tab] ") :
-- captions.txt ---------
IMG_001.jpg [tab] Nom de la première image
IMG_002.jpg [tab] Deuxième image
IMG_003.jpg [tab] Encore une image [tab] avec une légende!
IMG_004.jpg [tab] Dernière image [tab] avec une autre légende.
-------------------------
Puis lancer de nouveau la commande album :
% album /home/httpd/test/Photos
Vous verrez que la légende a été modifée.
Maintenant, créez un fichier avec du texte dedans :
/home/httpd/test/Photos/header.txt
Et relancez la commande album une fois de plus. Vous verrez alors le texte
du fichier affichée au sommet de la page.
3: Masquer des photos
Il y a quelques moyens de masquer des photos / des fichiers / des répertoires
mais nous allons utiliser le fichier des légendes. Essayez de placer un
commentaire avec le caractère '#' devant le nom d'une image dans captions.txt:
-- captions.txt ---------
IMG_001.jpg [tab] Nom de la première image
#IMG_002.jpg [tab] Deuxième image
IMG_003.jpg [tab] Encore une image [tab] avec une légende!
IMG_004.jpg [tab] Dernière image [tab] avec une autre légende.
-------------------------
Relancez la commande album et vous verrez que l'image IMG_002.jpg a maintenant
disparu.
Si vous aviez procédé de la sorte la première fois, vous n'auriez généré ni
l'image de taille réduite ni la vignette correspondante. Si vous le souhaitez,
vous pouvez les supprimer en utilisant l'option -clean :
% album -clean /home/httpd/test/Photos4: Utiliser un thème
Si les thèmes ont été correctement installés and sont accessibles via
them_path (chemin d'accès aux thèmes), alors vous pouvez utiliser un thème
lors de la génération de votre album :
% album -theme Blue /home/httpd/test/Photos
L'album photo courant devrait être maintenant basé sur le thème Blue (bleu).
S'il y a tout un tas de liens cassés ou d'images qui n'apparaissent pas, il
y a de forte chance pour que votre thème n'ait pas été installé dans un
répertoire accessible depuis le web ; voir les documents d'installation.
Album sauvegarde les options que vous lui indiquez. Ainsi, la prochaine fois
que vous lancerez la commande album :
% album /home/httpd/test/Photos
vous utiliserez toujours le thème Blue. Pour désactiver un thème, tapez :
% album -no_theme /home/httpd/test/Photos5: Images réduites
Les images de pleine taille sont en générale d'une taille trop imposante pour
un album photo sur le web. C'est pourquoi nous utiliserons des images réduites
sur les pages web générées :
% album -medium 33% /home/httpd/test/Photos
Cependant, vous avez toujours accès aux images pleine taille en cliquant
simplement sur les images réduites.
La commande :
% album -just_medium /home/httpd/test/Photos
empêchera la liaison entre les images de taille réduite et les images pleine
taille, en présumant que nous avons lancé précédemment une commande avec
l'option -medium.
6: Ajouter des légendes EXIF
Ajoutons la valeur du diaphragme dans les légendes de chaque image.
% album -exif "<br>diaphragme=%Aperture%" /home/httpd/test/Photos
Cette commande ajoutera seulement la valeur du diaphragme pour les images qui
disposent de la balise exif (le symbole entre les caractères '%') 'Aperture'
signifiant diaphragme en français ! Nous avons également ajouté la balise
<br> qui permet d'ajouter cette information exif sur une nouvelle ligne.
Nous pouvons rajouter d'autres informations exif :
% album -exif "<br>focale: %FocalLength%" /home/httpd/test/Photos
Parce que album sauvegarde vos précédentes options, nous disposons maintenant
de deux balises exif pour toutes les images spécifiant à la fois le diaphragme
et la focale.
Supprimons le diaphragme :
% album -no_exif "<br>diaphragme=%Aperture%" /home/httpd/test/Photos
La chaîne de caractères suivant l'option '-no_exif' a besoin de correspondre
exactement à celle entrée précédemment avec l'option '-exif' sinon elle sera
ignorée. Vous pouvez également éditer le fichier de configuration qu'album a
créé ici :
/home/httpd/test/Photos/album.conf
Puis supprimez l'option en question.
7: Ajouter d'autres albums
Imaginons que vous faites un voyage en Espagne. Vous prenez des photos et les
mettez dans le répertoire :
/home/httpd/test/Photos/Espagne/
Maintenant, exécutez la commande album depuis le répertoire principal :
% album /home/httpd/test/Photos
Cette commande modifiera l'album principal Photos qui sera relié à Espagne
puis elle lancera également la commande album sur le répertoire Espagne avec
les mêmes caractéristiques / thème, etc.
Maintenant, faisons un autre voyage en Italie et créons le répertoire :
/home/httpd/test/Photos/Italie/
Nous pourrions lancer la commande depuis le répertoire principal :
% album /home/httpd/test/Photos
Mais ceci rescannerait le répertoire Espagne qui n'a pas changé. Album ne
générera aucune page HTML ni vignette à moins qu'il ait le besoin de la
faire. Cependant, il peut perdre du temps, plus particulièrement si vos
albums photos deviennent de plus en plus volumineux. Aussi, vous pouvez
juste demander d'ajouter le nouveau répertoire :
% album -add /home/httpd/test/Photos/Italie
Cette commande modifiera l'index de la première page (dans Photos) et
générera l'album correspond au répertorie Italie.
8: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/txt_7 0000644 0000000 0000000 00000031715 12236405003 013534 0 ustar root root Modules Plug-in : utilisation, création...
ITEM: Qu'est-ce qu'un module plug-in ?
Les modules plug-in sont des bouts de code qui vous permettent de modifier le
comportement d'album. Ils peuvent être aussi simples que la façon de créer des
légendes EXIF ou quelque chose d'aussi compliqué que créer un album à partir
d'une base de données d'images plutôt que d'utiliser une hiérarchie dans un
système de fichiers.
ITEM: Installation d'un module plug-in et son support
Il y a un certain nombre de modules plug-in disponibles avec l'installation
standard d'album. Si vous souhaitez mettre à jour album avec les modules
plug-in d'une précédente version d'album qui ne dispose pas de modules plug-in
(pré v3.10), vous aurez besoin de faire une fois :
% album -configure
Vous n'aurez pas besoin de refaire cette commande lors des futures mises à
jour d'album.
Cette commande installera les modules plug-in actuels dans un des répertoires
par défaut des modules plug-in. album cherchera les modules plug-in dans un
certain nombre d'endroits. Ceux par défaut sont :
/etc/album/plugins/
/usr/share/album/plugins/
$HOME/.album/plugins/
En réalité, ces répertoires 'plug-in' sont ceux trouvés dans les endroits
spécifiés par l'option '--data_path' dont les noms par défaut sont :
/etc/album/
/usr/share/album/
$HOME/.album/
Vous pouvez spécifier un nouveau répertoire avec l'option '--data_path' et
ajouter un répertoire 'plugins' à ce niveau ou utiliser l'option
'--plugin_path'.
Les modules plug-in se terminent en général par l'extension ".alp" mais vous
n'avez pas besoin de spécifier cette extension lorsque vous les utilisez. Par
exemple, si vous avez un module installé ici :
/etc/album/plugins/utils/mv.alp
alors vous l'appellerez ainsi : utils/mv
ITEM: Chargement / déchargement des modules plug-in
Pour lister tous les modules plug-in actuellement installés, taper :
% album -list_plugins
Pour montrer des informations relatives à des modules spécifiques (en
utilisant 'utils/mv' comme exemple) :
% album -plugin_info utils/mv
Les modules plug-in seront sauvés dans le fichier de configuration pour un
album donné ainsi vous n'avez pas besoin de les respécifier à chaque fois, à
l'exclusion des modules plug-in qui s'exécutent une seule fois comme par
exemple 'utils/mv' ('mv' = 'move' : correspond à un déplacement de fichiers
donc ne peut être exécutée qu'une seule fois pour un jeu de fichiers donné).
Vous pouvez utiliser les options -no_plugin et -clear_plugin pour désactiver
les modules plug-in qui ont été sauvés dans le fichier de configuration de
l'album courant. De la même façon que les
options standard d'album, -no_plugin désactivera un module plug-in
spécifique alors que -clear_plugin désactivera l'ensemble des modules
plug-in. Toutes les options attachées à ces modules seront également
effacées.
ITEM: Options des modules plug-in
Quelques modules plug-in acceptent des options en ligne de commande. Pour
visualiser comment les utiliser, taper :
% album -plugin_usage utils/mv
Cependant, quand vous spécifiez une option pour un module plug-in, vous devez
indiquer à album à quel module plug-in l'option correspond. A la place de la
syntaxe utilisée pour les options standards d'album :
% album -une_option
vous devez préfixer l'option avec le nom du module plug-in suivi de
deux-points :
% album -un_plugin:une_option
Par exemple, vous pouvez spécifier le nom de l'index créé par le module
plug-in 'utils/capindex'.
% album -plugin utils/capindex -utils/capindex:index blah.html
C'est peu pratique. Vous pouvez raccourcir le nom du module plug-in tant qu'il
ne rentre pas en conflit avec un autre module plug-in déjà chargé et ayant le
même nom :
% album -plugin utils/capindex -capindex:index blah.html
Evidemment, les autres types d'options (chaînes de caractères, nombres et
tableaux) sont acceptés et utilisent la même convention. Ces options sont
sauvegardées dans le fichier de configuration de l'album de la même façon que
les options standard.
Avertissement : comme mentionné, une fois que nous utilisons un module plug-in
sur un album, il est sauvegardé dans le fichier de configuration. Si vous
voulez ajouter d'autres options à un album déjà configuré pour utiliser un
module plug-in, vous devez soit mentionner le module plug-in ou soit utiliser
le nom complet du module quand vous spécifiez les options (autrement, album ne
saura pas à qui appartient l'option raccourcie).
Par exemple, considérons un module plug-in imaginaire :
% album -plugin un/exemple/vignetteGen Photos/Espagne
Après ça, supposons que nous voulons utiliser la variable booléenne "rapide" du
module vignetteGen.
Ceci ne fonctionnera pas :
% album -vignetteGen:rapide Photos/Espagne
Mais l'une de ces solutions fonctionnera :
% album -plugin un/exemple/vignetteGen -vignetteGen:rapide blah.html Photos/Espagne% album -un/exemple/vignetteGen:rapide Photos/Espagne
ITEM: Ecrire des modules plug-in
Les modules plug-in sont de petits modules écrits en perl qui s'appellent via
des fonctions particulières ('hooks') du code d'album.
Il y a de telles fonctions pour la plupart des fonctionnalités d'album et le
code du module plug-in peut souvent soit remplacer soit compléter le code
d'album. Davantage de ces fonctions pourraient être rajoutées dans les futures
versions d'album si besoin.
Vous pouvez afficher la liste de toutes ces fonctions autorisées par album :
% album -list_hooks
Et vous pouvez obtenir des informations spécifiques pour chacune de ces
fonctions :
% album -hook_info <hook_name>
Nous pouvons utiliser album pour générer à notre place un cadre pour nos
modules plug-in :
% album -create_plugin
Pour effectuer cette tâche, vous avez besoin de comprendre les fonctions
'hooks' dans album et les options d'album.
Nous pouvons aussi écrire un module plug-in à la main. Pour cela, utiliser comme
base de travail un module plug-in déjà écrit facilite le travail.
Dans notre module plug-in, nous enregistrons notre fonction 'hook' en appelant
la fonction album::hook(). Pour appeler des fonctions dans le code d'album,
nous utilisons l'espace de nommage album.
Par exemple, pour enregistrer le code pour la fonction 'hook'
clean_name, notre module plug-in appelle :
album::hook($opt,'clean_name',\&my_clean);
Ainsi, quand album appelle la fonction clean_name, il appellera
également la sous-routine appelée my_clean de notre module
plug-in (sous-routine que nous devons fournir).
Pour écrire cette sous-routine my_clean, regardons les
informations de la fonction 'hook' clean_name :
Args: ($opt, 'clean_name', $name, $iscaption)
Description: Nettoyer un nom de fichier pour affichage.
Le nom est soit un nom de fichier soit il provient d'un fichier de légendes.
Retourne: le nom nettoyé
Les arguments que la sous-routine my_clean reçoit sont spécifiés
sur la première ligne. Supposons qu'on veuille convertir tous les noms en
majuscules. Nous devrions utiliser :
sub my_clean {
my ($opt, $hookname, $name, $iscaption) = @_;
return uc($name);
}
Voici une explication sur les arguments :
$opt Ceci est le descripteur de toutes les options d'album.
Nous ne nous en servons pas ici. Vous pourrez en avoir parfois
besoin si vous appelez les fonctions internes d'album. Ceci est
également valable si l'argument $data est fourni.
$hookname Dans notre cas, ce sera 'clean_name'. Ceci nous permet
d'enregistrer la même sous-routine pour gérer différentes
fonctions 'hooks'.
$name Ceci est le nom que nous allons nettoyer.
$iscaption Ceci nous indique si le nom provient d'un fichier de
légendes.
Pour comprendre n'importe quelles options après la variable
$hookname, vous aurez peut-être besoin de jeter un oeil sur
le code correspondant dans album.
Dans notre cas, nous avons seulement besoin d'utiliser la variable
$name fournie, nous appelons la routine perl de mise en majuscule et
nous retournons son résultat. Le code est ainsi terminé mais nous avons besoin
maintenant de créer un environnement pour notre module plug-in.
Des fonctions 'hooks' vous permettent de remplacer le code d'album. Par
exemple, vous pourriez écrire du code pour un module plug-in qui génére des
vignettes pour les fichiers au format pdf (utiliser l'outil 'convert' est un
desmoyens de le faire). Nous pouvons enregistrer du code pour la fonction
'hook' relative aux vignettes et simplement retourner 'undef' si nous ne
sommes pas en train de regarder un fichier pdf. Mais quand nous voyons un
fichier pdf, nous créons alors une vignette que nous retournons. Quand album
récupérera une vignette, alors il utilisera celle-ci et sautera l'exécution
de son propre code relatif aux vignettes.
Maintenant, terminons d'écrire notre module plug-in de mise en majuscules. Un
module plug-in doit comporter les éléments suivants :
1) Fournir une routine de démarrage appelée 'start_plugin'. Celle-ci
fera sûrement l'enregistrement des fonctions 'hooks' et spécifiera les
options en ligne de commande pour le module.
2) La routine 'start_plugin' doit retourne la table de hachage
des informations du module, laquelle table a besoin d'avoir les clés
suivantes définies :
author => Le nom de l'auteur
href => Une adresse internet (ou une adresse électronique) de
l'auteur
version => Le numéro de version du module plug-in
description => Un texte de description du module plug-in
3) Terminer le code du module en retournant '1' (similaire à un module perl).
Voici notre exemple de code plug-in clean_name dans son module
complet :
sub start_plugin {
my ($opt) = @_;
album::hook($opt,'clean_name',\&my_clean);
return {
author => 'David Ljung Madison',
href => 'http://MarginalHacks.com/',
version => '1.0',
description => "Conversion des noms des images en majuscules",
};
}
sub my_clean {
return uc($name);
}
1;
Finalement, nous avons besoin de le sauvegarder quelque part. Les modules
plug-in étant organisés dans une hiérarchie de répertoires pour modules
plug-in, nous pourrions le sauver dans un répertoire de module comme :
captions/formatting/NAME.alp
En fait, si vous regardez dans examples/formatting/NAME.alp, vous
trouverez qu'il y a déjà un module plug-in qui fait essentiellement la même
chose.
Si vous souhaitez que votre module accepte des options en ligne de commande,
utilisez 'add_option'. Ceci doit être réalisé dans le code de la
routine 'start_plugin'. Quelques exemples :
album::add_option(1,"fast",album::OPTION_BOOL, usage=>"Fais le rapidement");
album::add_option(1,"name", album::OPTION_STR, usage=>"Votre nom");
album::add_option(1,"colors",album::OPTION_ARR, usage=>"Liste des couleurs");
Pour de plus amples informations, regardez le code de la routine 'add_option'
dans album et jetez un oeil dans les autres routines qui l'utilisent (au début
du code d'album et dans les modules plug-in qui utilisent 'add_option').
Pour lire une option qu'un utilisateur pourrait avoir utilisée, nous utilisons
la fonction option() :
my $fast = album::option($opt, "fast");
Si l'utilisateur fournit une mauvaise valeur pour une option, vous pouvez
appeler la fonction usage() :
album::usage("-colors array can only include values [red, green, blue]");
Si votre module plug-in a besoin de charger des modules perl qui ne font pas
partie de la distribution standard de Perl, faites-le de façon
conditionnelle. Pour avoir un example, regardez le module plug-in
plugins/extra/rss.alp.
Vous pouvez également appeler n'importe quelle routines trouvées dans le script
album en utilisant l'espace de nommage album::. Soyez sûr de ce que vous
faites. Quelques routines utiles :
album::add_head($opt,$data, "<meta name='ajoute_ceci' content='à <head>'>");
album::add_header($opt,$data, "<p>Ceci est ajouté à l'en-tête de l'album");
album::add_footer($opt,$data, "<p>Ceci est ajouté au pied de page de l'album");
Le meilleur moyen de savoir comment écrire des modules plug-in est de regarder
d'autres modules plug-in, si possible en en copiant un réalisant une tache
similaire et en travaillant à partir de ça. Des outils de développement pour
les modules plug-in pourraient être créer à l'avenir.
Une fois de plus, album peut vous aider à créer un environnement pour vos
modules plug-in :
% album -create_plugin
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/new_txt_4 0000644 0000000 0000000 00000016353 12236175734 014422 0 ustar root root Fichiers de configuration
ITEM: Fichiers de configuration
Le comportement du script album peut tre control via des options en ligne
de commande comme :
% album -no_known_images% album -geometry 133x100% album -exif "Fichier : %File name% " -exif "pris avec %Camera make%"
Mais ces options peuvent aussi tre dfinies dans un fichier de configuration :
# Exemple de fichier de configuration # les commentaires sont ignors
known_images 0 # known_images=0 est la mme chose que no_known_images
geometry 133x100
exif "Fichier : %File name% "
exif "pris avec %Camera make%"
Le format du fichier de configuration est d'une option par ligne
ventuellement suivie par des espaces et la valeur de l'option. Les options
boolennes peuvent tre initialises sans valeur ou bien tre positionnes
avec 0 et 1.
ITEM: Localisation des fichiers de configuration
album recherche les fichiers de configuration dans quelques endroits ; dans
l'ordre :
/etc/album/conf Configuration valable pour l'ensemble du systme
/etc/album.conf Configuration valable pour l'ensemble du systme
$BASENAME/album.conf Dans le rpertoire d'installation d'album
$HOME/.albumrc Configuration dpendante de l'utilisateur
$HOME/.album.conf Configuration dpendante de l'utilisateur
$DOT/album.conf Configuration dpendante de l'utilisateur (je conserver mes fichiers "point" alleurs)
$USERPROFILE/album.conf Pour Windows (C:\Documents et Settings\Utilisateur)
album regarde galement des fichiers album.conf l'intrieur mme des
rpertoires de l'album photo courant.
Les sous-albums photos peuvent aussi disposer d'un fichier album.conf qui
modifiera la configuration de base des rpertoires parent (ceci vous permet,
par exemple, d'avoir plusieurs thmes pour des parties diffrentes de votre
album photo).
N'importe quel fichier album.conf dans le rpertoire de votre album photo
configurera l'album et tous les sous-albums moins qu'un autre fichier de
configuration album.conf ne soit trouv dans un sous-album.
Par exemple, considrons la configuration pour un album photo situ dans le
rpertoire 'images/album.conf' :
theme Dominatrix6
columns 3
Une autre configuration est trouve dans le rpertoire
'images/europe/album.conf' :
theme Blue
crop
album utilisera le thme Dominatrix6 pour l'album photo du rpertoire images/
et tous ses sous-albums except pour le sous-album images/europe/ qui
disposera du thme Blue. Toutes les images de l'album photo du rpertoire
images/ seront sur 3 colonnes y compris dans le sous-album images/europe/ car
ce paramtre y est inchang. Cependant, toutes les vignettes du sous-album
images/europe/ seront recadres du fait de la prsence de l'option 'crop' dans
le fichier de configuration.
ITEM: Sauvegarde des options
Ds que vous lancez le script album, les options en ligne de commande sont
sauvegardes dans un fichier album.conf situ l'intrieur du rpertoire de
votre album photo. Si un tel fichier existe dj, il sera modifi et non
remplac ce qui permet d'diter trs facilement ce fichier via un diteur de texte.
Ceci facilite l'usage ultrieur du script album. Par exemple, si vous gnrez
pour la premire fois un album photo avec :
% album -crop -no_known_images -theme Dominatrix6 -sort date images/
Alors la prochaine fois que vous appellerez album, vous aurez juste besoin de
taper :
% album images/
Ceci fonctionne galement pour les sous-albums photo :
% album images/africa/
trouvera aussi toutes les options sauvegardes.
Quelques options l'usage limit comme -add (ajouter un nouveau sous-album),
-clean (effacer les fichiers inutiles), -force (forcer la regnration d'un
album photo), -depth (prciser la profondeur c'est--dire le nombre de niveaux
de sous-albums sur laquelle s'applique la commande), etc... ne sont pas
sauvegardes pour des raisons videntes.
Lancer plusieurs fois album dans le mme rpertoire peut devenir confus si
vous ne comprenez pas comment les options sont sauvegardes.
Voici quelques exemples.
Introduction :
1) Les options en ligne de commande sont traits avant les options du fichier
de configuration trouv dans le rpertoire de l'album photo.
2) album utilisera les mmes options la prochaine fois que vous le lancez si
vous ne spcifiez aucune option.
Par exemple, si on suppose qu'on lance deux fois album dans un rpertoire :
% album -exif "commentaire 1" photos/espagne% album photos/espagne
La deuxime fois que vous utiliserez album, vous aurez toujours le
commentaire exif "commentaire 1" pour l'album photo de ce rpertoire.
3) album ne finira pas avec de multiples copies d'une mme option acceptant
plusieurs arguments si vous continuez l'appeler avec la mme ligne de
commande.
Par exemple :
% album -exif "commentaire 1" photos/espagne% album -exif "commentaire 1" photos/espagne
La deuxime fois que vous lancez album, vous n'aurez pas la fin plusieurs
copies du commentaire exif "commentaire 1" dans vos photos.
Cependant, veuillez noter que si vous re-prciser chaque fois les
mmes options, album pourrait tre plus lent s'excuter car il pensera
qu'il a besoin de regnrer vos fichiers html !
Ainsi par exemple, si vous lancez :
% album -medium 640x640 photos/espagne
(puis plus tard...)
% album -medium 640x640 photos/espagne
Alors la seconde fois regnrera inutilement toutes vos photos de taille
moyenne ("medium"). Ceci est beaucoup lent.
Il est donc prfrable de spcifier les options en ligne de commande
seulement la premire fois, puis d'utiliser ensuite la sauvegarde qui en a t
faite comme ici :
% album -medium 640x640 photos/espagne
(puis plus tard...)
% album photos/espagne
Malheureusement, ces contraintes signifient que, pour toutes les options
acceptant plusieurs arguments, les dernires valeurs entres se retrouveront
en dbut de liste comme sur l'exemple ci-dessous avec l'option -exif.
% album -exif "commentaire 1" photos/espagne% album -exif "commentaire 2" photos/espagne
Les commentaires seront en fait ordonns ainsi : "commentaire 2" puis
"commentaire 1".
Pour prciser l'ordre exact, vous aurez besoin de re-spcifier toutes les
options :
Soit en spcifiant de nouveau "commentaire 1" pour le remettre en premire
position dans la liste.
% album -exif "commentaire 1" photos/espagne
Ou juste en spcifiant toutes les options dans l'ordre que vous souhaitez :
% album -exif "commentaire 1" -exif "commentaire 2" photos/espagne
Quelques fois, il peut tre plus facile d'diter directement le fichier
album.conf afin d'y apporter les modifications souhaites.
Finalement, ceci nous permet seulement d'accumuler les options.
On peut effacer les options en utiliser -no et -clear (voir la section
correspondante Options), ces
modifications tant galement sauvegardes d'une utilisation une autre.
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/langmenu 0000644 0000000 0000000 00000001507 12661460265 014306 0 ustar root root English Deutsch Español Français Nederlands Русский Italiano magyar
album-4.17/Docs/fr/new_txt_2 0000644 0000000 0000000 00000015146 12236200334 014400 0 ustar root root MINI HOW-TO
ITEM: Simple album
En supposant que vous avez dj install album correctement, nous pouvons
raliser quelques manipulations basiques. Si vous rencontrez une erreur ou
un quelconque problme ici, regardez les documents d'installation.
Vous avez besoin d'un rpertoire accessible depuis le web o mettre vos
thmes et votre album photos. Nous utiliserons /home/httpd/test dans ce
document. Ce rpertoire a besoin d'tre accessible par le serveur web. Dans
cet exemple, nous utiliserons l'URL suivante :
http://myserver/test
Adaptez vos commandes / URLs en fonction de vos besoins.
Premirement, crez un rpertoire et mettez-y des images dedans. Nous
l'appellerons ainsi :
/home/httpd/test/Photos
Puis nous ajouterons quelques images dnommes 'IMG_001.jpg' 'IMG_004.jpg'.
Maintenant, pour ce test basique, lançons simplement album:
% album /home/httpd/test/Photos
Maintenant, vous pouvez visualiser l'album cr via un navigateur l'adresse :
http://myserver/test/Photos
ITEM: Ajouter des lgendes
Crez un fichier /home/httpd/test/Photos/captions.txt avec le contenu
suivants (utilisez la touche 'tab' si vous voyez " [tab] ") :
-- captions.txt ---------
IMG_001.jpg [tab] Nom de la première image
IMG_002.jpg [tab] Deuxième image
IMG_003.jpg [tab] Encore une image [tab] avec une légende!
IMG_004.jpg [tab] Dernière image [tab] avec une autre légende.
-------------------------
Puis lancer de nouveau la commande album :
% album /home/httpd/test/Photos
Vous verrez que la lgende a t modife.
Maintenant, crez un fichier avec du texte dedans :
/home/httpd/test/Photos/header.txt
Et relancez la commande album une fois de plus. Vous verrez alors le texte
du fichier affiche au sommet de la page.
ITEM: Masquer des photos
Il y a quelques moyens de masquer des photos / des fichiers / des rpertoires
mais nous allons utiliser le fichier des lgendes. Essayez de placer un
commentaire avec le caractre '#' devant le nom d'une image dans captions.txt:
-- captions.txt ---------
IMG_001.jpg [tab] Nom de la première image
#IMG_002.jpg [tab] Deuxième image
IMG_003.jpg [tab] Encore une image [tab] avec une légende!
IMG_004.jpg [tab] Dernière image [tab] avec une autre légende.
-------------------------
Relancez la commande album et vous verrez que l'image IMG_002.jpg a maintenant
disparu.
Si vous aviez procd de la sorte la premire fois, vous n'auriez gnr ni
l'image de taille rduite ni la vignette correspondante. Si vous le souhaitez,
vous pouvez les supprimer en utilisant l'option -clean :
% album -clean /home/httpd/test/Photos
ITEM: Utiliser un thme
Si les thmes ont t correctement installs and sont accessibles via
them_path (chemin d'accs aux thmes), alors vous pouvez utiliser un thme
lors de la gnration de votre album :
% album -theme Blue /home/httpd/test/Photos
L'album photo courant devrait tre maintenant bas sur le thme Blue (bleu).
S'il y a tout un tas de liens casss ou d'images qui n'apparaissent pas, il
y a de forte chance pour que votre thme n'ait pas t install dans un
rpertoire accessible depuis le web ; voir les documents d'installation.
Album sauvegarde les options que vous lui indiquez. Ainsi, la prochaine fois
que vous lancerez la commande album :
% album /home/httpd/test/Photos
vous utiliserez toujours le thme Blue. Pour dsactiver un thme, tapez :
% album -no_theme /home/httpd/test/Photos
ITEM: Images rduites
Les images de pleine taille sont en gnrale d'une taille trop imposante pour
un album photo sur le web. C'est pourquoi nous utiliserons des images rduites
sur les pages web gnres :
% album -medium 33% /home/httpd/test/Photos
Cependant, vous avez toujours accs aux images pleine taille en cliquant
simplement sur les images rduites.
La commande :
% album -just_medium /home/httpd/test/Photos
empchera la liaison entre les images de taille rduite et les images pleine
taille, en prsumant que nous avons lanc prcdemment une commande avec
l'option -medium.
ITEM: Ajouter des lgendes EXIF
Ajoutons la valeur du diaphragme dans les lgendes de chaque image.
% album -exif "<br>diaphragme=%Aperture%" /home/httpd/test/Photos
Cette commande ajoutera seulement la valeur du diaphragme pour les images qui
disposent de la balise exif (le symbole entre les caractres '%') 'Aperture'
signifiant diaphragme en franais ! Nous avons galement ajout la balise
<br> qui permet d'ajouter cette information exif sur une nouvelle ligne.
Nous pouvons rajouter d'autres informations exif :
% album -exif "<br>focale: %FocalLength%" /home/httpd/test/Photos
Parce que album sauvegarde vos prcdentes options, nous disposons maintenant
de deux balises exif pour toutes les images spcifiant la fois le diaphragme
et la focale.
Supprimons le diaphragme :
% album -no_exif "<br>diaphragme=%Aperture%" /home/httpd/test/Photos
La chane de caractres suivant l'option '-no_exif' a besoin de correspondre
exactement celle entre prcdemment avec l'option '-exif' sinon elle sera
ignore. Vous pouvez galement diter le fichier de configuration qu'album a
cr ici :
/home/httpd/test/Photos/album.conf
Puis supprimez l'option en question.
ITEM: Ajouter d'autres albums
Imaginons que vous faites un voyage en Espagne. Vous prenez des photos et les
mettez dans le rpertoire :
/home/httpd/test/Photos/Espagne/
Maintenant, excutez la commande album depuis le rpertoire principal :
% album /home/httpd/test/Photos
Cette commande modifiera l'album principal Photos qui sera reli Espagne
puis elle lancera galement la commande album sur le rpertoire Espagne avec
les mmes caractristiques / thme, etc.
Maintenant, faisons un autre voyage en Italie et crons le rpertoire :
/home/httpd/test/Photos/Italie/
Nous pourrions lancer la commande depuis le rpertoire principal :
% album /home/httpd/test/Photos
Mais ceci rescannerait le rpertoire Espagne qui n'a pas chang. Album ne
gnrera aucune page HTML ni vignette moins qu'il ait le besoin de la
faire. Cependant, il peut perdre du temps, plus particulirement si vos
albums photos deviennent de plus en plus volumineux. Aussi, vous pouvez
juste demander d'ajouter le nouveau rpertoire :
% album -add /home/httpd/test/Photos/Italie
Cette commande modifiera l'index de la premire page (dans Photos) et
gnrera l'album correspond au rpertorie Italie.
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/langhtml 0000644 0000000 0000000 00000001602 12661460265 014302 0 ustar root root
album-4.17/Docs/fr/Section_1.html 0000644 0000000 0000000 00000053433 12661460265 015274 0 ustar root root
MarginalHacks album - Installation
- Documentation
1: Configuration minimale
1) Le script Perl album
2) Les outils ImageMagick (et
plus particulièrement 'convert')
Mettez le script 'album' et les outils ImageMagick dans un répertoire
accessible via votre variable d'environnement PATH ou appelez 'album' avec son
chemin d'accès complet (en spécifiant également le chemin d'accès complet à
'convert' soit dans le script 'album' soit dans les fichiers de configuration
du script).
2: Configuration initiale
La première fois que vous lancerez 'album', celui-ci vous posera quelques
questions pour initialiser votre configuration.
Si votre machine tourne sous Unix / OSX, alors passez en mode administrateur
('root') et vous pourrez ainsi initialiser la configuration globale et les
thèmes pour l'ensemble des utilisateurs et pas seulement l'utilisateur
courant.
3: Installation optionnelle
3) Themes
4) ffmpeg (pour les
vignettes de films)
5) jhead (pour
lire les informations EXIF)
6) des plugins
7) de nombreux outils disponible sur
MarginalHacks.com
4: Unix
La plupart des distributions Unix sont fournies avec ImageMagick et
perl. Ainsi vous n'avez qu'à charger le script 'album' et les thèmes (voir les
points #1 et #3 ci-dessus) et c'est tout.
Pour tester votre installation, lancez le script dans un répertoire contenant
des images :
% album /path/to/my/photos/5: Debian Unix
Le script 'album' fait partie de la branche stable de la distribution Debian,
même si en ce moment...
Je recommande de télécharger la dernière version sur MarginalHacks. Sauvez le
paquetage .deb et, en mode administrateur (root), tapez :
% dpkg -i album.deb6: Macintosh OSX
Ceci marche bien également sur OSX mais vous devez utiliser une fenêtre de
programmation (console). Installez seulement le script 'album' et les outils
ImageMagick puis tapez, depuis l'endroit où se trouve le script, le nom du
script suivi des options du script que vous souhaitez et enfin le chemin d'accès
au répertoire où sont vos photos (le tout séparé par des espaces) comme par
exemple :
% album -theme Blue /path/to/my/photos/7: Win95, Win98, Win2000/Win2k, WinNT, WinXP
(Windows 95, Windows 98, Windows 2000, Windows NT, Windows XP)
Il y a deux façons pour exécuter un script perl depuis Windows : soit en
utilisant ActivePerl ou Cygwin.
ActivePerl est plus simple et vous permet de lancer 'album' depuis le prompt
du DOS. Cygwin est un paquetage plus hermétique pour le profane mais plus
robuste qui vous donne accès à tout un tas d'utilitaires "à la sauce Unix" :
le script 'album' est lancé depuis un prompt bash (environnement Unix).
Méthode via Cygwin
------------------
1) Installer Cygwin
Choisir les paquetages : perl, ImageMagick, bash
Ne pas utiliser directement l'installation normale d'ImageMagick !!! Vous devez
absolument utiliser les paquetages d'ImageMagick pour Cygwin !
2) Installer album dans le
répertoire du bash ou l'appeler en utilisant un chemin d'accès complet :
bash% album /some/path/to/photos
3) Si vous voulez afficher les informations exif dans vos légendes, vous avez
besoin de la version Cygwin de jhead.
Méthode via ActivePerl
----------------------
1) Installer ImageMagick pour
Windows
2) Installer ActivePerl,
installation complète ou Full install (pas besoin d'un profil PPM)
Choisir : "Ajouter perl à PATH" ("Add perl to PATH") et "Créer une
association avec les fichiers d'extension perl" ("Create Perl file extension association")
3) Pour Win98 : installer tcap
dans le chemin d'accès général
4) Sauvegarder le script 'album' sous le nom 'album.pl' dans le chemin d'accès
général de Windows
5) Utiliser une commande DOS pour taper :
C:> album.pl C:\some\path\to\photosNote : certains versions de Windows (2000/NT au-moins) disposent de leur
propre programme "convert.exe" localisé dans le répertoire c:\windows\system32
directory (un utilitaire NTFS ?).
Si vous avez un tel programme, alors vous avez besoin d'éditer votre variable
d'environnement PATH ou de spécifier complètement le chemin d'accès à
'convert' (celui d'ImageMagick) dans le script 'album'.
8: Comment puis-je éditer la variable d'environnement PATH sous Windows ?Utilisateurs de Windows NT4
Cliquer avec le bouton droit de la souris sur "Mon ordinateur" et
sélectionner Propriétés.
Sélectionner l'onglet "Environnement".
Dans la fenêtre "Variables du système", sélectionner la variable "Path".
Dans la fenêtre d'édition de la valeur de cette variable, ajouter les
nouveaux chemins d'accès séparés par des points virgules.
Presser le bouton "Ok / Mettre à jour" puis presser de nouveau "Ok"
Utilisateurs de Windows 2000
Cliquer avec le bouton droit de la souris sur "Mon ordinateur" et
sélectionner "Propriétés".
Sélectionner l'onglet "Réglages avancés".
Cliquer sur les "variables d'environnement".
Dans la fenêtre de sélection des variables d'environnement, double-cliquer
sur la variable "Path".
Dans la fenêtre d'édition de la valeur de cette variable, ajouter les
nouveaux chemins d'accès séparés par des points virgules.
Presser le bouton "Ok / Mettre à jour" puis presser de nouveau "Ok"
Utilisateurs Windows XP
Cliquer sur "Mon ordinateur" et sélectionner "Changer les propriétés".
Double-cliquer sur "Système".
Sélectionner l'onglet "Réglages avancés".
Cliquer sur les "variables d'environnement".
Dans la fenêtre de sélection des variables d'environnement, double-cliquer
sur la variable "Path".
Dans la fenêtre d'édition de la valeur de cette variable, ajouter les
nouveaux chemins d'accès séparés par des points virgules.
Presser le bouton "Ok"
9: Macintosh OS9
Je n'ai pas de plans pour réaliser un portage sur OS9 (je ne connais pas quels
sont les états des shells ni de perl pour les versions antérieures à OSX). If
vous avez réussi à faire tourner 'album' sur OS9, faites-le moi savoir.
10: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/txt_4 0000644 0000000 0000000 00000016541 12236405003 013531 0 ustar root root Fichiers de configuration
ITEM: Fichiers de configuration
Le comportement du script album peut être controlé via des options en ligne
de commande comme :
% album -no_known_images% album -geometry 133x100% album -exif "Fichier : %File name% " -exif "pris avec %Camera make%"
Mais ces options peuvent aussi être définies dans un fichier de configuration :
# Exemple de fichier de configuration # les commentaires sont ignorés
known_images 0 # known_images=0 est la même chose que no_known_images
geometry 133x100
exif "Fichier : %File name% "
exif "pris avec %Camera make%"
Le format du fichier de configuration est d'une option par ligne
éventuellement suivie par des espaces et la valeur de l'option. Les options
booléennes peuvent être initialisées sans valeur ou bien être positionnées
avec 0 et 1.
ITEM: Localisation des fichiers de configuration
album recherche les fichiers de configuration dans quelques endroits ; dans
l'ordre :
/etc/album/conf Configuration valable pour l'ensemble du système
/etc/album.conf Configuration valable pour l'ensemble du système
$BASENAME/album.conf Dans le répertoire d'installation d'album
$HOME/.albumrc Configuration dépendante de l'utilisateur
$HOME/.album.conf Configuration dépendante de l'utilisateur
$DOT/album.conf Configuration dépendante de l'utilisateur (je conserver mes fichiers "point" alleurs)
$USERPROFILE/album.conf Pour Windows (C:\Documents et Settings\Utilisateur)
album regarde également des fichiers album.conf à l'intérieur même des
répertoires de l'album photo courant.
Les sous-albums photos peuvent aussi disposer d'un fichier album.conf qui
modifiera la configuration de base des répertoires parent (ceci vous permet,
par exemple, d'avoir plusieurs thèmes pour des parties différentes de votre
album photo).
N'importe quel fichier album.conf dans le répertoire de votre album photo
configurera l'album et tous les sous-albums à moins qu'un autre fichier de
configuration album.conf ne soit trouvé dans un sous-album.
Par exemple, considérons la configuration pour un album photo situé dans le
répertoire 'images/album.conf' :
theme Dominatrix6
columns 3
Une autre configuration est trouvée dans le répertoire
'images/europe/album.conf' :
theme Blue
crop
album utilisera le thème Dominatrix6 pour l'album photo du répertoire images/
et tous ses sous-albums excepté pour le sous-album images/europe/ qui
disposera du thème Blue. Toutes les images de l'album photo du répertoire
images/ seront sur 3 colonnes y compris dans le sous-album images/europe/ car
ce paramètre y est inchangé. Cependant, toutes les vignettes du sous-album
images/europe/ seront recadrées du fait de la présence de l'option 'crop' dans
le fichier de configuration.
ITEM: Sauvegarde des options
Dès que vous lancez le script album, les options en ligne de commande sont
sauvegardées dans un fichier album.conf situé à l'intérieur du répertoire de
votre album photo. Si un tel fichier existe déjà, il sera modifié et non
remplacé ce qui permet d'éditer très facilement ce fichier via un éditeur de texte.
Ceci facilite l'usage ultérieur du script album. Par exemple, si vous générez
pour la première fois un album photo avec :
% album -crop -no_known_images -theme Dominatrix6 -sort date images/
Alors la prochaine fois que vous appellerez album, vous aurez juste besoin de
taper :
% album images/
Ceci fonctionne également pour les sous-albums photo :
% album images/africa/
trouvera aussi toutes les options sauvegardées.
Quelques options à l'usage limité comme -add (ajouter un nouveau sous-album),
-clean (effacer les fichiers inutiles), -force (forcer la regénération d'un
album photo), -depth (préciser la profondeur c'est-à-dire le nombre de niveaux
de sous-albums sur laquelle s'applique la commande), etc... ne sont pas
sauvegardées pour des raisons évidentes.
Lancer plusieurs fois album dans le même répertoire peut devenir confus si
vous ne comprenez pas comment les options sont sauvegardées.
Voici quelques exemples.
Introduction :
1) Les options en ligne de commande sont traités avant les options du fichier
de configuration trouvé dans le répertoire de l'album photo.
2) album utilisera les mêmes options la prochaine fois que vous le lancez si
vous ne spécifiez aucune option.
Par exemple, si on suppose qu'on lance deux fois album dans un répertoire :
% album -exif "commentaire 1" photos/espagne% album photos/espagne
La deuxième fois que vous utiliserez album, vous aurez toujours le
commentaire exif "commentaire 1" pour l'album photo de ce répertoire.
3) album ne finira pas avec de multiples copies d'une même option acceptant
plusieurs arguments si vous continuez à l'appeler avec la même ligne de
commande.
Par exemple :
% album -exif "commentaire 1" photos/espagne% album -exif "commentaire 1" photos/espagne
La deuxième fois que vous lancez album, vous n'aurez pas à la fin plusieurs
copies du commentaire exif "commentaire 1" dans vos photos.
Cependant, veuillez noter que si vous re-préciser à chaque fois les
mêmes options, album pourrait être plus lent à s'exécuter car il pensera
qu'il a besoin de regénérer vos fichiers html !
Ainsi par exemple, si vous lancez :
% album -medium 640x640 photos/espagne
(puis plus tard...)
% album -medium 640x640 photos/espagne
Alors la seconde fois regénérera inutilement toutes vos photos de taille
moyenne ("medium"). Ceci est beaucoup lent.
Il est donc préférable de spécifier les options en ligne de commande
seulement la première fois, puis d'utiliser ensuite la sauvegarde qui en a été
faite comme ici :
% album -medium 640x640 photos/espagne
(puis plus tard...)
% album photos/espagne
Malheureusement, ces contraintes signifient que, pour toutes les options
acceptant plusieurs arguments, les dernières valeurs entrées se retrouveront
en début de liste comme sur l'exemple ci-dessous avec l'option -exif.
% album -exif "commentaire 1" photos/espagne% album -exif "commentaire 2" photos/espagne
Les commentaires seront en fait ordonnés ainsi : "commentaire 2" puis
"commentaire 1".
Pour préciser l'ordre exact, vous aurez besoin de re-spécifier toutes les
options :
Soit en spécifiant de nouveau "commentaire 1" pour le remettre en première
position dans la liste.
% album -exif "commentaire 1" photos/espagne
Ou juste en spécifiant toutes les options dans l'ordre que vous souhaitez :
% album -exif "commentaire 1" -exif "commentaire 2" photos/espagne
Quelques fois, il peut être plus facile d'éditer directement le fichier
album.conf afin d'y apporter les modifications souhaitées.
Finalement, ceci nous permet seulement d'accumuler les options.
On peut effacer les options en utiliser -no et -clear (voir la section
correspondante Options), ces
modifications étant également sauvegardées d'une utilisation à une autre.
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/new_txt_8 0000644 0000000 0000000 00000025731 12236166650 014423 0 ustar root root Support des langues
ITEM: Utilisation des langues
(ncessite album v4.0 ou suprieur)
Album est fourni avec des fichiers de langues (nous avons besoin d'une aide
pour les traductions ; voyez ci-dessous !). Les fichiers de langues modifieront
la plupart des messages envoys par album, de mme que toutes les sorties HTML
qui ne sont pas gnrs par le thme.
Modifier tout le texte d'un thme pour qu'il corresponde votre langue est
aussi simple qu'diter les fichiers du thme. Il y a un exemple de ceci avec
le thme "simple-Czech".
Pour utiliser une langue, ajoutez l'option "lang" votre fichier principal
album.conf ou autrement, spcifiez-la lorsque vous gnrez votre album pour la
premire fois (elle sera sauve pour cet album par la suite).
Les langues peuvent tre effaces comme n'importe quelle option avec :
% album -clear_lang ...
Vous pouvez spcifier plusieurs langues, ce qui peut tre utile si une langue
est incomplte, mais vous voudriez une langue par dfaut autre que
l'anglais. Ainsi, par exemple, si vous voulez le hollandais comme langue
principal avec en secours le sudois chef [sic !], vous pourriez faire :
% album -lang swedish_chef -lang nl ...
Si vous spcifiez un sous-langage (tel que es-bo pour espagnol, Bolivie),
alors album essayera 'es' en premier comme langue de secours.
Notez qu' cause d'un bogue connu, vous devez spcifier toutes les langues
dsires en un seul coup plutt qu'au cours de plusieurs invocations d'album.
Pour voir quelles sont les langues disponibles :
% album -list_langs
Malheureusement, la plupart des langues sont tout juste compltes mais ceci
est une chance pour les personnes qui souhaiteraient nous aider pour devenir un...
ITEM: Traducteurs volontaires
Le projet album a besoin de volontaires pour raliser des traductions
principalement :
1) Le Mini How-To. Traduisez s'il vous plat partir de la source.
2) les messages d'album comme expliqu ci-dessous.
Si vous tes disposs traduire l'une ou les deux sections, contactez-moi
s'il vous plat !
Si vous vous sentez particulirement ambitieux, n'hsitez pas traduire
n'importe quelle section de la documentation en me le faisant savoir !
ITEM: Traduction de la documentation
Le document le plus important traduire est le "Mini How-To".
Traduisez-le s'il vous plat partir du texte original.
Veuillez galement me faire savoir comment vous souhaitez tre remerci, par
votre nom, un nom et une adresse lectronique ou un nom et un site internet.
Egalement, s'il vous plat, incluez l'orthographe et la distinction majuscule
/ minuscule adquates du nom de votre langue dans votre langue. Par
exemple, "franais" la place de "French".
Je suis ouvert toute suggestion concernant le jeu de caractres
utiliser. Les options actuelles sont :
1) Caractres HTML tel que [é]] (bien qu'ils ne fonctionnent que
dans les navigateurs)
2) Unicode (UTF-8) tel que [é] (seulement dans les navigateurs et dans
quelques terminaux)
3) Code ASCII, si possible, tel que [] (fonctionne dans les diteurs de
texte mais pas dans cette page configure avec le jeu de caractres unicode)
4) Code iso spcifique certaines langues comme le jeu iso-8859-8-I pour l'hbreu.
Actuellement, le jeu unicode (utf-8) semble tre le mieux plac pour les
langues qui ne sont pas couvertes par le jeu iso-8859-1 car il couvre toutes
les langues et nous aide grer les tradutions incompltes (qui autrement
ncessiteraient de multiples jeux de caractres ce qui serait un
dsastre). N'importe quel code iso qui est un sous-ensemble de l'utf-8 peut
tre utilis.
Si le terminal principal pour une langue donne a un jeu de caractres iso
la place de l'utf, alors cela peut tre une bonne raison d'utiliser un jeu de
caractres non-utf.
ITEM: Messages d'Album
album gre tous les textes de messages en utilisant son propre systme de
support de langue, similaire au systme utilis par le module perl Locale::Maketext.
(plus d'information sur l'inspiration du systme dans TPJ13)
Un message d'erreur, par exemple, peut ressembler ceci :
No themes found in [[some directory]].
Avec un exemple spcifique devenir :
No themes found in /www/var/themes.
En hollandais, ceci donnerait :
Geen thema gevonden in /www/var/themes.
La "variable" dans ce cas est "/www/var/themes" et n'est videmment pas
traduite. Dans album, le vrai message d'erreur ressemble cela :
'No themes found in [_1].'
# Args: [_1] = $dir
La traduction (en hollandais) ressemble ceci :
'No themes found in [_1].' => 'Geen thema gevonden in [_1].'
Aprs la traduction, album remplacera [_1] par le nom du rpertoire.
Il y a parfois plusieurs variables pouvant changer de position :
Quelques exemples de messages d'erreur :
Need to specify -medium with -just_medium option.
Need to specify -theme_url with -theme option.
En hollandais, le premier donnerait :
Met de optie -just_medium moet -medium opgegeven worden.
Le message d'erreur rel avec sa traduction en hollandais est :
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet [_1] opgegeven worden'
# Args: [_1]='-medium' [_2]='-just_medium'
Note que les variables ont chang de position.
Il y a aussi des oprateurs spciaux pour les quantits. Par exemple, nous
souhaitons traduire :
'I have 42 images'
ou le nombre 42 peut changer. En anglais, il est correct de dire :
0 images, 1 image, 2 images, 3 images...
alors qu'en hollandais nous aurons :
0 afbeeldingen, 1 afbeelding, 2 afbeeldingen, 3 afbeeldingen..
Mais d'autres langues (telles que des langues slaves) peuvent avoir des rgles
spciales quant savoir si "image" doit tre au pluriel en fonction de la
quantit demande 1, 2, 3 ou 4 etc ! Le cas le plus simple est couvert par
l'oprateur [quant] :
[quant,_1,image]
Ceci est similaire "[_1] image" except que "image" sera mis au pluriel si
[_1] est 0 ou plus grand que 1 :
0 images, 1 image, 2 images, 3 images...
La forme plurielle s'obtient simplement en ajoutant un 's'. Si cela n'est pas
correct, nous pouvons spcifier la forme plurielle :
[quant,_1,afbeelding,afbeeldingen]
qui nous donne le dcompte en hollandais voqu plus haut.
Et si nous avons besoin d'une forme spcifique pour 0, nous pouvons le
spcifier :
[quant,_1,directory,directories,no directories]
ce qui donnerait :
no directories, 1 directory, 2 directories, ...
Il y a aussi un raccourci pour [quant] en utilisant '*' d'o les quivalences
:
[quant,_1,image]
[*,_1,image]
Finalement, voici un exemple de traduction pour un nombre d'images :
'[*,_1,image]'
=> '[*,_1,afbeelding,afbeeldingen]',
Si vous avez quelque chose de plus compliqu alors vous pouvez utiliser du
code perl. Je peux vous aider l'crire si vous m'indiquez comment la
traduction doit fonctionner :
'[*,_1,image]'
=> \&russian_quantity; # Ceci est une sous-routine dfinie quelque part
Puisque les chanes traduites sont (gnralement) places entre des
apostrophes (') et aussi cause des codes spciaux entre [crochets], nous
avons besoin de les citer correctement.
Les apostrophes dans une chane ont besoin d'tre prcdes par une barre
oblique ou slash en anglais (\) :
'I can\'t find any images'
et les crochets sont cits en utilisant le tilda (~) :
'Problem with option ~[-medium~]'
ce qui malheureusement peut devenir assez dplaisant si la chose l'intrieur
des crochets est une variable :
'Problem with option ~[[_1]~]'
Soyez prudent et vrifiez que tous les crochets sont ferms de faon
approprie.
De plus, dans presque tous les cas, la traduction devrait avoir le mme nombre
de variables que le message original :
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet' # <- O est pass [_1] ?!?
Heureusement, la plupart du travail est faite pour vous. Les fichiers de
langue sont sauvs dans le rpertoire spcifi par l'option -data_path (ou
-lang_path) o album stocke ses donnes. Ce sont essentiellement du code perl
et ils peuvent tre auto-gnrs par album :
% album -make_lang sw
Cette commande crera un nouveau fichier de langue vide dnomm'sw'
(sudois). Allez de l'avant en ditant ce fichier et en ajoutant autant de
traductions que vous pouvez. Les traductions laisses vides sont tolres :
elles ne seront simplement pas utilises. Les traductions parmi les plus
importantes (comme celles qui sont affiches dans les pages HTML) se trouvent
au sommet du fichier et devraient probablement tre traduite en premier.
Choisir un jeu de caractres n'est pas chose aise car il devrait tre bas
sur les jeux de caractres que vous pensez que les gens sont susceptibles
d'avoir disposition aussi bien dans leur terminal que dans leur navigateur.
Si vous voulez construire un nouveau fichier de langue en utilisant une
traduction provenant d'un fichier existant (par exemple pour mettre jour une
langue avec les nouveaux messages qui ont t ajouts dans album), vous devez
d'abord charg la langue en premier :
% album -lang sw -make_lang sw
Toutes les traductions dans le fichier de langue sudois courant seront
copies vers le nouveau fichier (quoique les commentaires et autre code ne
soient pas copis).
Pour les trs longues lignes de texte, ne vous faites pas de souci en ajoutant
des caractres de fin de ligne (\n) except s'ils existent dans le message
original : album grera de faon approprie les sections de texte les plus longues.
Contactez-moi s'il vous plat quand vous commencez un travail de
traduction. Ainsi je peux tre sre que nous n'avons pas deux traducteurs
travaillant sur les mmes parties. Et soyez sre de m'envoyer des mises jour
des fichiers de langue au fur et mesure des progrs ; mme s'ils sont
incomplets, ils sont utiles !
Si vous avez des questions propos de la faon de lire la syntaxe des
fichiers de langue, faites-le moi savoir s'il vous plat.
ITEM: Pourquoi vois-je toujours des termes anglais ?
Aprs avoir chois une autre langue, vous pouvez toujours parfois voir des
termes en anglais :
1) Les noms des options sont toujours en anglais. (-geometry est toujours
-geometry)
2) La chane courante n'est actuellement pas traduite.
3) Il est peu probable que la sortie d'un module plug-in soit traduite.
4) Les fichiers de langue ne sont pas toujours complet et ne traduiront
uniquement que ce qu'ils connaissent.
5) album peut avoir de nouveaux messages que le fichier de langue ne connat
encore pas.
6) La plupart des thmes sont en anglais.
Heureusement, ce dernier est le plus simple changer. Editer simplement le
thme et remplacer les portions de texte HTML avec n'importe quelle langue que
vous souhaitez ou crez de nouveau graphique dans une langue diffrentes pour
les icnes en anglais.
Si vous crez un nouveau thme, je serais ravi de le savoir !
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/new_txt_1 0000644 0000000 0000000 00000015163 12236201174 014401 0 ustar root root Installation
ITEM: Configuration minimale
1) Le script Perl album
2) Les outils ImageMagick (et
plus particulirement 'convert')
Mettez le script 'album' et les outils ImageMagick dans un rpertoire
accessible via votre variable d'environnement PATH ou appelez 'album' avec son
chemin d'accs complet (en spcifiant galement le chemin d'accs complet
'convert' soit dans le script 'album' soit dans les fichiers de configuration
du script).
ITEM: Configuration initiale
La premire fois que vous lancerez 'album', celui-ci vous posera quelques
questions pour initialiser votre configuration.
Si votre machine tourne sous Unix / OSX, alors passez en mode administrateur
('root') et vous pourrez ainsi initialiser la configuration globale et les
thmes pour l'ensemble des utilisateurs et pas seulement l'utilisateur
courant.
ITEM: Installation optionnelle
3) Themes
4) ffmpeg (pour les
vignettes de films)
5) jhead (pour
lire les informations EXIF)
6) des plugins
7) de nombreux outils disponible sur
MarginalHacks.com
ITEM: Unix
La plupart des distributions Unix sont fournies avec ImageMagick et
perl. Ainsi vous n'avez qu' charger le script 'album' et les thmes (voir les
points #1 et #3 ci-dessus) et c'est tout.
Pour tester votre installation, lancez le script dans un rpertoire contenant
des images :
% album /path/to/my/photos/
ITEM: Debian Unix
Le script 'album' fait partie de la branche stable de la distribution Debian,
mme si en ce moment...
Je recommande de tlcharger la dernire version sur MarginalHacks. Sauvez le
paquetage .deb et, en mode administrateur (root), tapez :
% dpkg -i album.deb
ITEM: Macintosh OSX
Ceci marche bien galement sur OSX mais vous devez utiliser une fentre de
programmation (console). Installez seulement le script 'album' et les outils
ImageMagick puis tapez, depuis l'endroit o se trouve le script, le nom du
script suivi des options du script que vous souhaitez et enfin le chemin d'accs
au rpertoire o sont vos photos (le tout spar par des espaces) comme par
exemple :
% album -theme Blue /path/to/my/photos/
ITEM: Win95, Win98, Win2000/Win2k, WinNT, WinXP
(Windows 95, Windows 98, Windows 2000, Windows NT, Windows XP)
Il y a deux faons pour excuter un script perl depuis Windows : soit en
utilisant ActivePerl ou Cygwin.
ActivePerl est plus simple et vous permet de lancer 'album' depuis le prompt
du DOS. Cygwin est un paquetage plus hermtique pour le profane mais plus
robuste qui vous donne accs tout un tas d'utilitaires " la sauce Unix" :
le script 'album' est lanc depuis un prompt bash (environnement Unix).
Mthode via Cygwin
------------------
1) Installer Cygwin
Choisir les paquetages : perl, ImageMagick, bash
Ne pas utiliser directement l'installation normale d'ImageMagick !!! Vous devez
absolument utiliser les paquetages d'ImageMagick pour Cygwin !
2) Installer album dans le
rpertoire du bash ou l'appeler en utilisant un chemin d'accs complet :
bash% album /some/path/to/photos
3) Si vous voulez afficher les informations exif dans vos lgendes, vous avez
besoin de la version Cygwin de jhead.
Mthode via ActivePerl
----------------------
1) Installer ImageMagick pour
Windows
2) Installer ActivePerl,
installation complte ou Full install (pas besoin d'un profil PPM)
Choisir : "Ajouter perl PATH" ("Add perl to PATH") et "Crer une
association avec les fichiers d'extension perl" ("Create Perl file extension association")
3) Pour Win98 : installer tcap
dans le chemin d'accs gnral
4) Sauvegarder le script 'album' sous le nom 'album.pl' dans le chemin d'accs
gnral de Windows
5) Utiliser une commande DOS pour taper :
C:> album.pl C:\some\path\to\photosNote : certains versions de Windows (2000/NT au-moins) disposent de leur
propre programme "convert.exe" localis dans le rpertoire c:\windows\system32
directory (un utilitaire NTFS ?).
Si vous avez un tel programme, alors vous avez besoin d'diter votre variable
d'environnement PATH ou de spcifier compltement le chemin d'accs
'convert' (celui d'ImageMagick) dans le script 'album'.
ITEM: Comment puis-je diter la variable d'environnement PATH sous Windows ?
Utilisateurs de Windows NT4
Cliquer avec le bouton droit de la souris sur "Mon ordinateur" et
slectionner Proprits.
Slectionner l'onglet "Environnement".
Dans la fentre "Variables du systme", slectionner la variable "Path".
Dans la fentre d'dition de la valeur de cette variable, ajouter les
nouveaux chemins d'accs spars par des points virgules.
Presser le bouton "Ok / Mettre jour" puis presser de nouveau "Ok"
Utilisateurs de Windows 2000
Cliquer avec le bouton droit de la souris sur "Mon ordinateur" et
slectionner "Proprits".
Slectionner l'onglet "Rglages avancs".
Cliquer sur les "variables d'environnement".
Dans la fentre de slection des variables d'environnement, double-cliquer
sur la variable "Path".
Dans la fentre d'dition de la valeur de cette variable, ajouter les
nouveaux chemins d'accs spars par des points virgules.
Presser le bouton "Ok / Mettre jour" puis presser de nouveau "Ok"
Utilisateurs Windows XP
Cliquer sur "Mon ordinateur" et slectionner "Changer les proprits".
Double-cliquer sur "Systme".
Slectionner l'onglet "Rglages avancs".
Cliquer sur les "variables d'environnement".
Dans la fentre de slection des variables d'environnement, double-cliquer
sur la variable "Path".
Dans la fentre d'dition de la valeur de cette variable, ajouter les
nouveaux chemins d'accs spars par des points virgules.
Presser le bouton "Ok"
ITEM: Macintosh OS9
Je n'ai pas de plans pour raliser un portage sur OS9 (je ne connais pas quels
sont les tats des shells ni de perl pour les versions antrieures OSX). If
vous avez russi faire tourner 'album' sur OS9, faites-le moi savoir.
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/txt_3 0000644 0000000 0000000 00000045462 12236405003 013534 0 ustar root root Utiliser album / Options de base
ITEM: Exécution basique
Créez un répertoire contenant uniquement des images. Le script album et
les autres outils ne doivent pas se trouver dans ce répertoire. Lancez
la commande album en précisant ce répertoire :
% album /exemple/chemin/vers/les/images
Ou, si vous êtes déjà dans le répertoire exemple/chemin/vers/les/images :
% album images/
Quand l'opération est terminée, vous aurez un album photo à l'intérieur
de ce répertoire avec comme fichier d'entrée index.html.
Si ce chemin fait partie de votre serveur web, alors vous pourrez
visualiser votre album photos à partir de votre navigateur. Si vous
ne le trouvez pas, contactez votre administrateur système.
ITEM: Options
Il y a trois types d'options: options booléennes (vrai / faux), options
acceptant des chaînes de caractères ou des numéros et options acceptant
plusieurs arguments. Les options booléennes peuvent être désactivées en
les préfixant avec -no_ :
% album -no_image_pages
Les chaînes de caractères et les nombres sont entrés après une option :
% album -type gif
% album -columns 5
Les options acceptant plusieurs arguments peuvent être utilisées de
deux manières. La première avec un argument à la fois :
% album -exif hi -exif there
ou avec plusieurs arguments en utilisant la syntaxe '--' :
% album --exif hi there --
Vous pouvez supprimer une valeur particulière d'une option à plusieurs
arguments avec -no_<option> suivi du nom de l'argument et effacer
tous les arguments d'une telle option avec -clear_<option>.
Pour effacer tous les arguments d'une option acceptant plusieurs arguments
(provenant par exemple d'une précédente utilisation de la commande album) :
% album -clear_exif -exif "new exif"
(l'option -clear_exif effacera les anciens arguments de l'option exif puis
l'option -exif suivante permettra d'ajouter un nouveau commentaire dans
la section exif).
Et pour terminer, vous pouvez supprimer un argument particulier d'une option
à plusieurs arguments avec 'no_' :
% album -no_exif hi
supprimera la valeur 'hi' et laissera intacte la valeur 'there' de l'option
exif.
Voir également la section sur Sauvegarde des options.
Pour voir une courte page d'aide :
% album -h
Pour voir davantage d'options :
% album -more
Et pour avoir encore plus d'options :
% album -usage=2
Vous pouvez spécifier un nombre plus grand que 2 pour voir encore davantage
d'options (jusqu'à 100).
Les modules de plug-in peuvent aussi disposer d'options pour leur propre
usage.
ITEM: Thèmes
Les thèmes sont une composante essentielle qui rend album attrayant. Vous
pouvez particulariser le look de votre album photo en téléchargeant un
thème depuis le site MarginalHacks ou même écrire votre propre thème en
phase avec votre site web.
Pour utiliser un thème, téléchargez l'archive correspondante du thème au
format .tar ou .zip et installez-là.
Les thèmes sont spécifiés grâce à l'option -theme_path qui permet d'indiquer
les endroits où sont stockées les thèmes. Ces chemins sont nécessairement
quelque part sous la racine du répertoire de votre site web mais pas à
l'intérieur même de votre album photo. De plus, ces chemins doivent être
accessible depuis un navigateur.
Vous pouvez rajouter un thème dans l'un des chemins spécifié par l'option
theme_path et utilisé par album ou créer un nouveau thème et indiquer son
chemin d'accès avec cette option (le répertoire indiqué par l'option
-theme_path est celui où se trouve le thème et pas le répertoire du thème
lui-même).
Par la suite, appelez album avec l'option -theme accompagnée ou non de
-theme_path:
% album -theme Dominatrix6 mes_photos/
% album -theme Dominatrix6 -theme_path /home/httpd/album/Themes/ mes_photos/
Vous pouvez également créer vos propres thèmes très facilement. Ce sujet est
abordé un peu plus loin dans cette documentation.
ITEM: Sous-albums
Créez des répertoires dans votre répertoire créé précedemment et mettez-y
des images. Lancez une nouvell fois album : vos sous-répertoires seront
explorés et donneront naissance à des sous-albums du premier album.
Si vous apportez des modifications dans un seul sous-album, vous pouvez
exécuter album uniquement sur ce sous-album ; les liens avec l'album
parent seront conservés.
Si vous ne souhaitez pas descendre dans l'arborescence des répertoires,
vous pouvez limiter la profondeur du niveau d'exploration avec l'option
-depth. Exemple :
% album images/ -depth 1
Cette commande ne générera qu'un album photo pour les images du
répertoire courant.
Si vous avez plusieurs sous-albums et que vous voulez ajouter un nouveau
sous-album sans regénérer les autres, alors utilisez l'option -add :
% album -add images/nouvel_album/
Ceci ajoutera nouvel_album à la page HTML pour 'images/' et créera
ensuite les vignettes et les pages HTML pour toutes les données contenues
dans 'images/nouvel_album'.
ITEM: Eviter la regénération des vignettes
album essaie d'éviter au maximum le travail inutile. Il ne crée seulement
des vignettes que si elles n'existent pas et n'ont pas été modifiées. Ceci
permet d'accélérer les traitements successifs d'album.
Cependant, cela peut provoquer un problème si vous changez la taille ou
recadrez vos vignettes car album ne réalisera pas que ces dernières ont
changées. Pour forcer la regénération des vignettes, utilisez l'option
-force :
% album -force images/
Mais vous ne devriez pas avoir besoin d'utiliser l'option -force à chaque
fois.
ITEM: Nettoyer les vignettes
Si vous supprimez une image de votre album, alors vous laisserez des
vignettes et des pages HTML. Pour les supprimer, lancer album avec
l'option -clean :
% album -clean images/
ITEM: Taille d'images moyenne
Quand vous cliquez sur la vignette d'un album, vous êtes dirigés vers
une page spécifique à cette image. Par défaut, cette page affiche l'image
en taille réelle ainsi que les boutons de navigation, les légendes et
tout le toutim. Quand vous cliquez sur l'image de cette page, l'URL
pointe alors uniquement sur l'image en taille réelle.
Si vous voulez avoir une image de taille réduite sur la page affichant
cette image, utilisez l'option -medium en précisant la géométrie que vous
souhaitez obtenir. Vous pouvez utiliser toutes les géométries supportées
par ImageMagick (voir la page man de cet outil pour de plus amples détails).
Par exemple :
# Une image faisant la moitié de la taille réelle
% album -medium 50%
# Une image qui s'insère dans 640x480 (taille maximale)
% album -medium 640x480
# Une image qui est réduite pour s'insérer dans 640x480
# (mais qui ne sera pas élargie si elle est déjà plus petite que 640x480)
% album -medium '640x480>'
Les caractères de 'quotation' du dernier exemple seront obligatoires sur
la plupart des systèmes à cause de la présence du caractère '>'.
ITEM: Légendes
Les images et les vignettes peuvent avoir des noms et des légendes. Il y a
plusieurs moyens de préciser / changer les noms et les légendes dans vos
albums photo.
Le nom est
lié à l'image ou à la page qui l'héberge et la légende suit juste en dessous.
Le nom par défaut est le fichier nettoyé :
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
Un moyen de préciser une légende est d'utiliser un fichier texte avec le
même nom que l'image mais l'extension .txt. Par exemple,
"Kodi_Cow.txt" pourrait contenir "Kodi takes down a cow! ("Kodi
maîtrise une vache !")
Vous pouvez renommer vos images et spécifier toutes les légendes d'un
répertoire avec un fichier captions.txt.
Chaque ligne du fichier doit être le nom d'une image ou d'un
répertoire, suivi par une tabulation, suivi par le nouveau
nom. Vous pouvez aussi spécifier (séparé par une tabulation), une légende
optionnelle puis un tag ALT, optionnel également, pour l'image. Pour sauter
un champ, utilisez 'tabulation' 'espace' 'tabulation'.
Exemple :
001.gif Ma première photo
002.gif Maman et Papa dans le grand canyon
003.gif Ani DiFranco ma fiancée Whaou !
Les images et les répertoires sont listés dans l'ordre dans lequel ils
sont trouvés dans le fichier de légende. Vous pouvez modifier ce tri avec
les options '-sort date' et '-sort name'.
Si votre éditeur de texte ne gère pas très bien les tabulations, vous
pouvez séparer les champs par un double deux-points mais .b/seulement
si votre légende ne contient aucune tabulation :
003.gif :: Ani DiFranco :: Ma fiancée :: Whaou !
Si vous ne souhaitez avoir des légendes que sur les pages contenant les
images (et pas sur les pages affichant les albums), utilisez :
% album -no_album_captions
Si vous voulez créer ou éditer vos légendes depuis un accès web, regardez
le script CGI caption_edit.cgi (mais soyez sûr de limiter l'accès à ce
script sinon n'importe qui pourra modifier vos légendes).
ITEM: Légendes EXIF
Vous pouvez également préciser des légendes extraites des informations
EXIF (Exchangeable Image File Format) ajoutées aux images par la plupart
des appareils photo numériques.
Mais tout d'abord, vous avez besoin d'installer 'jhead'. Vous pouvez,
par exemple, lancer jhead sur un fichier au format jpeg (.jpg ou .jpeg)
et ainsi voir les commentaires et informations affichés.
Les légendes EXIF sont ajoutés à la suite des légendes normales et sont
spécifiés à l'aide de l'option -exif :
% album -exif "<br>Fichier: %File name% pris avec %Camera make%"
Tous les %tags% trouvés seront remplacées par les informations EXIF
correspondantes. Si des %tags% ne sont pas trouvés dans les informations
EXIF, alors la légende EXIF est ignorée. A cause de ce comportement, vous
pouvez multiplier les arguments passés à l'option -exif :
% album -exif "<br>Fichier: %File name% " -exif "pris %Camera make%"
De la sorte, si le tag 'Camera make' n'est pas trouvé, vous pourrez toujours
avoir la légende relative au tag 'File name'.
De la même façon que pour toutes les options acceptant plusieurs arguments,
vous pouvez utiliser la syntaxe --exif :
% album --exif "<br>Fichier: %File name% " "pris avec %Camera make%" --
Comme montré dans l'exemple, il est possible d'inclure des balises HTML dans
vos légendes EXIF :
% album -exif "<br>Ouverture: %Aperture%"
Afin de voir la liste des tags EXIF possible (Résolution, Date / Heure,
Ouverture, etc...), utilisez un programme comme 'jhead' sur une image issue
d'un appareil photo numérique.
Vous pouvez également préciser des légendes EXIF uniquement pour les albums
ou les pages affichant une image. Voir les options -exif_album et
-exif_image.
ITEM: En-têtes et pieds-de-page
Dans chaque répertoire abritant un album, vous pouvez avoir des fichiers texte
header.txt and footer.txt.
Ces fichiers seront copiés tels quels dans l'en-tête et le pied-de-page
de votre album (si cette fonctionnalité est supportée par votre thème).
ITEM: Masquer des Fichiers / des Répertoires
Chaque fichier non reconnu par album comme étant une image est ignoré.
Pour afficher ces fichiers, utilisez l'option -no_known_images (l'option
par défaut est -known_images).
Vous pouvez marquer une image comme n'étant pas une image en éditant un
fichier vide avec le même et l'extension .not_img ajoutée à la fin.
Vous pouvez ignorer complètement un fichier en créant un fichier vide avec
le même nom et l'extension .hide_album ajoutée à la fin.
Vous pouvez éviter de parcourir un répertoire complet (bien qu'étant
toujours inclus dans la liste de vos répertoires) en créant un fichier
<dir>/.no_album.
Vous pouvez ignorer complètement des répertoires créant un fichier
<dir>/.hide_album
La version pour Windows d'album n'utilise pas le . pour no_album,
hide_album et not_img car il est difficile de créer des
.fichiers dans Windows.
ITEM: Recadrer les images
Si vos images comportent un large éventail de ratios (c'est-à-dire autres
que les traditionnels ratios portrait / paysage) ou si votre thème ne
supporte qu'une seule orientation, alors vos vignettes peuvent être
recadrées afin qu'elles partagent toutes la même géométrie :
% album -crop
Le recadrage par défaut est de recadrer l'image au centre. Si vous n'aimez
pas le recadrage central utilisé par album pour générer les vignettes, vous
pouvez donner des directives à album afin de spécifier où recadrer des
images spécifiques. Pour cela, il suffit de changer le nom du fichier
contenant l'image pour qu'il ait la directive de recadrage juste avant
l'extension. Vous pouvez ainsi demander à album de recadrer l'image en haut,
en bas, à droite ou à gauche. Par exemple, supposons que nous ayons un
portrait "Kodi.gif" que vous voulez recadrer au sommet de votre vignette.
Renommez le fichier en "Kodi.CROPtop.gif" et c'est tout (vous pouvez
évenutellement utiliser l'option -clean pour supprimer l'ancienne
vignette). La chaîne de caractères précisant le recadrage sera supprimée
du nom affiché dans votre navigateur.
La géométrie par défaut est 133x133. De cette façon, les images en position
paysage auront des vignettes au format 133x100 et les images en position
portrait auront des vignettes au format 100x133. Si vous utilisez le
recadrage et souhaitez que vos vignettes aient toujours le même ratio que
les photos numériques; alors essayez 133x100 :
% album -crop -geometry 133x100
Souvenez-vous que si vous recadrez ou changez la géométrie d'un album
précédemment généré, vous devrez utiliser l'option -force une fois afin
de regénérer complètement toutes vos vignettes.
ITEM: Film vidéo
album peut générer des vignettes issues de prise instantanée pour de
nombreux formats vidéo si vous installez ffmpeg.
Si vous êtes sur un système linux sur une architecture x86, vous n'avez qu'à
télécharger le fichier exécutable, ou autrement, télécharger le
paquetage complet depuis ffmpeg.org (c'est très facile d'installation).
ITEM: Graver des CDs (en utilisant file://)
Si vous utilisez album pour graver des CDs ou si vous souhaitez accèder
à vos albums depuis votre navigateur avec le protocole file://, alors
vous ne voulez pas qu'album suppose que le fichier "index.html" soit
la page principale puisque votre navigateur ne le saura probablement pas.
De plus, si vous utilisez des thèmes, vous devez utiliser des
chemins d'accès relatifs. Vous ne pouvez pas utiliser l'option
-theme_url car vous ne savez pas où sera l'URL final. Sur Windows, le
chemin d'accès aux thèmes pourrait être "C:/Themes" ou sous UNIX ou OSX,
il pourrait être quelque chose comme "/mnt/cd/Themes", tout dépendant
de la façon dont le CD a été monté.
Pour résoudre ces cas de figure, utilisez l'option -burn :
% album -burn ...
Ceci implique que les chemins d'accès de l'album vers les thèmes ne
change pas. Le meilleur moyen de faire ceci consiste à prendre le
répertoire racine que vous allez graver et d'y mettre vos thèmes et votre
album puis de spécifier le chemin complet vers le thème. Par exemple,
créez les répertoires :
monISO/Photos/
monISO/Themes/Blue
Puis vous lancez :
% album -burn -theme monISO/Themes/Blue monISO/Photos
Ensuite, vous pouvez créer une image ISO depuis le répertoire mon ISO (ou
plus haut).
Les utilisateurs Windows peuvent également jeter un oeil sur shellrun
qui permet de lancer automatiquement l'album dans le navigateur. (Ou
voyez aussi winopen).
ITEM: Indexer entièrement votre album
Pour naviguer sur un album entièrement compris sur une page, utilisez l'outil
caption_index.
Il utilise les mêmes options qu'album (bien qu'il en ignore la plupart) de
telle sorte que vous pouvez remplacer l'appel à "album" par "caption_index".
La sortie est la page HTML de l'index de l'album complet.
Regardez l'index d'exemple réalisé à partir d'un de mes albums photo d'exemple
ITEM: Mettre à jour des albums avec CGI
Premièrement, vous avez besoin de charger vos photos dans le répertoire
de l'album. Je vous suggère d'utiliser ftp pour faire cette manipulation.
Vous pouvez aussi écrire un script java qui chargerait les fichiers. Si
quelqu'un pouvait me montrer comment faire, j'apprécierais beaucoup.
Ensuite, vous avez besoin de pouvoir exécuter album à distance. Pour éviter
les abus, je vous conseille de mettre en place un script CGI qui crée
un fichier bidon (ou qui transfère ce fichier via ftp) et d'avoir un
cron job (process tournant en arrière plan) qui teste régulièrement
à quelques minutes d'intervalle si ce fichier est présent et, s'il l'est,
de le supprimer et de lancer album. Cette méthode ne fonctionne que sous
unix et vous aurez sûrement besoin de modifier votre variable
d'environnement $PATH ou d'utiliser des chemins absolus dans le script
pour la conversion).
Si vous souhaitez une gratification immédiate, vous pouvez lancer album
depuis un script CGI comme celui-ci.
Si l'utilisateur du serveur web n'est pas le propriétaire des photos, vous
aurez besoin d'utiliser un script setuid via CGI [toujours pour unix
seulement].
Mettez ce script setuid dans un emplacement protégé, changez son propriétaire
pour qu'il soit le même que celui de vos photos et lancez la commande
"chmod ug+s" sur le script. Vous trouverez ici des exemples de scripts
setui et CGI. N'oubliez pas de les éditer.
Regardez également caption_edit.cgi
qui vous permet (ou une autre personne) d'éditer les légendes / noms /
en-têtes / pieds-de-pages à travers le web.
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/txt_6 0000644 0000000 0000000 00000056453 12236405003 013541 0 ustar root root Création de thèmes
ITEM: Métodes
Il y a des moyens faciles et d'autres compliqués pour créer un thème sur
mesure en fonction de ce que vous voulez faire.
ITEM: Editer le code HTML d'un thème existant
Si vous voulez juste modifier légèrement un thème afin qu'il corresponde à
l'environnement de votre site, il semble opportun d'éditer un thème existant.
Dans le répertoire du thème, il y a deux fichiers avec l'extension
th. album.th est le patron pour les pages de l'album (les pages des vignettes)
et image.th est le patron pour les pages des images (où vous voyez les images
moyennement réduites ou en pleine taille). Ces fichiers sont très similaire à
du code HTML excepté quelques rajouts de code <: ePerl :>. Même si vous ne
connaissez ni Perl ni ePerl, vous pouvez néanmoins éditer le code HTML pour y
apporter des changements basiques.
Des thèmes pour bien démarrer :
N'importe quel thème dans simmer_theme peut servir comme "Blue" ou "Maste". Si
vous avez seulement besoin de 4 bordures aux coins de vos vignettes, alors
jetez un oeil sur "Eddie Bauer". Si vous voulez des bordures transparentes ou
qui se recouvrent, regardez "FunLand".
Si vous voulez quelque chose avec un minimum de code, essayez "simple" mais
attention, je n'ai pas mis à jour ce thème depuis un bon bout de temps.
ITEM: Le moyen facile : simmer_theme pour les graphiques
La plupart des thèmes ont un même format basique, montrent une série de
vignettes pour des répertoires puis pour des images avec une bordure et une
ligne graphiques ainsi qu'un fond d'écran. Si c'est ce que vous voulez mais
que vous souhaitez créer de nouveaux graphiques, il y a un outil qui vous
permettra de construire des thèmes.
Si vous créez un répertoire avec des images et un fichier CREDIT ainsi qu'un
fichier Font ou Style.css, alors l'utilitaire simmer_theme vous permettra de
réaliser des thèmes.
Fichiers :
Font/Style.css
Ce fichier détermine les fontes utilisées par le thème. Le fichier "Font" est
le plus ancien système, décrit ci-dessous. Créez un fichier Style.css et
définissez des styles pour : body (le corps), title (le titre), main (la page
principale), credit (le crédit) et tout ce que vous voulez.
Regardez FunLand pour un exemple basique.
Autrement, utilisez un fichier Font. Un exemple de fichier Font est :
--------------------------------------------------
$TITLE_FONT = "size='4' color='#ffffff' face='Times New Roman,Georgia,Times'";
$MAIN_FONT = "face='Times New Roman,Georgia,Times'";
$CREDIT_FONT = "size='-1' face='Verdana' color='#ffffff'";
$BODY = "background='$PATH/bkgrnd.gif' link='#0099FF'">
--------------------------------------------------
CREDIT
Le fichier de crédit comporte deux lignes et est utilisé pour l'index des
thèmes à MarginalHacks. Si vous ne nous soumettez jamais votre thème, alors
vous n'avez pas besoin de ce fichier (mais faites-le s'il vous plaît !). En
tout cas, les deux lignes (et seulement deux lignes) sont :
1) une courte description du thème (à faire tenir sur une seule ligne),
2) Votre nom (qui peut être à l'intérieur d'un mailto: ou d'un lien internet).
Null.gif
Chaque thème créé par simmer a besoin d'une image "espace" c'est-à-dire une
image au format gif transparent de dimensions 1x1. Vous pouvez simplement la
copier depuis un autre thème créé par simmer.
Fichiers d'images optionnels :
Images de la barre
La barre est composée de Bar_L.gif (à gauche), Bar_R.gif (à droite) et
Bar_M.gif au milieu. L'image de la barre du milieu est étirée. Si vous avez
besoin d'une barre centrale qui ne soit pas étirée, utilisez :
Bar_L.gif, Bar_ML.gif, Bar_M.gif, Bar_MR.gif, Bar_R.gif
Dans ce cas, Bar_ML.gif et Bar_MR.gif ne seront pas étirées (voir le thème
Craftsman pour un exemple de cette technique).
Locked.gif
Une image de cadenas pour tous les répertoires ayant un fichier nommé
.htaccess.
Images de fond
Si vous voulez une image en fond d'écran, spécifiez-la dans le fichier Font
dans la section $BODY comme dans l'exemple ci-dessus. La valeur de la variable
$PATH sera remplacée par le chemin d'accès aux fichiers du thème.
More.gif
Quand une page d'album comporte plusieurs sous-albums à lister, l'image
'More.gif' est affichée en premier.
Next.gif, Prev.gif, Back.gif
Ces images sont respectivement utilisées pour les boutons des flèches arrière
et avant et pour le bouton pour remonter dans la hiérarchie des albums.
Icon.gif
Cette image, affichée dans le coin supérieur gauche des albums parents, est
souvent le texte "Photos" seulement.
Images des bordures
Il y a plusieurs méthodes pour découper une bordure, de la plus simple à la
plus complexe, l'ensemble dépendant de la complexité de la bordure et du
nombre de sections que vous voulez pouvoir étirer :
4 morceaux Utilisez Bord_L.gif, Bord_R.gif, Bord_T.gif, Bord_B.gif
(les coins vont avec les images droites et gauches)
Les bordures en 4 morceaux ne s'étirent en général pas très bien et de
fait ne fonctionnent pas bien sur les pages d'images. En général, vous
pouvez couper les coins des images droites et gauches pour faire :
8 morceaux Incluez aussi Bord_TL.gif, Bord_TR.gif, Bord_BL.gif,
Bord_BR.gif
Les bordures en 8 morceaux vous permettent généralement d'étirer et de
gérer la plupart des images recadrées.
12 morceaux Incluez aussi Bord_LT.gif, Bord_RT.gif, Bord_LB.gif,
Bord_RB.gif
12 morceaux permettent d'étirer des bordures ayant des coins plus
complexes comme par exemple les thèmes Dominatrix ou Ivy.
Bordures chevauchantes Peuvent utiliser des images transparentes qui
peuvent partiellement chevaucher vos vignettes. Voir ci-dessous.
Voici comment des morceaux pour des bordures normales sont disposés :
bordure à 12 morceaux
TL T TR bordure à 8 morceaux bordure à 4 morceaux
LT RT TL T TR TTTTTTT
L IMG R L IMG R L IMG R
LB RB BL B BR BBBBBBB
BL B BR
Notez que chaque rangée d'images doit avoir la même hauteur, alors que ce
n'est pas le cas pour la largeur (c'est-à-dire hauteur TL = hauteur T =
hauteur TR).
Ceci n'est pas totalement vrai pour les bordures qui se chevauchent !
Une fois que vous avez créé ces fichiers, vous pouvez lancer l'utilitaire
simmer_theme (un outil téléchargeable depuis MarginalHacks.com) et votre thème
deviendra prêt à être utilisé !
Si vous avez besoin de bordures différentes pour les pages d'images, alors
utilisez les mêmes noms de fichiers maix en les préfixant par 'I' comme par
exemple IBord_LT.gif, IBord_RT.gif,...
Les bordures chevauchantes autorisent des effets réellement fantastiques avec
les bordures des images. Actuellement, il n'y a pas de support pour des
bordures chevauchantes différentes pour les images.
Pour utiliser les bordures chevauchantes, créez les images :
Over_TL.png Over_T.png Over_TR.png
Over_L.png Over_R.png
Over_BL.png Over_B.png Over_BR.png
Puis, déterminez combien de pixels des bordures vont déborder (en dehors de la
photo). Mettez ces valeurs dans des fichiers: Over_T.pad Over_R.pad Over_B.pad
Over_L.pad.
Voir le thème "Themes/FunLand" pour un exemple simple.
Images polyglottes
Si vos images comportent du texte, vous pouvez les traduire dans d'autres
langues et, ainsi, vos albums pourront être générés dans d'autres
langages. Par exemple, vous pouvez créer une image "More.gif" hollandaise et
mettre ce fichier dans le répertoire 'lang/nl' de votre thème (nl est le code
de langage pour le hollandais).
Quand l'utilisateur lancera album en hollandais (album -lang nl) alors le
thème utilisera les images hollandaises s'il les trouve. Le thème "Themes/Blue"
comporte un tel exemple simple. Les images actuellement traduites sont :
More, Back, Next, Prev and Icon
Vous pouvez créer une page HTML qui donne la liste des traductions
immédiatement disponibles dans les thèmes avec l'option -list_html_trans :
% album -list_html_trans > trans.html
Puis, visualisez le fichier trans.html dans un navigateur. Malheureusement,
plusieurs langages ont des tables d'encodage des caractères différents et une
page HTML n'en dispose que d'une seule. La table d'encodage est utf-8 mais
vous pouvez éditer la ligne "charset=utf-8" pour visualiser correctement les
différents caractères utilisés dans les langages en fonction des différentes
tables d'encodage (comme par exemple l'hébreu).
Si vous avez besoin de plus de mots traduits pour les thèmes, faites-le moi
savoir et si vous créez des images dans une nouvelle langue pour un thème,
envoyez-les moi s'il vous plaît !
ITEM: Partir de zéro : l'API des thèmes
Ceci est une autre paire de manches : vous avez besoin d'avoir une idée
vraiment très claire de la façon dont vous voulez qu'album positionne vos
images sur votre page. Ce serait peut-être une bonne idée de commencer en
premier par modifier des thèmes existants afin de cerner ce que la plupart des
thèmes fait. Regardez également les thèmes existants pour des exemples de code
(voir les suggestions ci-dessus).
Les thèmes sont des répertoires qui contiennent au minimum un fichier
'album.th'. Ceci est le patron du thème pour les pages de l'album. Souvent,
les répertoires contiennent aussi un fichier 'image.th' qui est un patron du
thème pour les images ainsi que des fichiers graphiques / css utilisés par le
thème. Les pages de l'album contiennent les vignettes et les pages des images
montrent les images pleine page ou recadrées.
Les fichiers .th sont en ePerl qui est du perl encapsulé à l'intérieur
d'HTML. Ils finissent par ressembler à ce que sera l'album et les images HTML
eux-mêmes.
Pour écrire un thème, vous aurez besoin de connaître la syntaxe ePerl. Vous
pouvez trouver plus d'information sur l'outil ePerl en général à MarginalHacks
(bien que cet outil ne soit pas nécessaire pour l'utilisation des thèmes dans album).
Il y a une pléthore de routines de support disponibles mais souvent une
fraction d'entre elles seulement est nécessaire (cela peut aider de regarder
les autres thèmes afin de voir comment ils sont construits en général).
Table des fonctions:
Fonctions nécessaires
Meta() Doit être appelée depuis la section du HTML
Credit() Affiche le crédit ('cet album a été créé par..')
Doit être appelée depuis la section du HTML
Body_Tag() Appelée depuis l'intérieur du tag .
Chemins et options
Option($name) Retourne la valeur d'une option / configuration
Version() Retourne la version d'album
Version_Num() Retourne le numéro de la version d'album en chiffres
uniquement (c'est-à-dire. "3.14")
Path($type) Retourne l'information du chemin pour le $type de :
album_name Nom de l'album
dir Répertoire courant de travail d'album
album_file Chemin complet au fichier d'album index.html
album_path Chemin des répertoires parent
theme Chemin complet du répertoire du thème
img_theme Chemin complet du répertoire du thème depuis les pages des images
page_post_url Le ".html" à ajouter sur les pages des images
parent_albums Tableau des albums parents (segmentation par album_path)
Image_Page() 1 si on est en train de générer une page d'image, 0 si c'est une page de vignettes
Page_Type() Soit 'image_page' ou 'album_page'
Theme_Path() Le chemin d'accès (via le système de fichiers) aux fichiers du thème
Theme_URL() Le chemin d'accès (via une URL) aux fichiers du thème
En-tête et pied-de-page
isHeader(), pHeader() Test pour et afficher l'en-tête
isFooter(), pFooter() La même chose pour le pied-de-page
En général, vous bouclez à travers les images et les répertoires en utilisant
des variables locales :
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Ceci affichera le nom de chaque image. Nos types d'objets sont soit 'pics'
pour les images soit 'dirs' pour les répertoires-enfants. Ici se trouvent les
fonctions relatives aux objets :
Objets (le type est soit 'pics' (défaut) soit 'dirs')
First($type) Renvoie comme objet la première image ou le premier sous-album.
Last($type) Renvoie le dernier objet
Next($obj) Etant donné un objet, renvoie l'objet suivant
Next($obj,1) La même chose mais retourne au début une fois la fin atteinte
Prev($obj), Prev($obj,1) Similaire à Next()
num('pics') ou juste num() Nombre total d'images de cet album
num('dirs') Nombre total de sous-albums
Egalement :
num('parent_albums') Nombre total d'albums parents conduisant à cet album
Consultation d'objet :
get_obj($num, $type, $loop)
Trouve un objet à partir de son numéro (type 'pics' ou 'dirs').
Si la variable $loop est positionnée alors le
compteur rebouclera au début lors de la recherche
Propriétés des objets
Chaque objet (image ou sous-album) possède des propriétés.
L'accès à certaines propriétés se fait par un simple champ :
Get($obj,$field) Retourne un simple champ pour un objet donné
Champ Description
----- ----------
type Quel type d'objet ? Soit 'pics' soit 'dirs'
is_movie Booléen: est-ce que c'est un film ?
name Nom (nettoyé et optionnel pour les légendes)
cap Légende de l'image
capfile Fichier optionnel des légendes
alt Etiquette (tag) alt
num_pics [répertoires seulement, -dir_thumbs] Nombre d'images dans le répertoire
num_dirs [répertoires seulement, -dir_thumbs] Nombre de sous-répertoire dans le répertoire
L'accès à des propriétés se fait via un champ et un sous-champ. Par exemple,
chaque image comporte une information sur ses différentes tailles : plein
écran, moyenne et vignette (bien que la taille moyenne soit optionnelle).
Get($obj,$size,$field) Retourne la propriété de l'image pour une taille donnéee
Taille Champ Description
------ ----- ----------
$size x Largeur
$size y Hauteur
$size file Nom du fichier (sans le chemin)
$size path Nom du fichier (chemin complete)
$size filesize Taille du fichier en octets
full tag L'étiquette (tag) (soit 'image' soit 'embed') - seulement pour 'full'
Il y a aussi des informations relatives aux URL dont l'accès se fait en
fonction de la page d'où on vient ('from' / depuis) et l'image ou la page vers
lequel on va ('to' / vers) :
Get($obj,'URL',$from,$to) Renvoie un URL pour un objet 'depuis -> 'vers
Get($obj,'href',$from,$to) Idem mais utilise une chaîne de caractères avec 'href'
Get($obj,'link',$from,$to) Idem mais met le nom de l'objet à l'intérieur d'un lien href
Depuis Vers Description
------ ---- ----------
album_page image Image_URL vers album_page
album_page thumb Thumbnail vers album_page
image_page image Image_URL vers image_page
image_page image_page Cette page d'image vers une autre page d'image
image_page image_src L'URL d'<img src> pour la page d'image
image_page thumb Page des vignettes depuis la page d'image
Les objets répertoires ont aussi :
Depuis Vers Description
------ ---- ----------
album_page dir URL vers le répertoire depuis la page de son album-parent
Albums parent
Parent_Album($num) Renvoie en chaîne de caractères le nom de l'album parent (incluant le href)
Parent_Albums() Retourne une liste de chaînes de caractères des albums parents (incluant le href)
Parent_Album($str) Crée la chaîne de caractères $str à partir de l'appel à la fonction Parent_Albums()
Back() L'URL pour revenir en arrière ou remonter d'une page
Images
This_Image L'objet image pour une page d'image
Image($img,$type) Les étiquettes d'<img> pour les types 'medium', 'full' et 'thumb'
Image($num,$type) Idem mais avec le numéro de l'image
Name($img) Le nom nettoyé ou légendé pour une image
Caption($img) La légende pour une image
Albums enfants
Name($alb) Le nom du sous-album
Caption($img) La légende pour une image
Quelques routines utiles
Pretty($str,$html,$lines) Formate un nom.
Si la variable $html est définie alors le code HTML est autorisé
(c'est-à-dire utilise 0 pour <title> et associés). Actuellement,
préfixe seulement avec la date dans une taille de caractères plus petite
(c'est-à-dire '2004-12-03.Folder').
Si la variable $lines est définie alors le multiligne est
autorisé. Actuellement, suis seulement la date avec un retour à la ligne 'br'.
New_Row($obj,$cols,$off) Devons-nous commencer une nouvelle ligne après cet objet ?
Utiliser la variable $off si l'offset du premier objet démarre à partir de 1
Image_Array($src,$x,$y,$also,$alt)
Retourne un tag HTML <img> à partir de $src, $x,...
Image_Ref($ref,$also,$alt)
Identique à Image_Array, mais la variable $ref peut
être une table de hachage de Image_Arrays indexée par
le langage (par défaut, '_').
album choisit l'Image_Array en fonction de la définition des langages.
Border($img,$type,$href,@border)
Border($str,$x,$y,@border)
Crée une image entière entourée de bordures. Voir
'Bordures' pour de plus amples détails.
Si vous créez un thème à partir de zéro, considérez l'ajout du support pour
l'option -slideshow. Le moyen le plus facile de réaliser cette opération est
de copier / coller le code "slideshow" d'un thème existant.
ITEM: Soumettre des thèmes
Vous avez personnalisé un thème ? Je serais ravi de le voir même s'il est
totalement spécifique à votre site internet.
Si vous avez un nouveau thème que vous souhaiteriez rendre publique,
envoyez-le moi ou envoyez une adresse URL où je puisse le voir. N'oubliez pas
de mettre le fichier CREDIT à jour et faites-moi savoir si vous donnez ce
thème à MarginalHacks pour une utilisation libre ou si vous souhaitez le
mettre sous une license particulière.
ITEM: Conversion des thèmes v2.0 aux thèmes v3.0
La version v2.0 d'album a introduit une interface de thèmes qui a été réécrite
dans la version v3.0 d'album. La plupart des thèmes de la version 2.0 (plus
spécialement ceux qui n'utilisent pas la plupart des variables globales)
fonctionneront toujours mais l'interface est obsolète et pourrait disparaître
dans un futur proche.
La conversion des thèmes de la version 2.0 à la version 3.0 n'est pas bien
difficile.
Les thèmes de la version 2.0 utilisent des variables globales pour tout un tas
de choses. Celles-ci sont maintenant obsolètes. Dans la version 3.0, vous
devez conserver une trace des images et des répertoires dans des variables et
utiliser des 'itérateurs' qui sont fournis. Par exemple :
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Ceci parcourra toutes les images et affichera leur nom.
Le tableau ci-dessous vous montre comment réécrire des appels codés avec
l'ancien style utilisant une variable globale en des appels codés avec le
nouveau style qui utilise une variable locale. Cependant pour utiliser ces
appels, vous devez modifier vos boucles comme ci-dessus.
Voici un tableau de conversion pour aider au passage des thèmes de la version
2.0 à la version 3.0 :
# Les variables globales ne doivent plus être utilisées
# OBSOLETE - Voir les nouvelles méthodes d'itérations avec variables locales
# ci-dessus
$PARENT_ALBUM_CNT Réécrire avec : Parent_Album($num) et Parent_Albums($join)
$CHILD_ALBUM_CNT Réécrire avec : my $dir = First('dirs'); $dir=Next($dir);
$IMAGE_CNT Réécrire avec : my $img = First('pics'); $pics=Next($pics);
@PARENT_ALBUMS Utiliser à la place : @{Path('parent_albums')}
@CHILD_ALBUMS, @CHILD_ALBUM_NAMES, @CHILD_ALBUM_URLS, ...
# Anciennes méthodes modifiant les variables globales
# OBSOLETE - Voir les nouvelles méthodes d'itérations avec variables locales
# ci-dessus
Next_Image(), Images_Left(), Image_Cnt(), Image_Prev(), Image_Next()
Set_Image_Prev(), Set_Image_Next(), Set_Image_This()
Next_Child_Album(), Child_Album_Cnt(), Child_Albums_Left()
# chemins et autres
pAlbum_Name() Path('album_name')
Album_Filename() Path('album_file')
pFile($file) print read_file($file)
Get_Opt($option) Option($option)
Index() Option('index')
pParent_Album($str) print Parent_Album($str)
# Albums parents
Parent_Albums_Left Obsolète, voir '$PARENT_ALBUM_CNT' ci-dessus
Parent_Album_Cnt Obsolète, voir '$PARENT_ALBUM_CNT' ci-dessus
Next_Parent_Album Obsolète, voir '$PARENT_ALBUM_CNT' ci-dessus
pJoin_Parent_Albums print Parent_Albums(\@_)
# Images, utilisant la variable '$img'
pImage() Utiliser $img à la place et :
print Get($img,'href','image');
print Get($img,'thumb') if Get($img,'thumb');
print Name($img), "</a>";
pImage_Src() print Image($img,'full')
Image_Src() Image($img,'full')
pImage_Thumb_Src() print Image($img,'thumb')
Image_Name() Name($img)
Image_Caption() Caption($img)
pImage_Caption() print Get($img,'Caption')
Image_Thumb() Get($img,'URL','thumb')
Image_Is_Pic() Get($img,'thumb')
Image_Alt() Get($img,'alt')
Image_Filesize() Get($img,'full','filesize')
Image_Path() Get($img,'full','path')
Image_Width() Get($img,'medium','x') || Get($img,'full','x')
Image_Height() Get($img,'medium','y') || Get($img,'full','y')
Image_Filename() Get($img,'full','file')
Image_Tag() Get($img,'full','tag')
Image_URL() Get($img,'URL','image')
Image_Page_URL() Get($img,'URL','image_page','image_page') || Back()
# Routines pour les albums enfant utilisant la variable '$alb'
pChild_Album($nobr) print Get($alb,'href','dir');
my $name = Name($alb);
$name =~ s/<br>//g if $nobr;
print $name,"</a>";
Child_Album_Caption() Caption($alb,'dirs')
pChild_Album_Caption() print Child_Album_Caption($alb)
Child_Album_URL() Get($alb,'URL','dir')
Child_Album_Name() Name($alb)
# Inchangé
Meta() Meta()
Credit() Credit()
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/Section_7.html 0000644 0000000 0000000 00000067703 12661460265 015307 0 ustar root root
MarginalHacks album - Modules Plug-in : utilisation, création...
- Documentation
A l b u m
S e v e n - - M o d u l e s P l u g - i n : u t i l i s a t i o n , c r a t i o n . . .
1: Qu'est-ce qu'un module plug-in ?
Les modules plug-in sont des bouts de code qui vous permettent de modifier le
comportement d'album. Ils peuvent être aussi simples que la façon de créer des
légendes EXIF ou quelque chose d'aussi compliqué que créer un album à partir
d'une base de données d'images plutôt que d'utiliser une hiérarchie dans un
système de fichiers.
2: Installation d'un module plug-in et son support
Il y a un certain nombre de modules plug-in disponibles avec l'installation
standard d'album. Si vous souhaitez mettre à jour album avec les modules
plug-in d'une précédente version d'album qui ne dispose pas de modules plug-in
(pré v3.10), vous aurez besoin de faire une fois :
% album -configure
Vous n'aurez pas besoin de refaire cette commande lors des futures mises à
jour d'album.
Cette commande installera les modules plug-in actuels dans un des répertoires
par défaut des modules plug-in. album cherchera les modules plug-in dans un
certain nombre d'endroits. Ceux par défaut sont :
/etc/album/plugins/
/usr/share/album/plugins/
$HOME/.album/plugins/
En réalité, ces répertoires 'plug-in' sont ceux trouvés dans les endroits
spécifiés par l'option '--data_path' dont les noms par défaut sont :
/etc/album/
/usr/share/album/
$HOME/.album/
Vous pouvez spécifier un nouveau répertoire avec l'option '--data_path' et
ajouter un répertoire 'plugins' à ce niveau ou utiliser l'option
'--plugin_path'.
Les modules plug-in se terminent en général par l'extension ".alp" mais vous
n'avez pas besoin de spécifier cette extension lorsque vous les utilisez. Par
exemple, si vous avez un module installé ici :
/etc/album/plugins/utils/mv.alp
alors vous l'appellerez ainsi : utils/mv3: Chargement / déchargement des modules plug-in
Pour lister tous les modules plug-in actuellement installés, taper :
% album -list_plugins
Pour montrer des informations relatives à des modules spécifiques (en
utilisant 'utils/mv' comme exemple) :
% album -plugin_info utils/mv
Les modules plug-in seront sauvés dans le fichier de configuration pour un
album donné ainsi vous n'avez pas besoin de les respécifier à chaque fois, à
l'exclusion des modules plug-in qui s'exécutent une seule fois comme par
exemple 'utils/mv' ('mv' = 'move' : correspond à un déplacement de fichiers
donc ne peut être exécutée qu'une seule fois pour un jeu de fichiers donné).
Vous pouvez utiliser les options -no_plugin et -clear_plugin pour désactiver
les modules plug-in qui ont été sauvés dans le fichier de configuration de
l'album courant. De la même façon que les
options standard d'album, -no_plugin désactivera un module plug-in
spécifique alors que -clear_plugin désactivera l'ensemble des modules
plug-in. Toutes les options attachées à ces modules seront également
effacées.
4: Options des modules plug-in
Quelques modules plug-in acceptent des options en ligne de commande. Pour
visualiser comment les utiliser, taper :
% album -plugin_usage utils/mv
Cependant, quand vous spécifiez une option pour un module plug-in, vous devez
indiquer à album à quel module plug-in l'option correspond. A la place de la
syntaxe utilisée pour les options standards d'album :
% album -une_option
vous devez préfixer l'option avec le nom du module plug-in suivi de
deux-points :
% album -un_plugin:une_option
Par exemple, vous pouvez spécifier le nom de l'index créé par le module
plug-in 'utils/capindex'.
% album -plugin utils/capindex -utils/capindex:index blah.html
C'est peu pratique. Vous pouvez raccourcir le nom du module plug-in tant qu'il
ne rentre pas en conflit avec un autre module plug-in déjà chargé et ayant le
même nom :
% album -plugin utils/capindex -capindex:index blah.html
Evidemment, les autres types d'options (chaînes de caractères, nombres et
tableaux) sont acceptés et utilisent la même convention. Ces options sont
sauvegardées dans le fichier de configuration de l'album de la même façon que
les options standard.
Avertissement : comme mentionné, une fois que nous utilisons un module plug-in
sur un album, il est sauvegardé dans le fichier de configuration. Si vous
voulez ajouter d'autres options à un album déjà configuré pour utiliser un
module plug-in, vous devez soit mentionner le module plug-in ou soit utiliser
le nom complet du module quand vous spécifiez les options (autrement, album ne
saura pas à qui appartient l'option raccourcie).
Par exemple, considérons un module plug-in imaginaire :
% album -plugin un/exemple/vignetteGen Photos/Espagne
Après ça, supposons que nous voulons utiliser la variable booléenne "rapide" du
module vignetteGen.
Ceci ne fonctionnera pas :
% album -vignetteGen:rapide Photos/Espagne
Mais l'une de ces solutions fonctionnera :
% album -plugin un/exemple/vignetteGen -vignetteGen:rapide blah.html Photos/Espagne% album -un/exemple/vignetteGen:rapide Photos/Espagne5: Ecrire des modules plug-in
Les modules plug-in sont de petits modules écrits en perl qui s'appellent via
des fonctions particulières ('hooks') du code d'album.
Il y a de telles fonctions pour la plupart des fonctionnalités d'album et le
code du module plug-in peut souvent soit remplacer soit compléter le code
d'album. Davantage de ces fonctions pourraient être rajoutées dans les futures
versions d'album si besoin.
Vous pouvez afficher la liste de toutes ces fonctions autorisées par album :
% album -list_hooks
Et vous pouvez obtenir des informations spécifiques pour chacune de ces
fonctions :
% album -hook_info <hook_name>
Nous pouvons utiliser album pour générer à notre place un cadre pour nos
modules plug-in :
% album -create_plugin
Pour effectuer cette tâche, vous avez besoin de comprendre les fonctions
'hooks' dans album et les options d'album.
Nous pouvons aussi écrire un module plug-in à la main. Pour cela, utiliser comme
base de travail un module plug-in déjà écrit facilite le travail.
Dans notre module plug-in, nous enregistrons notre fonction 'hook' en appelant
la fonction album::hook(). Pour appeler des fonctions dans le code d'album,
nous utilisons l'espace de nommage album.
Par exemple, pour enregistrer le code pour la fonction 'hook'
clean_name, notre module plug-in appelle :
album::hook($opt,'clean_name',\&my_clean);
Ainsi, quand album appelle la fonction clean_name, il appellera
également la sous-routine appelée my_clean de notre module
plug-in (sous-routine que nous devons fournir).
Pour écrire cette sous-routine my_clean, regardons les
informations de la fonction 'hook' clean_name :
Args: ($opt, 'clean_name', $name, $iscaption)
Description: Nettoyer un nom de fichier pour affichage.
Le nom est soit un nom de fichier soit il provient d'un fichier de légendes.
Retourne: le nom nettoyé
Les arguments que la sous-routine my_clean reçoit sont spécifiés
sur la première ligne. Supposons qu'on veuille convertir tous les noms en
majuscules. Nous devrions utiliser :
sub my_clean {
my ($opt, $hookname, $name, $iscaption) = @_;
return uc($name);
}
Voici une explication sur les arguments :
$opt Ceci est le descripteur de toutes les options d'album.
Nous ne nous en servons pas ici. Vous pourrez en avoir parfois
besoin si vous appelez les fonctions internes d'album. Ceci est
également valable si l'argument $data est fourni.
$hookname Dans notre cas, ce sera 'clean_name'. Ceci nous permet
d'enregistrer la même sous-routine pour gérer différentes
fonctions 'hooks'.
$name Ceci est le nom que nous allons nettoyer.
$iscaption Ceci nous indique si le nom provient d'un fichier de
légendes.
Pour comprendre n'importe quelles options après la variable
$hookname, vous aurez peut-être besoin de jeter un oeil sur
le code correspondant dans album.
Dans notre cas, nous avons seulement besoin d'utiliser la variable
$name fournie, nous appelons la routine perl de mise en majuscule et
nous retournons son résultat. Le code est ainsi terminé mais nous avons besoin
maintenant de créer un environnement pour notre module plug-in.
Des fonctions 'hooks' vous permettent de remplacer le code d'album. Par
exemple, vous pourriez écrire du code pour un module plug-in qui génére des
vignettes pour les fichiers au format pdf (utiliser l'outil 'convert' est un
desmoyens de le faire). Nous pouvons enregistrer du code pour la fonction
'hook' relative aux vignettes et simplement retourner 'undef' si nous ne
sommes pas en train de regarder un fichier pdf. Mais quand nous voyons un
fichier pdf, nous créons alors une vignette que nous retournons. Quand album
récupérera une vignette, alors il utilisera celle-ci et sautera l'exécution
de son propre code relatif aux vignettes.
Maintenant, terminons d'écrire notre module plug-in de mise en majuscules. Un
module plug-in doit comporter les éléments suivants :
1) Fournir une routine de démarrage appelée 'start_plugin'. Celle-ci
fera sûrement l'enregistrement des fonctions 'hooks' et spécifiera les
options en ligne de commande pour le module.
2) La routine 'start_plugin' doit retourne la table de hachage
des informations du module, laquelle table a besoin d'avoir les clés
suivantes définies :
author => Le nom de l'auteur
href => Une adresse internet (ou une adresse électronique) de
l'auteur
version => Le numéro de version du module plug-in
description => Un texte de description du module plug-in
3) Terminer le code du module en retournant '1' (similaire à un module perl).
Voici notre exemple de code plug-in clean_name dans son module
complet :
sub start_plugin {
my ($opt) = @_;
album::hook($opt,'clean_name',\&my_clean);
return {
author => 'David Ljung Madison',
href => 'http://MarginalHacks.com/',
version => '1.0',
description => "Conversion des noms des images en majuscules",
};
}
sub my_clean {
return uc($name);
}
1;
Finalement, nous avons besoin de le sauvegarder quelque part. Les modules
plug-in étant organisés dans une hiérarchie de répertoires pour modules
plug-in, nous pourrions le sauver dans un répertoire de module comme :
captions/formatting/NAME.alp
En fait, si vous regardez dans examples/formatting/NAME.alp, vous
trouverez qu'il y a déjà un module plug-in qui fait essentiellement la même
chose.
Si vous souhaitez que votre module accepte des options en ligne de commande,
utilisez 'add_option'. Ceci doit être réalisé dans le code de la
routine 'start_plugin'. Quelques exemples :
album::add_option(1,"fast",album::OPTION_BOOL, usage=>"Fais le rapidement");
album::add_option(1,"name", album::OPTION_STR, usage=>"Votre nom");
album::add_option(1,"colors",album::OPTION_ARR, usage=>"Liste des couleurs");
Pour de plus amples informations, regardez le code de la routine 'add_option'
dans album et jetez un oeil dans les autres routines qui l'utilisent (au début
du code d'album et dans les modules plug-in qui utilisent 'add_option').
Pour lire une option qu'un utilisateur pourrait avoir utilisée, nous utilisons
la fonction option() :
my $fast = album::option($opt, "fast");
Si l'utilisateur fournit une mauvaise valeur pour une option, vous pouvez
appeler la fonction usage() :
album::usage("-colors array can only include values [red, green, blue]");
Si votre module plug-in a besoin de charger des modules perl qui ne font pas
partie de la distribution standard de Perl, faites-le de façon
conditionnelle. Pour avoir un example, regardez le module plug-in
plugins/extra/rss.alp.
Vous pouvez également appeler n'importe quelle routines trouvées dans le script
album en utilisant l'espace de nommage album::. Soyez sûr de ce que vous
faites. Quelques routines utiles :
album::add_head($opt,$data, "<meta name='ajoute_ceci' content='à <head>'>");
album::add_header($opt,$data, "<p>Ceci est ajouté à l'en-tête de l'album");
album::add_footer($opt,$data, "<p>Ceci est ajouté au pied de page de l'album");
Le meilleur moyen de savoir comment écrire des modules plug-in est de regarder
d'autres modules plug-in, si possible en en copiant un réalisant une tache
similaire et en travaillant à partir de ça. Des outils de développement pour
les modules plug-in pourraient être créer à l'avenir.
Une fois de plus, album peut vous aider à créer un environnement pour vos
modules plug-in :
% album -create_plugin6: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/old.txt_4 0000644 0000000 0000000 00000016546 10573245540 014325 0 ustar root root Fichiers de configuration
ITEM: Fichiers de configuration
Le comportement du script album peut être controlé via des options en ligne
de commande comme :
% album -no_known_images% album -geometry 133x100% album -exif "Fichier : %File name% " -exif "pris avec %Camera make%"
Mais ces options peuvent aussi être définies dans un fichier de configuration :
# Exemple de fichier de configuration # les commentaires sont ignorés
known_images 0 # known_images=0 est la même chose que no_known_images
geometry 133x100
exif "Fichier : %File name% "
exif "pris avec %Camera make%"
Le format du fichier de configuration est d'une option par ligne
éventuellement suivie par des espaces et la valeur de l'option. Les options
booléennes peuvent être initialisées sans valeur ou bien être positionnées
avec 0 et 1.
ITEM: Localisation des fichiers de configuration
album recherche les fichiers de configuration dans quelques endroits ; dans
l'ordre :
/etc/album/conf Configuration valable pour l'ensemble du système
/etc/album.conf Configuration valable pour l'ensemble du système
$BASENAME/album.conf Dans le répertoire d'installation d'album
$HOME/.albumrc Configuration dépendante de l'utilisateur
$HOME/.album.conf Configuration dépendante de l'utilisateur
$DOT/album.conf Configuration dépendante de l'utilisateur (je
conserver mes fichiers "point" alleurs)
$USERPROFILE/album.conf Pour Windows (C:\Documents et Settings\Utilisateur)
album regarde également des fichiers album.conf à l'intérieur même des
répertoires de l'album photo courant.
Les sous-albums photos peuvent aussi disposer d'un fichier album.conf qui
modifiera la configuration de base des répertoires parent (ceci vous permet,
par exemple, d'avoir plusieurs thèmes pour des parties différentes de votre
album photo).
N'importe quel fichier album.conf dans le répertoire de votre album photo
configurera l'album et tous les sous-albums à moins qu'un autre fichier de
configuration album.conf ne soit trouvé dans un sous-album.
Par exemple, considérons la configuration pour un album photo situé dans le
répertoire 'images/album.conf' :
theme Dominatrix6
columns 3
Une autre configuration est trouvée dans le répertoire
'images/europe/album.conf' :
theme Blue
crop
album utilisera le thème Dominatrix6 pour l'album photo du répertoire images/
et tous ses sous-albums excepté pour le sous-album images/europe/ qui
disposera du thème Blue. Toutes les images de l'album photo du répertoire
images/ seront sur 3 colonnes y compris dans le sous-album images/europe/ car
ce paramètre y est inchangé. Cependant, toutes les vignettes du sous-album
images/europ/ seront recadrées du fait de la présence de l'option 'crop' dans
le fichier de configuration.
ITEM: Sauvegarde des options
Dès que vous lancez le script album, les options en ligne de commande sont
sauvegardées dans un fichier album.conf situé à l'intérieur du répertoire de
votre album photo. Si un tel fichier existe déjà, il sera modifié et non
remplacé ce qui permet d'éditer très facilement ce fichier via un éditeur de texte.
Ceci facilite l'usage ultérieur du script album. Par exemple, si vous générez
pour la première fois un album photo avec :
% album -crop -no_known_images -theme Dominatrix6 -sort date images/
Alors la prochaine fois que vous appellerez album, vous aurez juste besoin de
taper :
% album images/
Ceci fonctionne également pour les sous-albums photo :
% album images/africa/
trouvera aussi toutes les options sauvegardées.
Quelques options à l'usage limité comme -add (ajouter un nouveau sous-album),
-clean (effacer les fichiers inutiles), -force (forcer la regénération d'un
album photo), -depth (préciser la profondeur c'est-à-dire le nombre de niveaux
de sous-albums sur laquelle s'applique la commande), etc... ne sont pas sauvegardées pour des raisons évidentes.
Lancer plusieurs fois album dans le même répertoire peut devenir confus si
vous ne comprenez pas comment les options sont sauvegardées.
Voici quelques exemples.
Introduction :
1) Les options en ligne de commande sont traités avant les options du fichier
de configuration trouvé dans le répertoire de l'album photo.
2) album utilisera les mêmes options la prochaine fois que vous le lancez si
vous ne spécifiez aucune option.
Par exemple, si on suppose qu'on lance deux fois album dans un répertoire :
% album -exif "commentaire 1" photos/espagne% album photos/espagne
La deuxième fois que vous utiliserez album, vous aurez toujours le
commentaire exif "commentaire 1" pour l'album photo de ce répertoire.
3) album ne finira pas avec de multiples copies d'une même option acceptant
plusieurs arguments si vous continuez à l'appeler avec la même ligne de
commande.
Par exemple :
% album -exif "commentaire 1" photos/espagne% album -exif "commentaire 1" photos/espagne
La deuxième fois que vous lancez album, vous n'aurez pas à la fin plusieurs
copies du commentaire exif "commentaire 1" dans vos photos.
Cependant, veuillez noter que si vous re-préciser à chaque fois les
mêmes options, album pourrait être plus lent à s'exécuter car il pensera
qu'il a besoin de regénérer vos fichiers html !
Ainsi par exemple, si vous lancez :
% album -medium 640x640 photos/espagne
(puis plus tard...)
% album -medium 640x640 photos/espagne
Alors la seconde fois regénérera inutilement toutes vos photos de taille
moyenne ("medium"). Ceci est beaucoup lent.
Il est donc préférable de spécifier les options en ligne de commande
seulement la première fois, puis d'utiliser ensuite la sauvegarde qui en a été
faite comme ici :
% album -medium 640x640 photos/espagne
(puis plus tard...)
% album photos/espagne
Malheureusement, ces contraintes signifient que, pour toutes les options
acceptant plusieurs arguments, les dernières valeurs entrées se retrouveront
en début de liste comme sur l'exemple ci-dessous avec l'option -exif.
% album -exif "commentaire 1" photos/espagne% album -exif "commentaire 2" photos/espagne
Les commentaires seront en fait ordonnés ainsi : "commentaire 2" puis
"commentaire 1".
Pour préciser l'ordre exact, vous aurez besoin de re-spécifier toutes les
options :
Soit en spécifiant de nouveau "commentaire 1" pour le remettre en première
position dans la liste.
% album -exif "commentaire 1" photos/espagne
Ou juste en spécifiant toutes les options dans l'ordre que vous souhaitez :
% album -exif "commentaire 1" -exif "commentaire 2" photos/espagne
Quelques fois, il peut être plus facile d'éditer directement le fichier
album.conf afin d'y apporter les modifications souhaitées.
Finalement, ceci nous permet seulement d'accumuler les options.
On peut effacer les options en utiliser -no et -clear (voir la section
correspondante Options), ces
modifications étant également sauvegardées d'une utilisation à une autre.
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/conf 0000655 0000000 0000000 00000000000 12661457776 017271 1album-4.17/Docs/it/conf ustar root root album-4.17/Docs/fr/=.txt_2 0000644 0000000 0000000 00000016071 10417666203 013712 0 ustar root root MINI HOW-TO
ITEM: Simple album
En supposant que vous avez d=C3=A9j=C3=A0 installer album correctement, nou=
s pouvons r=C3=A9aliser quelques manipulations basiques. Si vous rencontrez=
une erreur ou un quelconque probl=C3=A8me ici, regardez les documents d'in=
stallation.
Vous avez besoin d'un r=C3=A9pertoire accessible depuis le web o=C3=B9 mett=
re vos th=C3=A8mes et votre album photos. Nous utiliserons /home/httpd/test=
dans ce document. Ce r=C3=A9pertoire a besoin d'=C3=AAtre accessible par l=
e serveur web. Dans cet exemple, nous utiliserons l'URL suivante :
http://myserver/test
Adaptez vos commandes / URLs en fonction de vos besoins.
Premi=C3=A8rement, cr=C3=A9ez un r=C3=A9pertoire et mettez-y des images ded=
ans. Nous l'appellerons ainsi :
/home/httpd/test/Photos
Puis nous ajouterons quelques images d=C3=A9nomm=C3=A9es 'IMG_001.jpg' =C3=
=A0 'IMG_004.jpg'.
Maintenant, pour ce test basique, lan=C3=A7ons simplement album:
% album /home/httpd/test/Photos
Maintenant, vous pouvez visualiser l'album cr=C3=A9=C3=A9 via un navigateur=
=C3=A0 l'adresse :
http://myserver/test/Photos
ITEM: Ajouter des l=C3=A9gendes
Cr=C3=A9ez un fichier /home/httpd/test/Photos/captions.txt avec le contenu =
suivants (utilisez la touche 'tab' si vous voyez " [tab] ") :
=2D- captions.txt ---------
IMG_001.jpg [tab] Nom de la première image
IMG_002.jpg [tab] Deuxième image
IMG_003.jpg [tab] Encore une image [tab] avec une légende!
IMG_004.jpg [tab] Dernière image [tab] avec une autre l&eacu=
te;gende.
=2D------------------------
Puis lancer de nouveau la commande album :
% album /home/httpd/test/Photos
Vous verrez que la l=C3=A9gende a =C3=A9t=C3=A9 modif=C3=A9e.
Maintenant, cr=C3=A9ez un fichier avec du texte dedans : /home/httpd/test/P=
hotos/header.txt
Et relancez la commande album une fois de plus. Vous verrz alors le texte d=
u fichier affich=C3=A9e au sommet de la page.
ITEM: Masquer des photos
Il y a quelques moyens de masquer des photos / des fichiers / des r=C3=A9pe=
rtoires mais nous allons utiliser le fichier des l=C3=A9gendes. Essayez de =
placer un commentaire avec le caract=C3=A8re '#' devant le nom d'une image =
dans captions.txt:
=2D- captions.txt ---------
IMG_001.jpg [tab] Nom de la première image
#IMG_002.jpg [tab] Deuxième image
IMG_003.jpg [tab] Encore une image [tab] avec une légende!
IMG_004.jpg [tab] Dernière image [tab] avec une autre l&eacu=
te;gende.
=2D------------------------
Relancez la commande album et vous verrez que l'image IMG_002.jpg a mainten=
ant disparu.
Si vous aviez proc=C3=A9d=C3=A9 de la sorte la premi=C3=A8re fois, vous n'a=
uriez g=C3=A9n=C3=A9r=C3=A9 ni l'image de taille r=C3=A9duite ni la vignett=
e correspondante. Si vous le souhaitez, vous pouvez les supprimer en utilis=
ant l'option -clean :
% album -clean /home/httpd/test/Photos
ITEM: Utiliser un th=C3=A8me
Si les th=C3=A8mes ont =C3=A9t=C3=A9 correctement install=C3=A9s and sont a=
ccessibles via them_path (chemin d'acc=C3=A8s aux th=C3=A8mes), alors vous =
pouvez utiliser un th=C3=A8me lors de la g=C3=A9n=C3=A9ration de votre albu=
m :
% album -theme Blue /home/httpd/test/Photos
L'album photo courant devrait =C3=AAtre maintenant bas=C3=A9 sur le th=C3=
=A8me Blue (bleu). S'il y a tout un tas de liens cass=C3=A9s ou d'images qu=
i n'apparaissent pas, il y a de forte chance pour que votre th=C3=A8me n'ai=
t pas =C3=A9t=C3=A9 install=C3=A9 dans un r=C3=A9pertoire accessible depuis=
le web ; voir les documents d'installation.
Album sauvegarde les options que vous lui indiquez. Ainsi, la prochaine foi=
s que vous lancerez la commande album :
% album /home/httpd/test/Photos
vous utiliserez toujours le th=C3=A8me Blue. Pour d=C3=A9sactiver un th=C3=
=A8me, tapez :
% album -no_theme /home/httpd/test/Photos
ITEM: Images r=C3=A9duites
Les images de pleine taille sont en g=C3=A9n=C3=A9rale d'une taille trop im=
posante pour un album photo sur le web. C'est pourquoi nous utiliserons des=
images r=C3=A9duites sur les pages web g=C3=A9n=C3=A9r=C3=A9es :
% album -medium 33% /home/httpd/test/Photos
Cependant, vous avez toujours acc=C3=A8s aux images pleine taille en cliqua=
nt simplement sur les images r=C3=A9duites.
La commande :
% album -just_medium /home/httpd/test/Photos
emp=C3=AAchera la liaison entre les images de taille r=C3=A9duite et les im=
ages pleine taille, en pr=C3=A9sumant que nous avons lanc=C3=A9 pr=C3=A9c=
=C3=A9demment une commande avec l'option -medium.
ITEM: Ajouter des l=C3=A9gendes EXIF
Ajoutons la valeur du diaphragme dans les l=C3=A9gendes de chaque image.
% album -exif " diaphragme=3D%Aperture%" /home/httpd/test/Photos
Cette commande ajoutera seulement la valeur du diaphragme pour les images q=
ui disposent de la balise exif (le symbole entre les caract=C3=A8res '%') '=
Aperture' signifiant diaphragme en fran=C3=A7ais ! Nous avons =C3=A9galemen=
t ajout=C3=A9 la balise qui permet d'ajouter cette information exif su=
r une nouvelle ligne.
Nous pouvons rajouter d'autres informations exif :
% album -exif " focale: %FocalLength%" /home/httpd/test/Photos
Parce que album sauvegarde vos pr=C3=A9c=C3=A9dentes options, nous disposon=
s maintenant de deux balises exif pour toutes les images sp=C3=A9cifiant =
=C3=A0 la fois le diaphragme et la focale.
Supprimons le diaphragme :
% album -no_exif " diaphragme=3D%Aperture%" /home/httpd/test/Photos
La cha=C3=AEne de caract=C3=A8res suivant l'option '-no_exif' a besoin de c=
orrespondre exactement =C3=A0 celle entr=C3=A9e pr=C3=A9c=C3=A9demment avec=
l'option '-exif' sinon elle sera ignor=C3=A9e. Vous pouvez =C3=A9galement =
=C3=A9diter le fichier de configuration qu'album a cr=C3=A9=C3=A9 ici :
/home/httpd/test/Photos/album.conf
Puis supprimez l'option en question.
ITEM: Ajouter d'autres albums
Imaginons que vous faites un voyage en Espagne. Vous prenez des photos et l=
es mettez dans le r=C3=A9pertoire :
/home/httpd/test/Photos/Espagne/
Maintenant, ex=C3=A9cutez la commande album depuis le r=C3=A9pertoire princ=
ipal :
% album /home/httpd/test/Photos
Cette commande modifiera l'album principal Photos qui sera reli=C3=A9 =C3=
=A0 Espagne puis elle lancera =C3=A9galement la commande album sur le r=C3=
=A9pertoire Espagne avec les m=C3=AAmes caract=C3=A9ristiques / th=C3=A8me,=
etc.
Maintenant, faisons un autre voyage en Italie et cr=C3=A9ons le r=C3=A9pert=
oire :
/home/httpd/test/Photos/Italie/
=09
Nous pourrions lancer la commande depuis le r=C3=A9pertoire principal :
% album /home/httpd/test/Photos
Mais ceci rescannerait le r=C3=A9pertoire Espagne qui n'a pas chang=C3=A9. =
Album ne g=C3=A9n=C3=A9rera aucune page HTML ni vignette =C3=A0 moins qu'il=
ait le besoin de la faire. Cependant, il peut perdre du temps, plus partic=
uli=C3=A8rement si vos albums photos deviennent de plus en plus volumineux.=
Aussi, vous pouvez juste demander d'ajouter le nouveau r=C3=A9pertoire :
% album -add /home/httpd/test/Photos/Italie
Cette commande modifiera l'index de la premi=C3=A8re page (dans Photos) et =
g=C3=A9n=C3=A9rera l'album correspond au r=C3=A9pertorie Italie.
--Boundary-00=_RABPE4wDiedqZVJ--
album-4.17/Docs/fr/txt_5 0000644 0000000 0000000 00000013366 12236405003 013534 0 ustar root root Demande d'ajout de fonctionnalités, bogues, correctifs et dépannage
ITEM: Demande d'ajout de fonctionnalités
S'il y a quelque chose que vous souhaitez voir ajouter à album, vérifiez tout
d'abord que cette fonctionnalité n'existe pas déjà. Consultez la page d'aide ou
l'aide en ligne :
% man album% album -h
Regardez aussi les options -more et -usage.
Si vous ne voyez rien ici, vous pouvez vous lancer dans l'écriture d'un
correctif ou d'un module plug-in.
ITEM: Rapports de bogues
Avant de soumettre un bogue, vérifiez que vous disposez de la dernière version
d'album s'il vous plaît !
Quand vous soumettez un bogue, j'ai besoin de savoir au-moins :
1) Votre système d'exploitation
2) La description fidèle de votre problème et les messages d'erreur affichés
J'aimerais également savoir, si c'est possible :
1) La commande exacte que vous avez lancée avec album
2) La sortie affichée à l'écran par cette commande
Et en général j'ai aussi besoin de la sortie affichée par album en mode
déboguage :
% album -d
Enfin, soyez sûr d'avoir la dernière version d'album ainsi que pour les thèmes.
ITEM: Ecrire des correctifs, modifier album
Si vous voulez modifier le script album, vous devriez d'abord me contacter
afin de voir si cela ne fait pas partie de mon plan de développement.
Si non, alors vous devriez considérer la rédaction d'un module plug-in plutôt
que de modifier le code source d'album. Ceci évite de rajouter de la
complexité à album pour des fonctionnalités qui pourraient avoir une
utilisation limitée.
Si ces modifications concernent le script album (par exemple s'il s'agit d'un
bogue), alors téléchargez d'abord
la dernière version d'album, puis corrigez-la et envoyez-moi soit la
différence entre la version originale et votre version corrigée, soit un
correctif ou encore le script album complet. Si vous mettez des commentaires à
propos des changements que vous apportez, cela serait vachement bien aussi.
ITEM: Bogues connus
v3.11: -clear_* et -no_* n'effacent pas les options du répertoire parent.
v3.10: Graver un CD ne fonctionne pas tout à fait avec des chemins d'accès
absolus pour les répertoires abritant les thèmes.
v3.00: Les options à plusieurs arguments ou de code sont sauvegardées à
rebours. Par exemple :
"album -lang aa .. ; album -lang bb .." utilisera encore la langue 'aa'.
Aussi, dans certains cas, les options à plusieurs arguments ou de code
présentes dans des sous-albums ne seront pas ordonnées dans le bon
ordre lors du premier appel à album et vous aurez besoin de relancer
album. Par exemple :
"album -exif A photos/ ; album -exif B photos/sub"
donnera "B A" pour l'album photo sub puis "A B" après l'appel à "album
photos/sub"
ITEM: PROBLEME : Mes pages d'index sont trop grandes !
Je reçois beaucoup de requêtes me demandant de couper les pages d'index dès
qu'on dépasse un certain nombre d'images.
Le problème est que c'est difficile à gérer à moins que les pages d'index soient
vues commes des sous-albums. Et dans ce cas, vous auriez alors sur une même
page trois composantes majeures, plus des indexes, des albums et des
vignettes. Et non seulement ceci est encombrant mais cela nécessiterait aussi de
mettre à jour l'ensemble des thèmes.
J'espère que la prochaine version majeure d'album pourra faire cela mais, en
attendant, la solution la plus facile à mettre en oeuvre est de séparer les
images à l'intérieur de sous-répertoires avant de lancer album.
J'ai un outil qui transférera les nouvelles images dans des sous-répertoires
puis lancera album :
in_album
ITEM: ERREUR : no delegate for this image format (./album)
[NdT : le message signifie : aucun outil pour traiter ce format d'image (./album)]
Le script album se trouve dans votre répertoire de photos et il ne peut pas
créer une vignette de lui-même ! Au choix :
1) Déplacer le script album en dehors de votre répertoire de photos
(recommandé)
2) Lancer album avec l'option -known_images
ITEM: ERREUR : no delegate for this image format (some_non_image_file)
[NdT : le message signifie : aucun outil pour ce format d'image
(fichier_qui_n_est_pas_une_image)]
Ne mettez pas des fichiers qui ne soient pas des images dans votre répertoire
de photos ou alors lancez album avec l'option -known_images
ITEM: ERREUR : no delegate for this image format (some.jpg)
ITEM: ERREUR : identify: JPEG library is not available (some.jpg)
[NdT : les deux messages signifient :
- aucun outil pour ce format d'image (fichier.jpg)
- identify (nom d'un utilitaire) : la librairie JPEG n'est pas disponible (fichier.jpg)]
Votre installation de la suite ImageMagick n'est pas complète et ne sait pas
comment gérer le format de l'image donnée.
ITEM: ERREUR : Can't get [some_image] size from -verbose output.
[NdT : le message signigie : impossible d'obtenir la taille de [une_image] à partir
de la sortie affichée via l'option -verbose]
ImageMagick ne connaît pas la taille de l'image spécifiée.
1) Soit votre installation d'ImageMagick est incomplète et le type de l'image
ne peut pas être géré
2) Soit vous exécutez album sans l'option -known_images sur un répertoire qui
contient des fichiers qui ne sont pas des images
Si vous êtes un utilisateur de gentoo linux et que
vous voyez cette erreur, alors lancez cette commande depuis le compte
administrateur ou "root" (merci à Alex Pientka) :
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/old.txt_8 0000644 0000000 0000000 00000025725 10671126733 014331 0 ustar root root Support des langues
ITEM: Utilisation des langues
(ncessite album v4.0 ou suprieur)
Album est fourni avec des fichiers de langues (nous avons besoin d'une aide
pour les traductions ; voyez ci-dessous). Les fichiers de langues modifieront
la plupart des messages envoys par album, de mme que toutes les sorties HTML
qui ne sont pas gnrs par le thme.
Modifier tout le texte d'un thme pour qu'il corresponde votre langue est
aussi simple qu'diter les fichiers du thme. Il y a un exemple de ceci avec
le thme "simple-Czech".
Pour utiliser une langue, ajoutez l'option "lang" votre fichier principal
album.conf ou autrement, spcifiez-la lorsque vous gnrez votre album pour la
premire fois (elle sera sauve pour cet album par la suite).
Les langues peuvent tre effaces comme n'importe quelle option avec :
% album -clear_lang ...
Vous pouvez spcifier plusieurs langues, ce qui peut tre utile si une langue
est incomplte, mais vous voudriez une langue par dfaut autre que
l'anglais. Ainsi, par exemple, si vous voulez le hollandais comme langue
principal avec en secours le sudois chef [sic !], vous pourriez faire :
% album -lang swedish_chef -lang nl ...
Si vous spcifiez un sous-langage (tel que es-bo pour espagnol, Bolivie),
alors album essayera 'es' en premier comme langue de secours.
Notez qu' cause d'un bogue connu, vous devez spcifier toutes les langues
dsires en un seul coup plutt qu'au cours de plusieurs invocations d'album.
Pour voir quelles sont les langues disponibles :
% album -list_langs
Malheureusement, la plupart des langues sont tout juste compltes mais ceci
est une chance pour les personnes qui souhaiteraient nous aider pour devenir un...
ITEM: Traducteurs volontaires
Le projet album a besoin de volontaires pour raliser des traductions
principalement :
1) Le Mini How-To. Traduisez s'il vous plat partir de la source.
2) les messages d'album comme expliqu ci-dessous.
Si vous tes disposs traduire l'une ou les deux sections, contactez-moi
s'il vous plat !
Si vous vous sentez particulirement ambitieux, n'hsitez pas traduire
n'importe quelle section de la documentation en me le faisant savoir !
ITEM: Traduction de la documentation
Le document le plus important traduire est le "Mini How-To".
Traduisez-le s'il vous plat partir du texte original.
Veuillez galement me faire savoir comment vous souhaitez tre remerci, par
votre nom, un nom et une adresse lectronique ou un nom et un site internet.
Egalement, s'il vous plat, incluez l'orthographe et la distinction majuscule
/ minuscule adquates du nom de votre langue dans votre langue. Par
exemple, "franais" la place de "French".
Je suis ouvert toute suggestion concernant le jeu de caractres
utiliser. Les options actuelles sont :
1) Caractres HTML tel que [é]] (bien qu'ils ne fonctionnent que
dans les navigateurs)
2) Unicode (UTF-8) tel que [é] (seulement dans les navigateurs et dans
quelques terminaux)
3) Code ASCII, si possible, tel que [] (fonctionne dans les diteurs de
texte mais pas dans cette page configure avec le jeu de caractres unicode)
4) Code iso spcifique certaines langues comme le jeu iso-8859-8-I pour l'hbreu.
Actuellement, le jeu unicode (utf-8) semble tre le mieux plac pour les
langues qui ne sont pas couvertes par le jeu iso-8859-1 car il couvre toutes
les langues et nous aide grer les tradutions incompltes (qui autrement
ncessiteraient de multiples jeux de caractres ce qui serait un
dsastre). N'importe quel code iso qui est un sous-ensemble de l'utf-8 peut
tre utilis.
Si le terminal principal pour une langue donne a un jeu de caractres iso
la place de l'utf, alors cela peut tre une bonne raison d'utiliser un jeu de
caractres non-utf.
ITEM: Messages d'Album
album gre tous les textes de messages en utilisant son propre systme de
support de langue, similaire au systme utilis par le module perl Locale::Maketext.
(plus d'information sur l'inspiration du systme dans TPJ13)
Un message d'erreur, par exemple, peut ressembler ceci :
No themes found in [[some directory]].
Avec un exemple spcifique devenir :
No themes found in /www/var/themes.
En hollandais, ceci donnerait :
Geen thema gevonden in /www/var/themes.
La "variable" dans ce cas est "/www/var/themes" et n'est videmment pas
traduit. Dans album, le vrai message d'erreur ressemble cela :
'No themes found in [_1].'
# Args: [_1] = $dir
La traduction (en hollandais) ressemble ceci :
'No themes found in [_1].' => 'Geen thema gevonden in [_1].'
Aprs la traduction, album remplacera [_1] par le nom du rpertoire.
Il y a parfois plusieurs variables pouvant changer de position :
Quelques exemples de messages d'erreur :
Need to specify -medium with -just_medium option.
Need to specify -theme_url with -theme option.
En hollandais, le premier donnerait :
Met de optie -just_medium moet -medium opgegeven worden.
Le message d'erreur rel avec sa traduction en hollandais est :
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet [_1] opgegeven worden'
# Args: [_1]='-medium' [_2]='-just_medium'
Note que les variables ont chang de position.
Il y a aussi des oprateurs spciaux pour les quantits. Par exemple, nous
souhaitons traduire :
'I have 42 images'
ou le nombre 42 peut changer. En anglais, il est correct de dire :
0 images, 1 image, 2 images, 3 images...
alors qu'en hollandais nous aurons :
0 afbeeldingen, 1 afbeelding, 2 afbeeldingen, 3 afbeeldingen..
Mais d'autres langues (telles que des langues slaves) peuvent avoir des rgles
spciales quant savoir si "image" doit tre au pluriel en fonction de la
quantit demande 1, 2, 3 ou 4 etc! Le cas le plus simple est couvert par
l'oprateur [quant] :
[quant,_1,image]
Ceci est similaire "[_1] image" except que "image" sera mis au pluriel si
[_1] est 0 ou plus grand que 1 :
0 images, 1 image, 2 images, 3 images...
La forme plurielle s'obtient simplement en ajoutant un 's'. Si cela n'est pas
correct, nous pouvons spcifier la forme plurielle :
[quant,_1,afbeelding,afbeeldingen]
qui nous donne le dcompte en hollandais voqu plus haut.
Et si nous avons besoin d'une forme spcifique pour 0, nous pouvons le
spcifier :
[quant,_1,directory,directories,no directories]
ce qui donnerait :
no directories, 1 directory, 2 directories, ...
Il y a aussi un raccourci pour [quant] en utilisant '*' d'o les quivalences
:
[quant,_1,image]
[*,_1,image]
Finalement, voici un exemple de traduction pour un nombre d'images :
'[*,_1,image]'
=> '[*,_1,afbeelding,afbeeldingen]',
Si vous avez quelque chose de plus compliqu alors vous pouvez utiliser du
code perl. Je peux vous aider l'crire si vous m'indiquez comment la
traduction doit fonctionner :
'[*,_1,image]'
=> \&russian_quantity; # Ceci est une sous-routine dfinie quelque part
Puisque les chanes traduites sont (gnralement) places entre des
apostrophes (') et aussi cause des codes spciaux entre [crochets], nous
avons besoin de les citer correctement.
Les apostrophes dans une chane ont besoin d'tre prcdes par une barre
oblique ou slash en anglais (\) :
'I can\'t find any images'
et les crochets sont cits en utilisant le tilda (~) :
'Problem with option ~[-medium~]'
ce qui malheureusement peut devenir assez dplaisant si la chose l'intrieur
des crochets est une variable :
'Problem with option ~[[_1]~]'
Soyez prudent et vrifiez que tous les crochets sont ferms de faon
approprie.
De plus, dans presque tous les cas, la traduction devrait avoir le mme nombre
de variables que le message original :
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet' # <- O est pass [_1] ?!?
Heureusement, la plupart du travail est faite pour vous. Les fichiers de
langue sont sauvs dans le rpertoire spcifi par l'option -data_path (ou
-lang_path) o album stocke ses donnes. Ce sont essentiellement du code perl
et ils peuvent tre auto-gnrs par album :
% album -make_lang sw
Cette commande crera un nouveau fichier de langue vide dnomm'sw'
(sudois). Allez de l'avant en ditant ce fichier et en ajoutant autant de
traductions que vous pouvez. Les traductions laisses vides sont tolres :
elles ne seront simplement pas utilises. Les traductions parmi les plus
importantes (comme celles qui sont affiches dans les pages HTML) se trouvent
au sommet du fichier et devraient probablement tre traduite en premier.
Choisir un jeu de caractres n'est pas chose aise car il devrait tre bas
sur les jeux de caractres que vous pensez que les gens sont susceptibles
d'avoir disposition aussi bien dans leur terminal que dans leur navigateur.
Si vous voulez construire un nouveau fichier de langue en utilisant une
traduction provenant d'un fichier existant (par exemple pour mettre jour une
langue avec les nouveaux messages qui ont t ajouts dans album), vous devez
d'abord charg la langue en premier :
% album -lang sw -make_lang sw
Toutes les traductions dans le fichier de langue sudois courant seront
copies vers le nouveau fichier (quoique les commentaires et autre code ne
soient pas copis).
Pour les trs longues lignes de texte, ne vous faites pas de souci en ajoutant
des caractres de fin de ligne (\n) except s'ils existent dans le message
original : album grera de faon approprie les sections de texte les plus longues.
Contactez-moi s'il vous plat quand vous commencez un travail de
traduction. Ainsi je peux tre sre que nous n'avons pas deux traducteurs
travaillant sur les mmes parties. Et soyez sre de m'envoyer des mises jour
des fichiers de langue au fur et mesure des progrs ; mme s'ils sont
incomplets, ils sont utiles !
Si vous avez des questions propos de la faon de lire la syntaxe des
fichiers de langue, faites-le moi savoir s'il vous plat.
ITEM: Pourquoi vois-je toujours des termes anglais ?
Aprs avoir chois une autre langue, vous pouvez toujours parfois voir des
termes en anglais :
1) Les noms des options sont toujours en anglais. (-geometry est toujours
-geometry)
2) La chane courante n'est actuellement pas traduite.
3) Il est peu probable que la sortie d'un module plug-in soit traduite.
4) Les fichiers de langue ne sont pas toujours complet et ne traduiront
uniquement que ce qu'ils connaissent.
5) album peut avoir de nouveaux messages que le fichier de langue ne connat
encore pas.
6) La plupart des thmes sont en anglais.
Heureusement, ce dernier est le plus simple changer. Editer simplement le
thme et remplacer les portions de texte HTML avec n'importe quelle langue que
vous souhaitez ou crez de nouveau graphique dans une langue diffrentes pour
les icnes en anglais.
Si vous crez un nouveau thme, je serais ravi de le savoir !
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/old.txt_7 0000644 0000000 0000000 00000030757 10671126731 014327 0 ustar root root Modules Plug-in : utilisation, création...
ITEM: Qu'est-ce qu'un module pllug-in ?
Les modules plug-in sont des bouts de code qui vous permettent de modifier le
comportement d'album. Ils peuvent être aussi simples que la façon de créer des
légendes EXIF ou quelque chose d'aussi compliqué que créer un album à partir
d'une base de données d'images plutôt que d'utiliser une hiérarchie dans un
système de fichiers.
ITEM: Installation d'un module plug-in et son support
Il y a un certain nombre de modules plug-in disponibles avec l'installation
standard d'album. Si vous souhaitez mettre à jour album avec les modules
plug-in d'une précédente version d'album qui ne dispose pas de modules plug-in
(pré v3.10), vous aurez besoin de faire une fois :
% album -configure
Vous n'aurez pas besoin de refaire cette commande lors des futures mises à
jour d'album.
Cette commande installera les modules plug-in actuels dans un des répertoires
par défaut des modules plug-in. album cherchera les modules plug-in dans un
certain nombre d'endroits. Ceux par défaut sont :
/etc/album/plugins/
/usr/share/album/plugins/
$HOME/.album/plugins/
En réalité, ces répertoires 'plug-in' sont ceux trouvés dans les endroits
spécifiés par l'option '--data_path' dont les noms par défaut sont :
/etc/album/
/usr/share/album/
$HOME/.album/
Vous pouvez spécifier un nouveau répertoire avec l'option '--data_path' et
ajouter un répertoire 'plugins' à ce niveau ou utiliser l'option
'--plugin_path'.
Les modules plug-in se terminent en général par l'extension ".alp" mais vous
n'avez pas besoin de spécifier cette extension lorsque vous les utilisez. Par
exemple, si vous avez un module installé ici :
/etc/album/plugins/utils/mv.alp
alors vous l'appellerez ainsi : utils/mv
ITEM: Chargement / déchargement des modules plug-in
Pour lister tous les modules plug-in actuellement installés, taper :
% album -list_plugins
Pour montrer des informations relatives à des modules spécifiques (en
utilisant 'utils/mv' comme exemple) :
% album -plugin_info utils/mv
Les modules plug-in seront sauvés dans le fichier de configuration pour un
album donné ainsi vous n'avez pas besoin de les respécifier à chaque fois, à
l'exclusion des modules plug-in qui s'exécutent une seule fois comme par
exemple 'utils/mv' ('mv' = 'move' : correspond à un déplacement de fichiers
donc ne peut être exécutée qu'une seule fois pour un jeu de fichiers donné).
Vous pouvez utiliser les options -no_plugin et -clear_plugin pour désactiver
mes modules plug-in qui ont été sauvés dans le fichier de configuration de
l'album courant. De la même façon que les
options standard d'album, -no_plugin désactivera un module plug-in
spécifique alors que -clear_plugin désactivera l'ensemble des modules
plug-in. Toutes les options attachées à ces modules seront également
effacées.
ITEM: Options des modules plug-in
Quelques modules plug-in acceptent des options en ligne de commande. Pour
visualiser comment les utiliser, taper :
% album -plugin_usage utils/mv
Cependant, quand vous spécifiez une option pour un module plug-in, vous devez
indiquer à album à quel module plug-in l'option correspond. A la place de la
syntaxe utilisée pour les options standards d'album :
% album -une_option
vous devez préfixer l'option avec le nom du module plug-in suivi de
deux-points :
% album -un_plugin:une_option
Par exemple, vous pouvez spécifier le nom de l'index créé par le module
plug-in 'utils/capindex'.
% album -plugin utils/capindex -utils/capindex:index blah.html
C'est peu pratique. Vous pouvez raccourcir le nom du module plug-in tant qu'il
ne rentre pas en conflit avec un autre module plug-in déjà chargé et ayant le
même nom :
% album -plugin utils/capindex -capindex:index blah.html
Evidemment, les autres types d'options (chaînes de caractères, nombres et
tableaux) sont acceptés et utilisent la même convention. Ces options sont
sauvegardées dans le fichier de configuration de l'album de la même façon que
les options standard.
Avertissement : comme mentionné, une fois que nous utilisons un module plug-in
sur un album, il est sauvegardé dans le fichier de configuration. Si vous
voulez ajouter d'autres options à un album déjà configuré pour utiliser un
module plug-in, vous devez soit mentionner le module plug-in ou soit utiliser
le nom complet du module quand vous spécifiez les options (autrement, album ne
saura pas à qui appartient l'option raccourcie).
Par exemple, considérons un module plug-in imaginaire :
% album -plugin un/exemple/vignetteGen Photos/Espagne
Après ça, supposons que nous voulons utiliser la variable booléenne "rapide" du
module vignetteGen.
Ceci ne fonctionnera pas :
% album -vignetteGen:rapide Photos/Espagne
Mais l'une de ces solutions fonctionnera :
% album -plugin un/exemple/vignetteGen -vignetteGen:rapide blah.html Photos/Espagne% album -un/exemple/vignetteGen:rapide Photos/Espagne
ITEM: Ecrire des modules plug-in
Les modules plug-in sont de petits modules écrits en perl qui s'appellent via
des fonctions particulières ('hooks') du code d'album.
Il y a de telles fonctions pour la plupart des fonctionnalités d'album et le
code du module plug-in peut souvent soit remplacer soit compléter le code
d'album. Davantage de ces fonctions pourraient être rajoutées dans les futures
versions d'album si besoin.
Vous pouvez afficher la liste de toutes ces fonctions autorisées par album :
% album -list_hooks
Et vous pouvez obtenir des informations spécifiques pour chacune de ces
fonctions :
% album -hook_info <hook_name>
Nous pouvons utiliser album pour générer à notre place un cadre pour nos
modules plug-in :
% album -create_plugin
Pour effectuer cette tâche, vous avez besoin de comprendre les fonctions
'hooks' dans album et les options d'album.
Nous pouvons aussi écrire un module plug-in à la main. Utiliser comme base de
travail un module plug-in déjà écrit facilite le travail.
Dans notre module plug-in, nous enregistrons notre fonction 'hook' en appelant
la fonction album::hook(). Pour appeler des fonctions dans le code d'album,
nous utilisons l'espace de nommage album.
Par exemple, pour enregistrer le code pour la fonction 'hook'
clean_name, notre module plug-in appelle :
album::hook($opt,'clean_name',\&my_clean);
Ainsi, quand album appelle la fonction clean_name, il appellera
également la sous-routine appelée my_clean de notre module
plug-in (sous-routine que nous devons fournir).
Pour écrire cette sous-routine my_clean, regardons les
informations de la fonction 'hook' clean_name :
Args: ($opt, 'clean_name', $name, $iscaption)
Description: Nettoyer un nom de fichier pour affichage.
Le nom est soit un nom de fichier soit il provient d'un fichier de légendes.
Retourne: le nom nettoyé
Les arguments que la sous-routine my_clean reçoit sont spécifiés
sur la première ligne. Supposons qu'on veuille convertir tous les noms en
majuscules. Nous devrions utiliser :
sub my_clean {
my ($opt, $hookname, $name, $iscaption) = @_;
return uc($name);
}
Voici une explication sur les arguments :
$opt Ceci est le descripteur de toutes les options d'album.
Nous ne nous en servons pas ici. Vous pourrez en avoir parfois
besoin si vous appelez les fonctions internes d'album. Ceci est
également valable si l'argument $data est fourni.
$hookname Dans notre cas, ce sera 'clean_name'. Ceci nous permet
d'enregistrer la même sous-routine pour gérer différentes
fonctions 'hooks'.
$name Ceci est le nom que nous allons nettoyer.
$iscaption Ceci nous indique si le nom provient d'un fichier de
légendes.
Pour comprendre n'importe quelles options après la variable
$hookname, vous aurez peut-être besoin de jeter un oeil sur
le code correspondant dans album.
Dans notre cas, nous avons seulement besoin d'utiliser la variable
$name fournie, nous appelons la routine perl de mise en majuscule et
nous retournons son résultat. Le code est ainsi terminé mais nous avons besoin
maintenant de créer un environnement pour notre module plug-in.
Des fonctions 'hooks' vous permettent de remplacer le code d'album. Par
exemple, vous pourriez écrire du code pour un module pllug-in qui génére des
vignettes pour les fichiers au format pdf (utiliser l'outil 'convert' est un
desmoyens de le faire). Nous pouvons enregistrer du code pour la fonction
'hook' relative aux vignettes et simplement retourner 'undef' si nous ne
sommes pas en train de regarder un fichier pdf. Mais quand nous voyons un
fichier pdf, nous créons alors une vignette que nous retournons. Quand album
récupérera une vignette, alors il utilisera celle-ci and sautera l'exécution
de son propre code relatif aux vignettes.
Maintenant, terminons d'écrire notre module plug-in de mise en majuscule. Un
module plug-in doit comporter les éléments suivants :
1) Fournir une routine de démarrage appelée 'start_plugin'. Celle-ci
fera sûrement l'enregistrement des fonctions 'hooks' et spécifiera les
options en ligne de commande pour le module.
2) La routine 'start_plugin' doit retourne la table de hachage
des informations du module, laquelle table a besoin d'avoir les clés
suivantes définies :
author => Le nom de l'auteur
href => Une adresse internet (ou une adresse électronique) de
l'auteur
version => Le numéro de version du module plug-in
description => Un texte de description du module plug-in
3) Terminer le code du module en retournant '1' (similaire à un module perl).
Voici notre exemple de code plug-in clean_name dans son module
complet :
sub start_plugin {
my ($opt) = @_;
album::hook($opt,'clean_name',\&my_clean);
return {
author => 'David Ljung Madison',
href => 'http://MarginalHacks.com/',
version => '1.0',
description => "Conversion des noms des images en majuscules",
};
}
sub my_clean {
return uc($name);
}
1;
Finalement, nous avons besoin de le sauvegarder quelque part. Les modules
plug-in étant organisés dans une hiérarchie de répertoires pour modules
plug-in, nous pourrions le sauver dans un répertoire de module comme :
captions/formatting/NAME.alp
En fait, si vous regardez dans examples/formatting/NAME.alp, vous
trouverez qu'il y a déjà un module plug-in qui fait essentiellement la même
chose.
Si vous souhaitez que votre module accepte des options en ligne de commande,
utilisez 'add_option'. Ceci doit être réalisé dans le code de la
routine 'start_plugin'. Quelques exemples :
album::add_option(1,"fast",album::OPTION_BOOL, usage=>"Fais le rapidement");
album::add_option(1,"name", album::OPTION_STR, usage=>"Votre nom");
album::add_option(1,"colors",album::OPTION_ARR, usage=>"Liste des couleurs");
Pour de plus amples informations, regardez le code de la routine 'add_option'
dans album et jetez un oeil dans les autres routines qui l'utilisent (au début
du code d'album et dans les modules plug-in qui utilisent 'add_option').
Pour lire une option qu'un utilisateur pourrait avoir utilisé, nous utilisons
la fonction option() :
my $fast = album::option($opt, "fast");
Si l'utilisateur fournit une mauvaise valeur pour une option, vous pouvez
appeler la fonction usage() :
album::usage("-colors array can only include values [red, green, blue]");
Si votre module plug-in a besoin de charger des modules perl qui ne font pas
partie de la distribution standard de Perl, faites-le de façon
conditionnelle. Pour avoir un example, regardez le module plug-in
plugins/extra/rss.alp.
Le meilleur moyen de savoir comment écrire des modules plug-in est de regarder
d'autres modules plug-in, si possible en en copiant un réalisant une tache
similaire et en travaillant à partir de ça. Des outils de développement pour
les modules plug-in pourraient être créer à l'avenir.
Une fois de plus, album peut vous aider à créer un environnement pour vos
modules plug-in :
% album -create_plugin
ITEM: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
album-4.17/Docs/fr/Section_3.html 0000644 0000000 0000000 00000105302 12661460265 015267 0 ustar root root
MarginalHacks album - Utiliser album / Options de base
- Documentation
A l b u m
T h r e e - - U t i l i s e r a l b u m / O p t i o n s d e b a s e
1: Exécution basique
Créez un répertoire contenant uniquement des images. Le script album et
les autres outils ne doivent pas se trouver dans ce répertoire. Lancez
la commande album en précisant ce répertoire :
% album /exemple/chemin/vers/les/images
Ou, si vous êtes déjà dans le répertoire exemple/chemin/vers/les/images :
% album images/
Quand l'opération est terminée, vous aurez un album photo à l'intérieur
de ce répertoire avec comme fichier d'entrée index.html.
Si ce chemin fait partie de votre serveur web, alors vous pourrez
visualiser votre album photos à partir de votre navigateur. Si vous
ne le trouvez pas, contactez votre administrateur système.
2: Options
Il y a trois types d'options: options booléennes (vrai / faux), options
acceptant des chaînes de caractères ou des numéros et options acceptant
plusieurs arguments. Les options booléennes peuvent être désactivées en
les préfixant avec -no_ :
% album -no_image_pages
Les chaînes de caractères et les nombres sont entrés après une option :
% album -type gif
% album -columns 5
Les options acceptant plusieurs arguments peuvent être utilisées de
deux manières. La première avec un argument à la fois :
% album -exif hi -exif there
ou avec plusieurs arguments en utilisant la syntaxe '--' :
% album --exif hi there --
Vous pouvez supprimer une valeur particulière d'une option à plusieurs
arguments avec -no_<option> suivi du nom de l'argument et effacer
tous les arguments d'une telle option avec -clear_<option>.
Pour effacer tous les arguments d'une option acceptant plusieurs arguments
(provenant par exemple d'une précédente utilisation de la commande album) :
% album -clear_exif -exif "new exif"
(l'option -clear_exif effacera les anciens arguments de l'option exif puis
l'option -exif suivante permettra d'ajouter un nouveau commentaire dans
la section exif).
Et pour terminer, vous pouvez supprimer un argument particulier d'une option
à plusieurs arguments avec 'no_' :
% album -no_exif hi
supprimera la valeur 'hi' et laissera intacte la valeur 'there' de l'option
exif.
Voir également la section sur Sauvegarde des options.
Pour voir une courte page d'aide :
% album -h
Pour voir davantage d'options :
% album -more
Et pour avoir encore plus d'options :
% album -usage=2
Vous pouvez spécifier un nombre plus grand que 2 pour voir encore davantage
d'options (jusqu'à 100).
Les modules de plug-in peuvent aussi disposer d'options pour leur propre
usage.
3: Thèmes
Les thèmes sont une composante essentielle qui rend album attrayant. Vous
pouvez particulariser le look de votre album photo en téléchargeant un
thème depuis le site MarginalHacks ou même écrire votre propre thème en
phase avec votre site web.
Pour utiliser un thème, téléchargez l'archive correspondante du thème au
format .tar ou .zip et installez-là.
Les thèmes sont spécifiés grâce à l'option -theme_path qui permet d'indiquer
les endroits où sont stockées les thèmes. Ces chemins sont nécessairement
quelque part sous la racine du répertoire de votre site web mais pas à
l'intérieur même de votre album photo. De plus, ces chemins doivent être
accessible depuis un navigateur.
Vous pouvez rajouter un thème dans l'un des chemins spécifié par l'option
theme_path et utilisé par album ou créer un nouveau thème et indiquer son
chemin d'accès avec cette option (le répertoire indiqué par l'option
-theme_path est celui où se trouve le thème et pas le répertoire du thème
lui-même).
Par la suite, appelez album avec l'option -theme accompagnée ou non de
-theme_path:
% album -theme Dominatrix6 mes_photos/
% album -theme Dominatrix6 -theme_path /home/httpd/album/Themes/ mes_photos/
Vous pouvez également créer vos propres thèmes très facilement. Ce sujet est
abordé un peu plus loin dans cette documentation.
4: Sous-albums
Créez des répertoires dans votre répertoire créé précedemment et mettez-y
des images. Lancez une nouvell fois album : vos sous-répertoires seront
explorés et donneront naissance à des sous-albums du premier album.
Si vous apportez des modifications dans un seul sous-album, vous pouvez
exécuter album uniquement sur ce sous-album ; les liens avec l'album
parent seront conservés.
Si vous ne souhaitez pas descendre dans l'arborescence des répertoires,
vous pouvez limiter la profondeur du niveau d'exploration avec l'option
-depth. Exemple :
% album images/ -depth 1
Cette commande ne générera qu'un album photo pour les images du
répertoire courant.
Si vous avez plusieurs sous-albums et que vous voulez ajouter un nouveau
sous-album sans regénérer les autres, alors utilisez l'option -add :
% album -add images/nouvel_album/
Ceci ajoutera nouvel_album à la page HTML pour 'images/' et créera
ensuite les vignettes et les pages HTML pour toutes les données contenues
dans 'images/nouvel_album'.
5: Eviter la regénération des vignettes
album essaie d'éviter au maximum le travail inutile. Il ne crée seulement
des vignettes que si elles n'existent pas et n'ont pas été modifiées. Ceci
permet d'accélérer les traitements successifs d'album.
Cependant, cela peut provoquer un problème si vous changez la taille ou
recadrez vos vignettes car album ne réalisera pas que ces dernières ont
changées. Pour forcer la regénération des vignettes, utilisez l'option
-force :
% album -force images/
Mais vous ne devriez pas avoir besoin d'utiliser l'option -force à chaque
fois.
6: Nettoyer les vignettes
Si vous supprimez une image de votre album, alors vous laisserez des
vignettes et des pages HTML. Pour les supprimer, lancer album avec
l'option -clean :
% album -clean images/7: Taille d'images moyenne
Quand vous cliquez sur la vignette d'un album, vous êtes dirigés vers
une page spécifique à cette image. Par défaut, cette page affiche l'image
en taille réelle ainsi que les boutons de navigation, les légendes et
tout le toutim. Quand vous cliquez sur l'image de cette page, l'URL
pointe alors uniquement sur l'image en taille réelle.
Si vous voulez avoir une image de taille réduite sur la page affichant
cette image, utilisez l'option -medium en précisant la géométrie que vous
souhaitez obtenir. Vous pouvez utiliser toutes les géométries supportées
par ImageMagick (voir la page man de cet outil pour de plus amples détails).
Par exemple :
# Une image faisant la moitié de la taille réelle
% album -medium 50%
# Une image qui s'insère dans 640x480 (taille maximale)
% album -medium 640x480
# Une image qui est réduite pour s'insérer dans 640x480
# (mais qui ne sera pas élargie si elle est déjà plus petite que 640x480)
% album -medium '640x480>'
Les caractères de 'quotation' du dernier exemple seront obligatoires sur
la plupart des systèmes à cause de la présence du caractère '>'.
8: Légendes
Les images et les vignettes peuvent avoir des noms et des légendes. Il y a
plusieurs moyens de préciser / changer les noms et les légendes dans vos
albums photo.
Le nom est
lié à l'image ou à la page qui l'héberge et la légende suit juste en dessous.
Le nom par défaut est le fichier nettoyé :
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
Un moyen de préciser une légende est d'utiliser un fichier texte avec le
même nom que l'image mais l'extension .txt. Par exemple,
"Kodi_Cow.txt" pourrait contenir "Kodi takes down a cow! ("Kodi
maîtrise une vache !")
Vous pouvez renommer vos images et spécifier toutes les légendes d'un
répertoire avec un fichier captions.txt.
Chaque ligne du fichier doit être le nom d'une image ou d'un
répertoire, suivi par une tabulation, suivi par le nouveau
nom. Vous pouvez aussi spécifier (séparé par une tabulation), une légende
optionnelle puis un tag ALT, optionnel également, pour l'image. Pour sauter
un champ, utilisez 'tabulation' 'espace' 'tabulation'.
Exemple :
001.gif Ma première photo
002.gif Maman et Papa dans le grand canyon
003.gif Ani DiFranco ma fiancée Whaou !
Les images et les répertoires sont listés dans l'ordre dans lequel ils
sont trouvés dans le fichier de légende. Vous pouvez modifier ce tri avec
les options '-sort date' et '-sort name'.
Si votre éditeur de texte ne gère pas très bien les tabulations, vous
pouvez séparer les champs par un double deux-points mais .b/seulement
si votre légende ne contient aucune tabulation :
003.gif :: Ani DiFranco :: Ma fiancée :: Whaou !
Si vous ne souhaitez avoir des légendes que sur les pages contenant les
images (et pas sur les pages affichant les albums), utilisez :
% album -no_album_captions
Si vous voulez créer ou éditer vos légendes depuis un accès web, regardez
le script CGI caption_edit.cgi (mais soyez sûr de limiter l'accès à ce
script sinon n'importe qui pourra modifier vos légendes).
9: Légendes EXIF
Vous pouvez également préciser des légendes extraites des informations
EXIF (Exchangeable Image File Format) ajoutées aux images par la plupart
des appareils photo numériques.
Mais tout d'abord, vous avez besoin d'installer 'jhead'. Vous pouvez,
par exemple, lancer jhead sur un fichier au format jpeg (.jpg ou .jpeg)
et ainsi voir les commentaires et informations affichés.
Les légendes EXIF sont ajoutés à la suite des légendes normales et sont
spécifiés à l'aide de l'option -exif :
% album -exif "<br>Fichier: %File name% pris avec %Camera make%"
Tous les %tags% trouvés seront remplacées par les informations EXIF
correspondantes. Si des %tags% ne sont pas trouvés dans les informations
EXIF, alors la légende EXIF est ignorée. A cause de ce comportement, vous
pouvez multiplier les arguments passés à l'option -exif :
% album -exif "<br>Fichier: %File name% " -exif "pris %Camera make%"
De la sorte, si le tag 'Camera make' n'est pas trouvé, vous pourrez toujours
avoir la légende relative au tag 'File name'.
De la même façon que pour toutes les options acceptant plusieurs arguments,
vous pouvez utiliser la syntaxe --exif :
% album --exif "<br>Fichier: %File name% " "pris avec %Camera make%" --
Comme montré dans l'exemple, il est possible d'inclure des balises HTML dans
vos légendes EXIF :
% album -exif "<br>Ouverture: %Aperture%"
Afin de voir la liste des tags EXIF possible (Résolution, Date / Heure,
Ouverture, etc...), utilisez un programme comme 'jhead' sur une image issue
d'un appareil photo numérique.
Vous pouvez également préciser des légendes EXIF uniquement pour les albums
ou les pages affichant une image. Voir les options -exif_album et
-exif_image.
10: En-têtes et pieds-de-page
Dans chaque répertoire abritant un album, vous pouvez avoir des fichiers texte
header.txt and footer.txt.
Ces fichiers seront copiés tels quels dans l'en-tête et le pied-de-page
de votre album (si cette fonctionnalité est supportée par votre thème).
11: Masquer des Fichiers / des Répertoires
Chaque fichier non reconnu par album comme étant une image est ignoré.
Pour afficher ces fichiers, utilisez l'option -no_known_images (l'option
par défaut est -known_images).
Vous pouvez marquer une image comme n'étant pas une image en éditant un
fichier vide avec le même et l'extension .not_img ajoutée à la fin.
Vous pouvez ignorer complètement un fichier en créant un fichier vide avec
le même nom et l'extension .hide_album ajoutée à la fin.
Vous pouvez éviter de parcourir un répertoire complet (bien qu'étant
toujours inclus dans la liste de vos répertoires) en créant un fichier
<dir>/.no_album.
Vous pouvez ignorer complètement des répertoires créant un fichier
<dir>/.hide_album
La version pour Windows d'album n'utilise pas le . pour no_album,
hide_album et not_img car il est difficile de créer des
.fichiers dans Windows.
12: Recadrer les images
Si vos images comportent un large éventail de ratios (c'est-à-dire autres
que les traditionnels ratios portrait / paysage) ou si votre thème ne
supporte qu'une seule orientation, alors vos vignettes peuvent être
recadrées afin qu'elles partagent toutes la même géométrie :
% album -crop
Le recadrage par défaut est de recadrer l'image au centre. Si vous n'aimez
pas le recadrage central utilisé par album pour générer les vignettes, vous
pouvez donner des directives à album afin de spécifier où recadrer des
images spécifiques. Pour cela, il suffit de changer le nom du fichier
contenant l'image pour qu'il ait la directive de recadrage juste avant
l'extension. Vous pouvez ainsi demander à album de recadrer l'image en haut,
en bas, à droite ou à gauche. Par exemple, supposons que nous ayons un
portrait "Kodi.gif" que vous voulez recadrer au sommet de votre vignette.
Renommez le fichier en "Kodi.CROPtop.gif" et c'est tout (vous pouvez
évenutellement utiliser l'option -clean pour supprimer l'ancienne
vignette). La chaîne de caractères précisant le recadrage sera supprimée
du nom affiché dans votre navigateur.
La géométrie par défaut est 133x133. De cette façon, les images en position
paysage auront des vignettes au format 133x100 et les images en position
portrait auront des vignettes au format 100x133. Si vous utilisez le
recadrage et souhaitez que vos vignettes aient toujours le même ratio que
les photos numériques; alors essayez 133x100 :
% album -crop -geometry 133x100
Souvenez-vous que si vous recadrez ou changez la géométrie d'un album
précédemment généré, vous devrez utiliser l'option -force une fois afin
de regénérer complètement toutes vos vignettes.
13: Film vidéo
album peut générer des vignettes issues de prise instantanée pour de
nombreux formats vidéo si vous installez ffmpeg.
Si vous êtes sur un système linux sur une architecture x86, vous n'avez qu'à
télécharger le fichier exécutable, ou autrement, télécharger le
paquetage complet depuis ffmpeg.org (c'est très facile d'installation).
14: Graver des CDs (en utilisant file://)
Si vous utilisez album pour graver des CDs ou si vous souhaitez accèder
à vos albums depuis votre navigateur avec le protocole file://, alors
vous ne voulez pas qu'album suppose que le fichier "index.html" soit
la page principale puisque votre navigateur ne le saura probablement pas.
De plus, si vous utilisez des thèmes, vous devez utiliser des
chemins d'accès relatifs. Vous ne pouvez pas utiliser l'option
-theme_url car vous ne savez pas où sera l'URL final. Sur Windows, le
chemin d'accès aux thèmes pourrait être "C:/Themes" ou sous UNIX ou OSX,
il pourrait être quelque chose comme "/mnt/cd/Themes", tout dépendant
de la façon dont le CD a été monté.
Pour résoudre ces cas de figure, utilisez l'option -burn :
% album -burn ...
Ceci implique que les chemins d'accès de l'album vers les thèmes ne
change pas. Le meilleur moyen de faire ceci consiste à prendre le
répertoire racine que vous allez graver et d'y mettre vos thèmes et votre
album puis de spécifier le chemin complet vers le thème. Par exemple,
créez les répertoires :
monISO/Photos/
monISO/Themes/Blue
Puis vous lancez :
% album -burn -theme monISO/Themes/Blue monISO/Photos
Ensuite, vous pouvez créer une image ISO depuis le répertoire mon ISO (ou
plus haut).
Les utilisateurs Windows peuvent également jeter un oeil sur shellrun
qui permet de lancer automatiquement l'album dans le navigateur. (Ou
voyez aussi winopen).
15: Indexer entièrement votre album
Pour naviguer sur un album entièrement compris sur une page, utilisez l'outil
caption_index.
Il utilise les mêmes options qu'album (bien qu'il en ignore la plupart) de
telle sorte que vous pouvez remplacer l'appel à "album" par "caption_index".
La sortie est la page HTML de l'index de l'album complet.
Regardez l'index d'exemple réalisé à partir d'un de mes albums photo d'exemple16: Mettre à jour des albums avec CGI
Premièrement, vous avez besoin de charger vos photos dans le répertoire
de l'album. Je vous suggère d'utiliser ftp pour faire cette manipulation.
Vous pouvez aussi écrire un script java qui chargerait les fichiers. Si
quelqu'un pouvait me montrer comment faire, j'apprécierais beaucoup.
Ensuite, vous avez besoin de pouvoir exécuter album à distance. Pour éviter
les abus, je vous conseille de mettre en place un script CGI qui crée
un fichier bidon (ou qui transfère ce fichier via ftp) et d'avoir un
cron job (process tournant en arrière plan) qui teste régulièrement
à quelques minutes d'intervalle si ce fichier est présent et, s'il l'est,
de le supprimer et de lancer album. Cette méthode ne fonctionne que sous
unix et vous aurez sûrement besoin de modifier votre variable
d'environnement $PATH ou d'utiliser des chemins absolus dans le script
pour la conversion).
Si vous souhaitez une gratification immédiate, vous pouvez lancer album
depuis un script CGI comme celui-ci.
Si l'utilisateur du serveur web n'est pas le propriétaire des photos, vous
aurez besoin d'utiliser un script setuid via CGI [toujours pour unix
seulement].
Mettez ce script setuid dans un emplacement protégé, changez son propriétaire
pour qu'il soit le même que celui de vos photos et lancez la commande
"chmod ug+s" sur le script. Vous trouverez ici des exemples de scripts
setui et CGI. N'oubliez pas de les éditer.
Regardez également caption_edit.cgi
qui vous permet (ou une autre personne) d'éditer les légendes / noms /
en-têtes / pieds-de-pages à travers le web.
17: Traduit par:
Jean-Marc [jean-marc.bouche AT 9online.fr]
1: Feature Requests
If there's something you want added to album, first make sure
it doesn't already exist! Check the man page or the usage:
% man album% album -h
Also see -more and -usage options.
If you don't see it there, consider writing a patch or a plugin.
2: Bug reports
Before you submit a bug, please make sure you have the most current release of album!
When submitting a bug, I need to know at least:
1) Your operating system
2) The exact problem and the exact error messages
I'd also like to know, if possible:
1) The exact album command you ran
2) The output from the command
And I generally also need the debug output of album:
% album -d
Finally, make sure that you've got the most current
version of album, and the most current themes as well.
3: Writing Patches, Modifying album
If you want to modify album, you might want to check with me
first to make sure it's not already on my development plate.
If not, then consider writing it as a plugin instead of patching
the album source. This avoids adding complexity to album for
features that may not be globally used.
If it needs to go into album (for example, if it's a bug), then
please make sure to first download the most recent copy of album
first, then patch that and send me either a diff, a patch, or the
full script. If you comment off the changes you make that'd be great too.
4: Known Bugs
v3.11: -clear_* and -no_* doesn't clear out parent directory options.
v3.10: Burning CDs doesn't quite work with theme absolute paths.
v3.00: Array and code options are saved backwards, for example:
"album -lang aa .. ; album -lang bb .." will still use language 'aa'
Also, in some cases array/code options in sub-albums will not
be ordered right the first time album adds them and you may
need to rerun album. For example:
"album -exif A photos/ ; album -exif B photos/sub"
Will have "B A" for the sub album, but "A B" after: "album photos/sub"
5: PROBLEM: My index pages are too large!
I get many requests to break up the index pages after reaching a certain
threshold of images.
The problem is that this is hard to manage - unless the index pages are
treated just like sub-albums, then you now have three major components
on a page, more indexes, more albums, and thumbnails. And not only is
that cumbersome, but it would require updating all the themes.
Hopefully the next major release of album will do this, but until then
there is another, easier solution - just break the images up into
subdirectories before running album.
I have a tool that will move new images into subdirectories for you and
then runs album:
in_album6:ERROR: no delegate for this image format (./album)
You have the album script in your photo directory and it can't make
a thumbnail of itself! Either:
1) Move album out of the photo directory (suggested)
2) Run album with -known_images
7:ERROR: no delegate for this image format (some_non_image_file)
Don't put non-images in your photo directory, or else run with -known_images.
8:ERROR: no delegate for this image format (some.jpg)9:ERROR: identify: JPEG library is not available (some.jpg)
Your ImageMagick installation isn't complete and doesn't know how
to handle the given image type.
10:ERROR: Can't get [some_image] size from -verbose output.
ImageMagick doesn't know the size of the image specified. Either:
1) Your ImageMagick installation isn't complete and can't handle the image type.
2) You are running album on a directory with non-images in it without
using the -known_images option.
If you're a gentoo linux user and you see this error, then run this command
as root (thanks Alex Pientka):
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
1: Configuration Files
Album behavior can be controlled through command-line options, such as:
% album -no_known_images% album -geometry 133x100% album -exif "File: %File name% " -exif "taken with %Camera make%"
But these options can also be specified in a configuration file:
# Example configuration file # comments are ignored
known_images 0 # known_images=0 is same as no_known_images
geometry 133x100
exif "File: %File name% "
exif "taken with %Camera make%"
The configuration file format is one option per line optionally followed
by whitespace and the option value. Boolean options can be set without
the option value or can be cleared/set with 0 and 1.
2: Location Of Configuration Files
album looks for configuration files in a few locations, in order:
/etc/album/conf System-wide settings
/etc/album.conf System-wide settings
$BASENAME/album.conf In the 'album' install directory
$HOME/.albumrc User specific settings
$HOME/.album.conf User specific settings
$DOT/album.conf User specific (I keep my dot files elsewhere)
$USERPROFILE/album.conf For Windows (C:\Documents and Settings\TheUser)
album also looks for album.conf files inside the photo album directories.
Sub-albums can also have album.conf which will alter the settings
from parent directories (this allows you to, for example, have a
different theme for part of your photo album). Any album.conf files
in your photo album directories will configure the album and any sub-albums
unless overridden by any album.conf settings found in a sub-album.
As an example, consider a conf for a photo album at 'images/album.conf':
theme Dominatrix6
columns 3
And another conf inside 'images/europe/album.conf':
theme Blue
crop
album will use the Dominatrix6 theme for the images/ album and all of
it's sub-albums except for the images/europe/ album which will use
the Blue theme. All of the images/ album and sub-albums will have
3 columns since that wasn't changed in the images/europe/ album, however
all of the thumbnails in images/europe/ and all of it's sub-albums
will be cropped due to the 'crop' configuration setting.
3: Saving Options
Whenever you run an album, the command-line options are saved in
an album.conf inside the photo album directory. If an album.conf
already exists it will be modified not overwritten, so it is safe
to edit this file in a text editor.
This makes it easy to make subsequent calls to album. If you
first generate an album with:
% album -crop -no_known_images -theme Dominatrix6 -sort date images/
Then the next time you call album you can just:
% album images/
This works for sub-albums as well:
% album images/africa/
Will also find all of the saved options.
Some 'one-time only' options are not saved for obvious reasons, such
as -add, -clean, -force, -depth, etc..
Running album multiple times on the same directories can
get confusing if you don't understand how options are saved.
Here are some examples.
Premises:
1) Command-line options are processed before conf options found
in the album directory.
2) Album should run the same the next time you call it if you
don't specify any options.
For example, consider running album twice on a directory:
% album -exif "comment 1" photos/spain% album photos/spain
The second time you run album you'll still get the "comment 1"
exif comment in your photos directory.
3) Album shouldn't end up with multiple copies of the same array
options if you keep calling it with the same command-line
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 1" photos/spain
The second time you run album you will NOT end up with multiple
copies of the "comment 1" exif comment.
However, please note that if you re-specify the same options
each time, album may run slower because it thinks it needs to
regenerate your html!
As an example, if you run:
% album -medium 640x640 photos/spain
(then later...)
% album -medium 640x640 photos/spain
Then the second time will unnecessarily regenerate all your
medium images. This is much slower.
It's better to specify command-line options only the first time
and let them get saved, such as:
% album -medium 640x640 photos/spain
(then later...)
% album photos/spain
Unfortunately these constraints mean that any new array options will
be put at the beginning of your list of -exif options.
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 2" photos/spain
The comments will actually be ordered "comment 2" then "comment 1"
To specify exact ordering, you may need to re-specify all options.
Either specify "comment 1" to put it back on top:
% album -exif "comment 1" photos/spain
Or just specify all the options in the order you want:
% album -exif "comment 1" -exif "comment 2" photos/spain
Sometimes it may be easier to merely edit the album.conf file directly
to make any changes.
Finally, this only allows us to accumulate options.
We can delete options using -no and -clear, see the section on Options,
these settings (or clearings) will also be saved from run to run.
1: Simple album
Presuming you've already installed album properly, we can do some
simple cases. If you have any errors or problems here, see the
installation docs.
You need a web directory to put themes and your photo album.
We'll use /home/httpd/test in this documentation. This needs
to be viewable by a webserver. In this example we'll use the URL:
http://myserver/test/
Adjust your commands/URLs appropriately
First create a directory and put some images in it. We'll call this:
/home/httpd/test/Photos
And we'll add some images called 'IMG_001.jpg' through 'IMG_004.jpg'
Now for the simple case, just run album:
% album /home/httpd/test/Photos
Now you can view the album in a web browser at something like:
http://myserver/test/Photos
2: Add captions
Create a file /home/httpd/test/Photos/captions.txt with the following
contents (use the 'tab' key where you see " [tab] ")
-- captions.txt ---------
IMG_001.jpg [tab] First image name
IMG_002.jpg [tab] Second image
IMG_003.jpg [tab] Another image [tab] with a caption!
IMG_004.jpg [tab] Last image [tab] with another caption.
-------------------------
And run album again:
% album /home/httpd/test/Photos
And you'll see the captions change.
Now create a file with text in: /home/httpd/test/Photos/header.txt
And run album again. You'll see that text at the top of the page.
3: Hiding Photos
There are a few ways to hide photos/files/directories, but we'll use
the captions file. Try commenting out an image with '#' in captions.txt:
-- captions.txt ---------
IMG_001.jpg [tab] First image name
#IMG_002.jpg [tab] Second image
IMG_003.jpg [tab] Another image [tab] with a caption!
IMG_004.jpg [tab] Last image [tab] with another caption.
-------------------------
Run album again, and you'll see that IMG_002.jpg is now missing.
If we had done this before running album the first time, we wouldn't
have ever generated the medium or thumbnail images. If you like,
you can remove them now with -clean:
% album -clean /home/httpd/test/Photos4: Using A Theme
If themes were installed properly and are in your theme_path then
you should be able to use a theme with your album:
% album -theme Blue /home/httpd/test/Photos
The photo album should now be using the Blue theme. If it has
a bunch of broken images, then your theme probably hasn't been
installed into a web-accessible directory, see the Installation docs.
Album saves the options you specify, so the next time you run album:
% album /home/httpd/test/Photos
You'll still be using the Blue theme. To turn off a theme, you can:
% album -no_theme /home/httpd/test/Photos5: Medium images
Full resolution images are usually too big for a web album, so
we'll use medium images on the image pages:
% album -medium 33% /home/httpd/test/Photos
You can still access the full size images by clicking on the medium image, or:
% album -just_medium /home/httpd/test/Photos
Will keep the full size image from being linked in (presuming we'd
run with the -medium option at some point)
6: Adding some EXIF captions
Let's add aperture info to the captions of each image.
% album -exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
This will only add aperture information for any images that have specified
the 'Aperture' exif tag (the part between the '%' signs). We also put
a <br> tag in there so the exif info is on a new line.
We can add more exif info:
% album -exif "<br>focal: %FocalLength%" /home/httpd/test/Photos
Because album saved our options before, we now get both EXIF tags for any
images that specify Aperture and FocalLength. Let's remove aperture:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
The '-no_exif' option has to match the previous exif string exactly or
it will be ignored. You can also edit the config file that album created:
/home/httpd/test/Photos/album.conf
And remove it there.
7: Adding more albums
Let's say we go on a trip to spain. We take some photos and put them in:
/home/httpd/test/Photos/Spain/
Now run album again on the top level:
% album /home/httpd/test/Photos
This will fixup Photos so it now links to spain and will run album
on Spain/ as well, with the same settings/theme, etc..
Now let's go on another trip, and we create:
/home/httpd/test/Photos/Italy/
We could run album on the top level:
% album /home/httpd/test/Photos
But that would rescan the Spain directory which hasn't changed.
Album usually won't generate any HTML or thumbnails unless it needs to,
but it can still waste time, especially as our albums get bigger.
So we can tell it to just add the new directory:
% album -add /home/httpd/test/Photos/Italy
This will fix the top index (in Photos) and generate the Italy album.
8: Translated by:
David Ljung Madison [http://GetDave.com/]
album-4.17/Docs/txt_7 0000655 0000000 0000000 00000000000 11015005334 017065 1album-4.17/Docs/it/txt_7 ustar root root album-4.17/Docs/old/ 0000755 0000000 0000000 00000000000 11072326462 012714 5 ustar root root album-4.17/Docs/old/messages_8 0000654 0000000 0000000 00000016204 10535430574 014704 0 ustar root root Language Support
ITEM: Language Support Details
Language support is coming soon. I need volunteers to do translations
for me, specifically of:
1) The Mini How-To. Please translate from the source.
2) album messages, as listed below.
If you are willing to do the translation of either one or both
of these items, please contact me!
Also be sure to let me know how you want to be credited,
by your name, name and email, or name and website.
And please include the proper spelling and capitalization of the
name of your language in your language. For example, "franais"
instead of the "French"
I am open to suggestions for what charset to use. Current options are:
1) HTML characters such as [é]] (though they only work in browsers)
2) Unicode (UTF) such as [é] (though again, only in browsers)
3) ASCII code, where possible, such as [] (works in text editors, though
not currently in this page because it's set to unicode)
ITEM: Album messages
Here's a full list of messages I need translated. If you can only
do a portion of the list, that could still be helpful.
Ignore anything that starts with "##" - that's just for organization.
########################################
## Beginning of translated messages
########################################
##
## USAGE
##
Usage: album
Makes a photo album
All boolean options can be turned off with '-no_
"
# Header for short index
Short_Header = "conf(my_doctype)
MarginalHacks album - Documentation
conf(my_head_head)
SPACE_OUT(Documentation)
conf(my_head_head2)
"
album-4.17/Docs/ru/txt_5 0000644 0000000 0000000 00000023442 11602260342 013550 0 ustar root root Специфические запросы, Сообщения о некорректной работе программы
ITEM: Специфические запросы
Если имеется что-то, что вы хотите добавить в приложение
album, убедитесь не существует уже это? Посмотрите
man страницу следующей командой:
% man album
% album -h
Естественно можно использовать опции -more и -usage
(будет удобнее читать).
Если вы не увидите того, что хотели увидеть, то можете
подумать о том, чтобы написать дополнение.
ITEM: Сообщения о некорректной работе программы
Перед тем, как прислать сообщение об ошибке, проверьте установлена
ли у вас последняя версия приложения album!
Когда присылается информация об ошибочной работе программы,
мне необходимо знать как минимум:
1) Тип и точное название вашей операционной системы
2) Точное описание проблемы и точное описание сообщений об ошибках
Так же необходимо знать, если возможно:
1) Точно команду, которой было запущено приложение album
2) Вывод программы после ее запуска
И, естественно, также необходимо запустить приложение album с ключем
отладки:
% album -d
В итоге, удостоверьтесь, что у вас установлена не только последняя
версия приложения album, но и самая последняя версия тем.
ITEM: Написание исправлений (патчей), модифицирование приложения album
Если вы хотите модифицровать album, вы наверняка захотите, убедиться
в том, что нет ли вашей задумки в моих ближайших планах.
Если нет, то прежде всего подумайте о разработке дополнения (plugin)
вместо модифицрования самого исходного кода приложения album. Это может
предотвратить ненужное усложнение album, путем введения возможностей,
которые не нужны всем потенциальным пользователям.
Если есть необходимость переработать само приложение album (к примеру, если
четко проявилась некорректная работа программы), то пожалуйста убедитесь еще раз
раз, что у вас загружена и используется самая последня копия приложения
album, и только потом приступайте к написанию исправления (патча),
который потом можно прислать мне или весь текст исправленно скрипта.
Естественно, если вы не внесете каких-либо комментариев в текст скрипта
- это тоже будет не очень хорошо.
ITEM: Известные ошибки
v3.11: -clear_* and -no_* не очищает родительский каталог.
v3.10: Не производится запись на CD и не работает с абсолютными путями тем.
v3.00: Множества и опции кода сохраняются в кавычках, к примеру:
"album -lang aa .. ; album -lang bb .." будет все еще использовать язык 'aa'
Так, в некоторых случаях опции множеств/кода не будут работать в правильном
порядка при первом вызове программы. Чтобы решить эту проблему надо
запустить приложение album по-новой. К примеру:
"album -exif A photos/ ; album -exif B photos/sub"
Будет иметь "B A" для подкаталога альбом, а "A B" после: "album photos/sub"
ITEM: ПРОБЛЕМА: Мои index-страницы очень большие!
Я получаю много отзывов о том, что index-страницы перестают нормально работать,
после достижения определенного порога параметров используемых изображений.
Эта проблема, которую сложно решить (особенно при большом количестве фотографий),
пока index-страница строится без альбомов второго уровня, т.е. когда ссылки все
фотографии расположены на одной странице. Но теперь у вас есть несколько важных элементов,
позволяющих упростить работу с приложением и избежать генерации очень больших index-
страниц. Это - создание других index-файлов, создание других альбомов и
создание других иконок. При этом, если ваши альбомы второго уровня имеют темы, отличные от тем,
альбомов первого уровня, можно запускать приложения только для части галлереи, а не
для всей коллекции изображений (например, только для одного альбома второго уровня, или
только для изменения вида или других параметров иконок альбома этого альбома второго
уровня).
Следующий релиз приложения album будет иметь такую возможность (т.е. автоматически
строить древовидную иерархическую систему галерей), но пока эту идею можно реализовать
немного иначе - просто, распологая изображения галерей второго уровня в отдельных,
каталогах и последовательно запуская в них приложение album (со своими настройками,
например, выбранными темами)
Так же имеется простое приложение, которое переместит новые изображения в
подкаталоги так, чтобы после запустить само приложение album:
in_album
ITEM: ОШИБКА: нет метода для этого формата изображения (./album)
Ваш скрипт самого приложения album может оказаться в вашей папке с изображениями,
в этом случае он не может сделать иконку предпросмотра самого себя. Либо:
1) Переместите вывод приложения album из каталога с фотографиями (допустим)
2) Запустите album с -known_images
ITEM: ОШИБКА: нет метода для этого формата изображения (some_non_image_file)
Размещайте только файлы изображения в вашем каталоге с фотографиями или запускайте
приложение album c опцией -known_images.
ITEM: ОШИБКА: нет метода для этого формата изображения (some.jpg)
ITEM: ОШИБКА: идентификация: JPEG библиотека не доступна (some.jpg)
Установка пакета ImageMagick выполнена не полностью, поэтому в системе нет
информации о том, что надо делать с данным типом графического файла.
ITEM: ОШИБКА: Не могу получить [some_image] размеры из -verbose output.
ImageMagick не располагает информацией о размере указанного изображения. Либо:
1) Ваша ImageMagick установка не выполнена полностью и в системе нет информации о том,
что делать с данным форматом графического файлы.
2) Вы запустили album в каталоге с файлами, которые не являются графическими, причем
не использовали опцию -known_images, чтобы дать информацию приложению об этом.
Если вы пользователь linux пользователь и видите ошибку, просто запустите
приложение как администратор (суперпользователь) (спасибо Alex Pientka):
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
ITEM: Переведено
Чубаровым И.Ю. (Tchubarov I, aka krolik, ceramic64@yandex.ru)
album-4.17/Docs/ru/Section_3.html 0000644 0000000 0000000 00000144517 12661460265 015321 0 ustar root root
MarginalHacks album - Запуск приложения, основные возможности
- Documentation
1: Основная работа
Создайте папку и поместите в нее графические файлы. Скрипт приложения album,
как и какую-либо другую программу помещать в этот каталог не нужно.
Надо просто запустить приложение album из любого места, просто указав папку
с изображениями:
% album /example/path/to/images/
Или, если, к примеру вы находитесь в /example/path/to каталоге:
% album images/
Когда все это будет сделано, вы получите готовый фотоальбом внутри папки
images/index.html.
Если это путь на вашем web-сервере, то вы сможете увидеть созданную галерею
в браузере, указав этот путь (в данном случае адрес). Если этого не произойдет -
свяжитесь с системным администраторов сервера, на котором находится ваш ресурс.
2: Опции
Имеется три типа опций. Булевы опции (они могут иметь только два значения),
строковые и числовые опции и опции в форме массивов. Булевы опции могут выключены
при помощи написания префикса -no_:
% album -no_image_pages
Строковые или числовые значение опций указываются после строки самой опции:
% album -type gif % album -columns 5
Множества опций могут быть заданы двумя способами, с одним аргументов за один раз:
% album -exif hi -exif there
Или с несколькими аргументами с использованием формы '--':
% album --exif hi there --
Вы можете убрать указанные опции конструкцией -no_<option>
и отчистить все множества опций конструкцией -clear_<option>.
Для отчиски множества опций (например, чтобы отчистить конфигурации из
предыдущего запуска приложения album), введите:
% album -clear_exif -exif "new exif"
(здесь опция -clear_exif вычистит все предыдущие exif установки и затем
следующая опция -exif добавит новый exif комментарий)
И в итоге, вы можете удалить множество опции путем написание префикса 'no_',
к примеру:
% album -no_exif hi
здесь будет удалено 'hi' exif значение, а значение 'there' (к примеру) останется
нетронутым.
Посмотрите также раздел по сохранению опций.
Получить краткое пояснение по опциям можно командой:
% album -h
Чтобы увидеть больше возможной введите:
% album -more
А, чтобы получить еще больше введите:
% album -usage=2
Вы можете указать любое число больше, и получить тот же результат
(к примеру написать 100)
Дополнения (plugin) могут иметь собственные опции, со своим собственными
особенностями использования.
3: Темы
Темы - это та часть галереи, которая делает альбом с фотографиями
особенным и интригующим. Вы можете можете сами определять как
будет выглядеть ваша галерея фотографий путем скачивания тем с ресурса
MarginalHacks или даже путем написания ваших собственных так, чтобы
они соответствовали стилевому оформлению вашего сайта.
Для использования темы, загрузите файл архива темы .tar илиr .zip и
распакуйте его.
Темы находятся приложения посредством указания опции -theme_path, которая
представляет собой место где помещены папки с темами. В принципе, это
место может быть где угодно на вашем компьютере или web-сервере, но только
не внутри папки с фотографиями.
Вы можете либо переместить тему по указанному в опции theme_paths пути
для галереи, которая уже используется или создать новый путь, который
тоже надо будет указать как аргумент все той же опции -theme_path.
(-theme_path может быть папкой внутри другой папки с темой, единственное
требование только, чтобы это была собственно отдельная папка)
Затем выполните приложение album с опцией -theme option, с указанием или без
опции -theme_path:
% album -theme Dominatrix6 my_photos/ % album -theme Dominatrix6 -theme_path /home/httpd/album/Themes/ my_photos/
Вы можете также создать ваши собственные темы очень легко, об этом будет рассказано
в последующих разделах этой документации.
4: Галереи более низких уровней.
Если сделать папки внутри первой папки и поместить в них изображения то
можно получить галереи второго уровня. Для этого просто надо запустить
приложение album, указав папку верхнего уровня, после чего будет
создана одна галерея, с входящим в нее галереями более низких уровней.
Причем если вы только измените одну из галерей более низкого уровня, и затем
снова запустите приложение album, проверит и обновит все ссылки на родительские
галереи, и сгенерирует, при необходимости, все заново.
Если же вы не хотите, чтобы приложение album создавало галереи более низких уровней,
целесообразно указать глубину анализа, при помощи опции. Например, так:
% album images/ -depth 1
В этом случае будут генерироваться галереи только в папке images.
Если же у вас много галерей низкого уровня, и вы хотите добавить новую галерею
фотографий без генерации всех предыдущих галерей второго уровня, вы можете
использовать опцию -add:
% album -add images/new_album/
В этом случае будет добавлено new_album к HTML в 'images/' и затем
будут сгенерированы иконки и HTML для всего, что находится внутри 'images/new_album/'
5: Повторная генерация иконок предпросмотра
Приложение album спроектировано так, чтобы не делать лишней работы. Он создает
иконки предпросмотра только если они не существуют в данный момент или были изменены
графические файлы прототипы. При таком подходе скорость существенно увеличивается,
особенно при обработке больших объемов графических файлов.
Правда, такой подход может стать причиной и проблем, если вы измените размер или
вырежете что-то из изображение самих иконок предпросмотра, поскольку в приложении
albom нет реализовано какое-либо действие, если вы меняете сами иконки предпросмотра
Но, вы можете использовать опцию принудительно генерации иконок предпросмотра, если
вы с ними все же что-то делали:
% album -force images/
Но, вам нет нужды использоваться -force все время, естественно.
6: Удаление иконок предпросмотра
Если вы хотите удалить изображения из вашей галереи, то вам так же надо будет
удалить и иконки предпросмотра и откорректировать HTML файл.
Вы может все это сделать при помощи всего одного запуска приложения album,
с опцией -clean option:
% album -clean images/ 7: Изображения среднего размера
Когда вы нажимаете на изображение иконки предпросмотра вы попадаете
на страницу с полноразмерным изображением. По умолчанию эта страница показывает
изображение полного размера (примерно так же как кнопки навигации и т.п.). Естественно,
если вы нажмете на изображение полного размера, то получите только его.
Но, если вы хотите, чтобы после нажатия на иконку предпросмотра выводилось окно с
уменьшенным изображением, можно использовать опцию -medium и указать геометрический размер этого изображения. Вы может указать любой размер, который сможет нормально интерпретировать утилита ImageMagick (для более полной информации - посмотрите инструкцию
к этому пакету). К примеру:
# Изображение, которое будет половину от полного размера
% album -medium 50%
# Изображение, которое будет вписано в прямоугольник 640x480 (по наибольшей стороне)
% album -medium 640x480
# Изображение, которое будет уменьшено и вписано в прямоугольник 640x480
# (но не увеличено, если оно меньше 640x480)
% album -medium '640x480>'
Вам необходимы 'кавычки' в последнем примере, т.к. большинство оболочек операционных систем трактует символ '>' как элемент другой команды.
8: Подписи под фотографиями
Изображения и иконки предпросмотра часто имеют названия и разные поясняющие надписи. И есть много способов, чтобы указать или изменить названия или надписи под изображениями в ваших галереях.
В качестве примера надписи может выступать название изображения, которое может быть
ссылкой на страницу с полноразмерным изображением, комментарий же может быть ниже:
По умолчанию имя изображение это имя файла, без расширения. Например:
"Kodi_Cow.gif" => "Kodi Cow"
Один из способов написать комментарий к изображению в галерее, использовать .txt файл, с
тем же самым именем файла, что и изображение. Для примера, указанного выше, это может быть файл "Kodi_Cow.txt", который вполне может содержать "Kodi takes down a cow!"
Вы можете переименовать ваши файлы с изображения и указать комментарии в отдельном файле, но для всех изображения сразу, расположим его в той же папке и назвав его captions.txt.
Каждая линия этого файла должна быть именем изображения, расположенного в папке галереи или именем папки более низкого уровня, написанного в форме таблицы.
Вы можете так же указать (отделяя при помощи знаков табуляции, т.е. клавиши TAB), дополнительные пояснительные надписи или альтернативные метки. (чтобы пропустить поле надписи просто используйте 'tab' 'space' 'tab')
Вот примеры:
001.gif Моя первая фотография
002.gif Мама и папа Мои родители в горах
003.gif Ani DiFranco My fiancee Yowsers!
Все изображения в папке будут отсортированы в том порядке, в котором они указаны в файле с надписями. Вы может изменить этот порядок путем использования опций '-sort date' и '-sort name'
Если ваш редактор не дает возможность использовать знаки табуляции (tabs) вы можете отделить поля при помощи двойного использования знака двоеточия, но только если пояснения к изображениям не будут содержать двоеточий и символов табуляции (tabs):
003.gif :: Ani DiFranco :: My fiancee :: Yowsers!
Если вы хотите только видеть пояснения на страницах с полноразмерными изображениями (не на главной странице галереи с иконками предпросмотра) используйте опцию:
% album -no_album_captions
Если вы хотите иметь web доступ для создания/редактирования ваших пояснения, ознакомьтесь с файлом caption_edit.cgi CGI скрипта (но не забудьте удостовериться, что доступ к этому файлу будет ограничен, чтобы кто угодно не смог внести в него ненужные изменения или правки!)
9: EXIF информация для комментариев в фотографиям
Вы можете также сделать комментарии, которые основываются на EXIF данных
(дословный перевод аббревиатуры EXIF - формат файлов, пригодный для обмена),
которые формирует практически любой современный цифровой фотоаппарата.
Чтобы осуществить это, вам нужно установить 'jhead' так, чтобы можно было его
запустить и увидеть информацию о JPG файле.
Комментарии, с EXIF информацией добавляются к обычным комментарием, после
добавления опции -exif при запуске приложения album, например:
% album -exif "<br>File: %File name% taken with %Camera make%"
Любой указанный %ярлык% будет замещен информация из EXIF. Если любой из %ярлыков%
не будет найдет в EXIF информации, то строка EXIF комментария будет пропущена.
Так же вы можете указать несколько строк для вывод EXIF информации, вот таким
образом:
% album -exif "<br>File: %File name% " -exif "taken with %Camera make%"
В этом случае, если поле данных 'камеры' не будет найдено вы можете получить
комментарий с информацией из поля 'имя файла'.
Подобно и другим опциям, чтобы добавить комментарий с EXIF информацией, можно
использовать формат опции --exif, примерно так:
% album --exif "<br>File: %File name% " "taken with %Camera make%" --
Заметим, однако, что как и в случае, указанном выше вы можете включить HTML код
в ваш ярлык поля EXIF:
% album -exif "<br>Aperture: %Aperture%"
Чтобы увидеть все возможные EXIF поля (разрешение, дата/время, диафрагма и т.п.)
можно запустить программу 'jhead' с интересующим файлом, как аргумент. Также
для просмотра информации в полях EXIF можно использовать любую другую программу,
которая выводит значения полей структуры EXIF. Обратите внимание, что значения
полей надо писать на английском языке.
Вы может также указывать EXIF комментарии только для страницы с иконками предпросмотра или страниц с полноразмерными изображениям. Для этого надо добавить
необходимые опции при вызове приложения album: -exif_album или -exif_image.
10: Верхний и нижний колонтитулы на страницах
В каждой папке с графическими файлами можно поместить текстовый файлы header.txt и footer.txt. При сборке альбома информация из них будет отражаться как верхний и нижний колонтитулы на странице с галереей, конечно, если используемая тема поддерживает эту возможность.
11: Скрытие файлов и папок
Любой тип файлов, который приложение album на опознает как графическое изображение
будет проигнорирован. Чтобы включить возможность отражения на странице с галерей
этих файлов, можно применить опцию -no_known_images. (-known_images - установлено
по умолчанию)
Вы можете так же пометить изображения как не файл не изображения, путем создания
пустого файла с тем же самым именем, что и изображение с графикой, но с
расширением: .not_img .
Таким же образом можно включить полное игнорирование, путем создания пустого
файла с тем же самым названием и расширением: .hide_album .
Если по каким-то причинам не хотите добавлять фотографии из какой-либо папки
в общую галерею фотографий, аналогично подходу с отдельными
файлами, можно добавить пустой файл <dir>/.no_album. Где <dir> - название
папки, которую не надо включать в общую галерею.
Точно так же можно полностью игнорирвать создание галерей для отдельных
папок, для этого создается пустой файл <dir>/.hide_album. Где <dir> - название
папки, которую надо игнорировать.
В Windows версиях приложения album нельзя создать файл, название которого
начиналось бы с точки, поэтому используется те же названия но без точек.
12: Обрезка изображений для создания иконок предпросмотра
Если ваши изображение очень большие и имеют различные соотношение по ширины
и высоте (к примеры, когда имеется много изображени форматов вертикальной и
горизонтальной ориентации) или если ваша тема позволяет работать с изображениями
только какой-то определенной ориентации, то вам может понадобиться сделать так,
чтобы иконки предпросмотра все были подрезаны в одном стиле с одним и тем же
соотношением ширины к высоте, то, для этого существует опция:.
% album -crop
По умолчанию все изображения вырезаются по центру. Но если вас это не
устраивает, то можно задать место откуда будет производится вырезка нужного
фрагмента для создания иконок предпросмотра. Для этого надо слегка изменить
названия изображений, так, чтобы при сборке галереи у приложения
album была информация о том, с какого места надо вырезать изображение,
для создания иконки предпросмотра. К примеру, у вас есть файл "Kodi.gif" c
горизонтальной ориентацией, чтобы при создании иконки предпросмотра была
вырезана верхняя часть из графического файла приведите название
файла к виду "Kodi.CROPtop.gif" (для удаления старых иконок предпросмотра
не забудьте воспользоваться опцией -clean).
Слово CROP будет убрано из название файла, когда он будет использоваться
для создания HTML страницы.
По умолчанию соотношение сторон иконок предпросмотра 133x133. Т.е. для
изображений с вертикальной ориентаций иконки будут создаваться как 133x100,
а с для горизонтальной - 100x133. Если вы используете опцию для обрезки
изображений и хотите, чтобы соотношения оставались те ми же самыми,
используйте такую команду:
% album -crop -geometry 133x100
Но, помните, что если вы измените -crop или -geometry установки
на ранее собранных галереях, вам потребуется указать опцию -force
(один раз, естественно), чтобы вся галерея была собрана заново.
13: Видео
Приложение album может генерировать скриншоты с многих форматов видео,
конечно, если вы установили пакет ffmpeg.
Если вы работаете на linux-машине с процессором x86, то вы можете просто
взять бинарные файлы этого пакета с ресурса ffmpeg.org (это проще установки).
14: Запись на CD (путем использования file://)
Если вы используете приложение album для записи на CD ваших галерей через
file://, то вам нет необходимости создавать "index.html". Более того, если
вы используете темы вам необходимы относительные пути. В данном случае
вы не можете использоваться опцию -theme_url, поскольку не знаете где же будет
конечный адрес вашей страницы. На Windows-машинах путь к теме может быть
похож на "C:/Themes" или на UNIX- или OSX-машинах он может быть
похож на что-то типаe "/mnt/cd/Themes", все будет зависеть от точки
монтирования привода CD. Чтобы решить все эти проблемы используйте
опцию -burn:
% album -burn ...
В результате должно получится, что пути к теме будут одни и те же.
Очень удобно это сделать, если папки с темами разместить на
верхнем уровне, как и папку с фотографиями галереи:
myISO/Photos/
myISO/Themes/Blue
Теперь можно запустить приложение album со следующими опциями:
% album -burn -theme myISO/Themes/Blue myISO/Photos
Теперь можно записать образ CD из папки myISO папки (или из любой точки выше).
Для Windows-пользователей можно также точно запустить и оболочку,
например, автоматически запустить браузер для просмотра галереи (или посмотрите winopen)
15: Индексирование всей галереи
Чтобы просматривать всю галерею под одной странице можно использовать опцию
caption_index. Он использует те же самые опции, что и приложение album
в обычном режиме запуска (несмотря на то, что многие из них все же
игнорируются). В результат получится HTML файл, с описанием всего, что
есть в галерее.
Для того, чтобы понять что это такое посмотрите примеры альбомов, example index на сайте
для галереи-примера.
16: Обновление галерей с использованием CGI
Первое, что вам будет необходимо для работы с CGI - это возможность
загрузки фотографий в папки ваших галерей. Обычно для этой цели
везде принято использовать ftp. Хотя вы может написать java-скрипт,
который загрузит файлы
Затем вам необходимо будет удаленно запустить приложение album (т.е.
запустить его на удаленной машине). Чтобы исключить возможные злоупотребления,
обычно CGI скрипт ставится так, чтобы только касаться файла (или будет
иметься доступ только по ftp) и затем будет выполнена работа по расписанию,
которая проверяет файлы каждые несколько минут, и если обнаружит, что один
из них был заменен, то запустит приложение album.
[только для unix] (Вероятно вам необходимо будет установить значение
переменной окружения $PATH или использоваться абсолютные пути в скрипте
при конвертации)
Если вы хотите мгновенного запуска приложения album, то для этого
надо просто использовать скрипт именно для его запуска, например, one..
Если фотографии не собственно пользователя web-сервера, то вам
необходимо запустить setud-скрипт, который запустит вам приложение
через CGI [только для unix]. Разместите setud-скрипт в безопасном месте,
измените его владельца, на того же самого, что и владелец фотографий,
затем запустить "chmod ug+s". Здесь имеются примеры
setuid - и CGICGI-скриптов. Просто подредактируйте их, как вам нужно.
Также посмотрите caption_edit.cgi который позволит вам (или другим)
удаленно (через web) редактировать captions/names/headers/footers
17: Переведено
Чубаровым И.Ю. (Tchubarov I, aka krolik, ceramic64@yandex.ru)
1: Using languages
(Requires album v4.0 or higher)
Album comes prepackaged with language files (we're in need of translation
help, see below!). The language files will alter most of album's output
messages, as well as any HTML output that isn't generated by the theme.
Altering any text in a theme to match your language is as simple as editing
the Theme files - there is an example of this with the "simple-Czech" theme.
To use a language, add the "lang" option to your main album.conf, or else
specify it the first time you generate an album (it will be saved with that
album afterwards).
Languages can be cleared like any code/array option with:
% album -clear_lang ...
You can specify multiple languages, which can matter if a language is
incomplete, but you'd like to default to another language than english.
So, for example, if you wanted Dutch as the primary language, with the
backup being Swedish Chef, you could do:
% album -lang swedish_chef -lang nl ...
If you specify a sublanguage (such as es-bo for Spanish, Bolivia), then
album will attempt 'es' first as a backup.
Note that because of a known bug, you should specify all the desired
languages at the same time instead of over multiple invocations of album.
To see what languages are available:
% album -list_langs
Sadly, most of the (real) languages are barely complete, but this
is a chance for people to help out by becoming a..
2: Translation Volunteers
The album project is in need of volunteers to do translations,
specifically of:
1) The Mini How-To. Please translate from the source.
2) album messages, as explained below.
If you are willing to do the translation of either one or both
of these items, please contact me!
If you're feeling particularly ambitious, feel free to translate any
of the other Documentation sources as well, just let me know!
3: Documentation Translation
The most important document to translate is the "Mini How-To".
Please translate from the text source.
Also be sure to let me know how you want to be credited,
by your name, name and email, or name and website.
And please include the proper spelling and capitalization of the
name of your language in your language. For example, "franais"
instead of "French"
I am open to suggestions for what charset to use. Current options are:
1) HTML characters such as [é]] (though they only work in browsers)
2) Unicode (UTF-8) such as [é] (only in browsers and some terminals)
3) ASCII code, where possible, such as [] (works in text editors, though
not currently in this page because it's set to unicode)
4) Language specific iso such as iso-8859-8-I for Hebrew.
Currently Unicode (utf-8) seems best for languages that aren't covered
by iso-8859-1, because it covers all languages and helps us deal with
incomplete translations (which would otherwise require multiple charsets,
which is a disaster). Any iso code that is a subset of utf-8 can be used.
If the main terminal software for a given language is in an iso charset
instead of utf, then that could be a good exception to use non-utf.
4: Album messages
album handles all text messages using it's own language support
system, similar to the system used by the perl module Locale::Maketext.
(More info on the inspiration for this is in TPJ13)
An error message, for example, may look like this:
No themes found in [[some directory]].
With a specific example being:
No themes found in /www/var/themes.
In Dutch, this would be:
Geen thema gevonden in /www/var/themes.
The "variable" in this case is "/www/var/themes" and it obviously
isn't translated. In album, the actual error message looks like:
'No themes found in [_1].'
# Args: [_1] = $dir
The translation (in Dutch) looks like:
'No themes found in [_1].' => 'Geen thema gevonden in [_1].'
After translating, album will replace [_1] with the directory.
Sometimes we'll have multiple variables, and they may change places:
Some example errors:
Need to specify -medium with -just_medium option.
Need to specify -theme_url with -theme option.
In Dutch, the first would be:
Met de optie -just_medium moet -medium opgegeven worden.
The actual error with it's Dutch translation is:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet [_1] opgegeven worden'
# Args: [_1]='-medium' [_2]='-just_medium'
Note that the variables have changed places.
There is also a special operator for quantities, for example,
we may wish to translate:
'I have 42 images'
Where the number 42 may change. In English, it is adequate to say:
0 images, 1 image, 2 images, 3 images...
Whereas in Dutch we would have:
0 afbeeldingen, 1 afbeelding, 2 afbeeldingen, 3 afbeeldingen..
But other languages (such as many slavic languages) may have special
rules as to whether "image" should be pluralized based on whether the
quantity is mod 2, 3 or 4, and so on! The simplest case is covered
by the [quant] operator:
[quant,_1,image]
This is similar to "[_1] image" except that "image" will be pluralized
if [_1] is 0 or greater than 1:
0 images, 1 image, 2 images, 3 images...
Pluralization is simply adding an 's' - if this isn't adequate, we can
specify the plural form:
[quant,_1,afbeelding,afbeeldingen]
Which gives us the Dutch count above.
And if we need a special form for 0, we can specify that:
[quant,_1,directory,directories,no directories]
Which would create:
no directories, 1 directory, 2 directories, ...
There is also a shorthand for [quant] using '*', so these are the same:
[quant,_1,image]
[*,_1,image]
So now an example translation for a number of images:
'[*,_1,image]'
=> '[*,_1,afbeelding,afbeeldingen]',
If you have something more complicated then you can use perl code, I
can help you write this if you let me know how the translation should work:
'[*,_1,image]'
=> \&russian_quantity; # This is a sub defined elsewhere..
Since the translation strings are (generally) placed in single-quotes (')
and due to the special [bracket] codes, we need to quote these correctly.
Single-quotes in the string need to be preceded by a slash (\):
'I can\'t find any images'
And square brackets are quoted using (~):
'Problem with option ~[-medium~]'
Which unfortunately can get ugly if the thing inside the square brackets
is a variable:
'Problem with option ~[[_1]~]'
Just be careful and make sure all brackets are closed appropriately.
Furthermore, in almost all cases, the translation should have the
same variables as the original:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet' # <- Where did [_1] go?!?
Fortunately, most of the work is done for you. Language files are
saved in the -data_path (or -lang_path) where album keeps it's data.
They are essentially perl code, and they can be auto-generated by album:
% album -make_lang sw
Will create a new, empty language file called 'sw' (Swedish). Go ahead
and edit that file, adding translations as you can. It's okay to leave
translations blank, they just won't get used. Some of the more important
translations (such as the ones that go into HTML pages) are at the top
and should probably be done first.
You will need to pick a charset, this is tricky, as it should be based
on what charsets you think people will be likely to have available
in their terminal as well as in their browser.
If you want to build a new language file, using translations from
a previous file (for example, to update a language with whatever
new messages have been added to album), you should load the language first:
% album -lang sw -make_lang sw
Any translations in the current Swedish language file will be copied
over to the new file (though comments and other code will not be copied!)
For the really long lines of text, don't worry about adding any newline
characters (\n) except where they exist in the original. album will
do word wrap appropriately for the longer sections of text.
Please contact me when you are starting translation work so I can
be sure that we don't have two translators working on the same parts,
and be sure to send me updates of language files as the progress, even
incomplete language files are useful!
If you have any questions about how to read the syntax of the language
file, please let me know.
5: Why am I still seeing English?
After choosing another language, you can still sometimes see English:
1) Option names are still in English. (-geometry is still -geometry)
2) The usage strings are not currently translated.
3) Plugin output is unlikely to be translated.
4) Language files aren't always complete, and will only translate what they know.
5) album may have new output that the language file doesn't know about yet.
6) Most themes are in English.
Fortunately the last one is the easiest to change, just edit the theme
and replace the HTML text portions with whatever language you like, or
create new graphics in a different language for icons with English.
If you create a new theme, I'd love to hear about it!
1: Methods
There are easy ways and complicated ways to create a custom theme,
depending on what you want to be able to do.
2: Editing current theme HTML
If you just want to slightly change the theme to match the output
of your site, it might make sense to edit a current theme.
In the theme directory there are two *.th files. album.th is
the template for album pages (the thumbnail pages) and image.th
is the template for image pages (where you can see medium or full
size images). The files are very similar to HTML except for
some embedded <: ePerl :> code. Even if you don't know perl or
ePerl you can still edit the HTML to make simple changes.
Good starting themes:
Any simmer_theme is going to be up to date and clean, such as "Blue" or
"Maste." If you only need 4 corner thumbnail borders then take a look
at "Eddie Bauer." If you want overlay/transparent borders, see FunLand.
If you want something demonstrating a minimal amount of code, try "simple"
but be warned that I haven't touched the theme in a long time.
3: The easy way, simmer_theme from graphics.
Most themes have the same basic form, show a bunch of thumbnails
for directories and then for images, with a graphic border, line and
background. If this is what you want, but you want to create new
graphics, then there is a tool that will build your themes for you.
If you create a directory with the images and a CREDIT file as well
as a Font or Style.css file, then simmer_theme will create theme for you.
Files:
Font/Style.css
This determines the fonts used by the theme. The "Font" file is the
older system, documented below. Create a Style.css file and define
styles for: body, title, main, credit and anything else you like.
See FunLand for a simple example.
Alternatively, use a font file. An example Font file is:
--------------------------------------------------
$TITLE_FONT = "size='4' color='#ffffff' face='Times New Roman,Georgia,Times'";
$MAIN_FONT = "face='Times New Roman,Georgia,Times'";
$CREDIT_FONT = "size='-1' face='Verdana' color='#ffffff'";
$BODY = "background='$PATH/bkgrnd.gif' link='#0099FF'">
--------------------------------------------------
CREDIT
The credit file is two lines and is used for the theme index at MarginalHacks.
If you're never submitting your theme to us, then you don't need this file.
(But please do!) If so, the two lines (and only two lines) are:
1) A short description of the theme (keep it all on one line)
2) Your name (can be inside a mailto: or href link)
Null.gif
Each simmer theme needs a spacer image, this is a 1x1 transparent gif.
You can just copy this from another simmer theme.
Optional image files:
Bar Images
The bar is composed of Bar_L.gif, Bar_R.gif and Bar_M.gif in the middle.
The middle is stretched. If you need a middle piece that isn't stretched, use:
Bar_L.gif, Bar_ML.gif, Bar_M.gif, Bar_MR.gif, Bar_R.gif
And then the Bar_ML.gif and Bar_MR.gif will be stretched. (See the
Craftsman theme for an example of this).
Locked.gif
A lock image for any directories that have .htaccess
Background image
If you want a background image, specify it in the Font file in the $BODY
section, as in the example above. The $PATH variable will be replaced
with the path to the theme files:
More.gif
When an album page has sub-albums to list, it first shows the 'More.gif'
image.
Next.gif, Prev.gif, Back.gif
For the next and previous arrows and the back button
Icon.gif
Shown at the top left by the parent albums, this is often just the text "Photos"
Border Images
There are many ways to slice up a border, from simple to complex, depending on
the complexity of the border and how much you want to be able to stretch it:
4 pieces Uses Bord_L.gif, Bord_R.gif, Bord_T.gif, Bord_B.gif
(The corners go with the left and right images)
4 piece borders usually don't stretch well so they don't work well on
image_pages. Generally you can cut the corners out of the left and
right images to make:
8 pieces Also includes Bord_TL.gif, Bord_TR.gif, Bord_BL.gif, Bord_BR.gif
8 piece borders allow you to stretch to handle most sized images
12 pieces Also includes Bord_LT.gif, Bord_RT.gif, Bord_LB.gif, Bord_RB.gif
12 pieces allow stretching of borders that have more complex corners (such
as Dominatrix6 or Ivy)
Overlay Borders Can use transparent images that can be partially
overlaying your thumbnail. See below.
Here's how the normal border pieces are laid out:
12 piece borders
TL T TR 8 piece borders 4 piece borders
LT RT TL T TR TTTTTTT
L IMG R L IMG R L IMG R
LB RB BL B BR BBBBBBB
BL B BR
Note that every row of images must be the same height, though the
widths do not have to line up. (i.e., height TL = height T = height TR)
(This is not true about overlay borders!)
Once you've created these files, you can run the simmer_theme tool
(an optional tool download at MarginalHacks.com) and your theme will
then be ready to use!
If you need different borders for the image pages, then use the same
filenames prefixed by 'I' - such as IBord_LT.gif, IBord_RT.gif,...
Overlay borders allow for really fantastic effects with image borders.
Currently there's no support for different overlay borders for images.
For using Overlay borders, create images:
Over_TL.png Over_T.png Over_TR.png
Over_L.png Over_R.png
Over_BL.png Over_B.png Over_BR.png
Then figure out how many pixels of the borders are padding (outside photo)
Then put those values in files: Over_T.pad Over_R.pad Over_B.pad Over_L.pad
See "Themes/FunLand" for a simple example
Multi-lingual Images
If your images have text, you can translate them into other languages
so that albums can be generated in other languages. For example, you
can create a Dutch "More.gif" image and put it in 'lang/nl/More.gif'
in the theme (nl is the language code for Dutch).
When the user runs album in Dutch (album -lang nl) then the theme
will use the Dutch image if found. Themes/Blue has a simple example.
The currently "translated" images are:
More, Back, Next, Prev and Icon
You can create an HTML table that shows the translations immediately
available to themes with -list_html_trans:
% album -list_html_trans > trans.html
Then view trans.html in a browser. Unfortunately different languages
have different charsets, and an HTML page can only have one. The
output is in utf-8, but you can edit the "charset=utf-8" to properly
view language characters in different charsets (such as hebrew).
If you need more words translated for themes, let me know, and if you
create any new language images for a theme, please send them to me!
4: From scratch, Theme API
This is a much heavier job - you need to have a very clear idea of
how you want album to place the images on your page. It might be
a good idea to start with modifying existing themes first to get
an idea of what most themes do. Also look at existing themes
for code examples (see suggestions above).
Themes are directories that contain at the minimum an 'album.th' file.
This is the album page theme template. Often they also contain an 'image.th'
which is the image theme template, and any graphics/css used by the theme.
Album pages contain thumbnails and image pages show full/medium sized images.
The .th files are ePerl, which is perl embedded inside of HTML. They
end up looking a great deal like the actual album and image HTML themselves.
To write a theme, you'll need to understand the ePerl syntax. You can
find more information from the actual ePerl tool available at MarginalHacks
(though this tool is not needed to use themes in album).
There are a plethora of support routines available, but often only
a fraction of these are necessary - it may help to look at other themes
to see how they are generally constructed.
Function table:
Required Functions
Meta() Must be called in the section of HTML
Credit() Gives credit ('this album created by..')
Must be called in the section of HTML
Body_Tag() Called inside the actual tag.
Paths and Options
Option($name) Get the value of an option/configuration setting
Version() Return the album version
Version_Num() Return the album version as just a number (i.e. "3.14")
Path($type) Returns path info for $type of:
album_name The name of this album
dir Current working album directory
album_file Full path to the album index.html
album_path The path of parent directories
theme Full path to the theme directory
img_theme Full path to the theme directory from image pages
page_post_url The ".html" to add onto image pages
parent_albums Array of parent albums (album_path split up)
Image_Page() 1 if we're generating an image page, 0 for album page.
Page_Type() Either 'image_page' or 'album_page'
Theme_Path() The filesystem path to the theme files
Theme_URL() The URL path to the theme files
Header and Footer
isHeader(), pHeader() Test for and print the header
isFooter(), pFooter() Same for the footer
Generally you loop through the images and directories using local variables:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
This will print the name of each image. Our object types are either 'pics'
for images or 'dirs' for the child directories. Here are the object functions:
Objects (type is either 'pics' (default) or 'dirs')
First($type) Get the first image or sub-album object.
Last($type) Last object
Next($obj) Given an object, return the next object
Next($obj,1) Same, loop past end to beginning.
Prev($obj), Prev($obj,1) Similar to Next()
num('pics') or just num() Total number of images in this album
num('dirs') Total number of children/sub-albums
Also:
num('parent_albums') Total number of parents leading up to this album.
Object lookup:
get_obj($num, $type, $loop)
Finds object by number ('pics' or 'dirs').
If $loop is set than the count will wrap around.
Object Properties
Each object (image or child albums) has properties.
Some properties are accessed by a single field:
Get($obj,$field) Get a single field of an object
Field Description
----- ----------
type What type of object? Either 'pics' or 'dirs'
is_movie Boolean: is this a movie?
name Name (cleaned and optionally from captions)
cap Image caption
capfile Optional caption file
alt Alt tag
num_pics [directories only, -dir_thumbs] Num of pics in directory
num_dirs [directories only, -dir_thumbs] Num of dirs in directory
Some properties are accessed by a field and subfield. For example,
each image has information for different sizes: full, medium and thumb
(though 'medium' is optional).
Get($obj,$size,$field) Get a property for a given size
Size Field Description
---- ----- ----------
$size x Width
$size y Height
$size file Filename (without path)
$size path Filename (full path)
$size filesize Filesize in bytes
full tag The tag (either 'image' or 'embed') - only for 'full'
We also have URL information which is access according to the
page it's coming 'from' and the image/page it's pointing 'to':
Get($obj,'URL',$from,$to) Get a URL for an object from -> to
Get($obj,'href',$from,$to) Same but wraps it in an 'href' string.
Get($obj,'link',$from,$to) Same but wraps the object name inside the href link.
From To Description
---- -- ----------
album_page image Image_URL from album_page
album_page thumb Thumbnail from album_page
image_page image Image_URL from image_page
image_page image_page This image page from another image page
image_page image_src The <img src> URL for the image page
image_page thumb Thumbnail from image_page
Directory objects also have:
From To Description
---- -- ----------
album_page dir URL to the directory from it's parent album page
Parent Albums
Parent_Album($num) Get a parent album string (including the href)
Parent_Albums() Return a list of the parent albums strings (including href)
Parent_Album($str) A join($str) call of Parent_Albums()
Back() The URL to go back or up one page.
Images
This_Image The image object for an image page
Image($img,$type) The <img> tags for type of medium,full,thumb
Image($num,$type) Same, but by image number
Name($img) The clean or captioned name for an image
Caption($img) The caption for an image
Child Albums
Name($alb)
Caption($img) The caption for an image
Convenience Routines
Pretty($str,$html,$lines) Pretty formats a name.
If $html then HTML is allowed (i.e., use 0 for <title> and the like)
Currently just puts prefix dates in a smaller font (i.e. '2004-12-03.Folder')
If $lines then multilines are allowed
Currently just follows dates with a 'br' line break.
New_Row($obj,$cols,$off) Should we start a new row after this object?
Use $off if the first object is offset from 1
Image_Array($src,$x,$y,$also,$alt)
Returns an <img> tag given $src, $x,...
Image_Ref($ref,$also,$alt)
Like Image_Array, but $ref can be a hash of
Image_Arrays keyed by language ('_' is default).
album picks the Image_Array by what languages are set.
Border($img,$type,$href,@border)
Border($str,$x,$y,@border)
Create the full bordered image.
See 'Borders' for more information.
If you're creating a theme from scratch, consider adding support for -slideshow.
The easiest way to do this is to cut/paste the "slideshow" code out of an
existing theme.
5: Submitting Themes
Have a custom theme? I'd love to see it, even if it's totally site-specific.
If you have a new theme you'd like to offer the public, feel free to send
it to me and/or a URL where I can see how it looks. Be sure to set the CREDIT
file properly and let me know if you are donating it to MarginalHacks for
everyone to use or if you want it under a specific license.
6: Converting v2.0 Themes to v3.0 Themes
album v2.0 introduced a theme interface which has been rewritten. Most
2.0 themes (especially those that don't use many of the global variables)
will still work, but the interface is deprecated and may disappear in
the near future.
It's not difficult to convert from v2.0 to v3.0 themes.
The v2.0 themes used global variables for many things. These are now
deprecated In v3.0 you should keep track of images and directories in
variables and use the 'iterators' that are supplied, for example:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Will loop through all the images and print their names.
The chart below shows you how to rewrite the old style calls which
used a global variable with the new style which uses a local variable,
but to use these calls you need to rewrite your loops as above.
Here is a conversion chart for helping convert v2.0 themes to v3.0:
# Global vars shouldn't be used
# ALL DEPRECATED - See new local variable loop methods above
$PARENT_ALBUM_CNT Rewrite with: Parent_Album($num) and Parent_Albums($join)
$CHILD_ALBUM_CNT Rewrite with: my $dir = First('dirs'); $dir=Next($dir);
$IMAGE_CNT Rewrite with: my $img = First('pics'); $pics=Next($pics);
@PARENT_ALBUMS Can instead use: @{Path('parent_albums')}
@CHILD_ALBUMS, @CHILD_ALBUM_NAMES, @CHILD_ALBUM_URLS, ...
# Old global variable modifiers:
# ALL DEPRECATED - See new local variable loop methods above
Next_Image(), Images_Left(), Image_Cnt(), Image_Prev(), Image_Next()
Set_Image_Prev(), Set_Image_Next(), Set_Image_This()
Next_Child_Album(), Child_Album_Cnt(), Child_Albums_Left()
# Paths and stuff
pAlbum_Name() Path('album_name')
Album_Filename() Path('album_file')
pFile($file) print read_file($file)
Get_Opt($option) Option($option)
Index() Option('index')
pParent_Album($str) print Parent_Album($str)
# Parent Albums
Parent_Albums_Left Deprecated, see '$PARENT_ALBUM_CNT' above
Parent_Album_Cnt Deprecated, see '$PARENT_ALBUM_CNT' above
Next_Parent_Album Deprecated, see '$PARENT_ALBUM_CNT' above
pJoin_Parent_Albums print Parent_Albums(\@_)
# Images, using variable '$img'
pImage() Use $img instead and:
print Get($img,'href','image');
print Get($img,'thumb') if Get($img,'thumb');
print Name($img), "</a>";
pImage_Src() print Image($img,'full')
Image_Src() Image($img,'full')
pImage_Thumb_Src() print Image($img,'thumb')
Image_Name() Name($img)
Image_Caption() Caption($img)
pImage_Caption() print Get($img,'Caption')
Image_Thumb() Get($img,'URL','thumb')
Image_Is_Pic() Get($img,'thumb')
Image_Alt() Get($img,'alt')
Image_Filesize() Get($img,'full','filesize')
Image_Path() Get($img,'full','path')
Image_Width() Get($img,'medium','x') || Get($img,'full','x')
Image_Height() Get($img,'medium','y') || Get($img,'full','y')
Image_Filename() Get($img,'full','file')
Image_Tag() Get($img,'full','tag')
Image_URL() Get($img,'URL','image')
Image_Page_URL() Get($img,'URL','image_page','image_page') || Back()
# Child album routines, using variable '$alb'
pChild_Album($nobr) print Get($alb,'href','dir');
my $name = Name($alb);
$name =~ s/<br>//g if $nobr;
print $name,"</a>";
Child_Album_Caption() Caption($alb,'dirs')
pChild_Album_Caption() print Child_Album_Caption($alb)
Child_Album_URL() Get($alb,'URL','dir')
Child_Album_Name() Name($alb)
# Unchanged
Meta() Meta()
Credit() Credit()
album-4.17/Docs/de/txt_2 0000644 0000000 0000000 00000013721 10547015046 013514 0 ustar root root MINI HOW-TO
ITEM: Einfaches Album
Vorausgesetzt Sie haben album korrekt installiert, können wir mit
einem einfachen Beispiel anfangen. Falls Sie hierbei irgendwelche
Probleme haben, lesen Sie bitte die Installationsdokumentation.
Sie benötigen ein Webverzeichnis, in das Sie die Themes und das
Fotoalbum speichern können. Wir werden in dieser Dokumentation
/home/httpd/test verwenden. Dieses Verzeichnis muss für den Webserver
lesbar sein. In diesem Falls verwenden wir die URL: http://meinserver/test/
Passen Sie bitte Ihre Kommandos/URLs entsprechend an.
Zuerst erstellen Sie ein Verzeichnis und legen ein paar Bilder darin ab.
Wir nennen das Verzeichnis: /home/httpd/test/Fotos
Nun fügen wir ein paar Bilder mit den Namen 'IMG_001.jpg' bis 'IMG_004.jpg' hinzu.
Für das einfache Beispiel, lassen Sie einfach album laufen:
% album /home/httpd/test/Fotos
Nun können Sie Ihr Album mit einem Webbrowser unter einer URL wie dieser betrachten:
http://myserver/test/Fotos
ITEM: Untertitel hinzufügen
Erstellen Sie eine Datei /home/httpd/test/Fotos/captions.txt mit dem folgenden
Inhalt (verwenden Sie die Tab-Taste wo ein " [tab] " angegeben ist)
-- captions.txt ---------
IMG_001.jpg [tab] Erster Bildname
IMG_002.jpg [tab] Zweites Bild
IMG_003.jpg [tab] Noch ein Bild [tab] mit Untertitel!
IMG_004.jpg [tab] Letztes Bild [tab] mit einem weiteren Untertitel.
-------------------------
Und lassen Sie album erneut laufen:
% album /home/httpd/test/Fotos
Und Sie sollten die Untertiteländerung sehen.
Nun erstellen Sie eine Datei mit Text: /home/httpd/test/Fotos/header.txt
Und lassen album erneut laufen. Sie werden diesen Text nun in der Kopfzeile
der Seite sehen.
ITEM: Fotos verstecken
Es gibt einige Wege, um Fotos/Dateien/Verzeichnisse zu versteken, aber wir
werden die Untertitel-Datei verwenden. Versuchen Sie, ein Bild mit einem '#' in der captions.txt auszukommentieren:
-- captions.txt ---------
IMG_001.jpg [tab] Erster Bildname
#IMG_002.jpg [tab] Zweites Bild
IMG_003.jpg [tab] Noch ein Bild [tab] mit einem Untertitel!
IMG_004.jpg [tab] Letztes Bild [tab] mit einem weiteren Untertitel.
-------------------------
Lassen Sie album erneut laufen, und Sie werden sehen, dass IMG_002.jpg
nun fehlt.
Wenn wir dies bereits vor dem ersten Durchlauf von album gemacht hätten, wäre nie
ein verkleinertes Bild oder ein Vorschaubild erzeugt worden.
Wenn Sie möchte, können Sie diese mit -clean entfernen:
% album -clean /home/httpd/test/Fotos
ITEM: Ein Thema verwenden
Wenn Sie die Themen korrekt installiert haben und sie sich in Ihrem theme_path,
sollten Sie in der Lage sein, ein Thema mit album zu verwenden:
% album -theme Blue /home/httpd/test/Fotos
Das Fotoalbum sollte nun das Blue-Thema verwende. Wenn es eine Menge
kaputter Bilder anzeigt, ist Ihr Thema-Pfad vermutlich nicht innerhalb
des vom Webserver erreichbaren Dateibaums installiert, sehen Sie
bitte in der Installationsdokumentation nach.
Album speichert die Optionen, wenn Sie also album erneut aufrufen:
% album /home/httpd/test/Fotos
werden Sie immer noch das Blue-Thema verwenden. Um ein Thema zu deaktivieren, verwenden Sie:
% album -no_theme /home/httpd/test/Fotos
ITEM: Mittlere Bilder
Bilder mit voller Auflösung sind meist zu groß für ein Webalbum,
also verwenden wir mittlere Bilder für die Bilderseiten:
% album -medium 33% /home/httpd/test/Fotos
Sie können die Bilder in voller Auflösung durch Klicken auf die mittleren Bilder erreichen oder:
% album -just_medium /home/httpd/test/Fotos
unterdrückt das Verlinken der hochaufgelösten Bilder (vorausgesetzt,
wir verwenden den -medium Paramter an irgendeiner Stelle).
ITEM: Ein paar EXIF-Untertitel hinzufügen
Nun fügen wir Blendeninformationen zu jedem Bild hinzu.
% album -exif "<br>Blende=%Aperture%" /home/httpd/test/Fotos
Dies wird die Blende nur zu Bildern hinzufügen, die über den 'Aperture' EXIF-Tag
verfügen (der Teil zwischen den '%'-Zeichen). Wir fügen außerdem einen <br>
hinzu, so dass die EXIF-Informationen in einer neuen Zeile angezeigt werden.
Wir können weitere EXIF-Informationen hinzufügen:
% album -exif "<br>Brennweite: %FocalLength%" /home/httpd/test/Fotos
Weil album die vorherigen Optionen wieder gespeichert hat, werden nun sowohl
Blende als auch Brennweite für alle Bilder mit Aperture- und FocalLength-Informationen
angezeigt. Nun entfernen wir die Blende:
% album -no_exif "<br>Blende=%Aperture%" /home/httpd/test/Fotos
Die '-no_exif' Option muss exakt auf die vorherige EXIF-Option zutreffen, anderenfalls
wird sie ignoriert. Sie können die Konfigurationsdatei, die album erstellt, auch
einfach bearbeiten:
/home/httpd/test/Fotos/album.conf
und den Eintrag dort entfernen.
ITEM: Weitere Alben hinzufügen
Angenommen, wir machen einen Ausflug nach Spanien. Wir machen ein paar Fotos
und legen sie nach:
/home/httpd/test/Fotos/Spanien/
Nun lassen wir album im Hauptverzeichnis laufen:
% album /home/httpd/test/Fotos
Dies wird die Fotos aus Spanien einbinden und die Bilder in Spanien/
erzeugen, mit den gleichen Einstellungen/Themen usw...
Jetzt machen wir noch einen Ausflug und erstellen:
/home/httpd/test/Fotos/Italien/
Wir könnten album jetzt wieder im Hauptverzeichnis laufen lassen:
% album /home/httpd/test/Fotos
Aber das würde auch das Spanien-Verzeichnis neu durchgehen, obwohl es sich
nicht geändert hat. Album erstellt normalerweise keine HTML-Seiten oder
Vorschaubilder, wenn diese bereits existieren. Aber es ist trotzdem eine Zeitverschwendung, besonders, wenn die Alben größer werden.
Daher können wir album sagen, einfach nur das neue Verzeichnis zu durchsuchen:
% album -add /home/httpd/test/Fotos/Italien
Dies erzeugt eine neue Startseite (in Fotos) und generiert das Italien-Album.
ITEM: Translated by:
Fridtjof Busse
album-4.17/Docs/de/Section_5.html 0000644 0000000 0000000 00000047523 12661460265 015264 0 ustar root root
MarginalHacks album - Feature Requests, Bugs, Patches and Troubleshooting
- Documentation
A l b u m
F i v e - - F e a t u r e R e q u e s t s , B u g s , P a t c h e s a n d T r o u b l e s h o o t i n g
1: Feature Requests
If there's something you want added to album, first make sure
it doesn't already exist! Check the man page or the usage:
% man album% album -h
Also see -more and -usage options.
If you don't see it there, consider writing a patch or a plugin.
2: Bug reports
Before you submit a bug, please make sure you have the most current release of album!
When submitting a bug, I need to know at least:
1) Your operating system
2) The exact problem and the exact error messages
I'd also like to know, if possible:
1) The exact album command you ran
2) The output from the command
And I generally also need the debug output of album:
% album -d
Finally, make sure that you've got the most current
version of album, and the most current themes as well.
3: Writing Patches, Modifying album
If you want to modify album, you might want to check with me
first to make sure it's not already on my development plate.
If not, then consider writing it as a plugin instead of patching
the album source. This avoids adding complexity to album for
features that may not be globally used.
If it needs to go into album (for example, if it's a bug), then
please make sure to first download the most recent copy of album
first, then patch that and send me either a diff, a patch, or the
full script. If you comment off the changes you make that'd be great too.
4: Known Bugs
v3.11: -clear_* and -no_* doesn't clear out parent directory options.
v3.10: Burning CDs doesn't quite work with theme absolute paths.
v3.00: Array and code options are saved backwards, for example:
"album -lang aa .. ; album -lang bb .." will still use language 'aa'
Also, in some cases array/code options in sub-albums will not
be ordered right the first time album adds them and you may
need to rerun album. For example:
"album -exif A photos/ ; album -exif B photos/sub"
Will have "B A" for the sub album, but "A B" after: "album photos/sub"
5: PROBLEM: My index pages are too large!
I get many requests to break up the index pages after reaching a certain
threshold of images.
The problem is that this is hard to manage - unless the index pages are
treated just like sub-albums, then you now have three major components
on a page, more indexes, more albums, and thumbnails. And not only is
that cumbersome, but it would require updating all the themes.
Hopefully the next major release of album will do this, but until then
there is another, easier solution - just break the images up into
subdirectories before running album.
I have a tool that will move new images into subdirectories for you and
then runs album:
in_album6:ERROR: no delegate for this image format (./album)
You have the album script in your photo directory and it can't make
a thumbnail of itself! Either:
1) Move album out of the photo directory (suggested)
2) Run album with -known_images
7:ERROR: no delegate for this image format (some_non_image_file)
Don't put non-images in your photo directory, or else run with -known_images.
8:ERROR: no delegate for this image format (some.jpg)9:ERROR: identify: JPEG library is not available (some.jpg)
Your ImageMagick installation isn't complete and doesn't know how
to handle the given image type.
10:ERROR: Can't get [some_image] size from -verbose output.
ImageMagick doesn't know the size of the image specified. Either:
1) Your ImageMagick installation isn't complete and can't handle the image type.
2) You are running album on a directory with non-images in it without
using the -known_images option.
If you're a gentoo linux user and you see this error, then run this command
as root (thanks Alex Pientka):
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
1: Configuration Files
Album behavior can be controlled through command-line options, such as:
% album -no_known_images% album -geometry 133x100% album -exif "File: %File name% " -exif "taken with %Camera make%"
But these options can also be specified in a configuration file:
# Example configuration file # comments are ignored
known_images 0 # known_images=0 is same as no_known_images
geometry 133x100
exif "File: %File name% "
exif "taken with %Camera make%"
The configuration file format is one option per line optionally followed
by whitespace and the option value. Boolean options can be set without
the option value or can be cleared/set with 0 and 1.
2: Location Of Configuration Files
album looks for configuration files in a few locations, in order:
/etc/album/conf System-wide settings
/etc/album.conf System-wide settings
$BASENAME/album.conf In the 'album' install directory
$HOME/.albumrc User specific settings
$HOME/.album.conf User specific settings
$DOT/album.conf User specific (I keep my dot files elsewhere)
$USERPROFILE/album.conf For Windows (C:\Documents and Settings\TheUser)
album also looks for album.conf files inside the photo album directories.
Sub-albums can also have album.conf which will alter the settings
from parent directories (this allows you to, for example, have a
different theme for part of your photo album). Any album.conf files
in your photo album directories will configure the album and any sub-albums
unless overridden by any album.conf settings found in a sub-album.
As an example, consider a conf for a photo album at 'images/album.conf':
theme Dominatrix6
columns 3
And another conf inside 'images/europe/album.conf':
theme Blue
crop
album will use the Dominatrix6 theme for the images/ album and all of
it's sub-albums except for the images/europe/ album which will use
the Blue theme. All of the images/ album and sub-albums will have
3 columns since that wasn't changed in the images/europe/ album, however
all of the thumbnails in images/europe/ and all of it's sub-albums
will be cropped due to the 'crop' configuration setting.
3: Saving Options
Whenever you run an album, the command-line options are saved in
an album.conf inside the photo album directory. If an album.conf
already exists it will be modified not overwritten, so it is safe
to edit this file in a text editor.
This makes it easy to make subsequent calls to album. If you
first generate an album with:
% album -crop -no_known_images -theme Dominatrix6 -sort date images/
Then the next time you call album you can just:
% album images/
This works for sub-albums as well:
% album images/africa/
Will also find all of the saved options.
Some 'one-time only' options are not saved for obvious reasons, such
as -add, -clean, -force, -depth, etc..
Running album multiple times on the same directories can
get confusing if you don't understand how options are saved.
Here are some examples.
Premises:
1) Command-line options are processed before conf options found
in the album directory.
2) Album should run the same the next time you call it if you
don't specify any options.
For example, consider running album twice on a directory:
% album -exif "comment 1" photos/spain% album photos/spain
The second time you run album you'll still get the "comment 1"
exif comment in your photos directory.
3) Album shouldn't end up with multiple copies of the same array
options if you keep calling it with the same command-line
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 1" photos/spain
The second time you run album you will NOT end up with multiple
copies of the "comment 1" exif comment.
However, please note that if you re-specify the same options
each time, album may run slower because it thinks it needs to
regenerate your html!
As an example, if you run:
% album -medium 640x640 photos/spain
(then later...)
% album -medium 640x640 photos/spain
Then the second time will unnecessarily regenerate all your
medium images. This is much slower.
It's better to specify command-line options only the first time
and let them get saved, such as:
% album -medium 640x640 photos/spain
(then later...)
% album photos/spain
Unfortunately these constraints mean that any new array options will
be put at the beginning of your list of -exif options.
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 2" photos/spain
The comments will actually be ordered "comment 2" then "comment 1"
To specify exact ordering, you may need to re-specify all options.
Either specify "comment 1" to put it back on top:
% album -exif "comment 1" photos/spain
Or just specify all the options in the order you want:
% album -exif "comment 1" -exif "comment 2" photos/spain
Sometimes it may be easier to merely edit the album.conf file directly
to make any changes.
Finally, this only allows us to accumulate options.
We can delete options using -no and -clear, see the section on Options,
these settings (or clearings) will also be saved from run to run.
1: Einfaches Album
Vorausgesetzt Sie haben album korrekt installiert, können wir mit
einem einfachen Beispiel anfangen. Falls Sie hierbei irgendwelche
Probleme haben, lesen Sie bitte die Installationsdokumentation.
Sie benötigen ein Webverzeichnis, in das Sie die Themes und das
Fotoalbum speichern können. Wir werden in dieser Dokumentation
/home/httpd/test verwenden. Dieses Verzeichnis muss für den Webserver
lesbar sein. In diesem Falls verwenden wir die URL: http://meinserver/test/
Passen Sie bitte Ihre Kommandos/URLs entsprechend an.
Zuerst erstellen Sie ein Verzeichnis und legen ein paar Bilder darin ab.
Wir nennen das Verzeichnis: /home/httpd/test/Fotos
Nun fügen wir ein paar Bilder mit den Namen 'IMG_001.jpg' bis 'IMG_004.jpg' hinzu.
Für das einfache Beispiel, lassen Sie einfach album laufen:
% album /home/httpd/test/Fotos
Nun können Sie Ihr Album mit einem Webbrowser unter einer URL wie dieser betrachten:
http://myserver/test/Fotos
2: Untertitel hinzufügen
Erstellen Sie eine Datei /home/httpd/test/Fotos/captions.txt mit dem folgenden
Inhalt (verwenden Sie die Tab-Taste wo ein " [tab] " angegeben ist)
-- captions.txt ---------
IMG_001.jpg [tab] Erster Bildname
IMG_002.jpg [tab] Zweites Bild
IMG_003.jpg [tab] Noch ein Bild [tab] mit Untertitel!
IMG_004.jpg [tab] Letztes Bild [tab] mit einem weiteren Untertitel.
-------------------------
Und lassen Sie album erneut laufen:
% album /home/httpd/test/Fotos
Und Sie sollten die Untertiteländerung sehen.
Nun erstellen Sie eine Datei mit Text: /home/httpd/test/Fotos/header.txt
Und lassen album erneut laufen. Sie werden diesen Text nun in der Kopfzeile
der Seite sehen.
3: Fotos verstecken
Es gibt einige Wege, um Fotos/Dateien/Verzeichnisse zu versteken, aber wir
werden die Untertitel-Datei verwenden. Versuchen Sie, ein Bild mit einem '#' in der captions.txt auszukommentieren:
-- captions.txt ---------
IMG_001.jpg [tab] Erster Bildname
#IMG_002.jpg [tab] Zweites Bild
IMG_003.jpg [tab] Noch ein Bild [tab] mit einem Untertitel!
IMG_004.jpg [tab] Letztes Bild [tab] mit einem weiteren Untertitel.
-------------------------
Lassen Sie album erneut laufen, und Sie werden sehen, dass IMG_002.jpg
nun fehlt.
Wenn wir dies bereits vor dem ersten Durchlauf von album gemacht hätten, wäre nie
ein verkleinertes Bild oder ein Vorschaubild erzeugt worden.
Wenn Sie möchte, können Sie diese mit -clean entfernen:
% album -clean /home/httpd/test/Fotos4: Ein Thema verwenden
Wenn Sie die Themen korrekt installiert haben und sie sich in Ihrem theme_path,
sollten Sie in der Lage sein, ein Thema mit album zu verwenden:
% album -theme Blue /home/httpd/test/Fotos
Das Fotoalbum sollte nun das Blue-Thema verwende. Wenn es eine Menge
kaputter Bilder anzeigt, ist Ihr Thema-Pfad vermutlich nicht innerhalb
des vom Webserver erreichbaren Dateibaums installiert, sehen Sie
bitte in der Installationsdokumentation nach.
Album speichert die Optionen, wenn Sie also album erneut aufrufen:
% album /home/httpd/test/Fotos
werden Sie immer noch das Blue-Thema verwenden. Um ein Thema zu deaktivieren, verwenden Sie:
% album -no_theme /home/httpd/test/Fotos5: Mittlere Bilder
Bilder mit voller Auflösung sind meist zu groß für ein Webalbum,
also verwenden wir mittlere Bilder für die Bilderseiten:
% album -medium 33% /home/httpd/test/Fotos
Sie können die Bilder in voller Auflösung durch Klicken auf die mittleren Bilder erreichen oder:
% album -just_medium /home/httpd/test/Fotos
unterdrückt das Verlinken der hochaufgelösten Bilder (vorausgesetzt,
wir verwenden den -medium Paramter an irgendeiner Stelle).
6: Ein paar EXIF-Untertitel hinzufügen
Nun fügen wir Blendeninformationen zu jedem Bild hinzu.
% album -exif "<br>Blende=%Aperture%" /home/httpd/test/Fotos
Dies wird die Blende nur zu Bildern hinzufügen, die über den 'Aperture' EXIF-Tag
verfügen (der Teil zwischen den '%'-Zeichen). Wir fügen außerdem einen <br>
hinzu, so dass die EXIF-Informationen in einer neuen Zeile angezeigt werden.
Wir können weitere EXIF-Informationen hinzufügen:
% album -exif "<br>Brennweite: %FocalLength%" /home/httpd/test/Fotos
Weil album die vorherigen Optionen wieder gespeichert hat, werden nun sowohl
Blende als auch Brennweite für alle Bilder mit Aperture- und FocalLength-Informationen
angezeigt. Nun entfernen wir die Blende:
% album -no_exif "<br>Blende=%Aperture%" /home/httpd/test/Fotos
Die '-no_exif' Option muss exakt auf die vorherige EXIF-Option zutreffen, anderenfalls
wird sie ignoriert. Sie können die Konfigurationsdatei, die album erstellt, auch
einfach bearbeiten:
/home/httpd/test/Fotos/album.conf
und den Eintrag dort entfernen.
7: Weitere Alben hinzufügen
Angenommen, wir machen einen Ausflug nach Spanien. Wir machen ein paar Fotos
und legen sie nach:
/home/httpd/test/Fotos/Spanien/
Nun lassen wir album im Hauptverzeichnis laufen:
% album /home/httpd/test/Fotos
Dies wird die Fotos aus Spanien einbinden und die Bilder in Spanien/
erzeugen, mit den gleichen Einstellungen/Themen usw...
Jetzt machen wir noch einen Ausflug und erstellen:
/home/httpd/test/Fotos/Italien/
Wir könnten album jetzt wieder im Hauptverzeichnis laufen lassen:
% album /home/httpd/test/Fotos
Aber das würde auch das Spanien-Verzeichnis neu durchgehen, obwohl es sich
nicht geändert hat. Album erstellt normalerweise keine HTML-Seiten oder
Vorschaubilder, wenn diese bereits existieren. Aber es ist trotzdem eine Zeitverschwendung, besonders, wenn die Alben größer werden.
Daher können wir album sagen, einfach nur das neue Verzeichnis zu durchsuchen:
% album -add /home/httpd/test/Fotos/Italien
Dies erzeugt eine neue Startseite (in Fotos) und generiert das Italien-Album.
8: Translated by:
Fridtjof Busse
1: Minimum Requirements
1) The album perl script
2) ImageMagick tools (specifically 'convert')
Put the 'album' script and the ImageMagick tools somewhere in your PATH,
or else call 'album' by it's full path (and specify the full path to
convert either in the album script or in the album configuration files.
2: Initial Configuration
The first time you run album it will ask you a few questions to
setup the configuration for you. If you're on UNIX/OSX, then you
can run the first time as root so that it sets up the global configuration
and themes for everyone instead of just the current user.
3: Optional Installation
3) Themes
4) ffmpeg (for movie thumbnails)
5) jhead (for reading EXIF info)
6) plugins
7) Various tools available at MarginalHacks.com
4: UNIX
Most UNIX distros come with ImageMagick and perl, so just download
the album script and themes (#1 and #3 above) and you're done.
To test your install, run the script on a directory with images:
% album /path/to/my/photos/5: Debian UNIX
album is in debian stable, though right now it's a bit stale.
I recommend getting the latest version from MarginalHacks.
You can save the .deb package, and then, as root, run:
% dpkg -i album.deb6: Macintosh OSX
It works fine on OSX, but you have to run it from a terminal window. Just
install the album script and ImageMagick tools, and type in the path to album,
any album options you want, and then the path to the directory with the
photos in them (all separated by spaces), such as:
% album -theme Blue /path/to/my/photos/7: Win95, Win98, Win2000/Win2k, WinNT, WinXP
(Windows 95, Windows 98, Windows 2000, Windows NT, Windows XP)
There are two methods to run perl scripts on Windows, either using ActivePerl
or Cygwin.
ActivePerl is simpler and allows you to run album from a DOS prompt,
though I've heard that it doesn't work with themes.
Cygwin is a bulkier but more robust package that gives you access to
a bunch of UNIX like utilities, and album is run from a bash (UNIX shell)
prompt.
Cygwin method
-------------
1) Install Cygwin
Choose packages: perl, ImageMagick, bash
Do not use the normal ImageMagick install! You must use the Cygwin ImageMagick packages!
2) Install album in bash path or call using absolute path:
bash% album /some/path/to/photos
3) If you want exif info in your captions, you need the Cygwin version of jheadActivePerl method
-----------------
1) Install ImageMagick for Windows
2) Install ActivePerl, Full install (no need for PPM profile)
Choose: "Add perl to PATH" and "Create Perl file extension association"
3) If Win98: Install tcap in path
4) Save album as album.pl in windows path
5) Use dos command prompt to run:
C:> album.pl C:\some\path\to\photosNote: Some versions of Windows (2000/NT at least) have their
own "convert.exe" in the c:\windows\system32 directory (an NTFS utility?).
If you have this, then you either need to edit your path variable,
or else just specify the full path to convert in your album script.
8: How do I edit the Windows path?Windows NT4 Users
Right Click on My Computer, select Properties.
Select Environment tab.
In System Variables box select Path.
In Value edit box add the new paths separated by semicolons
Press OK/Set, press OK again.
Windows 2000 Users
Right Click My Computer, select Properties.
Select Advanced tab.
Click Environment Variables.
In System Variables box select double-click Path
In Value edit box add the new paths separated by semicolons
Press OK/Set, press OK again.
Windows XP Users
Click My Computer, select Change a Setting.
Double click System.
Select Advanced tab.
Select Environment Variables.
In System Variables box select double-click Path
In Value edit box add the new paths separated by semicolons
Press OK.
9: Macintosh OS9
I don't have any plans to port this to OS9 - I don't know what
the state of shells and perl is for pre-OSX. If you have it working
on OS9, let me know.
1: What are Plugins?
Plugins are snippets of code that allow you to modify the behavior
of album. They can be as simple as a new way to create EXIF captions,
to something as complex as creating the album based on a database of
images instead of using the filesystem hierarchy.
2: Installing Plugins and plugin support
There are a number of plugins available with the standard installation of
album. If you are upgrading album with plugins from an earlier version
of album that did not have plugins (pre v3.10), you may need to once do:
% album -configure
You will not need to do this with future upgrades of album.
This will install the current plugins into one of the default
plugin directories - album will look for plugins in a number of
locations, the default locations are:
/etc/album/plugins/
/usr/share/album/plugins/
$HOME/.album/plugins/
In reality, these are 'plugins' directories found in the set of
locations specified by '--data_path' - hence the defaults are:
/etc/album/
/usr/share/album/
$HOME/.album/
You can specify a new location with --data_path and then add a 'plugins'
directory to that location, or use the --plugin_path option.
Plugins usually end with the ".alp" prefix, but you do not need
to specify this prefix when using plugins. For example, if you
have a plugin installed at:
/etc/album/plugins/utils/mv.alp
Then you would specify the plugin as: utils/mv3: Loading/Unloading Plugins
To list all the currently installed plugins:
% album -list_plugins
To show information about a specific plugin (using 'utils/mv' as an example):
% album -plugin_info utils/mv
Plugins will be saved in the configuration for a given album, so
they don't need to be respecified every time (excluding one-time
plugins such as 'utils/mv')
You can use -no_plugin and -clear_plugin to turn off plugins that have
been saved in an album configuration. As with normal album options,
-no_plugin will turn off a specific plugin, and -clear_plugin will
turn off all plugins. Any saved plugin options for that plugin will be
erased as well.
4: Plugin Options
A few plugins may be able to take command-line options, to view usage
for these plugins:
% album -plugin_usage utils/mv
But when specifying plugin options, you need to tell album which plugin
the option belongs to. Instead of specifying as a normal album option:
% album -some_option
You prefix the option with the plugin name followed by a colon:
% album -some_plugin:some_option
For example, you can specify the generated 'index' created by
the 'utils/capindex' plugin.
% album -plugin utils/capindex -utils/capindex:index blah.html
That's a bit unwieldy. You can shorten the name of the plugin as
long as it doesn't conflict with another plugin you've loaded (by
the same name):
% album -plugin utils/capindex -capindex:index
Obviously the other types of options (strings, numbers and arrays) are
possible and use the same convention. They are saved in album configuration
the same as normal album options.
One caveat: As mentioned, once we use a plugin on an album it is saved
in the configuration. If you want to add options to an album that is
already configured to use a plugin, you either need to mention the plugin
again, or else use the full name when specifying the options (otherwise
we won't know what the shortened option belongs to).
For example, consider an imaginary plugin:
% album -plugin some/example/thumbGen Photos/Spain
After that, let's say we want to use the thumbGen boolean option "fast".
This will not work:
% album -thumbGen:fast Photos/Spain
But either of these will work:
% album -plugin some/example/thumbGen -thumbGen:fast blah.html Photos/Spain% album -some/example/thumbGen:fast Photos/Spain5: Writing Plugins
Plugins are small perl modules that register "hooks" into the album code.
There are hooks for most of the album functionality, and the plugin hook
code can often either replace or supplement the album code. More hooks
may be added to future versions of album as needed.
You can see a list of all the hooks that album allows:
% album -list_hooks
And you can get specific information about a hook:
% album -hook_info <hook_name>
We can use album to generate our plugin framework for us:
% album -create_plugin
For this to work, you need to understand album hooks and album options.
We can also write the plugin by hand, it helps to use an already
written plugin as a base to work off of.
In our plugin we register the hook by calling the album::hook() function.
To call functions in the album code, we use the album namespace.
As an example, to register code for the clean_name hook our plugin calls:
album::hook($opt,'clean_name',\&my_clean);
Then whenever album does a clean_name it will also call the plugin
subroutine called my_clean (which we need to provide).
To write my_clean let's look at the clean_name hook info:
Args: ($opt, 'clean_name', $name, $iscaption)
Description: Clean a filename for printing.
The name is either the filename or comes from the caption file.
Returns: Clean name
The args that the my_clean subroutine get are specified on the first line.
Let's say we want to convert all names to uppercase. We could use:
sub my_clean {
my ($opt, $hookname, $name, $iscaption) = @_;
return uc($name);
}
Here's an explanation of the arguments:
$opt This is the handle to all of album's options.
We didn't use it here. Sometimes you'll need it if you
call any of albums internal functions. This is also true
if a $data argument is supplied.
$hookname In this case it will be 'clean_name'. This allows us
to register the same subroutine to handle different hooks.
$name This is the name we are going to clean.
$iscaption This tells us whether the name came from a caption file.
To understand any of the options after the $hookname you
may need to look at the corresponding code in album.
In this case we only needed to use the supplied $name, we called
the perl uppercase routine and returned that. The code is done, but now
we need to create the plugin framework.
Some hooks allow you to replace the album code. For example, you
could write plugin code that can generate thumbnails for pdf files
(using 'convert' is one way to do this). We can register code for
the 'thumbnail' hook, and just return 'undef' if we aren't looking
at a pdf file, but when we see a pdf file, we create a thumbnail
and then return that. When album gets back a thumbnail, then it
will use that and skip it's own thumbnail code.
Now let's finish writing our uppercase plugin. A plugin must do the following:
1) Supply a 'start_plugin' routine. This is where you will likely
register hooks and specify any command-line options for the plugin.
2) The 'start_plugin' routine must return the plugin info
hash, which needs the following keys defined:
author => The author name
href => A URL (or mailto, of course) for the author
version => Version number for this plugin
description => Text description of the plugin
3) End the plugin code by returning '1' (similar to a perl module).
Here is our example clean_name plugin code in a complete plugin:
sub start_plugin {
my ($opt) = @_;
album::hook($opt,'clean_name',\&my_clean);
return {
author => 'David Ljung Madison',
href => 'http://MarginalHacks.com/',
version => '1.0',
description => "Conver image names to uppercase",
};
}
sub my_clean {
return uc($name);
}
1;
Finally, we need to save this somewhere. Plugins are organized in the
plugin directory hierarchy, we could save this in a plugin directory as:
captions/formatting/NAME.alp
In fact, if you look in examples/formatting/NAME.alp you'll find that
there's a plugin already there that does essentially the same thing.
If you want your plugin to accept command-line options, use 'add_option.'
This must be done in the start_plugin code. Some examples:
album::add_option(1,"fast",album::OPTION_BOOL, usage=>"Do it fast");
album::add_option(1,"name", album::OPTION_STR, usage=>"Your name");
album::add_option(1,"colors",album::OPTION_ARR, usage=>"Color list");
For more info, see the 'add_option' code in album and see all of the uses
of it (at the top of album and in plugins that use 'add_option')
To read an option that the user may have set, we use option():
my $fast = album::option($opt, "fast");
If the user gave a bad value for an option, you can call usage():
album::usage("-colors array can only include values [red, green, blue]");
If your plugin needs to load modules that are not part of the
standard Perl distribution, please do this conditionally. For
an example of this, see plugins/extra/rss.alp.
You can also call any of the routines found in the album script
using the album:: namespace. Make sure you know what you are doing.
Some useful routines are:
album::add_head($opt,$data, "<meta name='add_this' content='to the <head>'>");
album::add_header($opt,$data, "<p>This gets added to the album header");
album::add_footer($opt,$data, "<p>This gets added to the album footer");
The best way to figure out how to write plugins is to look at other
plugins, possibly copying one that is similar to yours and working
off of that. Plugin development tools may be created in the future.
Again, album can help create the plugin framework for you:
% album -create_plugin
1: Using languages
(Requires album v4.0 or higher)
Album comes prepackaged with language files (we're in need of translation
help, see below!). The language files will alter most of album's output
messages, as well as any HTML output that isn't generated by the theme.
Altering any text in a theme to match your language is as simple as editing
the Theme files - there is an example of this with the "simple-Czech" theme.
To use a language, add the "lang" option to your main album.conf, or else
specify it the first time you generate an album (it will be saved with that
album afterwards).
Languages can be cleared like any code/array option with:
% album -clear_lang ...
You can specify multiple languages, which can matter if a language is
incomplete, but you'd like to default to another language than english.
So, for example, if you wanted Dutch as the primary language, with the
backup being Swedish Chef, you could do:
% album -lang swedish_chef -lang nl ...
If you specify a sublanguage (such as es-bo for Spanish, Bolivia), then
album will attempt 'es' first as a backup.
Note that because of a known bug, you should specify all the desired
languages at the same time instead of over multiple invocations of album.
To see what languages are available:
% album -list_langs
Sadly, most of the (real) languages are barely complete, but this
is a chance for people to help out by becoming a..
2: Translation Volunteers
The album project is in need of volunteers to do translations,
specifically of:
1) The Mini How-To. Please translate from the source.
2) album messages, as explained below.
If you are willing to do the translation of either one or both
of these items, please contact me!
If you're feeling particularly ambitious, feel free to translate any
of the other Documentation sources as well, just let me know!
3: Documentation Translation
The most important document to translate is the "Mini How-To".
Please translate from the text source.
Also be sure to let me know how you want to be credited,
by your name, name and email, or name and website.
And please include the proper spelling and capitalization of the
name of your language in your language. For example, "franais"
instead of "French"
I am open to suggestions for what charset to use. Current options are:
1) HTML characters such as [é]] (though they only work in browsers)
2) Unicode (UTF-8) such as [é] (only in browsers and some terminals)
3) ASCII code, where possible, such as [] (works in text editors, though
not currently in this page because it's set to unicode)
4) Language specific iso such as iso-8859-8-I for Hebrew.
Currently Unicode (utf-8) seems best for languages that aren't covered
by iso-8859-1, because it covers all languages and helps us deal with
incomplete translations (which would otherwise require multiple charsets,
which is a disaster). Any iso code that is a subset of utf-8 can be used.
If the main terminal software for a given language is in an iso charset
instead of utf, then that could be a good exception to use non-utf.
4: Album messages
album handles all text messages using it's own language support
system, similar to the system used by the perl module Locale::Maketext.
(More info on the inspiration for this is in TPJ13)
An error message, for example, may look like this:
No themes found in [[some directory]].
With a specific example being:
No themes found in /www/var/themes.
In Dutch, this would be:
Geen thema gevonden in /www/var/themes.
The "variable" in this case is "/www/var/themes" and it obviously
isn't translated. In album, the actual error message looks like:
'No themes found in [_1].'
# Args: [_1] = $dir
The translation (in Dutch) looks like:
'No themes found in [_1].' => 'Geen thema gevonden in [_1].'
After translating, album will replace [_1] with the directory.
Sometimes we'll have multiple variables, and they may change places:
Some example errors:
Need to specify -medium with -just_medium option.
Need to specify -theme_url with -theme option.
In Dutch, the first would be:
Met de optie -just_medium moet -medium opgegeven worden.
The actual error with it's Dutch translation is:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet [_1] opgegeven worden'
# Args: [_1]='-medium' [_2]='-just_medium'
Note that the variables have changed places.
There is also a special operator for quantities, for example,
we may wish to translate:
'I have 42 images'
Where the number 42 may change. In English, it is adequate to say:
0 images, 1 image, 2 images, 3 images...
Whereas in Dutch we would have:
0 afbeeldingen, 1 afbeelding, 2 afbeeldingen, 3 afbeeldingen..
But other languages (such as many slavic languages) may have special
rules as to whether "image" should be pluralized based on whether the
quantity is mod 2, 3 or 4, and so on! The simplest case is covered
by the [quant] operator:
[quant,_1,image]
This is similar to "[_1] image" except that "image" will be pluralized
if [_1] is 0 or greater than 1:
0 images, 1 image, 2 images, 3 images...
Pluralization is simply adding an 's' - if this isn't adequate, we can
specify the plural form:
[quant,_1,afbeelding,afbeeldingen]
Which gives us the Dutch count above.
And if we need a special form for 0, we can specify that:
[quant,_1,directory,directories,no directories]
Which would create:
no directories, 1 directory, 2 directories, ...
There is also a shorthand for [quant] using '*', so these are the same:
[quant,_1,image]
[*,_1,image]
So now an example translation for a number of images:
'[*,_1,image]'
=> '[*,_1,afbeelding,afbeeldingen]',
If you have something more complicated then you can use perl code, I
can help you write this if you let me know how the translation should work:
'[*,_1,image]'
=> \&russian_quantity; # This is a sub defined elsewhere..
Since the translation strings are (generally) placed in single-quotes (')
and due to the special [bracket] codes, we need to quote these correctly.
Single-quotes in the string need to be preceded by a slash (\):
'I can\'t find any images'
And square brackets are quoted using (~):
'Problem with option ~[-medium~]'
Which unfortunately can get ugly if the thing inside the square brackets
is a variable:
'Problem with option ~[[_1]~]'
Just be careful and make sure all brackets are closed appropriately.
Furthermore, in almost all cases, the translation should have the
same variables as the original:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet' # <- Where did [_1] go?!?
Fortunately, most of the work is done for you. Language files are
saved in the -data_path (or -lang_path) where album keeps it's data.
They are essentially perl code, and they can be auto-generated by album:
% album -make_lang sw
Will create a new, empty language file called 'sw' (Swedish). Go ahead
and edit that file, adding translations as you can. It's okay to leave
translations blank, they just won't get used. Some of the more important
translations (such as the ones that go into HTML pages) are at the top
and should probably be done first.
You will need to pick a charset, this is tricky, as it should be based
on what charsets you think people will be likely to have available
in their terminal as well as in their browser.
If you want to build a new language file, using translations from
a previous file (for example, to update a language with whatever
new messages have been added to album), you should load the language first:
% album -lang sw -make_lang sw
Any translations in the current Swedish language file will be copied
over to the new file (though comments and other code will not be copied!)
For the really long lines of text, don't worry about adding any newline
characters (\n) except where they exist in the original. album will
do word wrap appropriately for the longer sections of text.
Please contact me when you are starting translation work so I can
be sure that we don't have two translators working on the same parts,
and be sure to send me updates of language files as the progress, even
incomplete language files are useful!
If you have any questions about how to read the syntax of the language
file, please let me know.
5: Why am I still seeing English?
After choosing another language, you can still sometimes see English:
1) Option names are still in English. (-geometry is still -geometry)
2) The usage strings are not currently translated.
3) Plugin output is unlikely to be translated.
4) Language files aren't always complete, and will only translate what they know.
5) album may have new output that the language file doesn't know about yet.
6) Most themes are in English.
Fortunately the last one is the easiest to change, just edit the theme
and replace the HTML text portions with whatever language you like, or
create new graphics in a different language for icons with English.
If you create a new theme, I'd love to hear about it!
1: Basic execution
Create a directory with nothing but images in it. The album script and
other tools should not go here. Then run album specifying that directory:
% album /example/path/to/images/
Or, if you're in the /example/path/to directory:
% album images/
When it's done, you'll have a photo album inside that directory starting
with images/index.html.
If that path is in your web server, then you can view it with your
browser. If you can't find it, talk to your sysadmin.
2: Options
There are three types of options. Boolean options, string/num options
and array options. Boolean options can be turned off by prepending -no_:
% album -no_image_pages
String and number values are specified after a string option:
% album -type gif
% album -columns 5
Array options can be specified two ways, with one argument at a time:
% album -exif hi -exif there
Or multiple arguments using the '--' form:
% album --exif hi there --
You can remove specific array options with -no_<option>
and clear all the array options with -clear_<option>.
To clear out array options (say, from the previous album run):
% album -clear_exif -exif "new exif"
(The -clear_exif will clear any previous exif settings and then the
following -exif option will add a new exif comment)
And finally, you can remove specific array options with 'no_':
% album -no_exif hi
Which could remove the 'hi' exif value and leave the 'there' value intact.
Also see the section on Saving Options.
To see a brief usage:
% album -h
To see more options:
% album -more
And even more full list of options:
% album -usage=2
You can specify numbers higher than 2 to see even more options (up to about 100)
Plugins can also have options with their own usage.
3: Themes
Themes are an essential part of what makes album compelling.
You can customize the look of your photo album by downloading a
theme from MarginalHacks or even writing your own theme to match
your website.
To use a theme, download the theme .tar or .zip and unpack it.
Themes are found according to the -theme_path setting, which is
a list of places to look for themes. Those paths need to be somewhere
under the top of your web directory, but not inside a photo album
directory. It needs to be accessible from a web browser.
You can either move the theme into one of the theme_paths that album
is already using, or make a new one and specify it with the -theme_path
option. (-theme_path should point to the directory the theme is in,
not the actual theme directory itself)
Then call album with the -theme option, with or without -theme_path:
% album -theme Dominatrix6 my_photos/
% album -theme Dominatrix6 -theme_path /home/httpd/album/Themes/ my_photos/
You can also create your own themes pretty easily, this is covered
later in this documentation.
4: Sub-albums
Make directories inside your first directory and put images in that.
Run album again, and it will run through all the child directories
and create sub-albums of the first album.
If you make changes to just a sub-album, you can run album on that
and it will keep track of all the parent links.
If you don't want to traverse down the tree of directories, you
can limit it with the depth option. Example:
% album images/ -depth 1
Will only generate photo albums for the images directory.
If you have many sub-albums, and you want to add a new sub-album
without regenerating all the previous sub-albums, then you can use -add:
% album -add images/new_album/
Which will add the new_album to the HTML for 'images/' and then
generate the thumbs and HTML for everything inside 'images/new_album/'
5: Avoiding Thumbnail Regeneration
album tries to avoid unnecessary work. It only creates thumbnails if
they don't exist and haven't changed. This speeds up successive runs
of album.
This can cause a problem if you change the size or cropping of your
thumbnails, because album won't realize that the thumbnails have changed.
You can use the force option to force album to regenerate thumbnails:
% album -force images/
But you shouldn't need to use -force every time.
6: Cleaning Out The Thumbnails
If you remove images from an album then you'll have leftover thumbs and HTML.
You can remove them by running album once with the -clean option:
% album -clean images/7: Medium size images
When you click on an album thumbnail you're taken to an 'image_page.'
The image_page shows, by default, the full size image (as well as
navigation buttons and captions and such). When you click on the
image on the image_page, you'll be taken to the URL for just the full
size image.
If you want a medium size image on the image_page, use the -medium
option and specify a geometry for the medium size image. You can
specify any geometry that ImageMagick can use (see their man page
for more info). Some examples:
# An image that is half the full size
% album -medium 50%
# An image that fits inside 640x480 (maximum size)
% album -medium 640x480
# An image that is shrunk to fit inside 640x480
# (but won't be enlarged if it's smaller than 640x480)
% album -medium '640x480>'
You need the 'quotes' on the last example with most shells because
of the '>' character.
8: Captions
Images and thumbnails can have names and captions. There are a number
of ways to specify/change names and captions in your photo albums.
The name is linked to the image or image_page,
and the caption follows underneath.
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
One way to specify a caption is in a .txt file
with the same name as the image. For this example,
"Kodi_Cow.txt" could contain "Kodi takes down a cow!"
You can rename your images and specify captions in bulk
for an album directory with a captions.txt file.
Each line of the file should be an image or directory filename,
followed by a tab, followed by the new name. You can also
specify (separated by tabs), an optional caption and then an optional
image ALT tag. (To skip a field, use 'tab' 'space' 'tab')
Example:
001.gif My first photo
002.gif Mom and Dad My parents in the grand canyon
003.gif Ani DiFranco My fiancee Yowsers!
The images and directories will also be sorted in the order they are found
in the caption file. You can override this with '-sort date' and '-sort name'
If your editor doesn't handle tabs very well, then you can separate the
fields by double-colons, but only if the caption line doesn't contain any
tabs at all:
003.gif :: Ani DiFranco :: My fiancee :: Yowsers!
If you only want captions on image pages (not on album pages) use:
% album -no_album_captions
If you want web access to create/edit your captions, look at the
caption_edit.cgi CGI script (but be sure to limit access to the
script or anyone can change your captions!)
9: EXIF Captions
You can also specify captions that are based off of EXIF information
(Exchangeable Image File Format) which most digital cameras add to images.
First you need 'jhead' installed. You should be able to run jhead
on a JPG file and see the comments and information.
EXIF captions are added after the normal captions and are specified with -exif:
% album -exif "<br>File: %File name% taken with %Camera make%"
Any %tags% found will be replaced with EXIF information. If any %tags%
aren't found in the EXIF information, then that EXIF caption string is
thrown out. Because of this you can specify multiple -exif strings:
% album -exif "<br>File: %File name% " -exif "taken with %Camera make%"
This way if the 'Camera make' isn't found you can still get the 'File name'
caption.
Like any of the array style options you can use --exif as well:
% album --exif "<br>File: %File name% " "taken with %Camera make%" --
Note that, as above, you can include HTML in your EXIF tags:
% album -exif "<br>Aperture: %Aperture%"
To see the possible EXIF tags (Resolution, Date/Time, Aperture, etc..)
run a program like 'jhead' on an digital camera image.
You can also specify EXIF captions only for album or image pages, see
the -exif_album and -exif_image options.
10: Headers and Footers
In each album directory you can have text files header.txt and footer.txt
These will be copied verbatim into the header and footer of your album (if
it's supported by the theme).
11: Hiding Files/Directories
Any files that album does not recognize as image types are ignored.
To display these files, use -no_known_images. (-known_images is default)
You can mark an image as a non-image by creating an empty file with
the same name with .not_img added to the end.
You can ignore a file completely by creating an empty file with
the same name with .hide_album on the end.
You can avoid running album on a directory (but still include it in your
list of directories) by creating a file <dir>/.no_album
You can ignore directories completely by creating a file <dir>/.hide_album
The Windows version of album doesn't use dots for no_album, hide_album
and not_img because it's difficult to create .files in Windows.
12: Cropping Images
If your images are of a large variety of aspect ratios (i.e., other than
just landscape/portrait) or if your theme only allows one orientation,
then you can have your thumbnails cropped so they all fit the same geometry:
% album -crop
The default cropping is to crop the image to center. If you don't
like the centered-cropping method that the album uses to generate
thumbnails, you can give directives to album to specify where to crop
specific images. Just change the filename of the image so it has a
cropping directive before the filetype. You can direct album to crop
the image at the top, bottom, left or right. As an example, let's
say you have a portrait "Kodi.gif" that you want cropped on top for
the thumbnail. Rename the file to "Kodi.CROPtop.gif" and this will
be done for you (you might want to -clean out the old thumbnail).
The "CROP" string will be removed from the name that is printed in
the HTML.
The default geometry is 133x133. This way landscape images will
create 133x100 thumbnails and portrait images will create 100x133
thumbnails. If you are using cropping and you still want your
thumbnails to have that digital photo aspect ratio, then try 133x100:
% album -crop -geometry 133x100
Remember that if you change the -crop or -geometry settings on a
previously generated album, you will need to specify -force once
to regenerate all your thumbnails.
13: Video
album can generate snapshot thumbnails of many video formats if you
install ffmpeg
If you are running linux on an x86, then you can just grab the binary,
otherwise get the whole package from ffmpeg.org (it's an easy install).
14: Burning CDs (using file://)
If you are using album to burn CDs or you want to access your albums with
file://, then you don't want album to assume "index.html" as the default
index page since the browser probably won't. Furthermore, if you use
themes, you must use relative paths. You can't use -theme_url because
you don't know what the final URL will be. On Windows the theme path
could end up being "C:/Themes" or on UNIX or OSX it could be something
like "/mnt/cd/Themes" - it all depends on where the CD is mounted.
To deal with this, use the -burn option:
% album -burn ...
This requires that the paths from the album to the theme don't change.
The best way to do this is take the top directory that you're going to
burn and put the themes and the album in that directory, then specify
the full path to the theme. For example, create the directories:
myISO/Photos/
myISO/Themes/Blue
Then you can run:
% album -burn -theme myISO/Themes/Blue myISO/Photos
Then you can make a CD image from the myISO directory (or higher).
If you are using 'galbum' (the GUI front end) then you can't specify
the full path to the theme, so you'll need to make sure that the version
of the theme you want to burn is the first one found in the theme_path
(which is likely based off the data_path). In the above example you
could add 'myISO' to the top of the data_path, and it should
use the 'myISO/Themes/Blue' path for the Blue theme.
You can also look at shellrun for windows users, you can have it
automatically launch the album in a browser. (Or see winopen)
15: Indexing your entire album
To navigate an entire album on one page use the caption_index tool.
It uses the same options as album (though it ignores many
of them) so you can just replace your call to "album" with "caption_index"
The output is the HTML for a full album index.
See an example index
for one of my example photo albums16: Updating Albums With CGI
First you need to be able to upload the photo to the album directory.
I suggest using ftp for this. You could also write a javascript that
can upload files, if someone could show me how to do this I'd love to know.
Then you need to be able to remotely run album. To avoid abuse, I
suggest setting up a CGI script that touches a file (or they can just
ftp this file in), and then have a cron job that checks for that
file every few minutes, and if it finds it it removes it and runs album.
[unix only] (You will probably need to set $PATH or use absolute paths
in the script for convert)
If you want immediate gratification, you can run album from a CGI script
such as this one.
If your photos are not owned by the webserver user, then you
need to run through a setud script which you run from a CGI [unix only].
Put the setuid script in a secure place, change it's ownership to be the
same as the photos, and then run "chmod ug+s" on it. Here are example
setuid and CGI scripts. Be sure to edit them.
Also look at caption_edit.cgi which allows you (or others) to edit
captions/names/headers/footers through the web.
1: Methods
There are easy ways and complicated ways to create a custom theme,
depending on what you want to be able to do.
2: Editing current theme HTML
If you just want to slightly change the theme to match the output
of your site, it might make sense to edit a current theme.
In the theme directory there are two *.th files. album.th is
the template for album pages (the thumbnail pages) and image.th
is the template for image pages (where you can see medium or full
size images). The files are very similar to HTML except for
some embedded <: ePerl :> code. Even if you don't know perl or
ePerl you can still edit the HTML to make simple changes.
Good starting themes:
Any simmer_theme is going to be up to date and clean, such as "Blue" or
"Maste." If you only need 4 corner thumbnail borders then take a look
at "Eddie Bauer." If you want overlay/transparent borders, see FunLand.
If you want something demonstrating a minimal amount of code, try "simple"
but be warned that I haven't touched the theme in a long time.
3: The easy way, simmer_theme from graphics.
Most themes have the same basic form, show a bunch of thumbnails
for directories and then for images, with a graphic border, line and
background. If this is what you want, but you want to create new
graphics, then there is a tool that will build your themes for you.
If you create a directory with the images and a CREDIT file as well
as a Font or Style.css file, then simmer_theme will create theme for you.
Files:
Font/Style.css
This determines the fonts used by the theme. The "Font" file is the
older system, documented below. Create a Style.css file and define
styles for: body, title, main, credit and anything else you like.
See FunLand for a simple example.
Alternatively, use a font file. An example Font file is:
--------------------------------------------------
$TITLE_FONT = "size='4' color='#ffffff' face='Times New Roman,Georgia,Times'";
$MAIN_FONT = "face='Times New Roman,Georgia,Times'";
$CREDIT_FONT = "size='-1' face='Verdana' color='#ffffff'";
$BODY = "background='$PATH/bkgrnd.gif' link='#0099FF'">
--------------------------------------------------
CREDIT
The credit file is two lines and is used for the theme index at MarginalHacks.
If you're never submitting your theme to us, then you don't need this file.
(But please do!) If so, the two lines (and only two lines) are:
1) A short description of the theme (keep it all on one line)
2) Your name (can be inside a mailto: or href link)
Null.gif
Each simmer theme needs a spacer image, this is a 1x1 transparent gif.
You can just copy this from another simmer theme.
Optional image files:
Bar Images
The bar is composed of Bar_L.gif, Bar_R.gif and Bar_M.gif in the middle.
The middle is stretched. If you need a middle piece that isn't stretched, use:
Bar_L.gif, Bar_ML.gif, Bar_M.gif, Bar_MR.gif, Bar_R.gif
And then the Bar_ML.gif and Bar_MR.gif will be stretched. (See the
Craftsman theme for an example of this).
Locked.gif
A lock image for any directories that have .htaccess
Background image
If you want a background image, specify it in the Font file in the $BODY
section, as in the example above. The $PATH variable will be replaced
with the path to the theme files:
More.gif
When an album page has sub-albums to list, it first shows the 'More.gif'
image.
Next.gif, Prev.gif, Back.gif
For the next and previous arrows and the back button
Icon.gif
Shown at the top left by the parent albums, this is often just the text "Photos"
Border Images
There are many ways to slice up a border, from simple to complex, depending on
the complexity of the border and how much you want to be able to stretch it:
4 pieces Uses Bord_L.gif, Bord_R.gif, Bord_T.gif, Bord_B.gif
(The corners go with the left and right images)
4 piece borders usually don't stretch well so they don't work well on
image_pages. Generally you can cut the corners out of the left and
right images to make:
8 pieces Also includes Bord_TL.gif, Bord_TR.gif, Bord_BL.gif, Bord_BR.gif
8 piece borders allow you to stretch to handle most sized images
12 pieces Also includes Bord_LT.gif, Bord_RT.gif, Bord_LB.gif, Bord_RB.gif
12 pieces allow stretching of borders that have more complex corners (such
as Dominatrix6 or Ivy)
Overlay Borders Can use transparent images that can be partially
overlaying your thumbnail. See below.
Here's how the normal border pieces are laid out:
12 piece borders
TL T TR 8 piece borders 4 piece borders
LT RT TL T TR TTTTTTT
L IMG R L IMG R L IMG R
LB RB BL B BR BBBBBBB
BL B BR
Note that every row of images must be the same height, though the
widths do not have to line up. (i.e., height TL = height T = height TR)
(This is not true about overlay borders!)
Once you've created these files, you can run the simmer_theme tool
(an optional tool download at MarginalHacks.com) and your theme will
then be ready to use!
If you need different borders for the image pages, then use the same
filenames prefixed by 'I' - such as IBord_LT.gif, IBord_RT.gif,...
Overlay borders allow for really fantastic effects with image borders.
Currently there's no support for different overlay borders for images.
For using Overlay borders, create images:
Over_TL.png Over_T.png Over_TR.png
Over_L.png Over_R.png
Over_BL.png Over_B.png Over_BR.png
Then figure out how many pixels of the borders are padding (outside photo)
Then put those values in files: Over_T.pad Over_R.pad Over_B.pad Over_L.pad
See "Themes/FunLand" for a simple example
Multi-lingual Images
If your images have text, you can translate them into other languages
so that albums can be generated in other languages. For example, you
can create a Dutch "More.gif" image and put it in 'lang/nl/More.gif'
in the theme (nl is the language code for Dutch).
When the user runs album in Dutch (album -lang nl) then the theme
will use the Dutch image if found. Themes/Blue has a simple example.
The currently "translated" images are:
More, Back, Next, Prev and Icon
You can create an HTML table that shows the translations immediately
available to themes with -list_html_trans:
% album -list_html_trans > trans.html
Then view trans.html in a browser. Unfortunately different languages
have different charsets, and an HTML page can only have one. The
output is in utf-8, but you can edit the "charset=utf-8" to properly
view language characters in different charsets (such as hebrew).
If you need more words translated for themes, let me know, and if you
create any new language images for a theme, please send them to me!
4: From scratch, Theme API
This is a much heavier job - you need to have a very clear idea of
how you want album to place the images on your page. It might be
a good idea to start with modifying existing themes first to get
an idea of what most themes do. Also look at existing themes
for code examples (see suggestions above).
Themes are directories that contain at the minimum an 'album.th' file.
This is the album page theme template. Often they also contain an 'image.th'
which is the image theme template, and any graphics/css used by the theme.
Album pages contain thumbnails and image pages show full/medium sized images.
The .th files are ePerl, which is perl embedded inside of HTML. They
end up looking a great deal like the actual album and image HTML themselves.
To write a theme, you'll need to understand the ePerl syntax. You can
find more information from the actual ePerl tool available at MarginalHacks
(though this tool is not needed to use themes in album).
There are a plethora of support routines available, but often only
a fraction of these are necessary - it may help to look at other themes
to see how they are generally constructed.
Function table:
Required Functions
Meta() Must be called in the section of HTML
Credit() Gives credit ('this album created by..')
Must be called in the section of HTML
Body_Tag() Called inside the actual tag.
Paths and Options
Option($name) Get the value of an option/configuration setting
Version() Return the album version
Version_Num() Return the album version as just a number (i.e. "3.14")
Path($type) Returns path info for $type of:
album_name The name of this album
dir Current working album directory
album_file Full path to the album index.html
album_path The path of parent directories
theme Full path to the theme directory
img_theme Full path to the theme directory from image pages
page_post_url The ".html" to add onto image pages
parent_albums Array of parent albums (album_path split up)
Image_Page() 1 if we're generating an image page, 0 for album page.
Page_Type() Either 'image_page' or 'album_page'
Theme_Path() The filesystem path to the theme files
Theme_URL() The URL path to the theme files
Header and Footer
isHeader(), pHeader() Test for and print the header
isFooter(), pFooter() Same for the footer
Generally you loop through the images and directories using local variables:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
This will print the name of each image. Our object types are either 'pics'
for images or 'dirs' for the child directories. Here are the object functions:
Objects (type is either 'pics' (default) or 'dirs')
First($type) Get the first image or sub-album object.
Last($type) Last object
Next($obj) Given an object, return the next object
Next($obj,1) Same, loop past end to beginning.
Prev($obj), Prev($obj,1) Similar to Next()
num('pics') or just num() Total number of images in this album
num('dirs') Total number of children/sub-albums
Also:
num('parent_albums') Total number of parents leading up to this album.
Object lookup:
get_obj($num, $type, $loop)
Finds object by number ('pics' or 'dirs').
If $loop is set than the count will wrap around.
Object Properties
Each object (image or child albums) has properties.
Some properties are accessed by a single field:
Get($obj,$field) Get a single field of an object
Field Description
----- ----------
type What type of object? Either 'pics' or 'dirs'
is_movie Boolean: is this a movie?
name Name (cleaned and optionally from captions)
cap Image caption
capfile Optional caption file
alt Alt tag
num_pics [directories only, -dir_thumbs] Num of pics in directory
num_dirs [directories only, -dir_thumbs] Num of dirs in directory
Some properties are accessed by a field and subfield. For example,
each image has information for different sizes: full, medium and thumb
(though 'medium' is optional).
Get($obj,$size,$field) Get a property for a given size
Size Field Description
---- ----- ----------
$size x Width
$size y Height
$size file Filename (without path)
$size path Filename (full path)
$size filesize Filesize in bytes
full tag The tag (either 'image' or 'embed') - only for 'full'
We also have URL information which is access according to the
page it's coming 'from' and the image/page it's pointing 'to':
Get($obj,'URL',$from,$to) Get a URL for an object from -> to
Get($obj,'href',$from,$to) Same but wraps it in an 'href' string.
Get($obj,'link',$from,$to) Same but wraps the object name inside the href link.
From To Description
---- -- ----------
album_page image Image_URL from album_page
album_page thumb Thumbnail from album_page
image_page image Image_URL from image_page
image_page image_page This image page from another image page
image_page image_src The <img src> URL for the image page
image_page thumb Thumbnail from image_page
Directory objects also have:
From To Description
---- -- ----------
album_page dir URL to the directory from it's parent album page
Parent Albums
Parent_Album($num) Get a parent album string (including the href)
Parent_Albums() Return a list of the parent albums strings (including href)
Parent_Album($str) A join($str) call of Parent_Albums()
Back() The URL to go back or up one page.
Images
This_Image The image object for an image page
Image($img,$type) The <img> tags for type of medium,full,thumb
Image($num,$type) Same, but by image number
Name($img) The clean or captioned name for an image
Caption($img) The caption for an image
Child Albums
Name($alb)
Caption($img) The caption for an image
Convenience Routines
Pretty($str,$html,$lines) Pretty formats a name.
If $html then HTML is allowed (i.e., use 0 for <title> and the like)
Currently just puts prefix dates in a smaller font (i.e. '2004-12-03.Folder')
If $lines then multilines are allowed
Currently just follows dates with a 'br' line break.
New_Row($obj,$cols,$off) Should we start a new row after this object?
Use $off if the first object is offset from 1
Image_Array($src,$x,$y,$also,$alt)
Returns an <img> tag given $src, $x,...
Image_Ref($ref,$also,$alt)
Like Image_Array, but $ref can be a hash of
Image_Arrays keyed by language ('_' is default).
album picks the Image_Array by what languages are set.
Border($img,$type,$href,@border)
Border($str,$x,$y,@border)
Create the full bordered image.
See 'Borders' for more information.
If you're creating a theme from scratch, consider adding support for -slideshow.
The easiest way to do this is to cut/paste the "slideshow" code out of an
existing theme.
5: Submitting Themes
Have a custom theme? I'd love to see it, even if it's totally site-specific.
If you have a new theme you'd like to offer the public, feel free to send
it to me and/or a URL where I can see how it looks. Be sure to set the CREDIT
file properly and let me know if you are donating it to MarginalHacks for
everyone to use or if you want it under a specific license.
6: Converting v2.0 Themes to v3.0 Themes
album v2.0 introduced a theme interface which has been rewritten. Most
2.0 themes (especially those that don't use many of the global variables)
will still work, but the interface is deprecated and may disappear in
the near future.
It's not difficult to convert from v2.0 to v3.0 themes.
The v2.0 themes used global variables for many things. These are now
deprecated In v3.0 you should keep track of images and directories in
variables and use the 'iterators' that are supplied, for example:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Will loop through all the images and print their names.
The chart below shows you how to rewrite the old style calls which
used a global variable with the new style which uses a local variable,
but to use these calls you need to rewrite your loops as above.
Here is a conversion chart for helping convert v2.0 themes to v3.0:
# Global vars shouldn't be used
# ALL DEPRECATED - See new local variable loop methods above
$PARENT_ALBUM_CNT Rewrite with: Parent_Album($num) and Parent_Albums($join)
$CHILD_ALBUM_CNT Rewrite with: my $dir = First('dirs'); $dir=Next($dir);
$IMAGE_CNT Rewrite with: my $img = First('pics'); $pics=Next($pics);
@PARENT_ALBUMS Can instead use: @{Path('parent_albums')}
@CHILD_ALBUMS, @CHILD_ALBUM_NAMES, @CHILD_ALBUM_URLS, ...
# Old global variable modifiers:
# ALL DEPRECATED - See new local variable loop methods above
Next_Image(), Images_Left(), Image_Cnt(), Image_Prev(), Image_Next()
Set_Image_Prev(), Set_Image_Next(), Set_Image_This()
Next_Child_Album(), Child_Album_Cnt(), Child_Albums_Left()
# Paths and stuff
pAlbum_Name() Path('album_name')
Album_Filename() Path('album_file')
pFile($file) print read_file($file)
Get_Opt($option) Option($option)
Index() Option('index')
pParent_Album($str) print Parent_Album($str)
# Parent Albums
Parent_Albums_Left Deprecated, see '$PARENT_ALBUM_CNT' above
Parent_Album_Cnt Deprecated, see '$PARENT_ALBUM_CNT' above
Next_Parent_Album Deprecated, see '$PARENT_ALBUM_CNT' above
pJoin_Parent_Albums print Parent_Albums(\@_)
# Images, using variable '$img'
pImage() Use $img instead and:
print Get($img,'href','image');
print Get($img,'thumb') if Get($img,'thumb');
print Name($img), "</a>";
pImage_Src() print Image($img,'full')
Image_Src() Image($img,'full')
pImage_Thumb_Src() print Image($img,'thumb')
Image_Name() Name($img)
Image_Caption() Caption($img)
pImage_Caption() print Get($img,'Caption')
Image_Thumb() Get($img,'URL','thumb')
Image_Is_Pic() Get($img,'thumb')
Image_Alt() Get($img,'alt')
Image_Filesize() Get($img,'full','filesize')
Image_Path() Get($img,'full','path')
Image_Width() Get($img,'medium','x') || Get($img,'full','x')
Image_Height() Get($img,'medium','y') || Get($img,'full','y')
Image_Filename() Get($img,'full','file')
Image_Tag() Get($img,'full','tag')
Image_URL() Get($img,'URL','image')
Image_Page_URL() Get($img,'URL','image_page','image_page') || Back()
# Child album routines, using variable '$alb'
pChild_Album($nobr) print Get($alb,'href','dir');
my $name = Name($alb);
$name =~ s/<br>//g if $nobr;
print $name,"</a>";
Child_Album_Caption() Caption($alb,'dirs')
pChild_Album_Caption() print Child_Album_Caption($alb)
Child_Album_URL() Get($alb,'URL','dir')
Child_Album_Name() Name($alb)
# Unchanged
Meta() Meta()
Credit() Credit()
album-4.17/Docs/nl/txt_2 0000644 0000000 0000000 00000013412 10503615414 013527 0 ustar root root MINI HOW-TO
ITEM: Eenvouding album
Er van uitgaand dat je album hebt geinstalleerd, kunnen we een paar
eenvoudige gevallen bekijken. Als je hier fouten tegenkomt of problemen
hebt, kijk dan in de installatiehandleiding.
Je hebt een webmap nodig om thema's en je fotoalbum in op te slaan. We
zullen in dit document /home/httpd/test gebruiken. Die moet zichtbaar
zijn met een webserver. In dit voorbeeld zullen we de volgende URL
gebruiken:
http://myserver/test/
Pas je commando's/URL's aan waar nodig.
Maak eerst een map aan en stop er een paar plaatjes in. Deze noemen we:
/home/httpd/test/Photos
en voeg er een paar plaatjes aan toe met de namen 'IMG_001.jpg' tot en
met 'IMG_004.jpg'.
Voor het eenvoudigste geval, voer album uit:
% album /home/httpd/test/Photos
Nu kun je het album bekijken in een webbrowser met zoiets als:
http://myserver/test/Photos
ITEM: Bijschriften toevoegen
Maak een tekstbestand /home/httpd/test/Photos/captions.txt aan met de
volgende inhoud (gebruik de 'tab'-toets waar " [tab] " staat)
-- captions.txt ---------
IMG_001.jpg [tab] Naam van het eerste plaatje
IMG_002.jpg [tab] Tweede plaatje
IMG_003.jpg [tab] Nog een plaatje [tab] met een bijschrift!
IMG_004.jpg [tab] Laatste plaatje [tab] met een ander bijschrift.
-------------------------
Voer album opnieuw uit:
% album /home/httpd/test/Photos
en je zult zien dat de bijschriften zijn veranderd.
Maak nu een bestand met tekst aan in:
/home/httpd/test/Photos/header.txt
en voer album opnieuw uit. Je zult de tekst bovenaan de pagina zien.
ITEM: Foto's verbergen
Er zijn een paar manieren om foto's/bestanden/folders te verbergen, maar
we zullen hier het bijschriftenbestand gebruiken.
Verander een plaatje in commentaar met '#' in captions.txt:
-- captions.txt ---------
IMG_001.jpg [tab] Naam van het eerste plaatje
#IMG_002.jpg [tab] Tweede plaatje
IMG_003.jpg [tab] Nog een plaatje [tab] met een bijschrift!
IMG_004.jpg [tab] Laatste plaatje [tab] met nog een bijschrift.
-------------------------
Voer album opnieuw uit, en je zult zien dat IMG_002.jpg nu ontbreekt.
Als we dit hadden gedaan voordat we album de eerste keer hadden
uitgevoerd, dan hadden we nooit het middelgrote plaatje en het
postzegelplaatje aangemaakt. Als je wilt, kun je ze nu verwijderen met
-clean:
% album -clean /home/httpd/test/Photos
ITEM: Een thema gebruiken
Als de thema's correct zijn geinstalleerd en in het pad theme_path
staan, dan kun je een thema voor je album gebruiken:
% album -theme Blue /home/httpd/test/Photos
Het fotoalbum zou nu het thema Blue moeten gebruiken. Als er
afbeeldingen ontbreken in het album, dan is het thema waarschijnlijk
niet geinstalleerd in een map die bereikbaar is via het web; zie de
installatiehandleiding.
Album bewaart de opties die je opgeeft, dus de volgende keer dat je
album uitvoert:
% album /home/httpd/test/Photos
zul je nog steeds het thema Blue gebruiken. Om een thema uit te zetten,
kun je het volgende doen:
% album -no_theme /home/httpd/test/Photos
ITEM: Tussenformaat plaatjes
Plaatjes in volle resolutie zijn meestal te groot voor een webalbum, dus
gebruiken we middelgrote plaatjes op de plaatjespagina's:
% album -medium 33% /home/httpd/test/Photos
Je kunt nog steeds de plaatjes in volle resolutie opvragen door op het
middelgrote plaatje te klikken, of:
% album -just_medium /home/httpd/test/Photos
zorgt ervoor dat het plaatje in volle grootte niet langer opgevraagd kan
worden (aangenomen dat we album op enig moment uitvoeren met de -medium
optie).
ITEM: EXIF-bijschriften toevoegen
We kunnen de diafragma-instelling (aperture) toevoegen aan het
bijschrift van elk plaatje.
% album -exif "<br>aperture=%Aperture%"
/home/httpd/test/Photos
Dit voegt alleen diafragma-informatie toe voor plaatjes die
daadwerkelijk de EXIF-tag 'Aperture' (het gedeelte tussen de '%'-tekens)
bevatten. We zetten er ook een <br>-tag in zodat de
EXIF-informatie op een nieuwe regel komt.
We kunnen meer EXIF-informatie toevoegen:
% album -exif "<br>focal: %FocalLength%"
/home/httpd/test/Photos
Omdat album de eerdere opties heeft bewaard, krijgen we nu beide
EXIF-tags voor alle plaatjes waarin Aperture en FocalLength zijn opgegeven.
We kunnen de diafragma-informatie weer weghalen met:
% album -no_exif "<br>aperture=%Aperture%"
/home/httpd/test/Photos
De '-no_exif'-optie moet precies overeenkomen met de eerder opgegeven
string, anders gebeurd er niets. Je kunt ook het configuratiebestand dat
album heeft aangemaakt veranderen:
/home/httpd/test/Photos/album.conf
en verwijder de exif-regel daar.
ITEM: Albums toevoegen
Stel dat we op reis naar Spanje zijn geweest. We maken een aantal foto's
en zetten ze in:
/home/httpd/test/Photos/Spain/
Voer album opnieuw uit op het bovenste niveau:
% album /home/httpd/test/Photos
Dit zal Photos aanpassen zodat het nu ook naar Spanje verwijst, en zal
album ook uitvoeren in Spain/, met dezelfde instellingen/thema, etc..
Nu gaan we nogmaals op reis, en we maken:
/home/httpd/test/Photos/Italy/
We zouden album kunnen uitvoeren op het bovenste niveau:
% album /home/httpd/test/Photos
Maar dan zou de map Spain/ opnieuw gescand worden, terwijl deze niet
veranderd is. Album zal geen HTML of postzegelplaatjes aanmaken als dat
niet noodzakelijk is, maar het kost nog steeds tijd, zeker als onze
albums groter worden. We kunnen dus opgeven dat we alleen de nieuwe map
willen toevoegen:
% album -add /home/httpd/test/Photos/Italy
Dit zal de bovenste index aanpassen (in Photos) en het album Italy aanmaken.
ITEM: Vertaald door:
Marco W. Beijersbergen [http://cosine.nl]
album-4.17/Docs/nl/alt.txt_2 0000644 0000000 0000000 00000014253 12661463260 014321 0 ustar root root
MINI HOW-TO
ITEM: Simpel album
Veronderstel dat u al een album goed geïnstalleerd hebt, kunnen we toch nog wat simpele zaken behandelen.
Als u hier fouten of problemen heeft, bekijk dan de installatiedocumenten.
U heeft een webpad nodig om thema's en uw fotoalbum op te zetten.
Wij zullen /home/httpd/test gebruiken in deze documentatie. Dit moet
weergeefbaar zijn door een webserver. In dit voorbeeld zullen wij de volgende URL gebruiken:
http://myserver/test/
Verander uw commando's/URL's zoals geschikt
Allereerst, maak en map en stop er wat afbeeldingen in. Wij zullen deze noemen:
/home/httpd/test/Photos
En we voegen wat afbeeldingen toe genaamd 'IMG_001.jpg' tot 'IMG_004.jpg'
Nu, in het simpele geval, gewoon uw album uitvoeren:
% album /home/httpd/test/Photos
Nu kunt u het album bekijken in een webbrowser op iets zoals dit:
http://myserver/test/Photos
ITEM: Tekstinhoud toevoegen
Maak een bestand /home/httpd/test/Photos/captions.txt met de volgende
inhouden (use the 'tab' key where you see " [tab] ")
-- captions.txt ---------
IMG_001.jpg [tab] Eerste afbeeldingsnaam
IMG_002.jpg [tab] Tweede afbeelding
IMG_003.jpg [tab] Een andere afbeelding [tab] met een tekstinhoud!
IMG_004.jpg [tab] Laatste afbeelding [tab] net een andere tekstinhoud.
-------------------------
En bekijk het album opnieuw:
% album /home/httpd/test/Photos
En u zult de tekstinhouden zien veranderen.
Maak nu een bestand met tekst in: /home/httpd/test/Photos/header.txt
Bekijk het album opnieuw. U zult nu tekst zien bovenaan de pagina.
ITEM: Foto's verbergen
Er zijn een paar manieren om foto's/bestanden/mappen te verbergen, maar wij zullen
het captions bestand gebruiken. Probeer een afbeelding te voorzien van een '#' in captions.txt:
-- captions.txt ---------
IMG_001.jpg [tab] Eerste afbeeldingsnaam
#IMG_002.jpg [tab] Tweede afbeelding
IMG_003.jpg [tab] Een andere afbeelding [tab] met een tekstinhoud!
IMG_004.jpg [tab] Laatste afbeelding [tab] met een andere tekstinhoud.
-------------------------
Bekijk uw album opnieuw, en u zult zien dat IMG_002.jpg nu niet meer zichtbaar is.
Als we dit eerder hadden gedaan, voordat we het album de eerste keer hadden bekeken, zouden we nooit
het medium van thumbnailafbeeldingen gegenereerd hebben. Als u dit wilt,
kunt u ze nu verwijderen met -clean:
% album -clean /home/httpd/test/Photos
ITEM: Een thema gebruiken
Als thema's goed geïnstalleerd zijn en in uw theme_path staan, dan
zou het mogelijk moeten zijn om een thema te gebruiken in uw album:
% album -theme Blue /home/httpd/test/Photos
Het fotoalbum zou nu het blauwe thema moeten gebruiken. Als het nu
een rotzooi is van gebroken afbeeldingen, dan is het thema vast niet
geïnstalleerd in een web-toegankeljke map, bekijk hiervoor de installatiedocumeten.
Het album slaat de opties die u specificeert op, dus de volgende keer dat u uw album opent:
% album /home/httpd/test/Photos
Het blauwe thema zal dan nog steeds in gebruik zijn. Om het thema te verwijderen, kunt u invoeren:
% album -no_theme /home/httpd/test/Photos
ITEM: Mediumafbeeldingen
Volledige resolutie afbeeldingen zijn meestal te groot voor een webalbum, dus
zullen wij mediumafbeeldingen op de afbeeldingspagina's gebruiken:
% album -medium 33% /home/httpd/test/Photos
U heeft nog steeds toegang tot de volledige afbeeldingsgrootte door te klikken op de mediumafbeelding, of:
% album -just_medium /home/httpd/test/Photos
Dit zal de volledige afbeeldingsgrootte behouden i.p.v. verkleind te worden (veronderstel dat we
het tegelijk uitvoeren met de -medium optie)
ITEM: Wat EXIF tekstinhouden toevoegen
Laten we wat openingsinformatie aan de tekstinhouden van elke afbeelding toevoegen.
% album -exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
Dit zal alleen openingsinformatie toevoegen voor alle afbeeldingen die we gespecificeerd hebben in
de 'Aperture' exiftag (het deel tussen de '%'-tekens). We stoppen er ook
een <br> tag in zodat de exifinformatie op een nieuwe regel komt te staan.
We kunnen meer exifinformatie toevoegen:
% album -exif "<br>focal: %FocalLength%" /home/httpd/test/Photos
Omdat het album de opties van eerder heeft opgeslagen, krijgen we nu beide EXIF-tags voor elke
afbeelding die Aperture en FocalLength specificeerd. We gaan aperture verwijderen:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
De '-no_exif' optie moet met de vorige exifstring exact overeenkoment of
het zal genegeerd worden. U kunt ook het configbestand bewerken dat het album aanmaakt:
/home/httpd/test/Photos/album.conf
En verwijder het daar.
ITEM: Meer albums toevoegen
Laten we zeggen dat we op reis gaan naar Spanje. We maken wat foto's en stoppen ze in:
/home/httpd/test/Photos/Spain/
Bekijk nu het album opniew op het hoogste niveau:
% album /home/httpd/test/Photos
Dit zal de map Photos verversen zodat het nu linkt naar Spain en het zal ook een album uitvoeren
van Spain/, met dezelfde instellingen/thema, enz.
Nu gaan we een andere reis maken, en we maken:
/home/httpd/test/Photos/Italy/
We kunnen een album op het hoogste niveau uitvoeren:
% album /home/httpd/test/Photos
Maar dat zal de Spain-map, welke niet veranderd is, niet herscannen.
Albums genereren meestal geen HTML of thumbnails, alleen als het nodig is,
maar het kan nog steeds tijd verspillen, vooral als onze albums groter worden.
Dus we kunnen hem vertellen gewoon de nieuwe map toe te voegen:
% album -add /home/httpd/test/Photos/Italy
Dit zal de hoofdindex (in Photos) verversen en het Italië-album genereren.
ITEM: Vertaald door:
David Ljung Madison [http://GetDave.com/]
1: Feature Requests
If there's something you want added to album, first make sure
it doesn't already exist! Check the man page or the usage:
% man album% album -h
Also see -more and -usage options.
If you don't see it there, consider writing a patch or a plugin.
2: Bug reports
Before you submit a bug, please make sure you have the most current release of album!
When submitting a bug, I need to know at least:
1) Your operating system
2) The exact problem and the exact error messages
I'd also like to know, if possible:
1) The exact album command you ran
2) The output from the command
And I generally also need the debug output of album:
% album -d
Finally, make sure that you've got the most current
version of album, and the most current themes as well.
3: Writing Patches, Modifying album
If you want to modify album, you might want to check with me
first to make sure it's not already on my development plate.
If not, then consider writing it as a plugin instead of patching
the album source. This avoids adding complexity to album for
features that may not be globally used.
If it needs to go into album (for example, if it's a bug), then
please make sure to first download the most recent copy of album
first, then patch that and send me either a diff, a patch, or the
full script. If you comment off the changes you make that'd be great too.
4: Known Bugs
v3.11: -clear_* and -no_* doesn't clear out parent directory options.
v3.10: Burning CDs doesn't quite work with theme absolute paths.
v3.00: Array and code options are saved backwards, for example:
"album -lang aa .. ; album -lang bb .." will still use language 'aa'
Also, in some cases array/code options in sub-albums will not
be ordered right the first time album adds them and you may
need to rerun album. For example:
"album -exif A photos/ ; album -exif B photos/sub"
Will have "B A" for the sub album, but "A B" after: "album photos/sub"
5: PROBLEM: My index pages are too large!
I get many requests to break up the index pages after reaching a certain
threshold of images.
The problem is that this is hard to manage - unless the index pages are
treated just like sub-albums, then you now have three major components
on a page, more indexes, more albums, and thumbnails. And not only is
that cumbersome, but it would require updating all the themes.
Hopefully the next major release of album will do this, but until then
there is another, easier solution - just break the images up into
subdirectories before running album.
I have a tool that will move new images into subdirectories for you and
then runs album:
in_album6:ERROR: no delegate for this image format (./album)
You have the album script in your photo directory and it can't make
a thumbnail of itself! Either:
1) Move album out of the photo directory (suggested)
2) Run album with -known_images
7:ERROR: no delegate for this image format (some_non_image_file)
Don't put non-images in your photo directory, or else run with -known_images.
8:ERROR: no delegate for this image format (some.jpg)9:ERROR: identify: JPEG library is not available (some.jpg)
Your ImageMagick installation isn't complete and doesn't know how
to handle the given image type.
10:ERROR: Can't get [some_image] size from -verbose output.
ImageMagick doesn't know the size of the image specified. Either:
1) Your ImageMagick installation isn't complete and can't handle the image type.
2) You are running album on a directory with non-images in it without
using the -known_images option.
If you're a gentoo linux user and you see this error, then run this command
as root (thanks Alex Pientka):
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
1: Configuration Files
Album behavior can be controlled through command-line options, such as:
% album -no_known_images% album -geometry 133x100% album -exif "File: %File name% " -exif "taken with %Camera make%"
But these options can also be specified in a configuration file:
# Example configuration file # comments are ignored
known_images 0 # known_images=0 is same as no_known_images
geometry 133x100
exif "File: %File name% "
exif "taken with %Camera make%"
The configuration file format is one option per line optionally followed
by whitespace and the option value. Boolean options can be set without
the option value or can be cleared/set with 0 and 1.
2: Location Of Configuration Files
album looks for configuration files in a few locations, in order:
/etc/album/conf System-wide settings
/etc/album.conf System-wide settings
$BASENAME/album.conf In the 'album' install directory
$HOME/.albumrc User specific settings
$HOME/.album.conf User specific settings
$DOT/album.conf User specific (I keep my dot files elsewhere)
$USERPROFILE/album.conf For Windows (C:\Documents and Settings\TheUser)
album also looks for album.conf files inside the photo album directories.
Sub-albums can also have album.conf which will alter the settings
from parent directories (this allows you to, for example, have a
different theme for part of your photo album). Any album.conf files
in your photo album directories will configure the album and any sub-albums
unless overridden by any album.conf settings found in a sub-album.
As an example, consider a conf for a photo album at 'images/album.conf':
theme Dominatrix6
columns 3
And another conf inside 'images/europe/album.conf':
theme Blue
crop
album will use the Dominatrix6 theme for the images/ album and all of
it's sub-albums except for the images/europe/ album which will use
the Blue theme. All of the images/ album and sub-albums will have
3 columns since that wasn't changed in the images/europe/ album, however
all of the thumbnails in images/europe/ and all of it's sub-albums
will be cropped due to the 'crop' configuration setting.
3: Saving Options
Whenever you run an album, the command-line options are saved in
an album.conf inside the photo album directory. If an album.conf
already exists it will be modified not overwritten, so it is safe
to edit this file in a text editor.
This makes it easy to make subsequent calls to album. If you
first generate an album with:
% album -crop -no_known_images -theme Dominatrix6 -sort date images/
Then the next time you call album you can just:
% album images/
This works for sub-albums as well:
% album images/africa/
Will also find all of the saved options.
Some 'one-time only' options are not saved for obvious reasons, such
as -add, -clean, -force, -depth, etc..
Running album multiple times on the same directories can
get confusing if you don't understand how options are saved.
Here are some examples.
Premises:
1) Command-line options are processed before conf options found
in the album directory.
2) Album should run the same the next time you call it if you
don't specify any options.
For example, consider running album twice on a directory:
% album -exif "comment 1" photos/spain% album photos/spain
The second time you run album you'll still get the "comment 1"
exif comment in your photos directory.
3) Album shouldn't end up with multiple copies of the same array
options if you keep calling it with the same command-line
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 1" photos/spain
The second time you run album you will NOT end up with multiple
copies of the "comment 1" exif comment.
However, please note that if you re-specify the same options
each time, album may run slower because it thinks it needs to
regenerate your html!
As an example, if you run:
% album -medium 640x640 photos/spain
(then later...)
% album -medium 640x640 photos/spain
Then the second time will unnecessarily regenerate all your
medium images. This is much slower.
It's better to specify command-line options only the first time
and let them get saved, such as:
% album -medium 640x640 photos/spain
(then later...)
% album photos/spain
Unfortunately these constraints mean that any new array options will
be put at the beginning of your list of -exif options.
For example:
% album -exif "comment 1" photos/spain% album -exif "comment 2" photos/spain
The comments will actually be ordered "comment 2" then "comment 1"
To specify exact ordering, you may need to re-specify all options.
Either specify "comment 1" to put it back on top:
% album -exif "comment 1" photos/spain
Or just specify all the options in the order you want:
% album -exif "comment 1" -exif "comment 2" photos/spain
Sometimes it may be easier to merely edit the album.conf file directly
to make any changes.
Finally, this only allows us to accumulate options.
We can delete options using -no and -clear, see the section on Options,
these settings (or clearings) will also be saved from run to run.
MINI HOW-TO
1: Simpel album
Veronderstel dat u al een album goed geïnstalleerd hebt, kunnen we toch nog wat simpele zaken behandelen.
Als u hier fouten of problemen heeft, bekijk dan de installatiedocumenten.
U heeft een webpad nodig om thema's en uw fotoalbum op te zetten.
Wij zullen /home/httpd/test gebruiken in deze documentatie. Dit moet
weergeefbaar zijn door een webserver. In dit voorbeeld zullen wij de volgende URL gebruiken:
http://myserver/test/
Verander uw commando's/URL's zoals geschikt
Allereerst, maak en map en stop er wat afbeeldingen in. Wij zullen deze noemen:
/home/httpd/test/Photos
En we voegen wat afbeeldingen toe genaamd 'IMG_001.jpg' tot 'IMG_004.jpg'
Nu, in het simpele geval, gewoon uw album uitvoeren:
% album /home/httpd/test/Photos
Nu kunt u het album bekijken in een webbrowser op iets zoals dit:
http://myserver/test/Photos
2: Tekstinhoud toevoegen
Maak een bestand /home/httpd/test/Photos/captions.txt met de volgende
inhouden (use the 'tab' key where you see " [tab] ")
-- captions.txt ---------
IMG_001.jpg [tab] Eerste afbeeldingsnaam
IMG_002.jpg [tab] Tweede afbeelding
IMG_003.jpg [tab] Een andere afbeelding [tab] met een tekstinhoud!
IMG_004.jpg [tab] Laatste afbeelding [tab] net een andere tekstinhoud.
-------------------------
En bekijk het album opnieuw:
% album /home/httpd/test/Photos
En u zult de tekstinhouden zien veranderen.
Maak nu een bestand met tekst in: /home/httpd/test/Photos/header.txt
Bekijk het album opnieuw. U zult nu tekst zien bovenaan de pagina.
3: Foto's verbergen
Er zijn een paar manieren om foto's/bestanden/mappen te verbergen, maar wij zullen
het captions bestand gebruiken. Probeer een afbeelding te voorzien van een '#' in captions.txt:
-- captions.txt ---------
IMG_001.jpg [tab] Eerste afbeeldingsnaam
#IMG_002.jpg [tab] Tweede afbeelding
IMG_003.jpg [tab] Een andere afbeelding [tab] met een tekstinhoud!
IMG_004.jpg [tab] Laatste afbeelding [tab] met een andere tekstinhoud.
-------------------------
Bekijk uw album opnieuw, en u zult zien dat IMG_002.jpg nu niet meer zichtbaar is.
Als we dit eerder hadden gedaan, voordat we het album de eerste keer hadden bekeken, zouden we nooit
het medium van thumbnailafbeeldingen gegenereerd hebben. Als u dit wilt,
kunt u ze nu verwijderen met -clean:
% album -clean /home/httpd/test/Photos
ITEM: Een thema gebruiken
Als thema's goed geïnstalleerd zijn en in uw theme_path staan, dan
zou het mogelijk moeten zijn om een thema te gebruiken in uw album:
% album -theme Blue /home/httpd/test/Photos
Het fotoalbum zou nu het blauwe thema moeten gebruiken. Als het nu
een rotzooi is van gebroken afbeeldingen, dan is het thema vast niet
geïnstalleerd in een web-toegankeljke map, bekijk hiervoor de installatiedocumeten.
Het album slaat de opties die u specificeert op, dus de volgende keer dat u uw album opent:
% album /home/httpd/test/Photos
Het blauwe thema zal dan nog steeds in gebruik zijn. Om het thema te verwijderen, kunt u invoeren:
% album -no_theme /home/httpd/test/Photos
ITEM: Mediumafbeeldingen
Volledige resolutie afbeeldingen zijn meestal te groot voor een webalbum, dus
zullen wij mediumafbeeldingen op de afbeeldingspagina's gebruiken:
% album -medium 33% /home/httpd/test/Photos
U heeft nog steeds toegang tot de volledige afbeeldingsgrootte door te klikken op de mediumafbeelding, of:
% album -just_medium /home/httpd/test/Photos
Dit zal de volledige afbeeldingsgrootte behouden i.p.v. verkleind te worden (veronderstel dat we
het tegelijk uitvoeren met de -medium optie)
4: Wat EXIF tekstinhouden toevoegen
Laten we wat openingsinformatie aan de tekstinhouden van elke afbeelding toevoegen.
% album -exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
Dit zal alleen openingsinformatie toevoegen voor alle afbeeldingen die we gespecificeerd hebben in
de 'Aperture' exiftag (het deel tussen de '%'-tekens). We stoppen er ook
een <br> tag in zodat de exifinformatie op een nieuwe regel komt te staan.
We kunnen meer exifinformatie toevoegen:
% album -exif "<br>focal: %FocalLength%" /home/httpd/test/Photos
Omdat het album de opties van eerder heeft opgeslagen, krijgen we nu beide EXIF-tags voor elke
afbeelding die Aperture en FocalLength specificeerd. We gaan aperture verwijderen:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
De '-no_exif' optie moet met de vorige exifstring exact overeenkoment of
het zal genegeerd worden. U kunt ook het configbestand bewerken dat het album aanmaakt:
/home/httpd/test/Photos/album.conf
En verwijder het daar.
ITEM: Meer albums toevoegen
Laten we zeggen dat we op reis gaan naar Spanje. We maken wat foto's en stoppen ze in:
/home/httpd/test/Photos/Spain/
Bekijk nu het album opniew op het hoogste niveau:
% album /home/httpd/test/Photos
Dit zal de map Photos verversen zodat het nu linkt naar Spain en het zal ook een album uitvoeren
van Spain/, met dezelfde instellingen/thema, enz.
Nu gaan we een andere reis maken, en we maken:
/home/httpd/test/Photos/Italy/
We kunnen een album op het hoogste niveau uitvoeren:
% album /home/httpd/test/Photos
Maar dat zal de Spain-map, welke niet veranderd is, niet herscannen.
Albums genereren meestal geen HTML of thumbnails, alleen als het nodig is,
maar het kan nog steeds tijd verspillen, vooral als onze albums groter worden.
Dus we kunnen hem vertellen gewoon de nieuwe map toe te voegen:
% album -add /home/httpd/test/Photos/Italy
Dit zal de hoofdindex (in Photos) verversen en het Italië-album genereren.
5: Vertaald door:
David Ljung Madison [http://GetDave.com/]
1: Minimum Requirements
1) The album perl script
2) ImageMagick tools (specifically 'convert')
Put the 'album' script and the ImageMagick tools somewhere in your PATH,
or else call 'album' by it's full path (and specify the full path to
convert either in the album script or in the album configuration files.
2: Initial Configuration
The first time you run album it will ask you a few questions to
setup the configuration for you. If you're on UNIX/OSX, then you
can run the first time as root so that it sets up the global configuration
and themes for everyone instead of just the current user.
3: Optional Installation
3) Themes
4) ffmpeg (for movie thumbnails)
5) jhead (for reading EXIF info)
6) plugins
7) Various tools available at MarginalHacks.com
4: UNIX
Most UNIX distros come with ImageMagick and perl, so just download
the album script and themes (#1 and #3 above) and you're done.
To test your install, run the script on a directory with images:
% album /path/to/my/photos/5: Debian UNIX
album is in debian stable, though right now it's a bit stale.
I recommend getting the latest version from MarginalHacks.
You can save the .deb package, and then, as root, run:
% dpkg -i album.deb6: Macintosh OSX
It works fine on OSX, but you have to run it from a terminal window. Just
install the album script and ImageMagick tools, and type in the path to album,
any album options you want, and then the path to the directory with the
photos in them (all separated by spaces), such as:
% album -theme Blue /path/to/my/photos/7: Win95, Win98, Win2000/Win2k, WinNT, WinXP
(Windows 95, Windows 98, Windows 2000, Windows NT, Windows XP)
There are two methods to run perl scripts on Windows, either using ActivePerl
or Cygwin.
ActivePerl is simpler and allows you to run album from a DOS prompt,
though I've heard that it doesn't work with themes.
Cygwin is a bulkier but more robust package that gives you access to
a bunch of UNIX like utilities, and album is run from a bash (UNIX shell)
prompt.
Cygwin method
-------------
1) Install Cygwin
Choose packages: perl, ImageMagick, bash
Do not use the normal ImageMagick install! You must use the Cygwin ImageMagick packages!
2) Install album in bash path or call using absolute path:
bash% album /some/path/to/photos
3) If you want exif info in your captions, you need the Cygwin version of jheadActivePerl method
-----------------
1) Install ImageMagick for Windows
2) Install ActivePerl, Full install (no need for PPM profile)
Choose: "Add perl to PATH" and "Create Perl file extension association"
3) If Win98: Install tcap in path
4) Save album as album.pl in windows path
5) Use dos command prompt to run:
C:> album.pl C:\some\path\to\photosNote: Some versions of Windows (2000/NT at least) have their
own "convert.exe" in the c:\windows\system32 directory (an NTFS utility?).
If you have this, then you either need to edit your path variable,
or else just specify the full path to convert in your album script.
8: How do I edit the Windows path?Windows NT4 Users
Right Click on My Computer, select Properties.
Select Environment tab.
In System Variables box select Path.
In Value edit box add the new paths separated by semicolons
Press OK/Set, press OK again.
Windows 2000 Users
Right Click My Computer, select Properties.
Select Advanced tab.
Click Environment Variables.
In System Variables box select double-click Path
In Value edit box add the new paths separated by semicolons
Press OK/Set, press OK again.
Windows XP Users
Click My Computer, select Change a Setting.
Double click System.
Select Advanced tab.
Select Environment Variables.
In System Variables box select double-click Path
In Value edit box add the new paths separated by semicolons
Press OK.
9: Macintosh OS9
I don't have any plans to port this to OS9 - I don't know what
the state of shells and perl is for pre-OSX. If you have it working
on OS9, let me know.
1: What are Plugins?
Plugins are snippets of code that allow you to modify the behavior
of album. They can be as simple as a new way to create EXIF captions,
to something as complex as creating the album based on a database of
images instead of using the filesystem hierarchy.
2: Installing Plugins and plugin support
There are a number of plugins available with the standard installation of
album. If you are upgrading album with plugins from an earlier version
of album that did not have plugins (pre v3.10), you may need to once do:
% album -configure
You will not need to do this with future upgrades of album.
This will install the current plugins into one of the default
plugin directories - album will look for plugins in a number of
locations, the default locations are:
/etc/album/plugins/
/usr/share/album/plugins/
$HOME/.album/plugins/
In reality, these are 'plugins' directories found in the set of
locations specified by '--data_path' - hence the defaults are:
/etc/album/
/usr/share/album/
$HOME/.album/
You can specify a new location with --data_path and then add a 'plugins'
directory to that location, or use the --plugin_path option.
Plugins usually end with the ".alp" prefix, but you do not need
to specify this prefix when using plugins. For example, if you
have a plugin installed at:
/etc/album/plugins/utils/mv.alp
Then you would specify the plugin as: utils/mv3: Loading/Unloading Plugins
To list all the currently installed plugins:
% album -list_plugins
To show information about a specific plugin (using 'utils/mv' as an example):
% album -plugin_info utils/mv
Plugins will be saved in the configuration for a given album, so
they don't need to be respecified every time (excluding one-time
plugins such as 'utils/mv')
You can use -no_plugin and -clear_plugin to turn off plugins that have
been saved in an album configuration. As with normal album options,
-no_plugin will turn off a specific plugin, and -clear_plugin will
turn off all plugins. Any saved plugin options for that plugin will be
erased as well.
4: Plugin Options
A few plugins may be able to take command-line options, to view usage
for these plugins:
% album -plugin_usage utils/mv
But when specifying plugin options, you need to tell album which plugin
the option belongs to. Instead of specifying as a normal album option:
% album -some_option
You prefix the option with the plugin name followed by a colon:
% album -some_plugin:some_option
For example, you can specify the generated 'index' created by
the 'utils/capindex' plugin.
% album -plugin utils/capindex -utils/capindex:index blah.html
That's a bit unwieldy. You can shorten the name of the plugin as
long as it doesn't conflict with another plugin you've loaded (by
the same name):
% album -plugin utils/capindex -capindex:index
Obviously the other types of options (strings, numbers and arrays) are
possible and use the same convention. They are saved in album configuration
the same as normal album options.
One caveat: As mentioned, once we use a plugin on an album it is saved
in the configuration. If you want to add options to an album that is
already configured to use a plugin, you either need to mention the plugin
again, or else use the full name when specifying the options (otherwise
we won't know what the shortened option belongs to).
For example, consider an imaginary plugin:
% album -plugin some/example/thumbGen Photos/Spain
After that, let's say we want to use the thumbGen boolean option "fast".
This will not work:
% album -thumbGen:fast Photos/Spain
But either of these will work:
% album -plugin some/example/thumbGen -thumbGen:fast blah.html Photos/Spain% album -some/example/thumbGen:fast Photos/Spain5: Writing Plugins
Plugins are small perl modules that register "hooks" into the album code.
There are hooks for most of the album functionality, and the plugin hook
code can often either replace or supplement the album code. More hooks
may be added to future versions of album as needed.
You can see a list of all the hooks that album allows:
% album -list_hooks
And you can get specific information about a hook:
% album -hook_info <hook_name>
We can use album to generate our plugin framework for us:
% album -create_plugin
For this to work, you need to understand album hooks and album options.
We can also write the plugin by hand, it helps to use an already
written plugin as a base to work off of.
In our plugin we register the hook by calling the album::hook() function.
To call functions in the album code, we use the album namespace.
As an example, to register code for the clean_name hook our plugin calls:
album::hook($opt,'clean_name',\&my_clean);
Then whenever album does a clean_name it will also call the plugin
subroutine called my_clean (which we need to provide).
To write my_clean let's look at the clean_name hook info:
Args: ($opt, 'clean_name', $name, $iscaption)
Description: Clean a filename for printing.
The name is either the filename or comes from the caption file.
Returns: Clean name
The args that the my_clean subroutine get are specified on the first line.
Let's say we want to convert all names to uppercase. We could use:
sub my_clean {
my ($opt, $hookname, $name, $iscaption) = @_;
return uc($name);
}
Here's an explanation of the arguments:
$opt This is the handle to all of album's options.
We didn't use it here. Sometimes you'll need it if you
call any of albums internal functions. This is also true
if a $data argument is supplied.
$hookname In this case it will be 'clean_name'. This allows us
to register the same subroutine to handle different hooks.
$name This is the name we are going to clean.
$iscaption This tells us whether the name came from a caption file.
To understand any of the options after the $hookname you
may need to look at the corresponding code in album.
In this case we only needed to use the supplied $name, we called
the perl uppercase routine and returned that. The code is done, but now
we need to create the plugin framework.
Some hooks allow you to replace the album code. For example, you
could write plugin code that can generate thumbnails for pdf files
(using 'convert' is one way to do this). We can register code for
the 'thumbnail' hook, and just return 'undef' if we aren't looking
at a pdf file, but when we see a pdf file, we create a thumbnail
and then return that. When album gets back a thumbnail, then it
will use that and skip it's own thumbnail code.
Now let's finish writing our uppercase plugin. A plugin must do the following:
1) Supply a 'start_plugin' routine. This is where you will likely
register hooks and specify any command-line options for the plugin.
2) The 'start_plugin' routine must return the plugin info
hash, which needs the following keys defined:
author => The author name
href => A URL (or mailto, of course) for the author
version => Version number for this plugin
description => Text description of the plugin
3) End the plugin code by returning '1' (similar to a perl module).
Here is our example clean_name plugin code in a complete plugin:
sub start_plugin {
my ($opt) = @_;
album::hook($opt,'clean_name',\&my_clean);
return {
author => 'David Ljung Madison',
href => 'http://MarginalHacks.com/',
version => '1.0',
description => "Conver image names to uppercase",
};
}
sub my_clean {
return uc($name);
}
1;
Finally, we need to save this somewhere. Plugins are organized in the
plugin directory hierarchy, we could save this in a plugin directory as:
captions/formatting/NAME.alp
In fact, if you look in examples/formatting/NAME.alp you'll find that
there's a plugin already there that does essentially the same thing.
If you want your plugin to accept command-line options, use 'add_option.'
This must be done in the start_plugin code. Some examples:
album::add_option(1,"fast",album::OPTION_BOOL, usage=>"Do it fast");
album::add_option(1,"name", album::OPTION_STR, usage=>"Your name");
album::add_option(1,"colors",album::OPTION_ARR, usage=>"Color list");
For more info, see the 'add_option' code in album and see all of the uses
of it (at the top of album and in plugins that use 'add_option')
To read an option that the user may have set, we use option():
my $fast = album::option($opt, "fast");
If the user gave a bad value for an option, you can call usage():
album::usage("-colors array can only include values [red, green, blue]");
If your plugin needs to load modules that are not part of the
standard Perl distribution, please do this conditionally. For
an example of this, see plugins/extra/rss.alp.
You can also call any of the routines found in the album script
using the album:: namespace. Make sure you know what you are doing.
Some useful routines are:
album::add_head($opt,$data, "<meta name='add_this' content='to the <head>'>");
album::add_header($opt,$data, "<p>This gets added to the album header");
album::add_footer($opt,$data, "<p>This gets added to the album footer");
The best way to figure out how to write plugins is to look at other
plugins, possibly copying one that is similar to yours and working
off of that. Plugin development tools may be created in the future.
Again, album can help create the plugin framework for you:
% album -create_plugin
1: Using languages
(Requires album v4.0 or higher)
Album comes prepackaged with language files (we're in need of translation
help, see below!). The language files will alter most of album's output
messages, as well as any HTML output that isn't generated by the theme.
Altering any text in a theme to match your language is as simple as editing
the Theme files - there is an example of this with the "simple-Czech" theme.
To use a language, add the "lang" option to your main album.conf, or else
specify it the first time you generate an album (it will be saved with that
album afterwards).
Languages can be cleared like any code/array option with:
% album -clear_lang ...
You can specify multiple languages, which can matter if a language is
incomplete, but you'd like to default to another language than english.
So, for example, if you wanted Dutch as the primary language, with the
backup being Swedish Chef, you could do:
% album -lang swedish_chef -lang nl ...
If you specify a sublanguage (such as es-bo for Spanish, Bolivia), then
album will attempt 'es' first as a backup.
Note that because of a known bug, you should specify all the desired
languages at the same time instead of over multiple invocations of album.
To see what languages are available:
% album -list_langs
Sadly, most of the (real) languages are barely complete, but this
is a chance for people to help out by becoming a..
2: Translation Volunteers
The album project is in need of volunteers to do translations,
specifically of:
1) The Mini How-To. Please translate from the source.
2) album messages, as explained below.
If you are willing to do the translation of either one or both
of these items, please contact me!
If you're feeling particularly ambitious, feel free to translate any
of the other Documentation sources as well, just let me know!
3: Documentation Translation
The most important document to translate is the "Mini How-To".
Please translate from the text source.
Also be sure to let me know how you want to be credited,
by your name, name and email, or name and website.
And please include the proper spelling and capitalization of the
name of your language in your language. For example, "franais"
instead of "French"
I am open to suggestions for what charset to use. Current options are:
1) HTML characters such as [é]] (though they only work in browsers)
2) Unicode (UTF-8) such as [é] (only in browsers and some terminals)
3) ASCII code, where possible, such as [] (works in text editors, though
not currently in this page because it's set to unicode)
4) Language specific iso such as iso-8859-8-I for Hebrew.
Currently Unicode (utf-8) seems best for languages that aren't covered
by iso-8859-1, because it covers all languages and helps us deal with
incomplete translations (which would otherwise require multiple charsets,
which is a disaster). Any iso code that is a subset of utf-8 can be used.
If the main terminal software for a given language is in an iso charset
instead of utf, then that could be a good exception to use non-utf.
4: Album messages
album handles all text messages using it's own language support
system, similar to the system used by the perl module Locale::Maketext.
(More info on the inspiration for this is in TPJ13)
An error message, for example, may look like this:
No themes found in [[some directory]].
With a specific example being:
No themes found in /www/var/themes.
In Dutch, this would be:
Geen thema gevonden in /www/var/themes.
The "variable" in this case is "/www/var/themes" and it obviously
isn't translated. In album, the actual error message looks like:
'No themes found in [_1].'
# Args: [_1] = $dir
The translation (in Dutch) looks like:
'No themes found in [_1].' => 'Geen thema gevonden in [_1].'
After translating, album will replace [_1] with the directory.
Sometimes we'll have multiple variables, and they may change places:
Some example errors:
Need to specify -medium with -just_medium option.
Need to specify -theme_url with -theme option.
In Dutch, the first would be:
Met de optie -just_medium moet -medium opgegeven worden.
The actual error with it's Dutch translation is:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet [_1] opgegeven worden'
# Args: [_1]='-medium' [_2]='-just_medium'
Note that the variables have changed places.
There is also a special operator for quantities, for example,
we may wish to translate:
'I have 42 images'
Where the number 42 may change. In English, it is adequate to say:
0 images, 1 image, 2 images, 3 images...
Whereas in Dutch we would have:
0 afbeeldingen, 1 afbeelding, 2 afbeeldingen, 3 afbeeldingen..
But other languages (such as many slavic languages) may have special
rules as to whether "image" should be pluralized based on whether the
quantity is mod 2, 3 or 4, and so on! The simplest case is covered
by the [quant] operator:
[quant,_1,image]
This is similar to "[_1] image" except that "image" will be pluralized
if [_1] is 0 or greater than 1:
0 images, 1 image, 2 images, 3 images...
Pluralization is simply adding an 's' - if this isn't adequate, we can
specify the plural form:
[quant,_1,afbeelding,afbeeldingen]
Which gives us the Dutch count above.
And if we need a special form for 0, we can specify that:
[quant,_1,directory,directories,no directories]
Which would create:
no directories, 1 directory, 2 directories, ...
There is also a shorthand for [quant] using '*', so these are the same:
[quant,_1,image]
[*,_1,image]
So now an example translation for a number of images:
'[*,_1,image]'
=> '[*,_1,afbeelding,afbeeldingen]',
If you have something more complicated then you can use perl code, I
can help you write this if you let me know how the translation should work:
'[*,_1,image]'
=> \&russian_quantity; # This is a sub defined elsewhere..
Since the translation strings are (generally) placed in single-quotes (')
and due to the special [bracket] codes, we need to quote these correctly.
Single-quotes in the string need to be preceded by a slash (\):
'I can\'t find any images'
And square brackets are quoted using (~):
'Problem with option ~[-medium~]'
Which unfortunately can get ugly if the thing inside the square brackets
is a variable:
'Problem with option ~[[_1]~]'
Just be careful and make sure all brackets are closed appropriately.
Furthermore, in almost all cases, the translation should have the
same variables as the original:
'Need to specify [_1] with [_2] option'
=> 'Met de optie [_2] moet' # <- Where did [_1] go?!?
Fortunately, most of the work is done for you. Language files are
saved in the -data_path (or -lang_path) where album keeps it's data.
They are essentially perl code, and they can be auto-generated by album:
% album -make_lang sw
Will create a new, empty language file called 'sw' (Swedish). Go ahead
and edit that file, adding translations as you can. It's okay to leave
translations blank, they just won't get used. Some of the more important
translations (such as the ones that go into HTML pages) are at the top
and should probably be done first.
You will need to pick a charset, this is tricky, as it should be based
on what charsets you think people will be likely to have available
in their terminal as well as in their browser.
If you want to build a new language file, using translations from
a previous file (for example, to update a language with whatever
new messages have been added to album), you should load the language first:
% album -lang sw -make_lang sw
Any translations in the current Swedish language file will be copied
over to the new file (though comments and other code will not be copied!)
For the really long lines of text, don't worry about adding any newline
characters (\n) except where they exist in the original. album will
do word wrap appropriately for the longer sections of text.
Please contact me when you are starting translation work so I can
be sure that we don't have two translators working on the same parts,
and be sure to send me updates of language files as the progress, even
incomplete language files are useful!
If you have any questions about how to read the syntax of the language
file, please let me know.
5: Why am I still seeing English?
After choosing another language, you can still sometimes see English:
1) Option names are still in English. (-geometry is still -geometry)
2) The usage strings are not currently translated.
3) Plugin output is unlikely to be translated.
4) Language files aren't always complete, and will only translate what they know.
5) album may have new output that the language file doesn't know about yet.
6) Most themes are in English.
Fortunately the last one is the easiest to change, just edit the theme
and replace the HTML text portions with whatever language you like, or
create new graphics in a different language for icons with English.
If you create a new theme, I'd love to hear about it!
1: Basic execution
Create a directory with nothing but images in it. The album script and
other tools should not go here. Then run album specifying that directory:
% album /example/path/to/images/
Or, if you're in the /example/path/to directory:
% album images/
When it's done, you'll have a photo album inside that directory starting
with images/index.html.
If that path is in your web server, then you can view it with your
browser. If you can't find it, talk to your sysadmin.
2: Options
There are three types of options. Boolean options, string/num options
and array options. Boolean options can be turned off by prepending -no_:
% album -no_image_pages
String and number values are specified after a string option:
% album -type gif
% album -columns 5
Array options can be specified two ways, with one argument at a time:
% album -exif hi -exif there
Or multiple arguments using the '--' form:
% album --exif hi there --
You can remove specific array options with -no_<option>
and clear all the array options with -clear_<option>.
To clear out array options (say, from the previous album run):
% album -clear_exif -exif "new exif"
(The -clear_exif will clear any previous exif settings and then the
following -exif option will add a new exif comment)
And finally, you can remove specific array options with 'no_':
% album -no_exif hi
Which could remove the 'hi' exif value and leave the 'there' value intact.
Also see the section on Saving Options.
To see a brief usage:
% album -h
To see more options:
% album -more
And even more full list of options:
% album -usage=2
You can specify numbers higher than 2 to see even more options (up to about 100)
Plugins can also have options with their own usage.
3: Themes
Themes are an essential part of what makes album compelling.
You can customize the look of your photo album by downloading a
theme from MarginalHacks or even writing your own theme to match
your website.
To use a theme, download the theme .tar or .zip and unpack it.
Themes are found according to the -theme_path setting, which is
a list of places to look for themes. Those paths need to be somewhere
under the top of your web directory, but not inside a photo album
directory. It needs to be accessible from a web browser.
You can either move the theme into one of the theme_paths that album
is already using, or make a new one and specify it with the -theme_path
option. (-theme_path should point to the directory the theme is in,
not the actual theme directory itself)
Then call album with the -theme option, with or without -theme_path:
% album -theme Dominatrix6 my_photos/
% album -theme Dominatrix6 -theme_path /home/httpd/album/Themes/ my_photos/
You can also create your own themes pretty easily, this is covered
later in this documentation.
4: Sub-albums
Make directories inside your first directory and put images in that.
Run album again, and it will run through all the child directories
and create sub-albums of the first album.
If you make changes to just a sub-album, you can run album on that
and it will keep track of all the parent links.
If you don't want to traverse down the tree of directories, you
can limit it with the depth option. Example:
% album images/ -depth 1
Will only generate photo albums for the images directory.
If you have many sub-albums, and you want to add a new sub-album
without regenerating all the previous sub-albums, then you can use -add:
% album -add images/new_album/
Which will add the new_album to the HTML for 'images/' and then
generate the thumbs and HTML for everything inside 'images/new_album/'
5: Avoiding Thumbnail Regeneration
album tries to avoid unnecessary work. It only creates thumbnails if
they don't exist and haven't changed. This speeds up successive runs
of album.
This can cause a problem if you change the size or cropping of your
thumbnails, because album won't realize that the thumbnails have changed.
You can use the force option to force album to regenerate thumbnails:
% album -force images/
But you shouldn't need to use -force every time.
6: Cleaning Out The Thumbnails
If you remove images from an album then you'll have leftover thumbs and HTML.
You can remove them by running album once with the -clean option:
% album -clean images/7: Medium size images
When you click on an album thumbnail you're taken to an 'image_page.'
The image_page shows, by default, the full size image (as well as
navigation buttons and captions and such). When you click on the
image on the image_page, you'll be taken to the URL for just the full
size image.
If you want a medium size image on the image_page, use the -medium
option and specify a geometry for the medium size image. You can
specify any geometry that ImageMagick can use (see their man page
for more info). Some examples:
# An image that is half the full size
% album -medium 50%
# An image that fits inside 640x480 (maximum size)
% album -medium 640x480
# An image that is shrunk to fit inside 640x480
# (but won't be enlarged if it's smaller than 640x480)
% album -medium '640x480>'
You need the 'quotes' on the last example with most shells because
of the '>' character.
8: Captions
Images and thumbnails can have names and captions. There are a number
of ways to specify/change names and captions in your photo albums.
The name is linked to the image or image_page,
and the caption follows underneath.
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
One way to specify a caption is in a .txt file
with the same name as the image. For this example,
"Kodi_Cow.txt" could contain "Kodi takes down a cow!"
You can rename your images and specify captions in bulk
for an album directory with a captions.txt file.
Each line of the file should be an image or directory filename,
followed by a tab, followed by the new name. You can also
specify (separated by tabs), an optional caption and then an optional
image ALT tag. (To skip a field, use 'tab' 'space' 'tab')
Example:
001.gif My first photo
002.gif Mom and Dad My parents in the grand canyon
003.gif Ani DiFranco My fiancee Yowsers!
The images and directories will also be sorted in the order they are found
in the caption file. You can override this with '-sort date' and '-sort name'
If your editor doesn't handle tabs very well, then you can separate the
fields by double-colons, but only if the caption line doesn't contain any
tabs at all:
003.gif :: Ani DiFranco :: My fiancee :: Yowsers!
If you only want captions on image pages (not on album pages) use:
% album -no_album_captions
If you want web access to create/edit your captions, look at the
caption_edit.cgi CGI script (but be sure to limit access to the
script or anyone can change your captions!)
9: EXIF Captions
You can also specify captions that are based off of EXIF information
(Exchangeable Image File Format) which most digital cameras add to images.
First you need 'jhead' installed. You should be able to run jhead
on a JPG file and see the comments and information.
EXIF captions are added after the normal captions and are specified with -exif:
% album -exif "<br>File: %File name% taken with %Camera make%"
Any %tags% found will be replaced with EXIF information. If any %tags%
aren't found in the EXIF information, then that EXIF caption string is
thrown out. Because of this you can specify multiple -exif strings:
% album -exif "<br>File: %File name% " -exif "taken with %Camera make%"
This way if the 'Camera make' isn't found you can still get the 'File name'
caption.
Like any of the array style options you can use --exif as well:
% album --exif "<br>File: %File name% " "taken with %Camera make%" --
Note that, as above, you can include HTML in your EXIF tags:
% album -exif "<br>Aperture: %Aperture%"
To see the possible EXIF tags (Resolution, Date/Time, Aperture, etc..)
run a program like 'jhead' on an digital camera image.
You can also specify EXIF captions only for album or image pages, see
the -exif_album and -exif_image options.
10: Headers and Footers
In each album directory you can have text files header.txt and footer.txt
These will be copied verbatim into the header and footer of your album (if
it's supported by the theme).
11: Hiding Files/Directories
Any files that album does not recognize as image types are ignored.
To display these files, use -no_known_images. (-known_images is default)
You can mark an image as a non-image by creating an empty file with
the same name with .not_img added to the end.
You can ignore a file completely by creating an empty file with
the same name with .hide_album on the end.
You can avoid running album on a directory (but still include it in your
list of directories) by creating a file <dir>/.no_album
You can ignore directories completely by creating a file <dir>/.hide_album
The Windows version of album doesn't use dots for no_album, hide_album
and not_img because it's difficult to create .files in Windows.
12: Cropping Images
If your images are of a large variety of aspect ratios (i.e., other than
just landscape/portrait) or if your theme only allows one orientation,
then you can have your thumbnails cropped so they all fit the same geometry:
% album -crop
The default cropping is to crop the image to center. If you don't
like the centered-cropping method that the album uses to generate
thumbnails, you can give directives to album to specify where to crop
specific images. Just change the filename of the image so it has a
cropping directive before the filetype. You can direct album to crop
the image at the top, bottom, left or right. As an example, let's
say you have a portrait "Kodi.gif" that you want cropped on top for
the thumbnail. Rename the file to "Kodi.CROPtop.gif" and this will
be done for you (you might want to -clean out the old thumbnail).
The "CROP" string will be removed from the name that is printed in
the HTML.
The default geometry is 133x133. This way landscape images will
create 133x100 thumbnails and portrait images will create 100x133
thumbnails. If you are using cropping and you still want your
thumbnails to have that digital photo aspect ratio, then try 133x100:
% album -crop -geometry 133x100
Remember that if you change the -crop or -geometry settings on a
previously generated album, you will need to specify -force once
to regenerate all your thumbnails.
13: Video
album can generate snapshot thumbnails of many video formats if you
install ffmpeg
If you are running linux on an x86, then you can just grab the binary,
otherwise get the whole package from ffmpeg.org (it's an easy install).
14: Burning CDs (using file://)
If you are using album to burn CDs or you want to access your albums with
file://, then you don't want album to assume "index.html" as the default
index page since the browser probably won't. Furthermore, if you use
themes, you must use relative paths. You can't use -theme_url because
you don't know what the final URL will be. On Windows the theme path
could end up being "C:/Themes" or on UNIX or OSX it could be something
like "/mnt/cd/Themes" - it all depends on where the CD is mounted.
To deal with this, use the -burn option:
% album -burn ...
This requires that the paths from the album to the theme don't change.
The best way to do this is take the top directory that you're going to
burn and put the themes and the album in that directory, then specify
the full path to the theme. For example, create the directories:
myISO/Photos/
myISO/Themes/Blue
Then you can run:
% album -burn -theme myISO/Themes/Blue myISO/Photos
Then you can make a CD image from the myISO directory (or higher).
If you are using 'galbum' (the GUI front end) then you can't specify
the full path to the theme, so you'll need to make sure that the version
of the theme you want to burn is the first one found in the theme_path
(which is likely based off the data_path). In the above example you
could add 'myISO' to the top of the data_path, and it should
use the 'myISO/Themes/Blue' path for the Blue theme.
You can also look at shellrun for windows users, you can have it
automatically launch the album in a browser. (Or see winopen)
15: Indexing your entire album
To navigate an entire album on one page use the caption_index tool.
It uses the same options as album (though it ignores many
of them) so you can just replace your call to "album" with "caption_index"
The output is the HTML for a full album index.
See an example index
for one of my example photo albums16: Updating Albums With CGI
First you need to be able to upload the photo to the album directory.
I suggest using ftp for this. You could also write a javascript that
can upload files, if someone could show me how to do this I'd love to know.
Then you need to be able to remotely run album. To avoid abuse, I
suggest setting up a CGI script that touches a file (or they can just
ftp this file in), and then have a cron job that checks for that
file every few minutes, and if it finds it it removes it and runs album.
[unix only] (You will probably need to set $PATH or use absolute paths
in the script for convert)
If you want immediate gratification, you can run album from a CGI script
such as this one.
If your photos are not owned by the webserver user, then you
need to run through a setud script which you run from a CGI [unix only].
Put the setuid script in a secure place, change it's ownership to be the
same as the photos, and then run "chmod ug+s" on it. Here are example
setuid and CGI scripts. Be sure to edit them.
Also look at caption_edit.cgi which allows you (or others) to edit
captions/names/headers/footers through the web.
1: Basic execution
Create a directory with nothing but images in it. The album script and
other tools should not go here. Then run album specifying that directory:
% album /example/path/to/images/
Or, if you're in the /example/path/to directory:
% album images/
When it's done, you'll have a photo album inside that directory starting
with images/index.html.
If that path is in your web server, then you can view it with your
browser. If you can't find it, talk to your sysadmin.
2: Options
There are three types of options. Boolean options, string/num options
and array options. Boolean options can be turned off by prepending -no_:
% album -no_image_pages
String and number values are specified after a string option:
% album -type gif
% album -columns 5
Array options can be specified two ways, with one argument at a time:
% album -exif hi -exif there
Or multiple arguments using the '--' form:
% album --exif hi there --
You can remove specific array options with -no_<option>
and clear all the array options with -clear_<option>.
To clear out array options (say, from the previous album run):
% album -clear_exif -exif "new exif"
(The -clear_exif will clear any previous exif settings and then the
following -exif option will add a new exif comment)
And finally, you can remove specific array options with 'no_':
% album -no_exif hi
Which could remove the 'hi' exif value and leave the 'there' value intact.
Also see the section on Saving Options.
To see a brief usage:
% album -h
To see more options:
% album -more
And even more full list of options:
% album -usage=2
You can specify numbers higher than 2 to see even more options (up to about 100)
Plugins can also have options with their own usage.
3: Themes
Themes are an essential part of what makes album compelling.
You can customize the look of your photo album by downloading a
theme from MarginalHacks or even writing your own theme to match
your website.
To use a theme, download the theme .tar or .zip and unpack it.
Themes are found according to the -theme_path setting, which is
a list of places to look for themes. Those paths need to be somewhere
under the top of your web directory, but not inside a photo album
directory. It needs to be accessible from a web browser.
You can either move the theme into one of the theme_paths that album
is already using, or make a new one and specify it with the -theme_path
option. (-theme_path should point to the directory the theme is in,
not the actual theme directory itself)
Then call album with the -theme option, with or without -theme_path:
% album -theme Dominatrix6 my_photos/
% album -theme Dominatrix6 -theme_path /home/httpd/album/Themes/ my_photos/
You can also create your own themes pretty easily, this is covered
later in this documentation.
4: Sub-albums
Make directories inside your first directory and put images in that.
Run album again, and it will run through all the child directories
and create sub-albums of the first album.
If you make changes to just a sub-album, you can run album on that
and it will keep track of all the parent links.
If you don't want to traverse down the tree of directories, you
can limit it with the depth option. Example:
% album images/ -depth 1
Will only generate photo albums for the images directory.
If you have many sub-albums, and you want to add a new sub-album
without regenerating all the previous sub-albums, then you can use -add:
% album -add images/new_album/
Which will add the new_album to the HTML for 'images/' and then
generate the thumbs and HTML for everything inside 'images/new_album/'
5: Avoiding Thumbnail Regeneration
album tries to avoid unnecessary work. It only creates thumbnails if
they don't exist and haven't changed. This speeds up successive runs
of album.
This can cause a problem if you change the size or cropping of your
thumbnails, because album won't realize that the thumbnails have changed.
You can use the force option to force album to regenerate thumbnails:
% album -force images/
But you shouldn't need to use -force every time.
6: Cleaning Out The Thumbnails
If you remove images from an album then you'll have leftover thumbs and HTML.
You can remove them by running album once with the -clean option:
% album -clean images/7: Medium size images
When you click on an album thumbnail you're taken to an 'image_page.'
The image_page shows, by default, the full size image (as well as
navigation buttons and captions and such). When you click on the
image on the image_page, you'll be taken to the URL for just the full
size image.
If you want a medium size image on the image_page, use the -medium
option and specify a geometry for the medium size image. You can
specify any geometry that ImageMagick can use (see their man page
for more info). Some examples:
# An image that is half the full size
% album -medium 50%
# An image that fits inside 640x480 (maximum size)
% album -medium 640x480
# An image that is shrunk to fit inside 640x480
# (but won't be enlarged if it's smaller than 640x480)
% album -medium '640x480>'
You need the 'quotes' on the last example with most shells because
of the '>' character.
8: Captions
Images and thumbnails can have names and captions. There are a number
of ways to specify/change names and captions in your photo albums.
The name is linked to the image or image_page,
and the caption follows underneath.
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
One way to specify a caption is in a .txt file
with the same name as the image. For this example,
"Kodi_Cow.txt" could contain "Kodi takes down a cow!"
You can rename your images and specify captions in bulk
for an album directory with a captions.txt file.
Each line of the file should be an image or directory filename,
followed by a tab, followed by the new name. You can also
specify (separated by tabs), an optional caption and then an optional
image ALT tag. (To skip a field, use 'tab' 'space' 'tab')
Example:
001.gif My first photo
002.gif Mom and Dad My parents in the grand canyon
003.gif Ani DiFranco My fiancee Yowsers!
The images and directories will also be sorted in the order they are found
in the caption file. You can override this with '-sort date' and '-sort name'
If your editor doesn't handle tabs very well, then you can separate the
fields by double-colons, but only if the caption line doesn't contain any
tabs at all:
003.gif :: Ani DiFranco :: My fiancee :: Yowsers!
If you only want captions on image pages (not on album pages) use:
% album -no_album_captions
If you want web access to create/edit your captions, look at the
caption_edit.cgi CGI script (but be sure to limit access to the
script or anyone can change your captions!)
9: EXIF Captions
You can also specify captions that are based off of EXIF information
(Exchangeable Image File Format) which most digital cameras add to images.
First you need 'jhead' installed. You should be able to run jhead
on a JPG file and see the comments and information.
EXIF captions are added after the normal captions and are specified with -exif:
% album -exif "<br>File: %File name% taken with %Camera make%"
Any %tags% found will be replaced with EXIF information. If any %tags%
aren't found in the EXIF information, then that EXIF caption string is
thrown out. Because of this you can specify multiple -exif strings:
% album -exif "<br>File: %File name% " -exif "taken with %Camera make%"
This way if the 'Camera make' isn't found you can still get the 'File name'
caption.
Like any of the array style options you can use --exif as well:
% album --exif "<br>File: %File name% " "taken with %Camera make%" --
Note that, as above, you can include HTML in your EXIF tags:
% album -exif "<br>Aperture: %Aperture%"
To see the possible EXIF tags (Resolution, Date/Time, Aperture, etc..)
run a program like 'jhead' on an digital camera image.
You can also specify EXIF captions only for album or image pages, see
the -exif_album and -exif_image options.
10: Headers and Footers
In each album directory you can have text files header.txt and footer.txt
These will be copied verbatim into the header and footer of your album (if
it's supported by the theme).
11: Hiding Files/Directories
Any files that album does not recognize as image types are ignored.
To display these files, use -no_known_images. (-known_images is default)
You can mark an image as a non-image by creating an empty file with
the same name with .not_img added to the end.
You can ignore a file completely by creating an empty file with
the same name with .hide_album on the end.
You can avoid running album on a directory (but still include it in your
list of directories) by creating a file <dir>/.no_album
You can ignore directories completely by creating a file <dir>/.hide_album
The Windows version of album doesn't use dots for no_album, hide_album
and not_img because it's difficult to create .files in Windows.
12: Cropping Images
If your images are of a large variety of aspect ratios (i.e., other than
just landscape/portrait) or if your theme only allows one orientation,
then you can have your thumbnails cropped so they all fit the same geometry:
% album -crop
The default cropping is to crop the image to center. If you don't
like the centered-cropping method that the album uses to generate
thumbnails, you can give directives to album to specify where to crop
specific images. Just change the filename of the image so it has a
cropping directive before the filetype. You can direct album to crop
the image at the top, bottom, left or right. As an example, let's
say you have a portrait "Kodi.gif" that you want cropped on top for
the thumbnail. Rename the file to "Kodi.CROPtop.gif" and this will
be done for you (you might want to -clean out the old thumbnail).
The "CROP" string will be removed from the name that is printed in
the HTML.
The default geometry is 133x133. This way landscape images will
create 133x100 thumbnails and portrait images will create 100x133
thumbnails. If you are using cropping and you still want your
thumbnails to have that digital photo aspect ratio, then try 133x100:
% album -crop -geometry 133x100
Remember that if you change the -crop or -geometry settings on a
previously generated album, you will need to specify -force once
to regenerate all your thumbnails.
13: Video
album can generate snapshot thumbnails of many video formats if you
install ffmpeg
If you are running linux on an x86, then you can just grab the binary,
otherwise get the whole package from ffmpeg.org (it's an easy install).
14: Burning CDs (using file://)
If you are using album to burn CDs or you want to access your albums with
file://, then you don't want album to assume "index.html" as the default
index page since the browser probably won't. Furthermore, if you use
themes, you must use relative paths. You can't use -theme_url because
you don't know what the final URL will be. On Windows the theme path
could end up being "C:/Themes" or on UNIX or OSX it could be something
like "/mnt/cd/Themes" - it all depends on where the CD is mounted.
To deal with this, use the -burn option:
% album -burn ...
This requires that the paths from the album to the theme don't change.
The best way to do this is take the top directory that you're going to
burn and put the themes and the album in that directory, then specify
the full path to the theme. For example, create the directories:
myISO/Photos/
myISO/Themes/Blue
Then you can run:
% album -burn -theme myISO/Themes/Blue myISO/Photos
Then you can make a CD image from the myISO directory (or higher).
If you are using 'galbum' (the GUI front end) then you can't specify
the full path to the theme, so you'll need to make sure that the version
of the theme you want to burn is the first one found in the theme_path
(which is likely based off the data_path). In the above example you
could add 'myISO' to the top of the data_path, and it should
use the 'myISO/Themes/Blue' path for the Blue theme.
You can also look at shellrun for windows users, you can have it
automatically launch the album in a browser. (Or see winopen)
15: Indexing your entire album
To navigate an entire album on one page use the caption_index tool.
It uses the same options as album (though it ignores many
of them) so you can just replace your call to "album" with "caption_index"
The output is the HTML for a full album index.
See an example index
for one of my example photo albums16: Updating Albums With CGI
First you need to be able to upload the photo to the album directory.
I suggest using ftp for this. You could also write a javascript that
can upload files, if someone could show me how to do this I'd love to know.
Then you need to be able to remotely run album. To avoid abuse, I
suggest setting up a CGI script that touches a file (or they can just
ftp this file in), and then have a cron job that checks for that
file every few minutes, and if it finds it it removes it and runs album.
[unix only] (You will probably need to set $PATH or use absolute paths
in the script for convert)
If you want immediate gratification, you can run album from a CGI script
such as this one.
If your photos are not owned by the webserver user, then you
need to run through a setud script which you run from a CGI [unix only].
Put the setuid script in a secure place, change it's ownership to be the
same as the photos, and then run "chmod ug+s" on it. Here are example
setuid and CGI scripts. Be sure to edit them.
Also look at caption_edit.cgi which allows you (or others) to edit
captions/names/headers/footers through the web.
album-4.17/album.1 0000655 0000000 0000000 00000051050 14215673616 012443 0 ustar root root .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ALBUM 1"
.TH ALBUM 1 "2021-01-10" "album v4.17" ""
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
album \- Make a web photo album
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBalbum\fR [\fIalbum\ options\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
album is an \s-1HTML\s0 photo album generator that supports themes. It takes
a directory of images and creates all the thumbnails and \s-1HTML\s0 that
you need. It's fast, easy to use, and very powerful.
.PP
Place your photos in a new directory somewhere inside your web pages.
Then run \f(CW\*(C`album\*(C'\fR from a command-line prompt with the directory path
as an argument, and that's it.
.PP
To use themes, make sure the \f(CW\*(C`Themes\*(C'\fR directory is inside your web
path, and then use the \-theme option.
.SH "OPTIONS"
.IX Header "OPTIONS"
There are three types of options. Boolean options, string/num options and
array options. Boolean options can be turned off by prepending \-no_:
.PP
% album \-no_image_pages
.PP
String and number values are specified after a string option:
.PP
% album \-type gif
% album \-columns 5
.PP
Array options can be specified two ways, with one argument at a time:
.PP
% album \-exif hi \-exif there
.PP
Or multiple arguments using the '\-\-' form:
.PP
% album \-\-exif hi there \-\-
.PP
You can remove specific array options with \-no_
";
"
";
}
# Borders can be 0 pieces, 4 pieces, 8 or 12
# Ordered starting from top (left) going clockwise.
# 12 piece borders
# TL T TR 8 piece borders 4 piece borders
# LT RT TL T TR TTTTTTT
# L IMG R L IMG R L IMG R
# LB RB BL B BR BBBBBBB
# BL B BR
#
# OVERLAY BORDERS can be used by specifying an "padding" as an extra
# integer parameter to the T, L, R and B image arrays. This is the
# amount of the border that shouldn't overlap the image (the outside part).
# The T and L padding will be used for the TL border, etc..
# You cannot mix overlay borders with non-overlay, and overlay borders
# are always 8 pieces (you can skip any pieces with empty image arrays).
#
# Constraints for 12 piece borders:
# Same width: LT,L,LB. T,R,RB
# Same height: LT,RT. LB,RB
# Should be same height: TL,T,TR. BL,B,BR
# height LT = height RT, height LB = height RB
sub Border {
# Either call with:
# (img_object, type, href_type, border_image_arrays)
# (img_string, x,y, border_image_arrays) <-- DEPRECATED!
# Can also call (color,padding) instead of border_image_arrays (Minimalist)
my \$img = shift \@_;
my (\$x,\$y);
my \$href;
if (ref \$img ne 'HASH') {
# Called with (img_string,x,y, ..)
(\$x,\$y) = (shift \@_, shift \@_);
} else {
# Called with (img_object,type,href_type, ..)
my (\$type,\$href_type) = (shift \@_, shift \@_);
# Medium or full if not thumb?
\$type = Get(\$img,'medium','x') ? 'medium' : 'full' if \$type ne 'thumb';
# Lookup href
if (\$href_type) {
if (lc(\$href_type) eq 'next') {
my \$next = Next(\$img);
\$href = Get(\$next,'href','image_page','image_page') if \$next;
} else {
\$href = Get(\$img,'href',\$href_type);
}
}
\$x = Get(\$img,\$type,'x');
\$y = Get(\$img,\$type,'y');
my \$str = Image(\$img,\$type);
# Don't put anchor around movies, some browsers will follow href when
# they press play on the embedded player controls
my \$embed_movie = (\$img->{is_movie} && \$type ne 'thumb') ? 1 : 0;
\$str = \$href.\$str.'' if \$href && !\$embed_movie;
# And leave space for embedded player controls
\$y+=15 if \$embed_movie;
\$img = \$str;
}
my (\$width,\$height,\$overlay)=(1,2,3); # Constants for image arrays
# (color, padding) format (like Minimalist)
if (ref \$_[0] ne 'ARRAY' && \$_[1] =~ /^\\d+\$/) {
print <
\$img
COLOR_BORDER
return;
}
# No corners
if (scalar \@_ == 0) {
print "\$img \n";
return;
}
if (scalar \@_ == 4) {
my (\$T,\$R,\$B,\$L) = \@_;
# Stretch top,bottom to fit image
my \@t = \@\$T; my \@b = \@\$B; # Copy them so we can alter/stretch
my \@l = \@\$L; my \@r = \@\$R;
\$t[\$width] = \$x+\$L->[\$width]+\$R->[\$width];
\$b[\$width] = \$x+\$L->[\$width]+\$R->[\$width];
\$l[\$height] = \$y;
\$r[\$height] = \$y;
my (\$t,\$r,\$b,\$l) =
map( Image_Array(\@\$_), (\\\@t,\\\@r,\\\@b,\\\@l));
print <\$t \$l\$img\$r \$b
BORDER4
return;
}
if (scalar \@_ == 8) {
my (\$TL,\$T,\$TR,\$R,\$BR,\$B,\$BL,\$L) = \@_;
# OVERLAY BORDERS
if (\$#\$T==3 || \$#\$R==3 || \$#\$B==3 || \$#\$L==3) {
my \@t = \@\$T; my \@b = \@\$B; # Copy them so we can alter/stretch
my \@l = \@\$L; my \@r = \@\$R;
my \$t_pad = \$t[\$overlay]; my \$b_pad = \$b[\$overlay];
my \$l_pad = \$l[\$overlay]; my \$r_pad = \$r[\$overlay];
my \$full_width = \$l_pad + \$x + \$r_pad;
my \$full_height = \$t_pad + \$y + \$b_pad;
\$t[\$width] = \$full_width - \$TL->[\$width]-\$TR->[\$width];
\$b[\$width] = \$full_width - \$TL->[\$width]-\$TR->[\$width];
\$l[\$height] = \$full_height - \$TL->[\$height]-\$BL->[\$height];
\$r[\$height] = \$full_height - \$TR->[\$height]-\$BR->[\$height];
\$t[\$width] = 0 if \$t[\$width]<0;
\$b[\$width] = 0 if \$b[\$width]<0;
\$l[\$height] = 0 if \$l[\$width]<0;
\$r[\$height] = 0 if \$r[\$width]<0;
my (\$tl,\$t,\$tr,\$r,\$br,\$b,\$bl,\$l) =
map( Image_Array(\@\$_), (\$TL,\\\@t,\$TR,\\\@r,\$BR,\\\@b,\$BL,\\\@l));
# Unfortunately we have to put links on each piece or else they can't click..
my \$end = \$href ? "" : "";
print <
\$img
\$href\$tl\$end
\$href\$tr\$end
\$href\$bl\$end
\$href\$br\$end
\$href\$t\$end
\$href\$b\$end
\$href\$l\$end
\$href\$r\$end
OVERLAY8
return;
}
# REGULAR 8 PIECE BORDERS
my \$t = Image_Repeat_td(\$x+\$L->[\$width]+\$R->[\$width]-\$TL->[\$width]-\$TR->[\$width],0, \@\$T);
my \$b = Image_Repeat_td(\$x+\$L->[\$width]+\$R->[\$width]-\$BL->[\$width]-\$BR->[\$width],0, \@\$B);
my \$l = Image_Repeat_td(0,\$y, \@\$L);
my \$r = Image_Repeat_td(0,\$y, \@\$R);
my (\$tl,\$tr,\$br,\$bl) = map( Image_Array(\@\$_), (\$TL,\$TR,\$BR,\$BL));
print <
\$tl
\$t
\$tr
\$l
\$img
\$r
\$bl
\$b
\$br
BORDER8
return;
}
if (scalar \@_ == 12) {
my (\$TL,\$T,\$TR,\$RT,\$R,\$RB,\$BR,\$B,\$BL,\$LB,\$L,\$LT) = \@_;
# We might be calling without the need for 12 border pieces
my \$border = (\@\$T || \@\$R || \@\$B || \@\$L) ? 1 : 0;
my \$corners8 = (\@\$TR || \@\$TL || \@\$BL || \@\$BR) ? 1 : 0;
my \$corners12 = (\@\$RT || \@\$RB || \@\$LB || \@\$LT) ? 1 : 0;
return Border(\$img,\$x,\$y,\$TL,\$T,\$TR,\$R,\$BR,\$B,\$BL,\$L)
if \$corners8 && !\$corners12;
return Border(\$img,\$x,\$y,\$T,\$R,\$B,\$L) if \$border && !\$corners12;
return Border(\$img,\$x,\$y) if !\$border && !\$corners12;
my \$t = Image_Repeat_td(\$x+\$L->[\$width]+\$R->[\$width]-\$TL->[\$width]-\$TR->[\$width],0, \@\$T);
my \$b = Image_Repeat_td(\$x+\$L->[\$width]+\$R->[\$width]-\$BL->[\$width]-\$BR->[\$width],0, \@\$B);
my \$l = Image_Repeat_td(0,\$y-\$LT->[\$height]-\$LB->[\$height], \@\$L);
my \$r = Image_Repeat_td(0,\$y-\$RT->[\$height]-\$RB->[\$height], \@\$R);
my (\$tl,\$tr,\$rt,\$rb,\$br,\$bl,\$lb,\$lt) =
map( Image_Array(\@\$_), (\$TL,\$TR,\$RT,\$RB,\$BR,\$BL,\$LB,\$LT));
# Embedded stuff is aligned top in case there are controls, otherwise
# align middle in case the thumbnail is very small and there's blank space.
my \$align = \$img =~ /
Italiano
The name is linked to the image or image_page,
and the caption follows underneath.
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
One way to specify a caption is in a .txt file
with the same name as the image. For this example,
"Kodi_Cow.txt" could contain "Kodi takes down a cow!"
You can rename your images and specify captions in bulk
for an album directory with a captions.txt file.
Each line of the file should be an image or directory filename,
followed by a tab, followed by the new name. You can also
specify (separated by tabs), an optional caption and then an optional
image ALT tag. (To skip a field, use 'tab' 'space' 'tab')
Example:
001.gif My first photo
002.gif Mom and Dad My parents in the grand canyon
003.gif Ani DiFranco My fiancee Yowsers!
The images and directories will also be sorted in the order they are found
in the caption file. You can override this with '-sort date' and '-sort name'
If your editor doesn't handle tabs very well, then you can separate the
fields by double-colons, but only if the caption line doesn't contain any
tabs at all:
003.gif :: Ani DiFranco :: My fiancee :: Yowsers!
If you only want captions on image pages (not on album pages) use:
Le nom est
lié à l'image ou à la page qui l'héberge et la légende suit juste en dessous.
Le nom par défaut est le fichier nettoyé :
The default name is the filename cleaned up:
"Kodi_Cow.gif" => "Kodi Cow"
Un moyen de préciser une légende est d'utiliser un fichier texte avec le
même nom que l'image mais l'extension .txt. Par exemple,
"Kodi_Cow.txt" pourrait contenir "Kodi takes down a cow! ("Kodi
maîtrise une vache !")
Vous pouvez renommer vos images et spécifier toutes les légendes d'un
répertoire avec un fichier captions.txt.
Chaque ligne du fichier doit être le nom d'une image ou d'un
répertoire, suivi par une tabulation, suivi par le nouveau
nom. Vous pouvez aussi spécifier (séparé par une tabulation), une légende
optionnelle puis un tag ALT, optionnel également, pour l'image. Pour sauter
un champ, utilisez 'tabulation' 'espace' 'tabulation'.
Exemple :
001.gif Ma première photo
002.gif Maman et Papa dans le grand canyon
003.gif Ani DiFranco ma fiancée Whaou !
Les images et les répertoires sont listés dans l'ordre dans lequel ils
sont trouvés dans le fichier de légende. Vous pouvez modifier ce tri avec
les options '-sort date' et '-sort name'.
Si votre éditeur de texte ne gère pas très bien les tabulations, vous
pouvez séparer les champs par un double deux-points mais .b/seulement
si votre légende ne contient aucune tabulation :
003.gif :: Ani DiFranco :: Ma fiancée :: Whaou !
Si vous ne souhaitez avoir des légendes que sur les pages contenant les
images (et pas sur les pages affichant les albums), utilisez :
В качестве примера надписи может выступать название изображения, которое может быть
ссылкой на страницу с полноразмерным изображением, комментарий же может быть ниже:
По умолчанию имя изображение это имя файла, без расширения. Например:
"Kodi_Cow.gif" => "Kodi Cow"
Один из способов написать комментарий к изображению в галерее, использовать .txt файл, с
тем же самым именем файла, что и изображение. Для примера, указанного выше, это может быть файл "Kodi_Cow.txt", который вполне может содержать "Kodi takes down a cow!"
Вы можете переименовать ваши файлы с изображения и указать комментарии в отдельном файле, но для всех изображения сразу, расположим его в той же папке и назвав его captions.txt.
Каждая линия этого файла должна быть именем изображения, расположенного в папке галереи или именем папки более низкого уровня, написанного в форме таблицы.
Вы можете так же указать (отделяя при помощи знаков табуляции, т.е. клавиши TAB), дополнительные пояснительные надписи или альтернативные метки. (чтобы пропустить поле надписи просто используйте 'tab' 'space' 'tab')
Вот примеры:
001.gif Моя первая фотография
002.gif Мама и папа Мои родители в горах
003.gif Ani DiFranco My fiancee Yowsers!
Все изображения в папке будут отсортированы в том порядке, в котором они указаны в файле с надписями. Вы может изменить этот порядок путем использования опций '-sort date' и '-sort name'
Если ваш редактор не дает возможность использовать знаки табуляции (tabs) вы можете отделить поля при помощи двойного использования знака двоеточия, но только если пояснения к изображениям не будут содержать двоеточий и символов табуляции (tabs):
003.gif :: Ani DiFranco :: My fiancee :: Yowsers!
Если вы хотите только видеть пояснения на страницах с полноразмерными изображениями (не на главной странице галереи с иконками предпросмотра) используйте опцию:
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}