Documentation
include_file(langmenu)
"
album-4.10/Docs/ru/Short.html 0000644 0000000 0000000 00000034612 12010141351 014531 0 ustar root root
MarginalHacks album - Documentation
A l b u m
D o c u m e n t a t i o n
album-4.10/Docs/ru/txt_7 0000644 0000000 0000000 00000043425 11615154155 013556 0 ustar root root Дополнения (plugin), использование, создание
ITEM: Что такое дополнения (plugin)?
Дополнения (pluginы) это фрагменты кода, которые позволяют модифицировать
работу приложения album. Вероятно создание дополнений - это
один из самых простых способов от создания новых элементов
EXIF комментариев до создания базы данных изображений, основанных
на собственном алгоритме иерархии, а не на иерархии файловой системы.
ITEM: Установка дополнения и их поддержка
Вообще, есть большое число дополнений, доступных при стандартной установки
приложения album. Если вы обновили приложение album дополнениями из
более ранних версий приложения (ранее версии 3.10), вам может потребоваться
запустить команду, для конфигурирования приложения:
% album -configure
Позже, при работе с приложением album, эту команду запускать еще раз не нужно.
Эта команда устанавливает доступные на данный момент времени дополнения в
папку, указанную по умолчанию. Но вообще, приложение album ищет доступные
дополнения в следующих папках (это места по умолчанию):
/etc/album/plugins/
/usr/share/album/plugins/
$HOME/.album/plugins/
Все эти папки для дополнений можно указать приложению при запуске с опцией
'--data_path', но все же по умолчанию определено:
/etc/album/
/usr/share/album/
$HOME/.album/
Иными словами вы можете указать новое расположение папок опцией
--data_path, а затем добавить папку конкретного дополнения путем
указание пути к ней, через опцию --plugin_path.
Сами файлы дополнений обычно имеют префикс ".alp", при использовании
дополнения его указывать не нужно. К примеру, у вас есть дополнения,
установленное в:
/etc/album/plugins/utils/mv.alp
То вам при обращении к нему можно просто указать: utils/mv
ITEM: Загрузка/Выгрузка дополнений
Чтобы увидеть все установленные в данный момент времени дополнения
введите команду:
% album -list_plugins
А, чтобы посмотреть информацию об указанном дополнении (использующим
путь 'utils/mv'?, к примеру):
% album -plugin_info utils/mv
Дополнения будут сохранены как часть конфигурации для данной галереи,
поэтому не надо будет каждый раз их указывать по-новой при последующих
запусках, за исключением дополнений, которые работают однократно, таких
как 'utils/mv')
Вы можете использовать опции -no_plugin и -clear_plugin для отключения
дополнений, которые уже сохранены как часть конфигурации приложения
album. Как и другие обычные опции , предназначенные для отключения
чего-либо, опция -no_plugin отключит указанное дополнение, а -clear_plugin
отключит все дополнения. Любые опции, которые были указаны для дополнения,
будут стерты тоже.
ITEM: Опции дополнений
Сами дополнения способны воспринимать опции командной строки, чтобы посмотреть
использование можно ввести команду:
% album -plugin_usage utils/mv
Но когда указывают опции для дополнений, вам необходимо указать и то,
к каккому дополнению имеет отношения данная опция, поэтому
вместо обычного стиля указаний опций:
% album -some_option
При этом опция для дополнения отделяется двоеточием:
% album -some_plugin:some_option
К примеру, вы можете указать 'index' созданный дополнением
'utils/capindex', тогда следуюет ввести команду:
% album -plugin utils/capindex -utils/capindex:index blah.html
Получается не очень коротко, но можно укоротить названия для
дополнения, при условии если он не будет конфликтовать с другим
названием другого дополнения (с тем же самым именем).
% album -plugin utils/capindex -capindex:index
Есть и другие виды опций (строки, числа и множества) для них
вомзожно использовать те же самые соотношения. Они сохраняются
конфигурации приложения, как и другие обычные опции.
Одно предупреждение... Как было упомянуто выше, когда используется дополнения
они сохраняется в конфигурации приложения album. Если вы хотите добавить
опции, к приложению, которые обычно используются совместно с данным
дополнением, то необходимо либо упомянуть дополнение снова, либо
использоваться полное название когда указываются обычные опции.
К примеру, рассмотрим:
% album -plugin some/example/thumbGen Photos/Spain
Предположим, что после этого, необходимо использовать опцию "fast" для
thumbGen, то вот так ничего работать не будет работать:
% album -thumbGen:fast Photos/Spain
А вот это будет работать нормально:
% album -plugin some/example/thumbGen -thumbGen:fast blah.html Photos/Spain
% album -some/example/thumbGen:fast Photos/Spain
ITEM: Написание дополнений
Фактически дополнение - это маленькие программные модули perl, которые
"добавляются" в код приложения album.
Есть много вариантов программных модулей, расширяюших возможности
работы приложения album. Общая особенность всех их состоит в том, что они
либо замещают часть программного кода самого приложения, либо
замещают его собственным программным кодом. Естественно, по мере необходимости, со временем
можно будет добавить любые дополнения...
Перечь все установленных модулей можно увидеть путем ввода команды:
% album -list_hooks
Так же вы можете получить дополнительную информацию о программном коде:
% album -hook_info <hook_name>
Мы можем использовать приложения album для генерации каркаса дополнения:
% album -create_plugin
Для этой работы, необходимо четко понимать как работает приложение, и,
что позволяют получить опции.
Мы можем также написать дополнение полностью вручную, чтобы это сделать,
полезно изучить уже написанные дополнения, чтобы понять принцип их
работы.
Регистрация дополнений, производится путем вызова функции album::hook().
Для вызова функций в кода приложения album, используется пространство
имен приложения album.
К примеру, для регистрации программного кода для clean_name
дополнения hook производится вызов:
album::hook($opt,'clean_name',\&my_clean);
Затем если приложение album
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
Аргументы, которые соответствует подрограмме my_clean указаны
в первой строке. Если необходимо конвертировать их
в строчные буквам, то нужно использовать:
sub my_clean {
my ($opt, $hookname, $name, $iscaption) = @_;
return uc($name);
}
Объяснение аргументов:
$opt Это обозначение для все опций приложения album.
Здесь оно не используется. Но иногда оно может понадобится,
если необходимо вызвать какую-либо встроенную функцию
приложения album. Это же справедливо если использует аргумент
$data.
$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.
Некоторые программные модули, позволяют заместить программный код
самого приложения album. К примеру, необходимос написать
программный модуль, который будет генерировать иконки
предпросмотра для pdf файлов (приложение 'convert' именно этот
подход). Можно зарегистрировать программный для модуля
'thumbnail' и получить только поле 'undef', если не pdf файл
не найден, но когда pdf файл найден, создается иконка
предпросмотра, и только потом происходит возврат. Когда
приложение album возвращает иконку предпросмотра, то
он же и будет ее использовать, пропуская собственный фрагмент
программного кода для создания иконок предпросмотра.
Теперь пришла пора закончить написание нашего дополнения для
преобразования в происные буквы. Дополнение должны делать
следующее:
1) Поддерживать 'start_plugin' подпрограмму. Т.е. тот фрагмент кода
где происходит регистрация дополнительных программных модулей
и соответствующих им опций командной строки.
2) Подрограмма 'start_plugin' должна возращать информацию дополнения
в hash, в которой необходимо указать следующие поля:
author => Имя автора
href => URL (или mailto, конечно) для автора
version => Номер версии для дополнения
description => Текстовое описание дополнения
3) По окончанию дополнение возвращает '1' (аналогично как и perl модуль).
Ниже представлен наш пример, код дополнения clean_name
полностью:
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;
В конечном счете, нам необходимо все это сохранить где-либо.
Дополнения организованы в папке для дополнений, в соответствии
с иерархией данной папки, в нашем случае можно сохранить данные
по пути:
captions/formatting/NAME.alp
Фактически, если посмотреть examples/formatting/NAME.alp
можно обнаружить, что дополнение уже там находится, и, что
фактически оно одно и тоже.
Если необходимо, чтобы дополнение имело доступ к опциям
командной строки, то нужно использовать конструкцию 'add_option.'
И это должно быть сделано в разделе start_plugin.
Вот некоторые примеры:
album::add_option(1,"fast",album::OPTION_BOOL, usage=>"Делает это быстро");
album::add_option(1,"name", album::OPTION_STR, usage=>"Ваше имя");
album::add_option(1,"colors",album::OPTION_ARR, usage=>"Цвет списка");
Для большей информации, посмотрите код 'add_option' в приложении album
и ознакомьтесь со все вариантами его использования (в приложении album
и в дополнениях, которые испольузют 'add_option')
Для чтения опций, которые пользователь может установить,
используется option():
my $fast = album::option($opt, "быстро");
Чтобы пользователь не вводил неправильные значения опций, можно использовать
usage():
album::usage("-colors array can only include values [red, green, blue]");
Если вашему дополнению нужно загрузить модули, которые
не являются часть стандартного дистрибутива Perl, посмотрите
пример plugins/extra/rss.alp.
Так же можно вызывать любой фргамент программного кода в скрипте
приложение album, путем использования двоеточие. Чтобы точно знать
как это можно сделать посмотрите примеры:
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");
Лучший способ понять как написать дополнения - это посмотреть другое
работающее дополнение. Вероятно надо будет скопировать какую-либо
его часть и запустить его отдельно, чтобы понять как оно работает.
В будущем возможно появятся специальные программы для создание дополнений
для приложения album.
Есть опция, которая позволяет создать шаблон дополнения:
% album -create_plugin
ITEM: Переведено
Чубаровым И.Ю. (Tchubarov I, aka krolik, ceramic64@yandex.ru)
album-4.10/Docs/ru/txt_8 0000644 0000000 0000000 00000047626 12010141265 013552 0 ustar root root Языковая поддержка
ITEM: Использование языков
(Требуется приложение album версии 4.0 или выше)
Приложение Album уже содержит в себе запакованные языковые файлы (однако, нам
всё равно необходима помощь в переводе, подробности смотрите дальше!).
При запуске приложения эти языковые файлы будут влиять на содержание большей
части сообщений, которые генерируются приложением причём как в теме, которая
используются для создания альбома, так и менять вид некоторых сообщений, не
связанных с темой, а только с готовым HTML файлом.
Изменить любой текст в теме, в соответствии с вашим языком можно просто путём
простого редактирования самих файлов тем. Есть простой пример такой работы -
это "simple-Czech" тема.
Чтобы использовать язык надо добавить опцию "lang" в конфигурационном файле
album.conf или просто её указать при командной строке при первым запуске
приложения (естественно, после первого запуска - это опция будет сохранена
в том же самом конфигурационном файле).
Так же можно убрать возможность использования языковой опции путём запуска
приложение командой такого вида:
% album -clear_lang ...
Вы можете указать несколько языков, если вы хотите, чтобы один язык
использовался как главный, другой как дополнительный. К примеру, очень удобно
указать голландский язык как основной, а шведский язык использоваться как язык
для сохранения резервной копии альбома. Для этого надо выполнить:
% album -lang swedish_chef -lang nl ...
Если вы указали дополнительные языки (например Испанский или Боливийский,
командой es-bo), то приложение album будет работать с испанским языком 'es',
как главным для резервной копии.
Следует обратить внимание, что для того, чтобы не было проблем перезаписи
готовых галерей при нескольких запусках приложения album, необходимо указать
сразу несколько языков, с которыми вы хотите работать.
Чтобы увидеть какие языки доступны для приложения надо выполнить:
% album -list_langs
К сожалению, перевода для многих языков мира, ещё нет, но есть шанс, что люди
заинтересуются этим, чтобы сделать приложение album более популярным..
ITEM: Желающим помочь с переводом
Проекту приложения album необходимы добровольцы-переводчики, для нескольких
областей работы:
1) The Mini How-To. Пожалуйста переводите из source .
2) Сообщения выводимые самим приложение при запуске, более подробно см. ниже.
Если вы готовы помочь с переводом обоих пунктов - свяжитесь со мной обязательно!
Если же вы готовы перевести хоть что-то, дайте мне знать, что именно!
ITEM: Перевод документации
Наиболее важный документ это: "Mini How-To" .
Пожалуйста переводите его сразу из источника: text source .
Естественно вы можете быть уверенными, что я обязательно укажу ваше имя, электронный
адрес почты, ваш персональный сайт и т.п. на страницах своего сайта.
При переводе пожалуйста обратите внимание на правильное использование
заглавных букв и названия самого вашего языка in your language .
Для примера - "fran�ais" вместо "French".
Мне без разницы какую раскладку вы используете для работы. На данный момент доступны
следующие варианты:
1) HTML символы такие как [é]] (несмотря на то, что они работают только
в интернет браузерах)
2) Unicode (UTF-8) такие как [é] (работают только в интернет браузерах и некоторых
терминалах)
3) ASCII коды, где возможно, такие как [�] (работают в текстовых редакторах, на этой
странице не будут видны, т.к. её раскладка установлена как unicode)
4) Специфические языковые раскладки iso такие как iso-8859-8-I для иврита.
Современный Unicode (utf-8) по видимому это лучшая раскладка для всех языков.
Это существенно облегчает работу по адаптации этого приложения для разных стран
и народов. Однако utf не распространяется на некоторые языки, например, тот
же iso-8859-1. Несмотря на это всё равно есть возможность компенсировать это
через использования iso стандартов, т.к. между utf-8 и iso всегда можно
найти соответствие, путём задания нескольких параметров.
Т.е. если главное терминальное приложение написано для iso раскладки вместо utf,
то это будет очень хорошее решение, именно для тех языков, которых нет в
описании стандарта utf.
ITEM: Сообщения генерируемые приложением album
Приложение album генерирует все текстовые сообщения на заданном при запуске языке,
подобно тому как другие системы используют отдельный модуль, написанный на
языке perl Locale::Maketext .
(Больше информации об этому можно найти вот по этой ссылке TPJ13 )
Сообщение об ошибке, к примеру, может выглядеть примерно так:
Не найдено файлов тем [[в такой-то директории]].
Или, если приложение установлено по умолчанию:
Не найдено файлов тем в /www/var/themes.
Если задана опция использования голландского языка, сообщение будет иметь вид:
Geen thema gevonden in /www/var/themes.
Естественно путь в данном случае "/www/var/themes" не будет переведён.
Строка перевода в языковом файле должна быть:
'Не найдено файлов тем в [_1].'
# Args: [_1] = $dir
На голландском языке будет что-то вроде:
'Не найдено файлов тем [_1].' => 'Geen thema gevonden in [_1].'
После перевод, приложение album заменит [_1] нужной папкой.
Иногда имеется несколько переменных, и в соответствии с правилами вашего языка,
их можно поменять местами:
Некоторые примеры ошибок:
Необходимо указать -medium с -just_medium option.
Необходимо указать -theme_url с -theme option.
На голландском языке это будет похоже на:
Met de optie -just_medium moet -medium opgegeven worden.
Строка перевода для голландского языка (в языковом файле) тогда
будет в виде:
'Необходимо указать [_1] с [_2] опцией'
=> 'Met de optie [_2] moet [_1] opgegeven worden'
# Args: [_1]='-medium' [_2]='-just_medium'
Обратите внимание, что переменные заменены местами.
Есть так же специальный оператор для кавычек, к примеру,
мы хотим перевести:
'У меня есть 42 изображения'
Число 42 может быть изменено. В английском варианте нормальным будет:
0 images, 1 image, 2 images, 3 images...
А на голландском:
0 afbeeldingen, 1 afbeelding, 2 afbeeldingen, 3 afbeeldingen..
Но, в других языках (например, во многих языках славянской группы)
имеются другие правила к склонению слова "изображение", которое должно
быть изменённым в соответствии с тем, какое именно числительное стоит
после слова "изображение". Для русского это 1 изображение, 2 изображения,
3 изображения, 4 изображения, 5 изображений и т.п. Самый просто путь
решить эту проблему это ввести оператор [quant]:
[quant,_1,image]
Это аналогично предыдущему примеру с "[-1] image" за исключением того,
что словоформа будет изменяться, если числительное больше 1.
0 images, 1 image, 2 images, 3 images...
Для английского языка просто необходимо добавить 's', для указания
множественного числа, для голландского это будет выполнено в виде:
[quant,_1,afbeelding,afbeeldingen]
Что даёт правильное написание числительных на голландском языке.
Если же нам необходимо указать особую форму для 0, мы может указать:
[quant,_1,directory,directories,no directories]
Это даст в выводе приложения:
no directories, 1 directory, 2 directories, ...
Есть также сокращенный вариант оператора [quant] - это
использование '*', в тех же самых случаях:
[quant,_1,image]
[*,_1,image]
Тот же пример для голландского языка будет таким:
'[*,_1,image]'
=> '[*,_1,afbeelding,afbeeldingen]',
Если же вам нужно что-то более сложное, описанного выше, т.е. того, что
может дать существующий на данный момент код perl, дайте мне знать - я
подумаю как можно решить эту проблему, зная как перевод должен работать:
'[*,_1,image]'
=> \&russian_quantity; # Здесь дополнительные определения будут..
Строки для перевода в большей части помещены в одинарные кавычки ('),
при переводе следует следить за тем, чтобы открытие-закрытие кавычек
было корректным, иначе программа работать нормально не будет.
Если необходимо в сообщении вывести отдельный апостроф, перед ним
нужно написать слэш (\):
'I can\'t find any images'
Для того чтобы вывести квадратные скобки, перед ними нужно написать символ
тильды (~):
'Проблема с опцией ~[-medium~]'
Единственный момент, что подобный подход сложно использовать, если внутри
есть другой аргумент в квадратных скобках (могут возникнуть ошибки при работе
приложения в некоторых случаях):
'Проблема с опцией ~[[_1]~]'
Будьте внимательными, всегда проверяйте корректно ли закрыты-открыты скобки!
Более того, в большинстве случаем перевод должен использовать те же самые
переменные, что и оригинал:
'Необходимо указать [_1] с [_2] опцией'
=> 'Met de optie [_2] moet' # <- Куда исчезло [_1] ?!?
К счастью, большая часть работы уже сделана за вас. Языковые файлы
сохранены в опции -data_path(или -lang_path) или там где приложение
альбом по умолчанию хранит свои данные
Для генерации языкового файла можно ввести команду:
% album -make_lang sw
В этом случае будет создан новый, пустой языковый файл, готовый к
переводу, в данном случае он будет назван 'sw' (Швеция). Для перевода,
необходимо открыть этот файл и постепенно, начиная с верха перевести
всё, что вы можете. Если что-то непонятно - оставляйте всё как есть.
Наиболее важные сообщения, перенесены в самый верх этого файла, их
надо перевести в первую очередь.
Так же вам надо определиться с языковой раскладкой, это в некотором
смысле сложно, однако, я надеюсь, что людям доступен их терминал или
интернет браузер, где можно посмотреть в какой раскладке вы работаете.
Если вы хотите построить новый языковый файл, использую то, что уже
сделано ранее (т.е. из предыдущего языкового файла), к примеру, чтобы
добавить в языковый файл новые сообщения, вы должны указать первой
опцией выбора языка, а уже второй - генерацию языкового файла, таким
образом:
% album -lang sw -make_lang sw
Таким образом в генерируемый языковый файл, возьмёт всю информацию
из существующего языкового файла, за исключением комментариев!
Если у вас будут получаться очень длинные строки перевода, можете
не думать о том, как организовать перенос слов, как это приходится
делать, например, в программах на языке С, путём написания
символа возврата каретки (\n) за исключением того случая, когда
они указаны в оригинале. Приложение album будет само переносить
части длинной строки правильно.
Пожалуйста свяжитесь со мной, когда вы начнёте работу по переводу, чтобы
я был уверен, что два переводчика не делают одно и то же или работают
надо одной и той же частью текста. На основе вашей информации, я смогу
правильно обновлять языковые файлы, чтобы обеспечить тем самым
нормальную работу приложения album. Пожалуйста присылайте мне даже
незаконченные файлы, это лучше чем ничего!
Если у вас есть вопросы по реализации синтаксических особенностей вашего
языка, то тоже напишите мне об этом.
ITEM: Почему я всё ещё вижу сообщения на английском языке?
После указание другого языка, вы можете всё ещё видеть что-то на английском.
Вероятные причины могут быть следующими:
1) Некоторые слова всё ещё на английском. (-geometry всё ещё -geometry)
2) Использование строк до сих пор не переведено.
3) Результат работы дополнений (plugin) маловероятно, что будет с переводом.
4) Языковые файлы не всегда закончены, и когда будут переведены полностью -
никто не знает.
5) Новая версия приложения album может выдавать новые сообщение, которые
просто ещё нет в языковом файле.
6) Большинство слов в темах на английском.
Проблему последнего пункта очень просто решить, для этого достаточно просто
отредактировать файлы тем вручную, и заменить части html кода с английским
языком, на части кода со словами нужного вам языка. То же самое относится и
к графике, с названиями или английскими буквами. Нужно создать её по-новой,
поместить в папку темы. В любом случае, если вы создадите новую тему - я
буду очень этому рад, не забудьте об этом написать мне, чтобы я её включил
в список возможных тем.
album-4.10/Docs/ru/flag.png 0000644 0000000 0000000 00000000210 11524055304 014161 0 ustar root root PNG
IHDR m?h bKGD tIME4 ;r *IDAT8c &Z:j0
`d`j0 dc IENDB` album-4.10/Docs/ru/Section_7.html 0000644 0000000 0000000 00000101466 11615156365 015313 0 ustar root root
MarginalHacks album - Дополнения (plugin), использование, создание
- Documentation
A l b u m
S e v e n - - ( p l u g i n , использование, создание
)
Содержание
Что такое дополнения (plugin)?
Установка дополнения и их поддержка
Загрузка/Выгрузка дополнений
Опции дополнений
Написание дополнений
Переведено
1: Что такое дополнения (plugin)?
Дополнения (pluginы) это фрагменты кода, которые позволяют модифицировать
работу приложения album. Вероятно создание дополнений - это
один из самых простых способов от создания новых элементов
EXIF комментариев до создания базы данных изображений, основанных
на собственном алгоритме иерархии, а не на иерархии файловой системы.
2: Установка дополнения и их поддержка
Вообще, есть большое число дополнений, доступных при стандартной установки
приложения album. Если вы обновили приложение album дополнениями из
более ранних версий приложения (ранее версии 3.10), вам может потребоваться
запустить команду, для конфигурирования приложения:
% album -configure
Позже, при работе с приложением album, эту команду запускать еще раз не нужно.
Эта команда устанавливает доступные на данный момент времени дополнения в
папку, указанную по умолчанию. Но вообще, приложение album ищет доступные
дополнения в следующих папках (это места по умолчанию):
/etc/album/plugins/
/usr/share/album/plugins/
$HOME/.album/plugins/
Все эти папки для дополнений можно указать приложению при запуске с опцией
'--data_path', но все же по умолчанию определено:
/etc/album/
/usr/share/album/
$HOME/.album/
Иными словами вы можете указать новое расположение папок опцией
--data_path, а затем добавить папку конкретного дополнения путем
указание пути к ней, через опцию --plugin_path.
Сами файлы дополнений обычно имеют префикс ".alp", при использовании
дополнения его указывать не нужно. К примеру, у вас есть дополнения,
установленное в:
/etc/album/plugins/utils/mv.alp
То вам при обращении к нему можно просто указать: utils/mv
3: Загрузка/Выгрузка дополнений
Чтобы увидеть все установленные в данный момент времени дополнения
введите команду:
% album -list_plugins
А, чтобы посмотреть информацию об указанном дополнении (использующим
путь 'utils/mv'?, к примеру):
% album -plugin_info utils/mv
Дополнения будут сохранены как часть конфигурации для данной галереи,
поэтому не надо будет каждый раз их указывать по-новой при последующих
запусках, за исключением дополнений, которые работают однократно, таких
как 'utils/mv')
Вы можете использовать опции -no_plugin и -clear_plugin для отключения
дополнений, которые уже сохранены как часть конфигурации приложения
album. Как и другие обычные опции , предназначенные для отключения
чего-либо, опция -no_plugin отключит указанное дополнение, а -clear_plugin
отключит все дополнения. Любые опции, которые были указаны для дополнения,
будут стерты тоже.
4: Опции дополнений
Сами дополнения способны воспринимать опции командной строки, чтобы посмотреть
использование можно ввести команду:
% album -plugin_usage utils/mv
Но когда указывают опции для дополнений, вам необходимо указать и то,
к каккому дополнению имеет отношения данная опция, поэтому
вместо обычного стиля указаний опций:
% album -some_option
При этом опция для дополнения отделяется двоеточием:
% album -some_plugin:some_option
К примеру, вы можете указать 'index' созданный дополнением
'utils/capindex', тогда следуюет ввести команду:
% album -plugin utils/capindex -utils/capindex:index blah.html
Получается не очень коротко, но можно укоротить названия для
дополнения, при условии если он не будет конфликтовать с другим
названием другого дополнения (с тем же самым именем).
% album -plugin utils/capindex -capindex:index
Есть и другие виды опций (строки, числа и множества) для них
вомзожно использовать те же самые соотношения. Они сохраняются
конфигурации приложения, как и другие обычные опции.
Одно предупреждение... Как было упомянуто выше, когда используется дополнения
они сохраняется в конфигурации приложения album. Если вы хотите добавить
опции, к приложению, которые обычно используются совместно с данным
дополнением, то необходимо либо упомянуть дополнение снова, либо
использоваться полное название когда указываются обычные опции.
К примеру, рассмотрим:
% album -plugin some/example/thumbGen Photos/Spain
Предположим, что после этого, необходимо использовать опцию "fast" для
thumbGen, то вот так ничего работать не будет работать:
% album -thumbGen:fast Photos/Spain
А вот это будет работать нормально:
% album -plugin some/example/thumbGen -thumbGen:fast blah.html Photos/Spain
% album -some/example/thumbGen:fast Photos/Spain
5: Написание дополнений
Фактически дополнение - это маленькие программные модули perl, которые
"добавляются" в код приложения album.
Есть много вариантов программных модулей, расширяюших возможности
работы приложения album. Общая особенность всех их состоит в том, что они
либо замещают часть программного кода самого приложения, либо
замещают его собственным программным кодом. Естественно, по мере необходимости, со временем
можно будет добавить любые дополнения...
Перечь все установленных модулей можно увидеть путем ввода команды:
% album -list_hooks
Так же вы можете получить дополнительную информацию о программном коде:
% album -hook_info <hook_name>
Мы можем использовать приложения album для генерации каркаса дополнения:
% album -create_plugin
Для этой работы, необходимо четко понимать как работает приложение, и,
что позволяют получить опции.
Мы можем также написать дополнение полностью вручную, чтобы это сделать,
полезно изучить уже написанные дополнения, чтобы понять принцип их
работы.
Регистрация дополнений, производится путем вызова функции album::hook().
Для вызова функций в кода приложения album, используется пространство
имен приложения album.
К примеру, для регистрации программного кода для clean_name
дополнения hook производится вызов:
album::hook($opt,'clean_name',\&my_clean);
Затем если приложение album
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
Аргументы, которые соответствует подрограмме my_clean указаны
в первой строке. Если необходимо конвертировать их
в строчные буквам, то нужно использовать:
sub my_clean {
my ($opt, $hookname, $name, $iscaption) = @_;
return uc($name);
}
Объяснение аргументов:
$opt Это обозначение для все опций приложения album.
Здесь оно не используется. Но иногда оно может понадобится,
если необходимо вызвать какую-либо встроенную функцию
приложения album. Это же справедливо если использует аргумент
$data.
$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.
Некоторые программные модули, позволяют заместить программный код
самого приложения album. К примеру, необходимос написать
программный модуль, который будет генерировать иконки
предпросмотра для pdf файлов (приложение 'convert' именно этот
подход). Можно зарегистрировать программный для модуля
'thumbnail' и получить только поле 'undef', если не pdf файл
не найден, но когда pdf файл найден, создается иконка
предпросмотра, и только потом происходит возврат. Когда
приложение album возвращает иконку предпросмотра, то
он же и будет ее использовать, пропуская собственный фрагмент
программного кода для создания иконок предпросмотра.
Теперь пришла пора закончить написание нашего дополнения для
преобразования в происные буквы. Дополнение должны делать
следующее:
1) Поддерживать 'start_plugin' подпрограмму. Т.е. тот фрагмент кода
где происходит регистрация дополнительных программных модулей
и соответствующих им опций командной строки.
2) Подрограмма 'start_plugin' должна возращать информацию дополнения
в hash, в которой необходимо указать следующие поля:
author => Имя автора
href => URL (или mailto, конечно) для автора
version => Номер версии для дополнения
description => Текстовое описание дополнения
3) По окончанию дополнение возвращает '1' (аналогично как и perl модуль).
Ниже представлен наш пример, код дополнения clean_name
полностью:
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;
В конечном счете, нам необходимо все это сохранить где-либо.
Дополнения организованы в папке для дополнений, в соответствии
с иерархией данной папки, в нашем случае можно сохранить данные
по пути:
captions/formatting/NAME.alp
Фактически, если посмотреть examples/formatting/NAME.alp
можно обнаружить, что дополнение уже там находится, и, что
фактически оно одно и тоже.
Если необходимо, чтобы дополнение имело доступ к опциям
командной строки, то нужно использовать конструкцию 'add_option.'
И это должно быть сделано в разделе start_plugin.
Вот некоторые примеры:
album::add_option(1,"fast",album::OPTION_BOOL, usage=>"Делает это быстро");
album::add_option(1,"name", album::OPTION_STR, usage=>"Ваше имя");
album::add_option(1,"colors",album::OPTION_ARR, usage=>"Цвет списка");
Для большей информации, посмотрите код 'add_option' в приложении album
и ознакомьтесь со все вариантами его использования (в приложении album
и в дополнениях, которые испольузют 'add_option')
Для чтения опций, которые пользователь может установить,
используется option():
my $fast = album::option($opt, "быстро");
Чтобы пользователь не вводил неправильные значения опций, можно использовать
usage():
album::usage("-colors array can only include values [red, green, blue]");
Если вашему дополнению нужно загрузить модули, которые
не являются часть стандартного дистрибутива Perl, посмотрите
пример plugins/extra/rss.alp.
Так же можно вызывать любой фргамент программного кода в скрипте
приложение album, путем использования двоеточие. Чтобы точно знать
как это можно сделать посмотрите примеры:
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");
Лучший способ понять как написать дополнения - это посмотреть другое
работающее дополнение. Вероятно надо будет скопировать какую-либо
его часть и запустить его отдельно, чтобы понять как оно работает.
В будущем возможно появятся специальные программы для создание дополнений
для приложения album.
Есть опция, которая позволяет создать шаблон дополнения:
% album -create_plugin
6: Переведено
Чубаровым И.Ю. (Tchubarov I, aka krolik, ceramic64@yandex.ru)
Created by make_faq from Marginal Hacks
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
album-4.10/Docs/ru/Section_6.html 0000644 0000000 0000000 00000144224 11615156365 015311 0 ustar root root
MarginalHacks album - Создание собственных тем
- Documentation
Содержание
Методы
Редактирование HTML файлов существующих тем
Простейший путь simmer_theme из графики.
(на будущее) API для тем
Как прислать свою тему для добавление в состав приложения
Конвертация тем v2.0 в темы v3.0
Переведено
1: Методы
Для приложения album есть простые пути для создания своих тем, а есть сложные.
Все зависит от уровня ваших знаний, желания и того, что
вы хотите в итоге сделать.
2: Редактирование HTML файлов существующих тем
Если вы хотите только слегка изменить тему, чтобы, например, она
соответствовала дизайну вашего сайта, то самый простой путь - это
редактирование уже существующей темы. В папках тем имеется два
*.th файла. album.th - это шаблон для страниц самой галереи
(для страницы с иконками предпросмотра) и image.th - шаблон для
построения страниц с полноразмерными изображениями. Структура этих
файлов очень простая, за исключением некототрых вставок с элементами
<: ePerl :> кода. Даже если вы не знаете, что такое Perl или
ePerl вы все равно можете прекрасно редактировать элементы HTML-файла,
которые соответствуют общепринятым стандартам и тем самым осуществить
небольшую корректировку темы.
Простые и понятные темы:
Если вам надо получить галерею без лишних элементов - обратите внимание на
"Blue" или "Maste." Если же вас привлекает счетверенная окантовка
вокруг иконок предпросмотра посмотрите тему "Eddie Bauer." Если же
хотите что-то оригинальное, например наслаиващиеся и прозрачные рамки то,
смотрите тему FunLand.
Если вы хотите получить что-то совсем минималистическое, с минимальным
количеством кода, попробуйте тему "simple", но учтитет она очень давно
не обновлялась, поэтому она вполне может неккоректно работать с новейшими
типами графических файлов.
3: Простейший путь simmer_theme из графики.
Большинство тем имеют главный элемент (можно сказать главное меню галереи),
где отображаются иконки предпросмотра и точки входа в галереии более
низких уровней. Естественно в нем есть свой фон, рамки для иконок
предпросмотра и т.п. Подумайте, может вам для вашей новой темы будет
достаточно всего лишь заменить эти элементы?
Так же большинство тем имеют один и тот же элемент, который позволяет
отобразить полноразмерное изображение, естественно с заданными фоном,
рамками для графического изображения и т.п. Для того, чтобы что-то
сделать свое, вполне достаточно изменить только вспомогательные
графические элементы. Для этого есть довольно простой способ.
Если вы создаете папку с изображениями, файл с благодарностями (см. ниже),
файлы шрифтов (Font) и стиля (Style.css), то новая тема будет создана автоматически.
Файлы:
Font/Style.css
Это файл, который определяет шрифт, который будет использован в теме.
"Font" - файл, системе должен быть известен раннее (см. ниже).
Создание же файла Style.css file позволяет определить все стили для:
тела, заголовка, пояснений и т.п.
Посмотрите тему FunLand как один из простых примеров.
Либо можно использовать только файл шрифта. Пример такого файла представлен
ниже:
--------------------------------------------------
$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'">
--------------------------------------------------
Благодарности
Файл благодарностей - это те самые две строки, которые выводятся в галереях, созданными
приложением album, чтобы дать ссылки на ресурс MarginalHacks.
Если вы не собираетесь присылать тему нам, то вам, в общем, не стоит особенно беспокоится
об этом файле. Но, если же вам по крайней мере нравится сама идея, благодарности,
посмотрите как нужно оформить этот файл:
1) Краткое описание темы (все должно быть в одной строке)
2) Ваше имя (вы можете внутри указать mailto: or href link)
Null.gif
Для каждой темы необходим прозрачный рисунок типа gif, размером всего 1x1.
Вы можете его скопировать из любой другой темы.
Необязательные графические файлы для оформления тем:
Полосы
Полосы в темах сосздаются из файлов:
Bar_L.gif, Bar_R.gif and Bar_M.gif
(слева, справа, в середине - соответственно).
Полоса по середине растягивается. Если вам нужно, чтобы середина не была
растянута используется другие файлы:
Bar_L.gif, Bar_ML.gif, Bar_M.gif, Bar_MR.gif, Bar_R.gif
И затем файл Bar_ML.gif и Bar_MR.gif will, чтобы растянуть пространство
справа и слева. (Чтобы понять что это - посмотрите тему Craftsman в
качестве примера).
Locked.gif
Это изображения для отображения папок, котоыре были закрыты через .htaccess
Изображения фонов
Если вы хотитет использовать изображения фона, то его надо указать
в файле шрифтов в $BODY разделе, как показано в последнем примере.
При этом переменная $PATH должна быть замещена путем к файлам темы
More.gif
Когда страница имеет галерении более низкого уровня, то этот файл
просто отображает слова 'More.gif' в форме графическго изображения.
Next.gif, Prev.gif, Back.gif
Это файлы стрелок для предыдущего, последующего и обратного элемента галереи.
Icon.gif
Файл который выводится в левом верзнем углу меню галереи, часто
он просто содержит только слово "Photos" ("Фотографии")
Изображения рамок
Есть масса способом сделать рамку для изображения в галерееThere от простых,
до достаточно сложных. Все зависит от уровня сложно структуры самой
рамки и то, как вы будете "растягивать" элементы для построения этой
рамки:
4 элемента Использует Bord_L.gif, Bord_R.gif, Bord_T.gif, Bord_B.gif
(Углы слева и справа)
4-х элементные рамки обычно не растягиваются, т.к. они не будут
хорошо работать на страницах с полноразмерными изображениями,
вы можете только сделать углы справа и слева от изображения:
8 элементов Так включает файлы Bord_TL.gif, Bord_TR.gif, Bord_BL.gif, Bord_BR.gif
8-ми элементые рамки очень хорошо получается растягивать на страницах
с полноразмерными изображениями
12 элементов Включает файлы Bord_LT.gif, Bord_RT.gif, Bord_LB.gif, Bord_RB.gif
12-ти элементные рамки позволяют не только растягивать элементы рамки, но
и вводить дополнительно сложные элементы-украшения на углас изображения
(посмотрите темы Dominatrix6 или Ivy)
Overlay Borders Can use transparent images that can be partially
overlaying your thumbnail. See below.
Ниже показана обычная структура распределения элементов рамок:
12 элементов
TL T TR 8 элементов 4 элемента
LT RT TL T TR TTTTTTT
L IMG R L IMG R L IMG R
LB RB BL B BR BBBBBBB
BL B BR
Стоит обратить внимание на то, что даже изображения формата raw
должны быть одной и той же высоты, несмотря на то, что ширина у них
как правило не одинаковая одинаковая (т.е. высота TL= высоте T
= высоте TR), правда это не относится к рамкам с перекрывающимися
элементами.
Когда вы создатите эти файлы, то можете запустить дополнительное
приложение simmer-theme (его можно скачать с сайта MarginalHacks.com),
после чего ваша тема будет готова к использованию!
Если вам необходимо получить разные рамки на меню галереи и
страницах с полноразмерными изображениями, то надо использовать
те же самые имена файлов, но с добавлением префикса 'I'
(IBord_LT.gif, IBord_RT.gif,...)
Рамки с перекрывающимися элементами позволяют реализовать
удивительные эффекты в ваших галереях, путем изменения формы рамки.
Правда, на данный момент времени, отсутствует выбор способов начертания
этих элементов.
Для использования рамок с элементами перекрытия, надо создать изображения:
Over_TL.png Over_T.png Over_TR.png
Over_L.png Over_R.png
Over_BL.png Over_B.png Over_BR.png
Затем надо обозначить как много точек рамки будут снаружи фотографии.
И уже после, указать эти значения в файлах:
Over_T.pad Over_R.pad Over_B.pad Over_L.pad
Для примера посмотрите тему "Themes/FunLand".
Изображения для различных языков
Если ваши изображения имеют текст, вы можете его перевести на другие языки
так, что галереи могут быть сгенерированы для других языков. К примеру, вы
моежет создать голандскийй файл изображения "More.gif" и посместить его в
'lang/nl/More.gif' в папку с темой (nl - это код языка Голландии).
Когда пользователь запустит приложение album в Голландии (с опцией
album -lang nl), то тема будет использовать изображение, понятное
голандцам (т.е. то, которое будет найдено по указанному выше пути).
В теме Blue имеется простой пример того, как этот подход работает.
На данный момент времени переведены изображения для:
More, Back, Next, Prev and Icon
Вы можете создать HTML таблицу, которая покажет доступные языки
для тем, путем вызова приложения album с опцией -list_html_trans:
% album -list_html_trans > trans.html
После чего посмотрите файл trans.html в вашем интернет-браузере.
К сожалению, разные языки имеют разную раскладку, а HTML страница всегда
имеет только одну. Но в HTML документе будут симвлолы в utf-8, поэтому
всегда можно вручную отредактировать параметр "charset=utf-8", чтобы
правильно видеть буквы различных языков.
Если вам придется редактировать много тем, дайте мне знать, а если вы
если вы создадите много языковых графических файлов под свой язык -
пошлите их мне. Я размещу их в темах так, что люди из вашей страны
уже будут видетьь готовый набор картинок, на родном языке.
4: (на будущее) API для тем
Это гораздо более тяжелая работа. Для начала вам надо иметь очень
четки мысли о том, как должна выглядеть галерея, как должны быть
расположены картинки на странице, какие должны быть элементы
декорирования.
Здесь тоже, видимо, будет проше начать с простой модицификации
одной их существующих тем. Этот процесс сразу даст толчок к появлению
новых мыслей о том, как надо все сделать в конечном счетет, т.к.
станет понятно, что темы делают в процессе своей работы (и как работает
код, представленный ниже).
Любая папка с темой должная содержать как миним один файл - 'album.th'.
Это шаблон темы. Часто в папках можно увидеть файлы 'image.th',
который является шаблоном для изображения, так же в папке находятся
скрипты стиля и вспомогательные графические файлы. Страницы самой галереи
содержат иконки предпросмотра и полноразмерные изображения.
Файлы .th - написаны на ePerl, который является диалектом языка Perl,
специально разработанного для работы в HTML документе. Собственно
эти файлы и делают большую часть работы по соазданию галереи как таковой.
Чтобы написать тему самому, вам необходимо понимать синтаксис языка ePerl.
Вы можете найти много информации по этому вопросу, на ресурсе MarginalHacks,
путем изучения специальных вспомогательных приложений, работающих с этим
языком (обратите внимание на то, что сами темы не используют эти
вспомогательные приложения!)
Имеется много фрагментов кода, который гарантированно работает, и часто
для разработки нужен именно хорошо зарекомендовавший и отлаженный фрагмент
кода. Самое главное, что изучение этих фрагемтов поможет понять как построена
тема.
Функциональная таблица:
Требуемые функции
Meta() Должен быть вызван в HTML
Credit() Дает благодарность (то, что пишется внизу: 'this album created by..')
Должен быть вызван в HTML
Body_Tag() Вызывается внутри текущего ярлыка.
Paths and Options
Option($name) Дает значение опции или конфигурационной установки
Version() Возвращает версию приложения album
Version_Num() Возврашает только номвер версии приложения album (например, "3.14")
Path($type) Возвращает путь для $type:
album_name Название этой галереи
dir Текущая рабочая папка
album_file Полный путь к index.html
album_path Путь к "родительским" папкам
theme Полный путь к папке с темами
img_theme Полный путь к папке с темами из папки с графическими файлами галереи
page_post_url ".html" для добавления на страницы с изображениями
parent_albums Массив "родительских" галерей (album_path split up)
Image_Page() 1 если происходит генераци только страниц с изображениями, 0 - для меню галереи
Page_Type() Или страница с изображениями 'image_page' или меню галереи 'album_page'
Theme_Path() Путь к файлам темы в масштабе имен файловой системы
Theme_URL() URL пуьб к файлам темы
Верзний и нижний колонтитул
isHeader(), pHeader() Тест для печати верхнего колонтитула
isFooter(), pFooter() То же самое для нижнего колонтитула
Главный цикл используется следущие локальные переменные:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Этот скрипт печатает названия кажлого изображения. Типы объектов или
'pics' (для изображений) или 'dirs' для папок "потомков".
Имеется несколько функций объекта:
Объекты (тип или 'pics' (по умолчанию) или 'dirs')
First($type) Дает первый графический файл или объект галереи более низкого уровня.
Last($type) Прошлый объект
Next($obj) Возращает следующий объект
Next($obj,1) То же самое, но при достижении последнего переходит к началу.
Prev($obj), Prev($obj,1) Аналогичен Next()
num('pics') or just num() Общее число изображений в этой галерее
num('dirs') Общее число галерей более низкого уровня (галерей "потомков")
Also:
num('parent_albums') Общее число "прородителей" этой галереи.
Object lookup:
get_obj($num, $type, $loop)
Находится объекты по номеру ('pics' или 'dirs').
Если установлен цикл $loop то поиск будет бесконечным.
Свойства объектов
Каждый объект (изображение или галерея более низкого уровня) имеет свойства.
Некоторые свойства доступны через так называемые поля:
Get($obj,$field) Дает одно поле объекта
Поле Описание
----- ----------
type Какой тип объекта? Или 'pics', или 'dirs'
is_movie Логическое значение: это видео?
name Название (необязательно - берется из комментария)
cap Комментарий к изображению
capfile Необязательный файл комментариев
alt Альтернативный ярлык
num_pics [только для папок, -dir_thumbs] число pics в папке
num_dirs [только для папок, -dir_thumbs] число dirs в папке
Для некоторых свойств доступны дополнительные "подполя". К примеры,
каждое изображение имеет разную информацию о размерах: полное, среднее и
совсем маленькое (для иконки предросмотры). Стоит напомнить, что среднего размера
может и не быть в галерее.
Get($obj,$size,$field) Получить значение поля для данного размера
Свойство Поле Описание
---- ----- ----------
$size x Ширина
$size y Высота
$size file Название файла (без пути)
$size path Название файла (полный путь)
$size filesize Размер файла в байтах
full tag Ярлык (или 'image', или 'embed') - но только для 'full'
Так же имеется информация об URL, которая позволяет осуществить
доступ к странице находясь в 'from' к изображению или странице,
указанной в 'to':
Get($obj,'URL',$from,$to) Получить URL для объекта из->в
Get($obj,'href',$from,$to) То же самое, но данные возвращаются как 'href' строка.
Get($obj,'link',$from,$to) То же самое, но данные будут для объекта с указанным
именем внутри ссылки href.
Из В Описание
---- -- ----------
album_page image Адрес изображения для страницы галереи из album_page
album_page thumb Иконка предпросмотра из album_page
image_page image Адрес изображения из image_page
image_page image_page Страница с изображение из другой страницы с изображением
image_page image_src Адрес URL <img src> для страницы с изображением
image_page thumb Иконока предпросмотра для страницы с изображением
Папки с объектами так же имеют свойства:
Из В Определение
---- -- ----------
album_page dir URL к папке из страницы с "родительской" галереи
"Родительские" галереи
Parent_Album($num) Получить строку "родительской" галереи (включая href)
Parent_Albums() Получить список стро "родительской" галереи (включая href)
Parent_Album($str) Присоединить вызов ($str) для Parent_Albums()
Back() URL для возврата на первую страницу.
Изображения
This_Image Объект изображение для страницы с изображениями
Image($img,$type) Ярлык <img> для средних, полных и "иконочных" изображений
Image($num,$type) То же самое но для числа изображений
Name($img) Чистое и комментарий для изображения
Caption($img) Подпись к изображению
Галереи "потомков"
Name($alb)
Caption($img) Подпись к изображению
Элементы для упрощения
Pretty($str,$html,$lines) Очень удобный формат имени.
Если $html то HTML разрешено (т.е., используюя 0 для <title> и т.п.)
Постоянно только устанавливаются префексы для дат самым маленьким шрифтом ('2004-12-03.Папка')
Если $lines то "многострочность" разрешена
Постоянно только разрешены даты с символом конца строки 'br'.
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.
Если вы создали тему, то подумайте о том чтобы добавить поддержку
слайд-шоу (при использовании опции -slideshow). Самый легкий путь осуществить
эту идею добавить фрагементы кода, отмеченный словом "slideshow" из существующей
темы.
5: Как прислать свою тему для добавление в состав приложения
У вас есть собственная тема? Будет очень приятно ее увидеть, даже если она
сделана под конкретный сайт со своим стилевым оформлением.
И если вы хотите поделится результатом своей работы, дать позвожность
другим людям оформлять свои галереи в вашей теме, то вы можете прислать ее мне
(или дать ссылку на страницу какого-либо ресурса, где она использована),
чтобы ее можно было посмотреть. При этом проверьте правильно ли
заполнен файл благодарностей (CREDIT), и дайте мне знать существуют ли
какие-либо особые условия лицензии на использование, которая может
распространятся на вашу тему.
6: Конвертация тем v2.0 в темы v3.0
Интерфейс тем приложения album v2.0 впоследствии был изменен. Поэтому большинство
тем v2.0 (особеннно тех, в которых не используется много глобальных переменных)
будут все еще продолжать нормально работать, но, в недалеком будущем, нормальный
внешний вид галереи может быть сильно нарушен.
Чтобы этого не произошло несложно провести конвертацию тем из v2.0 в v3.0.
В темах v2.0 используются глобальные переменные для очень многих вещей.
Теперь этот подход не используется. В темах v3.0 для обозначения путей к изображениям и
папкам используются итераторы ('iterator'), к примеру:
my $image = First('pics');
while ($image) {
print Name($image);
$image = Next($image);
}
Данный фрагмент кода будет "пролистывать" все изображения в папке и
выводить их имена. На основе показанной выше схеме можно переписать,
все старые темы, которые используют глобальные переменные, в новом
варианте когда используются локальные переменные, значения которых
задается вызовом цикла, как показано в примере
Здесь представлена схема преобразования для помощи в конвертации тем v2.0 в v3.0:
# Глобальные переменные не надо использовать
# ВСЕ УБРАТЬ - как получить локальные переменные в примере см. выше
$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, ...
# Старые глобальные переменные:
# ВСЕ УБРАТЬ - как получить локальные переменные в примере см. выше
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()
# Пути и методы
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_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(\@_)
# Изображения, использующие переменную '$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()
# Галерея "потомок", использующая переменную '$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)
# Без изменения
Meta() Meta()
Credit() Credit()
7: Переведено
Чубаровым И.Ю. (Tchubarov I, aka krolik, ceramic64@yandex.ru)
Created by make_faq from Marginal Hacks
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
album-4.10/Docs/ru/index.html 0000644 0000000 0000000 00000057330 12010141351 014543 0 ustar root root
MarginalHacks album - Documentation
A l b u m
D o c u m e n t a t i o n
album-4.10/Docs/ru/txt_5 0000644 0000000 0000000 00000023442 11602260342 013541 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.10/Docs/ru/txt_4 0000644 0000000 0000000 00000025266 11602260340 013544 0 ustar root root Конфигурационные файлы
ITEM: Конфигурационные файлы
Работа приложения album управляется через опции командной строки, такие как:
% album -no_known_images
% album -geometry 133x100
% album -exif "File: %File name% " -exif "taken with %Camera make%"
Но эти опции могут быть указаны в конфигурационном файле:
# Пример конфигурационного файла # комментарии игнорируются
known_images 0 # known_images=0 is same as no_known_images
geometry 133x100
exif "File: %File name% "
exif "taken with %Camera make%"
Формат конфигурационного файла это одна строка текста, в которой
название опции и ее значение разделены пробелом. Опции, принимающие
только два значения определяются установкой значения 0 и 1. Допустимо
так же оставить поле значение пустым (будет использовано значение по умолчанию).
ITEM: Расположение конфигурационных файлов
Приложение album ищет конфигурационные файлы по следующим путям, в порядке уканном
ниже:
/etc/album/conf Системные установки
/etc/album.conf Системные установки
$BASENAME/album.conf В установочном каталоге приложения 'album'
$HOME/.albumrc Определенные пользователем установки
$HOME/.album.conf Определенные пользователем установки
$DOT/album.conf Установки привязанные к определенному пользователю
$USERPROFILE/album.conf Для Windows (C:\Documents and Settings\TheUser)
Приложение album так же ищет файлы конфигурационные файлы album.conf
внутри папки с файлами изображения. Галереи второго уровня могут так же
иметь свои конфигурационные файлы album.conf, которые своими установками
могут отличаться от конфигурационных файлов альбомов первого уровня (это
позволит вам, к примеру, использоваться разные типы для разных частей
вашего фотоальбома). Любой конфигурационный файл album.conf в папке
файлами изображений будет конфигурировать и любой альбом второго уровня, при
условии если в папках второго уровня не будет своего конфигурационного
файла album.conf.
К примеру, рассмотрим конфигурацию для некоторого файла 'images/album.conf':
theme Dominatrix6
columns 3
И другой конфигурационный файл, расположенный в другом месте 'images/europe/album.conf':
theme Blue
crop
Приложение album будет использовать тему Dominatrix6 для папки images/
и для всех альбомов второго уровня, за исключением альбома images/europe/, который
будет использоваться Blue тему. Все галереи, расположенные по адресу images/, и
все альбомы второго уровня будут иметь по 3 столбца, которые на будут
менятся в галерее второго уровня images/europe/, однако все
изображение предпросмотра (иконки) в images/europe/ и все галереи второго
уровня будут уменьшены из-за использования опции 'crop' в конфигурационном
файле.
ITEM: Опции записи
Когда вы запускаете приложение album, опции командной строки
сохраняются в файле album.conf в папке с файлами изображений.
Если album.conf уже существует, он будет модифицирован но
не перезаписан, поэтому можно безбоязненно редактировать этот
файл в любом текстовом редакторе.
Это подход позволяет легко осуществить последовательно вызов приложения album, для
организации иерархической системы галерей с файлами изображений. Если первый раз
вызывваете приложения album командой:
% album -crop -no_known_images -theme Dominatrix6 -sort date images/
Затем снова вызовете приложение album командой:
% album images/
Это будет точно так же работать и для галереей второго уровня:
% album images/africa/
Везде будут обнаружены конфигурационные файлы, в которых сохранены опции запуска
приложения album.
Некоторые опции 'one-time only', которые работают только один раз не сохраняются
в конфигурационных файлах по этим причинам, среди них:
-add, -clean, -force, -depth и т.д.
Запуск приложения album по нескольку раз в одной и той же папке может
стать причиной конфликта, если вы не понимаете каким образом
сохраняются опции.
Посмотрите несколько примеров.
Итак:
1) Опции командной строки обрабатывается перед опциями, которые находятся в
конфигурационном файле.
2) Приложение album должно быть запущено в следующий раз с теми же самыми опциями,
если только к предыдущим вы не добавили новые.
К примеру, рассмотрим двойной запуск приложения album в папке:
% album -exif "comment 1" photos/spain
% album photos/spain
Второй раз вы запустили приложение album, и вы получите дополнительный комментарий
exif, несмотря на то, что под фотографиями уже есть "comment 1", который
появился в результате первого запуска приложения.
3) Приложение album не добавляет еще раз копию той же самой опции, которая уже
была вызвана ранее
К примеру:
% album -exif "comment 1" photos/spain
% album -exif "comment 1" photos/spain
Второй вызов приложения album не будет причиной появления второй строки
"comment1" под фотографиями. Просто ничего не произойдет.
Однако, все же обратите внимание, что не всегда вызов приложения с теми же
самыми опциями, не принесет никаких проблем. По крайней мере второй вызов
приложения album может отнять у вас больше времени, поскольку для работы,
необходимо сгенерировать html по-новой!
К примеру, если вы запустите:
% album -medium 640x640 photos/spain
(затем позже...)
% album -medium 640x640 photos/spain
Второй вызов заставит программу генерировать заново изображения среднего размера.
А это намного дольше, чем первый вызов приложения
Гораздо лучше, просто указать нужное в опциях командной строки, затем дав им
сохранится, запустить приложение по новой, примерно так:
% album -medium 640x640 photos/spain
(затем позже...)
% album photos/spain
Увы, использование этих новых командных конструкций означет, что любые
новые опции будут помещены в в начала списка -exif опций.
К примеру:
% album -exif "comment 1" photos/spain
% album -exif "comment 2" photos/spain
Комментарии будут действительно следователь в обратном порядке "comment 2"
затем "comment 1"
Чтобы указать нужный порядок, вам необходимо переопределить все опции,
либо указать, написав "comment 1" так, с учетом того, что он будет перенесен
снизу вверх:
% album -exif "comment 1" photos/spain
Или только указать все в порядке, котором как вам надо:
% album -exif "comment 1" -exif "comment 2" photos/spain
Иногда это может оказаться более простым делом, чем редактирования файла
album.conf, поскольку изменения, которые вы хотите внести будут применены
сразу же.
Таким образом, этот подход позволяет нам аккумулировать нужные опции.
Мы можем удалить опции используя -no и -clear (посмотрите раздел опции),
эти установки (или обнуление установки) будут так же сохранятся от запуска
к запуску.
ITEM: Переведено
Чубаровым И.Ю. (Tchubarov I, aka krolik, ceramic64@yandex.ru)
album-4.10/Docs/ru/Section_8.html 0000644 0000000 0000000 00000106011 12010141351 015256 0 ustar root root
MarginalHacks album - Языковая поддержка
- Documentation
Содержание
Использование языков
Желающим помочь с переводом
Перевод документации
Сообщения генерируемые приложением album
Почему я всё ещё вижу сообщения на английском языке?
1: Использование языков
(Требуется приложение album версии 4.0 или выше)
Приложение Album уже содержит в себе запакованные языковые файлы (однако, нам
всё равно необходима помощь в переводе, подробности смотрите дальше!).
При запуске приложения эти языковые файлы будут влиять на содержание большей
части сообщений, которые генерируются приложением причём как в теме, которая
используются для создания альбома, так и менять вид некоторых сообщений, не
связанных с темой, а только с готовым HTML файлом.
Изменить любой текст в теме, в соответствии с вашим языком можно просто путём
простого редактирования самих файлов тем. Есть простой пример такой работы -
это "simple-Czech" тема.
Чтобы использовать язык надо добавить опцию "lang" в конфигурационном файле
album.conf или просто её указать при командной строке при первым запуске
приложения (естественно, после первого запуска - это опция будет сохранена
в том же самом конфигурационном файле).
Так же можно убрать возможность использования языковой опции путём запуска
приложение командой такого вида:
% album -clear_lang ...
Вы можете указать несколько языков, если вы хотите, чтобы один язык
использовался как главный, другой как дополнительный. К примеру, очень удобно
указать голландский язык как основной, а шведский язык использоваться как язык
для сохранения резервной копии альбома. Для этого надо выполнить:
% album -lang swedish_chef -lang nl ...
Если вы указали дополнительные языки (например Испанский или Боливийский,
командой es-bo), то приложение album будет работать с испанским языком 'es',
как главным для резервной копии.
Следует обратить внимание, что для того, чтобы не было проблем перезаписи
готовых галерей при нескольких запусках приложения album, необходимо указать
сразу несколько языков, с которыми вы хотите работать.
Чтобы увидеть какие языки доступны для приложения надо выполнить:
% album -list_langs
К сожалению, перевода для многих языков мира, ещё нет, но есть шанс, что люди
заинтересуются этим, чтобы сделать приложение album более популярным..
2: Желающим помочь с переводом
Проекту приложения album необходимы добровольцы-переводчики, для нескольких
областей работы:
1) The Mini How-To. Пожалуйста переводите из source .
2) Сообщения выводимые самим приложение при запуске, более подробно см. ниже.
Если вы готовы помочь с переводом обоих пунктов - свяжитесь со мной обязательно!
Если же вы готовы перевести хоть что-то, дайте мне знать, что именно!
3: Перевод документации
Наиболее важный документ это: "Mini How-To" .
Пожалуйста переводите его сразу из источника: text source .
Естественно вы можете быть уверенными, что я обязательно укажу ваше имя, электронный
адрес почты, ваш персональный сайт и т.п. на страницах своего сайта.
При переводе пожалуйста обратите внимание на правильное использование
заглавных букв и названия самого вашего языка in your language .
Для примера - "fran�ais" вместо "French".
Мне без разницы какую раскладку вы используете для работы. На данный момент доступны
следующие варианты:
1) HTML символы такие как [é]] (несмотря на то, что они работают только
в интернет браузерах)
2) Unicode (UTF-8) такие как [é] (работают только в интернет браузерах и некоторых
терминалах)
3) ASCII коды, где возможно, такие как [�] (работают в текстовых редакторах, на этой
странице не будут видны, т.к. её раскладка установлена как unicode)
4) Специфические языковые раскладки iso такие как iso-8859-8-I для иврита.
Современный Unicode (utf-8) по видимому это лучшая раскладка для всех языков.
Это существенно облегчает работу по адаптации этого приложения для разных стран
и народов. Однако utf не распространяется на некоторые языки, например, тот
же iso-8859-1. Несмотря на это всё равно есть возможность компенсировать это
через использования iso стандартов, т.к. между utf-8 и iso всегда можно
найти соответствие, путём задания нескольких параметров.
Т.е. если главное терминальное приложение написано для iso раскладки вместо utf,
то это будет очень хорошее решение, именно для тех языков, которых нет в
описании стандарта utf.
4: Сообщения генерируемые приложением album
Приложение album генерирует все текстовые сообщения на заданном при запуске языке,
подобно тому как другие системы используют отдельный модуль, написанный на
языке perl Locale::Maketext .
(Больше информации об этому можно найти вот по этой ссылке TPJ13 )
Сообщение об ошибке, к примеру, может выглядеть примерно так:
Не найдено файлов тем [[в такой-то директории]].
Или, если приложение установлено по умолчанию:
Не найдено файлов тем в /www/var/themes.
Если задана опция использования голландского языка, сообщение будет иметь вид:
Geen thema gevonden in /www/var/themes.
Естественно путь в данном случае "/www/var/themes" не будет переведён.
Строка перевода в языковом файле должна быть:
'Не найдено файлов тем в [_1].'
# Args: [_1] = $dir
На голландском языке будет что-то вроде:
'Не найдено файлов тем [_1].' => 'Geen thema gevonden in [_1].'
После перевод, приложение album заменит [_1] нужной папкой.
Иногда имеется несколько переменных, и в соответствии с правилами вашего языка,
их можно поменять местами:
Некоторые примеры ошибок:
Необходимо указать -medium с -just_medium option.
Необходимо указать -theme_url с -theme option.
На голландском языке это будет похоже на:
Met de optie -just_medium moet -medium opgegeven worden.
Строка перевода для голландского языка (в языковом файле) тогда
будет в виде:
'Необходимо указать [_1] с [_2] опцией'
=> 'Met de optie [_2] moet [_1] opgegeven worden'
# Args: [_1]='-medium' [_2]='-just_medium'
Обратите внимание, что переменные заменены местами.
Есть так же специальный оператор для кавычек, к примеру,
мы хотим перевести:
'У меня есть 42 изображения'
Число 42 может быть изменено. В английском варианте нормальным будет:
0 images, 1 image, 2 images, 3 images...
А на голландском:
0 afbeeldingen, 1 afbeelding, 2 afbeeldingen, 3 afbeeldingen..
Но, в других языках (например, во многих языках славянской группы)
имеются другие правила к склонению слова "изображение", которое должно
быть изменённым в соответствии с тем, какое именно числительное стоит
после слова "изображение". Для русского это 1 изображение, 2 изображения,
3 изображения, 4 изображения, 5 изображений и т.п. Самый просто путь
решить эту проблему это ввести оператор [quant]:
[quant,_1,image]
Это аналогично предыдущему примеру с "[-1] image" за исключением того,
что словоформа будет изменяться, если числительное больше 1.
0 images, 1 image, 2 images, 3 images...
Для английского языка просто необходимо добавить 's', для указания
множественного числа, для голландского это будет выполнено в виде:
[quant,_1,afbeelding,afbeeldingen]
Что даёт правильное написание числительных на голландском языке.
Если же нам необходимо указать особую форму для 0, мы может указать:
[quant,_1,directory,directories,no directories]
Это даст в выводе приложения:
no directories, 1 directory, 2 directories, ...
Есть также сокращенный вариант оператора [quant] - это
использование '*', в тех же самых случаях:
[quant,_1,image]
[*,_1,image]
Тот же пример для голландского языка будет таким:
'[*,_1,image]'
=> '[*,_1,afbeelding,afbeeldingen]',
Если же вам нужно что-то более сложное, описанного выше, т.е. того, что
может дать существующий на данный момент код perl, дайте мне знать - я
подумаю как можно решить эту проблему, зная как перевод должен работать:
'[*,_1,image]'
=> \&russian_quantity; # Здесь дополнительные определения будут..
Строки для перевода в большей части помещены в одинарные кавычки ('),
при переводе следует следить за тем, чтобы открытие-закрытие кавычек
было корректным, иначе программа работать нормально не будет.
Если необходимо в сообщении вывести отдельный апостроф, перед ним
нужно написать слэш (\):
'I can\'t find any images'
Для того чтобы вывести квадратные скобки, перед ними нужно написать символ
тильды (~):
'Проблема с опцией ~[-medium~]'
Единственный момент, что подобный подход сложно использовать, если внутри
есть другой аргумент в квадратных скобках (могут возникнуть ошибки при работе
приложения в некоторых случаях):
'Проблема с опцией ~[[_1]~]'
Будьте внимательными, всегда проверяйте корректно ли закрыты-открыты скобки!
Более того, в большинстве случаем перевод должен использовать те же самые
переменные, что и оригинал:
'Необходимо указать [_1] с [_2] опцией'
=> 'Met de optie [_2] moet' # <- Куда исчезло [_1] ?!?
К счастью, большая часть работы уже сделана за вас. Языковые файлы
сохранены в опции -data_path(или -lang_path) или там где приложение
альбом по умолчанию хранит свои данные
Для генерации языкового файла можно ввести команду:
% album -make_lang sw
В этом случае будет создан новый, пустой языковый файл, готовый к
переводу, в данном случае он будет назван 'sw' (Швеция). Для перевода,
необходимо открыть этот файл и постепенно, начиная с верха перевести
всё, что вы можете. Если что-то непонятно - оставляйте всё как есть.
Наиболее важные сообщения, перенесены в самый верх этого файла, их
надо перевести в первую очередь.
Так же вам надо определиться с языковой раскладкой, это в некотором
смысле сложно, однако, я надеюсь, что людям доступен их терминал или
интернет браузер, где можно посмотреть в какой раскладке вы работаете.
Если вы хотите построить новый языковый файл, использую то, что уже
сделано ранее (т.е. из предыдущего языкового файла), к примеру, чтобы
добавить в языковый файл новые сообщения, вы должны указать первой
опцией выбора языка, а уже второй - генерацию языкового файла, таким
образом:
% album -lang sw -make_lang sw
Таким образом в генерируемый языковый файл, возьмёт всю информацию
из существующего языкового файла, за исключением комментариев!
Если у вас будут получаться очень длинные строки перевода, можете
не думать о том, как организовать перенос слов, как это приходится
делать, например, в программах на языке С, путём написания
символа возврата каретки (\n) за исключением того случая, когда
они указаны в оригинале. Приложение album будет само переносить
части длинной строки правильно.
Пожалуйста свяжитесь со мной, когда вы начнёте работу по переводу, чтобы
я был уверен, что два переводчика не делают одно и то же или работают
надо одной и той же частью текста. На основе вашей информации, я смогу
правильно обновлять языковые файлы, чтобы обеспечить тем самым
нормальную работу приложения album. Пожалуйста присылайте мне даже
незаконченные файлы, это лучше чем ничего!
Если у вас есть вопросы по реализации синтаксических особенностей вашего
языка, то тоже напишите мне об этом.
5: Почему я всё ещё вижу сообщения на английском языке?
После указание другого языка, вы можете всё ещё видеть что-то на английском.
Вероятные причины могут быть следующими:
1) Некоторые слова всё ещё на английском. (-geometry всё ещё -geometry)
2) Использование строк до сих пор не переведено.
3) Результат работы дополнений (plugin) маловероятно, что будет с переводом.
4) Языковые файлы не всегда закончены, и когда будут переведены полностью -
никто не знает.
5) Новая версия приложения album может выдавать новые сообщение, которые
просто ещё нет в языковом файле.
6) Большинство слов в темах на английском.
Проблему последнего пункта очень просто решить, для этого достаточно просто
отредактировать файлы тем вручную, и заменить части html кода с английским
языком, на части кода со словами нужного вам языка. То же самое относится и
к графике, с названиями или английскими буквами. Нужно создать её по-новой,
поместить в папку темы. В любом случае, если вы создадите новую тему - я
буду очень этому рад, не забудьте об этом написать мне, чтобы я её включил
в список возможных тем.
Created by make_faq from Marginal Hacks
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
album-4.10/Docs/ru/txt_3 0000644 0000000 0000000 00000101304 11615155101 013531 0 ustar root root Запуск приложения, основные возможности
ITEM: Основная работа
Создайте папку и поместите в нее графические файлы. Скрипт приложения album,
как и какую-либо другую программу помещать в этот каталог не нужно.
Надо просто запустить приложение album из любого места, просто указав папку
с изображениями:
% album /example/path/to/images/
Или, если, к примеру вы находитесь в /example/path/to каталоге:
% album images/
Когда все это будет сделано, вы получите готовый фотоальбом внутри папки
images/index.html.
Если это путь на вашем web-сервере, то вы сможете увидеть созданную галерею
в браузере, указав этот путь (в данном случае адрес). Если этого не произойдет -
свяжитесь с системным администраторов сервера, на котором находится ваш ресурс.
ITEM: Опции
Имеется три типа опций. Булевы опции (они могут иметь только два значения),
строковые и числовые опции и опции в форме массивов. Булевы опции могут выключены
при помощи написания префикса -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) могут иметь собственные опции , со своим собственными
особенностями использования.
ITEM: Темы
Темы - это та часть галереи, которая делает альбом с фотографиями
особенным и интригующим. Вы можете можете сами определять как
будет выглядеть ваша галерея фотографий путем скачивания тем с ресурса
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/
Вы можете также создать ваши собственные темы очень легко, об этом будет рассказано
в последующих разделах этой документации.
ITEM: Галереи более низких уровней.
Если сделать папки внутри первой папки и поместить в них изображения то
можно получить галереи второго уровня. Для этого просто надо запустить
приложение album, указав папку верхнего уровня, после чего будет
создана одна галерея, с входящим в нее галереями более низких уровней.
Причем если вы только измените одну из галерей более низкого уровня, и затем
снова запустите приложение album, проверит и обновит все ссылки на родительские
галереи, и сгенерирует, при необходимости, все заново.
Если же вы не хотите, чтобы приложение album создавало галереи более низких уровней,
целесообразно указать глубину анализа, при помощи опции. Например, так:
% album images/ -depth 1
В этом случае будут генерироваться галереи только в папке images.
Если же у вас много галерей низкого уровня, и вы хотите добавить новую галерею
фотографий без генерации всех предыдущих галерей второго уровня, вы можете
использовать опцию -add:
% album -add images/new_album/
В этом случае будет добавлено new_album к HTML в 'images/' и затем
будут сгенерированы иконки и HTML для всего, что находится внутри 'images/new_album/'
ITEM: Повторная генерация иконок предпросмотра
Приложение album спроектировано так, чтобы не делать лишней работы. Он создает
иконки предпросмотра только если они не существуют в данный момент или были изменены
графические файлы прототипы. При таком подходе скорость существенно увеличивается,
особенно при обработке больших объемов графических файлов.
Правда, такой подход может стать причиной и проблем, если вы измените размер или
вырежете что-то из изображение самих иконок предпросмотра, поскольку в приложении
albom нет реализовано какое-либо действие, если вы меняете сами иконки предпросмотра
Но, вы можете использовать опцию принудительно генерации иконок предпросмотра, если
вы с ними все же что-то делали:
% album -force images/
Но, вам нет нужды использоваться -force все время, естественно.
ITEM: Удаление иконок предпросмотра
Если вы хотите удалить изображения из вашей галереи, то вам так же надо будет
удалить и иконки предпросмотра и откорректировать HTML файл.
Вы может все это сделать при помощи всего одного запуска приложения album,
с опцией -clean option:
% album -clean images/
ITEM: Изображения среднего размера
Когда вы нажимаете на изображение иконки предпросмотра вы попадаете
на страницу с полноразмерным изображением. По умолчанию эта страница показывает
изображение полного размера (примерно так же как кнопки навигации и т.п.). Естественно,
если вы нажмете на изображение полного размера, то получите только его.
Но, если вы хотите, чтобы после нажатия на иконку предпросмотра выводилось окно с
уменьшенным изображением, можно использовать опцию -medium и указать геометрический размер этого изображения. Вы может указать любой размер, который сможет нормально интерпретировать утилита ImageMagick (для более полной информации - посмотрите инструкцию
к этому пакету). К примеру:
# Изображение, которое будет половину от полного размера
% album -medium 50%
# Изображение, которое будет вписано в прямоугольник 640x480 (по наибольшей стороне)
% album -medium 640x480
# Изображение, которое будет уменьшено и вписано в прямоугольник 640x480
# (но не увеличено, если оно меньше 640x480)
% album -medium '640x480>'
Вам необходимы 'кавычки' в последнем примере, т.к. большинство оболочек операционных систем трактует символ '>' как элемент другой команды.
ITEM: Подписи под фотографиями
Изображения и иконки предпросмотра часто имеют названия и разные поясняющие надписи. И есть много способов, чтобы указать или изменить названия или надписи под изображениями в ваших галереях.
В качестве примера надписи может выступать название изображения, которое может быть
ссылкой на страницу с полноразмерным изображением, комментарий же может быть ниже:
По умолчанию имя изображение это имя файла, без расширения. Например:
"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 скрипта (но не забудьте удостовериться, что доступ к этому файлу будет ограничен, чтобы кто угодно не смог внести в него ненужные изменения или правки!)
ITEM: 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.
ITEM: Верхний и нижний колонтитулы на страницах
В каждой папке с графическими файлами можно поместить текстовый файлы header.txt и footer.txt. При сборке альбома информация из них будет отражаться как верхний и нижний колонтитулы на странице с галереей, конечно, если используемая тема поддерживает эту возможность.
ITEM: Скрытие файлов и папок
Любой тип файлов, который приложение album на опознает как графическое изображение
будет проигнорирован. Чтобы включить возможность отражения на странице с галерей
этих файлов, можно применить опцию -no_known_images. (-known_images - установлено
по умолчанию)
Вы можете так же пометить изображения как не файл не изображения, путем создания
пустого файла с тем же самым именем, что и изображение с графикой, но с
расширением: .not_img .
Таким же образом можно включить полное игнорирование, путем создания пустого
файла с тем же самым названием и расширением: .hide_album .
Если по каким-то причинам не хотите добавлять фотографии из какой-либо папки
в общую галерею фотографий, аналогично подходу с отдельными
файлами, можно добавить пустой файл <dir>/.no_album. Где <dir> - название
папки, которую не надо включать в общую галерею.
Точно так же можно полностью игнорирвать создание галерей для отдельных
папок, для этого создается пустой файл <dir>/.hide_album. Где <dir> - название
папки, которую надо игнорировать.
В Windows версиях приложения album нельзя создать файл, название которого
начиналось бы с точки, поэтому используется те же названия но без точек.
ITEM: Обрезка изображений для создания иконок предпросмотра
Если ваши изображение очень большие и имеют различные соотношение по ширины
и высоте (к примеры, когда имеется много изображени форматов вертикальной и
горизонтальной ориентации) или если ваша тема позволяет работать с изображениями
только какой-то определенной ориентации, то вам может понадобиться сделать так,
чтобы иконки предпросмотра все были подрезаны в одном стиле с одним и тем же
соотношением ширины к высоте, то, для этого существует опция:.
% album -crop
По умолчанию все изображения вырезаются по центру. Но если вас это не
устраивает, то можно задать место откуда будет производится вырезка нужного
фрагмента для создания иконок предпросмотра. Для этого надо слегка изменить
названия изображений, так, чтобы при сборке галереи у приложения
album была информация о том, с какого места надо вырезать изображение,
для создания иконки предпросмотра. К примеру, у вас есть файл "Kodi.gif" c
горизонтальной ориентацией, чтобы при создании иконки предпросмотра была
вырезана верхняя часть из графического файла приведите название
файла к виду "Kodi.CROPtop.gif" (для удаления старых иконок предпросмотра
не забудьте воспользоваться опцией -clean).
Слово CROP будет убрано из название файла, когда он будет использоваться
для создания HTML страницы.
По умолчанию соотношение сторон иконок предпросмотра 133x133. Т.е. для
изображений с вертикальной ориентаций иконки будут создаваться как 133x100,
а с для горизонтальной - 100x133. Если вы используете опцию для обрезки
изображений и хотите, чтобы соотношения оставались те ми же самыми,
используйте такую команду:
% album -crop -geometry 133x100
Но, помните, что если вы измените -crop или -geometry установки
на ранее собранных галереях, вам потребуется указать опцию -force
(один раз, естественно), чтобы вся галерея была собрана заново.
ITEM: Видео
Приложение album может генерировать скриншоты с многих форматов видео,
конечно, если вы установили пакет ffmpeg .
Если вы работаете на linux-машине с процессором x86, то вы можете просто
взять бинарные файлы этого пакета с ресурса ffmpeg.org (это проще установки).
ITEM: Запись на 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 )
ITEM: Индексирование всей галереи
Чтобы просматривать всю галерею под одной странице можно использовать опцию
caption_index . Он использует те же самые опции, что и приложение album
в обычном режиме запуска (несмотря на то, что многие из них все же
игнорируются). В результат получится HTML файл, с описанием всего, что
есть в галерее.
Для того, чтобы понять что это такое посмотрите примеры альбомов, example index на сайте
для галереи-примера .
ITEM: Обновление галерей с использованием CGI
Первое, что вам будет необходимо для работы с CGI - это возможность
загрузки фотографий в папки ваших галерей. Обычно для этой цели
везде принято использовать ftp. Хотя вы может написать java-скрипт,
который загрузит файлы
Затем вам необходимо будет удаленно запустить приложение album (т.е.
запустить его на удаленной машине). Чтобы исключить возможные злоупотребления,
обычно CGI скрипт ставится так, чтобы только касаться файла (или будет
иметься доступ только по ftp) и затем будет выполнена работа по расписанию,
которая проверяет файлы каждые несколько минут, и если обнаружит, что один
из них был заменен, то запустит приложение album.
[только для unix] (Вероятно вам необходимо будет установить значение
переменной окружения $PATH или использоваться абсолютные пути в скрипте
при конвертации)
Если вы хотите мгновенного запуска приложения album, то для этого
надо просто использовать скрипт именно для его запуска, например, one. .
Если фотографии не собственно пользователя web-сервера, то вам
необходимо запустить setud-скрипт, который запустит вам приложение
через CGI [только для unix]. Разместите setud-скрипт в безопасном месте,
измените его владельца, на того же самого, что и владелец фотографий,
затем запустить "chmod ug+s". Здесь имеются примеры
setuid - и CGI CGI -скриптов. Просто подредактируйте их, как вам нужно.
Также посмотрите caption_edit.cgi который позволит вам (или другим)
удаленно (через web) редактировать captions/names/headers/footers
ITEM: Переведено
Чубаровым И.Ю. (Tchubarov I, aka krolik, ceramic64@yandex.ru)
album-4.10/Docs/ru/english-errors.txt_5 0000644 0000000 0000000 00000022542 11533774253 016521 0 ustar root root * Ошибки и сообщения об ошибках
1: Специфические запросы
Если имеется что-то, что вы хотите добавить в приложение
album, убедитесь не существует уже это? Посмотрите
man страницу следующей командой:
% man album
% album -h
Естественно можно использовать опции -more и -usage
(будет удобнее читать).
Если вы не увидите того, что хотели увидеть, то можете
подумать о том, чтобы написать дополнение.
2: Сообщения о некорректной работе программы
Перед тем, как прислать сообщение об ошибке, проверьте установлена
ли у вас последняя версия приложения album!
Когда присылается информация об ошибочной работе программы,
мне необходимо знать как минимум:
1) Тип и точное название вашей операционной системы
2) Точное описание проблемы и точное описание сообщений об ошибках
Так же необходимо знать, если возможно:
1) Точно команду, которой было запущено приложение album
2) Вывод программы после ее запуска
И, естественно, также необходимо запустить приложение album с ключем
отладки:
% album -d
В итоге, удостоверьтесь, что у вас установлена не только последняя
версия приложения album, но и самая последняя версия тем.
3: Написание исправлений (патчей), модифицирование приложения album
Если вы хотите модифицровать album, вы наверняка захотите, убедиться
в том, что нет ли вашей задумки в моих ближайших планах.
Если нет, то прежде всего подумайте о разработке дополнения (plugin)
вместо модифицрования самого исходного кода приложения album. Это может
предотвратить ненужное усложнение album, путем введения возможностей,
которые не нужны всем потенциальным пользователям.
Если есть необходимость переработать само приложение album (к примеру, если
четко проявилась некорректная работа программы), то пожалуйста убедитесь еще раз
раз, что у вас загружена и используется самая последня копия приложения
album, и только потом приступайте к написанию исправления (патча),
который потом можно прислать мне или весь текст исправленно скрипта.
Естественно, если вы не внесете каких-либо комментариев в текст скрипта
- это тоже будет не очень хорошо.
4: Известные ошибки
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"
5: ПРОБЛЕМА: Мои index-страницы очень большие!
Я получаю много отзывов о том, что index-страницы перестают нормально работать,
после достижения определенного порога параметров используемых изображений.
Эта проблема, которую сложно решить (особенно при большом количестве фотографий),
пока index-страница строится без альбомов второго уровня, т.е. когда ссылки все
фотографии расположены на одной странице. Но теперь у вас есть несколько важных элементов,
позволяющих упростить работу с приложением и избежать генерации очень больших index-
страниц. Это - создание других index-файлов, создание других альбомов и
создание других иконок. При этом, если ваши альбомы второго уровня имеют темы, отличные от тем,
альбомов первого уровня, можно запускать приложения только для части галлереи, а не
для всей коллекции изображений (например, только для одного альбома второго уровня, или
только для изменения вида или других параметров иконок альбома этого альбома второго
уровня).
Следующий релиз приложения album будет иметь такую возможность (т.е. автоматически
строить древовидную иерархическую систему галерей), но пока эту идею можно реализовать
немного иначе - просто, распологая изображения галерей второго уровня в отдельных,
каталогах и последовательно запуская в них приложение album (со своими настройками,
например, выбранными темами)
Так же имеется простое приложение, которое переместит новые изображения в
подкаталоги так, чтобы после запустить само приложение album:
in_album
6: ERROR: no delegate for this image format (./album)
Ваш скрипт самого приложения album может оказаться в вашей папке с изображениями,
в этом случае он не может сделать иконку предпросмотра самого себя. Либо:
1) Переместите вывод приложения album из каталога с фотографиями (допустим)
2) Запустите album с -known_images
7: ERROR: no delegate for this image format (some_non_image_file)
Размещайте только файлы изображения в вашем каталоге с фотографиями или запускайте
приложение album c опцией -known_images.
8: ERROR: no delegate for this image format (some.jpg)
9: ERROR: identify: JPEG library is not available (some.jpg)
Установка пакета ImageMagick выполнена не полностью, поэтому в системе нет
информации о том, что надо делать с данным типом графического файла.
10: ERROR: Can't get [some_image] size from -verbose output.
ImageMagick не располагает информацией о размере указанного изображения. Либо:
1) Ваша ImageMagick установка не выполнена полностью и в системе нет информации о том,
что делать с данным форматом графического файлы.
2) Вы запустили album в каталоге с файлами, которые не являются графическими, причем
не использовали опцию -known_images, чтобы дать информацию приложению об этом.
Если вы пользователь linux пользователь и видите ошибку, просто запустите
приложение как администратор (суперпользователь) (спасибо Alex Pientka):
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
album-4.10/Docs/ru/Section_5.html 0000644 0000000 0000000 00000066603 11615156364 015313 0 ustar root root
MarginalHacks album - Специфические запросы, Сообщения о некорректной работе программы
- Documentation
Содержание
Специфические запросы
Сообщения о некорректной работе программы
Написание исправлений (патчей), модифицирование приложения album
Известные ошибки
ПРОБЛЕМА: Мои index-страницы очень большие!
ОШИБКА: нет метода для этого формата изображения (./album)
ОШИБКА: нет метода для этого формата изображения (some_non_image_file)
ОШИБКА: нет метода для этого формата изображения (some.jpg)
ОШИБКА: идентификация: JPEG библиотека не доступна (some.jpg)
ОШИБКА: Не могу получить [some_image] размеры из -verbose output.
Переведено
1: Специфические запросы
Если имеется что-то, что вы хотите добавить в приложение
album, убедитесь не существует уже это? Посмотрите
man страницу следующей командой:
% man album
% album -h
Естественно можно использовать опции -more и -usage
(будет удобнее читать).
Если вы не увидите того, что хотели увидеть, то можете
подумать о том, чтобы написать дополнение.
2: Сообщения о некорректной работе программы
Перед тем, как прислать сообщение об ошибке, проверьте установлена
ли у вас последняя версия приложения album!
Когда присылается информация об ошибочной работе программы,
мне необходимо знать как минимум:
1) Тип и точное название вашей операционной системы
2) Точное описание проблемы и точное описание сообщений об ошибках
Так же необходимо знать, если возможно:
1) Точно команду, которой было запущено приложение album
2) Вывод программы после ее запуска
И, естественно, также необходимо запустить приложение album с ключем
отладки:
% album -d
В итоге, удостоверьтесь, что у вас установлена не только последняя
версия приложения album, но и самая последняя версия тем.
3: Написание исправлений (патчей), модифицирование приложения album
Если вы хотите модифицровать album, вы наверняка захотите, убедиться
в том, что нет ли вашей задумки в моих ближайших планах.
Если нет, то прежде всего подумайте о разработке дополнения (plugin)
вместо модифицрования самого исходного кода приложения album. Это может
предотвратить ненужное усложнение album, путем введения возможностей,
которые не нужны всем потенциальным пользователям.
Если есть необходимость переработать само приложение album (к примеру, если
четко проявилась некорректная работа программы), то пожалуйста убедитесь еще раз
раз, что у вас загружена и используется самая последня копия приложения
album, и только потом приступайте к написанию исправления (патча),
который потом можно прислать мне или весь текст исправленно скрипта.
Естественно, если вы не внесете каких-либо комментариев в текст скрипта
- это тоже будет не очень хорошо.
4: Известные ошибки
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"
5: ПРОБЛЕМА: Мои index-страницы очень большие!
Я получаю много отзывов о том, что index-страницы перестают нормально работать,
после достижения определенного порога параметров используемых изображений.
Эта проблема, которую сложно решить (особенно при большом количестве фотографий),
пока index-страница строится без альбомов второго уровня, т.е. когда ссылки все
фотографии расположены на одной странице. Но теперь у вас есть несколько важных элементов,
позволяющих упростить работу с приложением и избежать генерации очень больших index-
страниц. Это - создание других index-файлов, создание других альбомов и
создание других иконок. При этом, если ваши альбомы второго уровня имеют темы, отличные от тем,
альбомов первого уровня, можно запускать приложения только для части галлереи, а не
для всей коллекции изображений (например, только для одного альбома второго уровня, или
только для изменения вида или других параметров иконок альбома этого альбома второго
уровня).
Следующий релиз приложения album будет иметь такую возможность (т.е. автоматически
строить древовидную иерархическую систему галерей), но пока эту идею можно реализовать
немного иначе - просто, распологая изображения галерей второго уровня в отдельных,
каталогах и последовательно запуская в них приложение album (со своими настройками,
например, выбранными темами)
Так же имеется простое приложение, которое переместит новые изображения в
подкаталоги так, чтобы после запустить само приложение album:
in_album
6: ОШИБКА: нет метода для этого формата изображения (./album)
Ваш скрипт самого приложения album может оказаться в вашей папке с изображениями,
в этом случае он не может сделать иконку предпросмотра самого себя. Либо:
1) Переместите вывод приложения album из каталога с фотографиями (допустим)
2) Запустите album с -known_images
7: ОШИБКА: нет метода для этого формата изображения (some_non_image_file)
Размещайте только файлы изображения в вашем каталоге с фотографиями или запускайте
приложение album c опцией -known_images.
8: ОШИБКА: нет метода для этого формата изображения (some.jpg)
9: ОШИБКА: идентификация: JPEG библиотека не доступна (some.jpg)
Установка пакета ImageMagick выполнена не полностью, поэтому в системе нет
информации о том, что надо делать с данным типом графического файла.
10: ОШИБКА: Не могу получить [some_image] размеры из -verbose output.
ImageMagick не располагает информацией о размере указанного изображения. Либо:
1) Ваша ImageMagick установка не выполнена полностью и в системе нет информации о том,
что делать с данным форматом графического файлы.
2) Вы запустили album в каталоге с файлами, которые не являются графическими, причем
не использовали опцию -known_images, чтобы дать информацию приложению об этом.
Если вы пользователь linux пользователь и видите ошибку, просто запустите
приложение как администратор (суперпользователь) (спасибо Alex Pientka):
USE="avi gif jpeg mpeg png quicktime tiff" emerge imagemagick
11: Переведено
Чубаровым И.Ю. (Tchubarov I, aka krolik, ceramic64@yandex.ru)
Created by make_faq from Marginal Hacks
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
album-4.10/Docs/ru/Section_1.html 0000644 0000000 0000000 00000060660 11615156364 015304 0 ustar root root
MarginalHacks album - Установка
- Documentation
Содержание
Минимальные требования
Начальная конфигурация
Необязательные элементы установки
UNIX
Debian UNIX
Macintosh OSX
Win95, Win98, Win2000/Win2k, WinNT, WinXP
Как я могу отредактировать путь в системе Windows?
Macintosh OS9
Переведено
1: Минимальные требования
1) Скрипты perl приложения album
2) Приложения из пакета ImageMagick (особенно важна для работы утилита 'convert')
Разместите скрипт 'album' и набор приложений из пакета ImageMagick где-нибудь в компьютере,
в соответствии с указанным путем (PATH), или вызовете 'album' посредством обращения с
указанием полного пути к испольняемому файлу (и укажите полный путь к приложению convert в
скрипте album или в конфигурационных файлах приложения album)
2: Начальная конфигурация
При первом запуске приложения album, программа задаст пользователю несколько вопросов,
для первоначального конфигурирования. Если вы работаете на системах UNIX/OSX, то
вы можете запустить первый раз программу от имени администратора (root) так, чтобы
у вас появилась возможность установить конфигурацию, распространяющуюся на всю систему
и темы для всех пользователей, а не только для текущего пользователя.
3: Необязательные элементы установки
3) Темы
4) ffmpeg (для видеоиконок предпросмотра)
5) jhead (для чтения EXIF информации)
6) Дополнения (plugins)
7) Различные инструменты, доступные на MarginalHacks.com
4: UNIX
Большая часть дистрибутивов UNIX уже имею в своем составе пакет ImageMagick и perl,
так, что для установки необходимо загрузить только сам скрипт приложения album
и темы (см. #1 и #3 выше). Чтобы проверить правильность установки, запустите
скрипт в каталоге с изображениями:
% album /path/to/my/photos/
5: Debian UNIX
Приложение album имеет пакета debian, хотя он и не самый последней версии.
Я рекомендую скачать самую последнюю версию с сайта MarginalHacks.
Вы можете сохранить .deb-пакет и затем, в режиме администратора (суперпользователя)
запустить установку командой:
% dpkg -i album.deb
6: Macintosh OSX
Приложение работет отлично на OSX, но его можно запустить только из окна терминала.
Инсталлируйте скрипты приложения album и пакет ImageMagick, и укажите путь с
к скриптам приложения album, любым способом, какой вам больше нравится. После чего
можете запустить приложение album, указав точный полный путь к каталогу с изображениями
(каждый элемент командной строки должен быть отделен пробелами), например, так:
% album -theme Blue /path/to/my/photos/
7: Win95, Win98, Win2000/Win2k, WinNT, WinXP
(Windows 95, Windows 98, Windows 2000, Windows NT, Windows XP)
Есть два способа запустить perl скрипты на Windows. Первый - это использование
ActivePerl, второй - Cygwin.
ActivePerl - проще и позволяет вам запустить приложение из командной строки DOS,
несмотря на то, что на некоторых машинах приложение не работает нормально с темами.
Cygwin - более мощная программа, которая позволяет получить доступ к утилитам, очень
походим на те, что используются в UNIX системах. Само приложение album, в этом случае,
будет запускать из bash (UNIX оболочки).
Способ с использованием Cygwin
-------------
1) Установите Cygwin
Выберете пакеты: perl, ImageMagick, bash
Не используйте обычный режим обычной установки пакеты ImageMagick. Вы должны
использовать ImageMagick для Cygwin!
2) Установите приложение album по пути указанному в bash или вызовайте, используя
абсолютный путь:
bash% album /some/path/to/photos
3) Если вы хотиете exif-информацию в подписях к фотографиям, то вам необходим
установить Cygwin-версию утилиты jhead
Способ с использованием ActivePerl
-----------------
1) Установите ImageMagick для Windows
2) Установите ActivePerl, Полная установка (правда, в этом нет необходимости,
если используется PPM-профайл)
Выберете: "Add perl to PATH" and "Create Perl file extension association"
3) Если используется Win98: Установите tcap в пути
4) Сохраните album как album.pl в windows-пути
5) Для запуска используйте команду оболочки DOS для запуска:
C:> album.pl C:\some\path\to\photos
Замечение: Некоторые версии Windows (2000/NT и более ранние версии) имеют
свой собственный "convert.exe" расположенный c:\windows\system32 каталоге (возможно это NTFS утилита).
Если у вас именно так, то вам необходимо будет отредактировать переменную, указывающую путь или
или все указывать полный путь к утилите convert (естественно из пакета ImageMagick) в настройках
вашего скрипта album.
8: Как я могу отредактировать путь в системе Windows?
Для пользователей Windows NT4:
Одним нажатием правой кнопки мышки на значке "Мой компьютере", выберете "Свойства"
Выберете вкладку Окружение.
В меню системных переменных выберете Path (путь, расположение)
В поле значение добавьте новые пути, отделенные точкой с запятой
Нажмите OK/Set и OK еще раз.
Для пользователей Windows 2000:
Одним нажатием правой кнопки мышки на значке "Мой компьютер", выберете "Свойства"
Выберете вкладку Дополнительно.
Нажмите на вкладке Окружение.
Во вкладке системные переменный выберете двойным нажатия Path (путь, расположение)
В поле значение и добавьте новый пути, отделенные точкой с запятой
Нажмите OK/Set и OK еще раз.
Для пользователей Windows:
Нажмите на значке "Мой компьютер", выберете Изменить установки.
Дважды нажмите на пункте Система.
Выберете вкладку Дополнительно.
Выберете переменные Окружения.
Во вкладке системные переменный выберете путем двойного нажатия выберете Path (путь, расположение)
В поле значение и добавьте новые пути, отделенные точкой с запятой
Нажмите OK.
9: Macintosh OS9
Пока нет планов портировать приложение album в OS9, поскольку еще нет данных о поддержке perl-скриптов,
в этой операционной системе. Если у вас есть опыт работы в OS9, и у вас есть мысли насчет того,
как можно портировать приложение в эту систему - свяжитесь со мной.
10: Переведено
Чубаровым И.Ю. (Tchubarov I, aka krolik, ceramic64@yandex.ru)
Created by make_faq from Marginal Hacks
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
album-4.10/Docs/ru/Section_2.html 0000644 0000000 0000000 00000064773 11615156364 015316 0 ustar root root
MarginalHacks album - Краткие рекомендации:
- Documentation
Содержание
Простой альбом
Добавление комментариев к фотографиям
Скрытие фотографий.
Использование тем
Большие изображения для альбома.
Добавление некоторых элементов EXIF в комментарию
Добавление дополнительных галерей
Переведено
1: Простой альбом
Полагаем, что вы уже установили приложение album. Теперь у вас есть возможность сделать
что-то полезное, при помощи этой программы. Если в процессе установки
появлялись ошибки или возникли какие-либо проблемы, посмотрите документацию где описан
процесс установки.
Для начала работы вам необходим web каталог для размещения в нем тем вашего альбома, фотографий
и файлов настройки. В этой документации мы предполагаем, что будет использован путь
/home/httpd/test
Естественно, необходимо, чтобы эта папка была видна как элемент web-сервера. В этом примере,
мы будем использовать адрес: http://myserver/test/
Первое - создайте каталог и скопируйте в него изображения. Мы назвали его так:
/home/httpd/test/Photos
Затем мы скопируйте в него какие-либо изображения, с названиями 'IMG_001.jpg' до 'IMG_004.jpg'
Теперь, чтобы создать галерею, надо запустить просто приложение album одной командой:
% album /home/httpd/test/Photos
Теперь вы можете увидеть свой альбом в web-браузере, просто адрес:
http://myserver/test/Photos
2: Добавление комментариев к фотографиям
Создайте файл /home/httpd/test/Photos/captions.txt следующего содержания
(используйте 'tab' клавишу везде где видите " [tab] ")
-- captions.txt ---------
IMG_001.jpg [tab] Комментарии для первого изображения
IMG_002.jpg [tab] Второе изображение
IMG_003.jpg [tab] Другое изображение [tab] с комментарием!
IMG_004.jpg [tab] Последнее изображение [tab] с комментарием.
-------------------------
Запустите album снова:
% album /home/httpd/test/Photos
И вы увидете, что комментарии у изображений изменились, в соответствии с той, информацией, что вы указали в файле caption.txt.
Теперь создайте файл с текстом в: /home/httpd/test/Photos/header.txt
И запустите album снова. В этом случае, вы увидите, что появился текст в верхней части страницы (шапка).
3: Скрытие фотографий.
Имеется несколько путей для скрытие фотографий в photos/files/directories, но мы
будем для этого использовать файл с комментариями. Попробуйте вставить символ '#' перед именем
файла в файле caption.txt:
-- captions.txt ---------
IMG_001.jpg [tab] Комментарии для первого изображения
#IMG_002.jpg [tab] Второе изображение
IMG_003.jpg [tab] Другое изображение [tab] с комментарием!
IMG_004.jpg [tab] Последнее изображение [tab] с комментарием.
-------------------------
Запустив album снова, вы увидите, что IMG_002.jpg теперь отсутствует.
Если бы мы сделали отметку символом '# перед первым запуском album, то генерации
иконки предпросмотра и уменьшенного изображения альбома вообще не произошло бы.
Но и сейчас, если вы хотите, чтобы их не было, при помощи использования
ключа -clean их можно удалить:
% album -clean /home/httpd/test/Photos
4: Использование тем
Если темы были правильно установлены и правильно указан к ним путь, то
у вас есть возможность использовать тему с приложением album:
% album -theme Blue /home/httpd/test/Photos
Теперь фотоальбом использует Blue тему. Если имеются пустые места от
непрорисованных изображений, то, вероятно, ваша тема не была установлена
в каталог, к которому система имеет доступ. Чтобы решить этот вопрос
обратись к документации, разделу установка.
Album сохраняет указанные опции так, что при следующем запуске приложения:
% album /home/httpd/test/Photos
Будет все еще использоваться Blue тема. Чтобы выключить тему, вы можете написать:
% album -no_theme /home/httpd/test/Photos
5: Большие изображения для альбома.
Обычно, изображение полного разрешения (т.е. те которые, выдает, например, цифровая камера)
слишком велики для использования их в web-галереях, но можно сгенирировть
их уменьшенный вариант, использовав команду:
% album -medium 33% /home/httpd/test/Photos
При этом доступ к изображениям полного разрешения у вас все равно остается,
в чем легко убедиться, нажав на его уменьшенный вариант. Но, если вы напишите:
% album -just_medium /home/httpd/test/Photos
Ссылки на изображения полного разрешения будут удалены (по умолчанию предполагается,
что album мы запускаем с опцией -medium)
6: Добавление некоторых элементов EXIF в комментарию
Теперь добавим информацию о диафрагме в комментарий к каждому изображению.
% album -exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
Эта команда добавляет информацию о диафрагме для каждого изображения, естественно для которого
есть информация поле 'Aperture' в блоке данных exif (это часть между '%' символами). Так же добавлены
<br> что позволяет вывести на новую линию информацию, считанного из поля данных структуры exif.
Мы можем добавить и больше информации из структуры exif, например:
% album -exif "<br>focal: %FocalLength%" /home/httpd/test/Photos
Поскольку альбом сохранен с нашими ранее использовавшимися опциями, мы теперь можем
получить данные с других полей данных EXIF для любого из изображений, например можно указать
диафрагму и фокусное расстояние. А вот так, можно убрать информацию об диафрагме:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
При использовании опции '-no_exif' ищется точное соответствие с указанным после полем
данных структуры exif или, если этого соответствие не найдено, просто ничего не происходит.
С той же целью вы можете отредактировать конфигурационный файл, который
автоматически создает приложение album:
/home/httpd/test/Photos/album.conf
7: Добавление дополнительных галерей
Предположим мы совершили турпоездку в Испанию. Некоторые фотографии этой поездки мы разместили в:
/home/httpd/test/Photos/Spain/
Теперь, если запустить приложение album на одном уровне выше:
% album /home/httpd/test/Photos
Появится ссылка на альбом второго уровня, расположенного в папке Spain, ссылка на который будет
располагаться с главной страницы альбома связанного с папкой Photos.
Альбомы второго уровня будут иметь те же самые установки, тему и т. п.
Теперь, если мы совершим еще одну поездку, мы можем создать папку:
/home/httpd/test/Photos/Italy/
И снова запустить album на верхнем уровне:
% album /home/httpd/test/Photos
Но эта команда будет сканировать Spain папку тоже, в которой ничего не
менялось. Album обычно не генерирует поновой любой HTML файл или иконку просмотра,
за исключением того, если указано, что это нужно сделать. Но, даже
такой подход может показаться очень длительным на слабых машинах
или если ваши галереи очень большие. Поэтому удобно указать приложению album
какой именно новый каталог надо сканировать для включения его
в ранее созданный альбом:
% album -add /home/httpd/test/Photos/Italy
Теперь альбом о новой поездке появится на странице главной страницы галереи.
8: Переведено
Чубаровым И.Ю. (Tchubarov I, aka krolik, ceramic64@yandex.ru)
Created by make_faq from Marginal Hacks
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
album-4.10/Docs/ru/Section_3.html 0000644 0000000 0000000 00000144347 11615156364 015313 0 ustar root root
MarginalHacks album - Запуск приложения, основные возможности
- Documentation
A l b u m
T h r e e - - ,
Содержание
Основная работа
Опции
Темы
Галереи более низких уровней.
Повторная генерация иконок предпросмотра
Удаление иконок предпросмотра
Изображения среднего размера
Подписи под фотографиями
EXIF информация для комментариев в фотографиям
Верхний и нижний колонтитулы на страницах
Скрытие файлов и папок
Обрезка изображений для создания иконок предпросмотра
Видео
Запись на CD (путем использования file://)
Индексирование всей галереи
Обновление галерей с использованием CGI
Переведено
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 - и CGI CGI -скриптов. Просто подредактируйте их, как вам нужно.
Также посмотрите caption_edit.cgi который позволит вам (или другим)
удаленно (через web) редактировать captions/names/headers/footers
17: Переведено
Чубаровым И.Ю. (Tchubarov I, aka krolik, ceramic64@yandex.ru)
Created by make_faq from Marginal Hacks
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
album-4.10/Docs/ru/langmenu 0000644 0000000 0000000 00000001507 12010141351 014272 0 ustar root root English
Deutsch
Русский
Nederlands
Français
magyar
Italiano
Español
album-4.10/Docs/ru/langhtml 0000644 0000000 0000000 00000001540 12010141351 014267 0 ustar root root
album-4.10/Docs/ru/txt_2 0000644 0000000 0000000 00000025664 11602260334 013547 0 ustar root root Краткие рекомендации:
ITEM: Простой альбом
Полагаем, что вы уже установили приложение album. Теперь у вас есть возможность сделать
что-то полезное, при помощи этой программы. Если в процессе установки
появлялись ошибки или возникли какие-либо проблемы, посмотрите документацию где описан
процесс установки.
Для начала работы вам необходим web каталог для размещения в нем тем вашего альбома, фотографий
и файлов настройки. В этой документации мы предполагаем, что будет использован путь
/home/httpd/test
Естественно, необходимо, чтобы эта папка была видна как элемент web-сервера. В этом примере,
мы будем использовать адрес: http://myserver/test/
Первое - создайте каталог и скопируйте в него изображения. Мы назвали его так:
/home/httpd/test/Photos
Затем мы скопируйте в него какие-либо изображения, с названиями 'IMG_001.jpg' до 'IMG_004.jpg'
Теперь, чтобы создать галерею, надо запустить просто приложение album одной командой:
% album /home/httpd/test/Photos
Теперь вы можете увидеть свой альбом в web-браузере, просто адрес:
http://myserver/test/Photos
ITEM: Добавление комментариев к фотографиям
Создайте файл /home/httpd/test/Photos/captions.txt следующего содержания
(используйте 'tab' клавишу везде где видите " [tab] ")
-- captions.txt ---------
IMG_001.jpg [tab] Комментарии для первого изображения
IMG_002.jpg [tab] Второе изображение
IMG_003.jpg [tab] Другое изображение [tab] с комментарием!
IMG_004.jpg [tab] Последнее изображение [tab] с комментарием.
-------------------------
Запустите album снова:
% album /home/httpd/test/Photos
И вы увидете, что комментарии у изображений изменились, в соответствии с той, информацией, что вы указали в файле caption.txt.
Теперь создайте файл с текстом в: /home/httpd/test/Photos/header.txt
И запустите album снова. В этом случае, вы увидите, что появился текст в верхней части страницы (шапка).
ITEM: Скрытие фотографий.
Имеется несколько путей для скрытие фотографий в photos/files/directories, но мы
будем для этого использовать файл с комментариями. Попробуйте вставить символ '#' перед именем
файла в файле caption.txt:
-- captions.txt ---------
IMG_001.jpg [tab] Комментарии для первого изображения
#IMG_002.jpg [tab] Второе изображение
IMG_003.jpg [tab] Другое изображение [tab] с комментарием!
IMG_004.jpg [tab] Последнее изображение [tab] с комментарием.
-------------------------
Запустив album снова, вы увидите, что IMG_002.jpg теперь отсутствует.
Если бы мы сделали отметку символом '# перед первым запуском album, то генерации
иконки предпросмотра и уменьшенного изображения альбома вообще не произошло бы.
Но и сейчас, если вы хотите, чтобы их не было, при помощи использования
ключа -clean их можно удалить:
% album -clean /home/httpd/test/Photos
ITEM: Использование тем
Если темы были правильно установлены и правильно указан к ним путь, то
у вас есть возможность использовать тему с приложением album:
% album -theme Blue /home/httpd/test/Photos
Теперь фотоальбом использует Blue тему. Если имеются пустые места от
непрорисованных изображений, то, вероятно, ваша тема не была установлена
в каталог, к которому система имеет доступ. Чтобы решить этот вопрос
обратись к документации, разделу установка.
Album сохраняет указанные опции так, что при следующем запуске приложения:
% album /home/httpd/test/Photos
Будет все еще использоваться Blue тема. Чтобы выключить тему, вы можете написать:
% album -no_theme /home/httpd/test/Photos
ITEM: Большие изображения для альбома.
Обычно, изображение полного разрешения (т.е. те которые, выдает, например, цифровая камера)
слишком велики для использования их в web-галереях, но можно сгенирировть
их уменьшенный вариант, использовав команду:
% album -medium 33% /home/httpd/test/Photos
При этом доступ к изображениям полного разрешения у вас все равно остается,
в чем легко убедиться, нажав на его уменьшенный вариант. Но, если вы напишите:
% album -just_medium /home/httpd/test/Photos
Ссылки на изображения полного разрешения будут удалены (по умолчанию предполагается,
что album мы запускаем с опцией -medium)
ITEM: Добавление некоторых элементов EXIF в комментарию
Теперь добавим информацию о диафрагме в комментарий к каждому изображению.
% album -exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
Эта команда добавляет информацию о диафрагме для каждого изображения, естественно для которого
есть информация поле 'Aperture' в блоке данных exif (это часть между '%' символами). Так же добавлены
<br> что позволяет вывести на новую линию информацию, считанного из поля данных структуры exif.
Мы можем добавить и больше информации из структуры exif, например:
% album -exif "<br>focal: %FocalLength%" /home/httpd/test/Photos
Поскольку альбом сохранен с нашими ранее использовавшимися опциями, мы теперь можем
получить данные с других полей данных EXIF для любого из изображений, например можно указать
диафрагму и фокусное расстояние. А вот так, можно убрать информацию об диафрагме:
% album -no_exif "<br>aperture=%Aperture%" /home/httpd/test/Photos
При использовании опции '-no_exif' ищется точное соответствие с указанным после полем
данных структуры exif или, если этого соответствие не найдено, просто ничего не происходит.
С той же целью вы можете отредактировать конфигурационный файл, который
автоматически создает приложение album:
/home/httpd/test/Photos/album.conf
ITEM: Добавление дополнительных галерей
Предположим мы совершили турпоездку в Испанию. Некоторые фотографии этой поездки мы разместили в:
/home/httpd/test/Photos/Spain/
Теперь, если запустить приложение album на одном уровне выше:
% album /home/httpd/test/Photos
Появится ссылка на альбом второго уровня, расположенного в папке Spain, ссылка на который будет
располагаться с главной страницы альбома связанного с папкой Photos.
Альбомы второго уровня будут иметь те же самые установки, тему и т. п.
Теперь, если мы совершим еще одну поездку, мы можем создать папку:
/home/httpd/test/Photos/Italy/
И снова запустить album на верхнем уровне:
% album /home/httpd/test/Photos
Но эта команда будет сканировать Spain папку тоже, в которой ничего не
менялось. Album обычно не генерирует поновой любой HTML файл или иконку просмотра,
за исключением того, если указано, что это нужно сделать. Но, даже
такой подход может показаться очень длительным на слабых машинах
или если ваши галереи очень большие. Поэтому удобно указать приложению album
какой именно новый каталог надо сканировать для включения его
в ранее созданный альбом:
% album -add /home/httpd/test/Photos/Italy
Теперь альбом о новой поездке появится на странице главной страницы галереи.
ITEM: Переведено
Чубаровым И.Ю. (Tchubarov I, aka krolik, ceramic64@yandex.ru)
album-4.10/Docs/conf 0000655 0000000 0000000 00000000000 11615156411 016574 1album-4.10/Docs/de/conf ustar root root album-4.10/Docs/nl/ 0000755 0000000 0000000 00000000000 12010141355 012525 5 ustar root root album-4.10/Docs/nl/Section_4.html 0000644 0000000 0000000 00000047332 11524055304 015262 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
Table Of Contents
Configuration Files
Location Of Configuration Files
Saving Options
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.
Created by make_faq from Marginal Hacks
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
album-4.10/Docs/nl/txt_6 0000655 0000000 0000000 00000000000 10670046152 017443 1album-4.10/Docs/de/txt_6 ustar root root album-4.10/Docs/nl/txt_1 0000655 0000000 0000000 00000000000 10716453531 017435 1album-4.10/Docs/de/txt_1 ustar root root album-4.10/Docs/nl/conf 0000655 0000000 0000000 00000000000 11615156411 017205 1album-4.10/Docs/de/conf ustar root root album-4.10/Docs/nl/Short.html 0000644 0000000 0000000 00000034374 11524055304 014534 0 ustar root root
MarginalHacks album - Documentation
A l b u m
D o c u m e n t a t i o n
album-4.10/Docs/nl/txt_7 0000655 0000000 0000000 00000000000 11015005334 017434 1album-4.10/Docs/de/txt_7 ustar root root album-4.10/Docs/nl/txt_8 0000655 0000000 0000000 00000000000 11615154173 017452 1album-4.10/Docs/de/txt_8 ustar root root album-4.10/Docs/nl/flag.png 0000644 0000000 0000000 00000000211 10503616365 014153 0 ustar root root PNG
IHDR m?h bKGD tIME2+ +IDAT8c\'?yC`FE ej IENDB` album-4.10/Docs/nl/Section_7.html 0000644 0000000 0000000 00000060657 11524055304 015272 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 , . .
Table Of Contents
What are Plugins?
Installing Plugins and plugin support
Loading/Unloading Plugins
Plugin Options
Writing Plugins
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/mv
3: 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/Spain
5: 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
Created by make_faq from Marginal Hacks
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
^
|
album-4.10/Docs/nl/txt_2.alt 0000644 0000000 0000000 00000014247 10557100501 014301 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/]