Readme файл на скриптовете BG Volumina
BG Volumina Script Kit Readme File



BG Volumina
Комплект скриптове за работа с библиографска база данни

НИКАКВИ ГАРАНЦИИ ИЛИ ПОДДРЪЖКА!
ПОЛЗВАТЕ СКРИПТОВЕТЕ ИЗЦЯЛО НА ВАША ОТГОВОРНОСТ!

Скриптовете BG Volumina нямат авторски права!
Можете да ги ползвате за всяка законна дейност!
Можете да ги променяте и разпостранявате по всякакъв начин!


КРАТКО ОПИСАНИЕ
BG Volumina е комплект Perl CGI скриптове за работа с библиографска база данни. Скриптовете Ви позволяват да създавате, добавяте, търсите, четете, записвате във файл и редактирате база данни във формат flat file или Comma Separated Values (CSV). Базата данни може да е в кодировка Unicode (UTF-8), както и да се състои от два или повече файла. Скриптовете имат английски и български интерфейс, а също версии за Linux и Windows. Подходящи са за CD-ROM презентации, работа в офлайн режим и в локална мрежа. Не са необходими външни Perl модули. Скриптовете нямат авторски права - тяхното ползване е свободно и безплатно за всяка законна дейност, включително разпостранение и изменения.

СВОЙСТВА
  • Можете да търсите във flat file (или Comma Separated Values - CSV) библиографски бази данни по полета АВТОР, ЗАГЛАВИЕ, МЯСТО НА ИЗДАВАНЕ, СПИСАНИЕ/ПОРЕДИЦА (по едно, две, три или всички полета едновременно).
  • Можете да задавате хронологичен обхват (например всички заглавия от 1970 до 1980).
  • Можете да сортирате резултатите от Вашето търсене по четири критерия за сортиране, както и да избирате Ваши критерии за сортиране и техния приоритет.
  • Можете да задавате търсене без оглед на главни и малки букви когато търсите на латиница (основният набор от букви) и кирилица.
  • Можете да ползвате глобалният символ * за да търсите с част от дума. Например може да напишете program* и ще намерите "Programming in Perl" и "Perl Programmers' Guide". Примерите са произволни!
  • Можете да търсите думи в произволен ред като ползвате знака ~ между тях. Например може да напишете Perl~programming и ще намерите "Programming in Perl" и "Perl Programming". Примерите са произволни!
  • Разполагате със статистика за Вашето търсене на всяка страница с резултати.
  • Можете да избирате по колко резултата на страница желаете.
  • Можете да избирате разделителния символ на Вашата база данни. Отворете скриптовете в текстов редактор и променете стойността на променливата за разделител.
  • Можете да ползвате база данни в кодировка Unicode (UTF-8).
  • Можете да ползвате база данни с два или повече файла, да изберете последователността на файловете и да търсите с една и съща заявка в различните файлове на Вашата база данни. Отворете Perl модула settings.pm в Unicode текстов редактор и запишете необходимите настройки.
  • Можете да четете цялата база данни разделена на страници. Също така можете да избирате по колко резултата на страница желаете. Можете да изберете Вашата начална страница и да продължите оттам, откъдето сте прекъснали работа предишния път. Можете да сортирате Вашите резултати по четири критерия за сортиране, както и да избирате Ваши критерии за сортиране и техния приоритет.
  • Можете да записвате Вашата база данни в един HTML форматиран файл.
  • Можете да добавяте нови записи към Вашата база данни.
  • Можете да редактирате Вашата база данни. Разполагате с невидимо подполе ALIAS в полето АВТОР и така можете да намирате с една заявка различните транслитерации на едно и също име.
  • Скриптовете и техните уеб формуляри имат български и английски интерфейс. Можете лесно да превеждате интерфейса и на други езици. Отворете скриптовете в текстов редактор с поддръжка на Unicode и редактирайте съответната част от началото на всеки скрипт.
  • Всички настройки на скриптовете (с изключение на файловите пътища), както и интерфейсите са записани в Perl модула settings.pm с цел по-лесно приспособяване на скриптовете.
  • Разполагате с версии на скриптовете за Linux and Windows операционни системи.

    • ИЗИСКВАНИЯ
  • Действащ уеб сървър с поддръжка за Perl CGI скриптове.
    За разработката на скриптовете ползвах Xitami за Windows и Apache за Linux.
  • Perl интерпретатор.
    Ползвах IndigoPerl 5.8.3 за Windows и Perl 5.8.3 от дистрибуцията Knoppix 3.3 Live Linux on CD.
    ВАЖНО: Необходим Ви е Perl 5.8.3 или по-висока версия за да ползвате скриптовете с база данни в кодировка Unicode (UTF-8).
    Всички скриптове от комплекта BG Volumina не изискват и не ползват каквито и да са външни Perl модули и затова се нуждаете само от Perl интерпретаторът.
  • Браузър с поддръжка на Unicode, Java, CSS и уеб формуляри.
  • Засега се предполага, че Вашата база данни има структурата АВТОР, ЗАГЛАВИЕ, МЯСТО НА ИЗДАВАНЕ, СПИСАНИЕ/ПОРЕДИЦА, ТОМ, ГОДИНА и СТРАНИЦИ. Бихте могли да преработите скриптовете съобразно специфичната структура на Вашата база данни.

    • ОГРАНИЧЕНИE
    Не може да ползвате скриптовете с база данни в единичен файл, който е в кодировка Unicode (UTF-8) и в който има повече от 5 500 записа. В такъв случай обмислете разделянето на базата данни в два или повече последователни файла.

    БЛАГОДАРНОСТИ,
    ИЗПОЛЗВАНИ ПРОГРАМИ И
    ПРОГРАМЕН КОД
  • Започнах разработката на скриптовете за нуждите на Катедрата по Стара история, Тракология и Средновековна история на Историческия факултет на Софийския Университет "Св. Климент Охридски" и благодаря на всички приятели и колеги за техните идеи и предложения.
  • Indigo Perl 5.8.3.
    http://www.indigostar.com/indigoperl.htm
  • XAMPP Perl Add-On 1.4.12 (Perl 5.8.6).
    http://www.apachefriends.org/en/xampp-windows.html#644
  • Jurgen Guntherodt - Open Perl IDE.
    http://open-perl-ide.sourceforge.net
  • Florian Balmer - Notepad2 1.0.12.
    http://www.flos-freeware.ch/notepad2.html
  • Paul Lutus - Arachnophilia 4.0 (Build 5310).
    http://www.arachnoid.com/arachnophilia/
  • iMatix Corporation - Xitami/2.5c1 уеб сървър за Widows.
    http://www.xitami.com/
  • Klaus Knopper - Knoppix 3.3 Live Linux on CD.
    http://www.knopper.net/knoppix/
  • Andrew Johnson "Sorting in Perl II (Schwartzian Transform)".
    http://www.itworld.com/nl/perl/11302000/ (30.11.2000).
  • Nik Silver "Perl Tutorial".
    ftp://agora.leeds.ac.uk/scs/doc (09.05.2004) Сайтът е закрит.
  • Ray Street "Multiple Search Results Pages in Perl".
    http://www.creativefundamentals.com (02.06.2004) Съответната страница е закрита.
  • WWW.CGISCRIPT.NET - CSS код (бутони, полета).
    http://www.cgiscript.net/ (01.06.2004) Съответните страници са закрити.
  • CSS код за бутон от
    http://www.createafreewebsite.net/html_tutorial/buttons.html (16.05.2004).
  • Скриптовете CAS
    http://www.createafreewebsite.net/downloads/cas_scripts.zip (16.05.2004).
  • Сайтът The JavaScript Source - разнообразен Java код:
    фокус в полета, забрана на някои символи във формулярите, бутони за увеличаване и намаляване на числени стойности, хипервръзка към предишна страница.

    • ИМЕ НА ПРОГРАМАТА
    Volumina е латинска дума в множествено число, която означава папирусов или пергаментов свитък.

    ИСТОРИЯ
    Това е първата публична версия на комплекта скриптове. Тя вече носи номер 0.3 поради редицата направени подобрения на първоначалните версии.

    ПЛАНОВЕ
  • Поправяне на все още неоткрити грешки.
  • Съставяне на help.
  • По-добри шрифтове за Линукс, особено за резолюция 1024x768.

    • АВТОР
    Димитър Д. Митов ddmitov@yahoo.com


    BG Volumina
    Bibliographic Database Script Kit

    NO WARRANTIES OR SUPPORT OF ANY KIND!
    USE THE SCRIPTS AT YOUR OWN RISK!

    BG Volumina scripts are not copyrighted and are in the public domain!
    You can use them for any legal purpose!
    You can modify and redistibute them by any means!


    SHORT DESCRIPTION
    BG Volumina is bibliographic database Perl CGI script kit. It enables you to create, append, search, read, dump, sort and edit bibliographic database in flat file / Comma Separated Values (CSV) format. Unicode (UTF-8) code page and multiple files database are supported. English and Bulgarian interfaces, as well as Linux and Windows versions are available. Suitable for CD-ROM presentations, offline and LAN environments. No external Perl modules needed. No copyrights - free for any legal purpose, including distribution and modifications.

    FEATURES
  • You can search in flat file (or Comma Separated Values - CSV) bibliographic databases by fields AUTHOR, TITLE, PLACE, JOURNAL (one, two, three or all of the fields simultaneously).
  • You can set time range (eg. all titles from 1970 to 1980).
  • You can sort your search results by four sort criteria and you can choose Your sort criteria and their priority.
  • You can perform case insensitive searches when you use Cyrillic and basic Latin letters.
  • You can use the global symbol * to search for a part of word. E.g. You can type program* and you will find both "Programming in Perl" and "Perl Programmers' Guide". Examples are random!
  • You can search for words in any order using the tilde ~ between them. E.g. You can type: Perl~programming and you will find both "Programming in Perl" and "Perl Programming". Examples are random!
  • You have search statistics on every results page.
  • You can choose how many search results per page you want.
  • You can choose your delimiting symbol of your database. Open the scripts in a text editor and change the delimiter value.
  • You can use Unicode encoded (UTF-8) database.
  • You can use multiple files database, choose the files sequence and search with the same query in the different files of your database. Open settings.pm Perl module in a Unicode text editor and save Your settings.
  • You can read your whole database splitted in pages. You can also choose how many results per page you want. You can choose your start page and continue from where you stopped last time. You can sort by four sort criteria and choose your sort criteria and their priority.
  • You can dump your database in a single HTML formatted file.
  • You can add more records to your database.
  • You can edit your database. You have an invisible subfield ALIAS in the AUTHOR field and so you can find the different transliterations of one and the same name using one search request.
  • You have scripts and web forms with Bulgarian or English interface. You can easily translate the interface in other languages. Open the scripts in a Unicode text editor and edit the appropriate part of the beginning of each script.
  • All scripts' settings (with the exception of file paths) are stored within a Perl module named settings.pm for easier modification of the scripts.
  • Linux and Windows versions of the scripts are available.

    • REQUIREMENTS
  • A running web server with support for Perl CGI scripts.
    I used Xitami for Windows and Apache for Linux for the development of the scripts.
  • A Perl interpreter.
    I used IndigoPerl 5.8.3 for Windows and Perl 5.8.3 inside Knoppix 3.3 Live Linux on CD distribution.
    IMPORTANT: You need Perl 5.8.3 or higher to run the scripts with Unicode encoded (UTF-8) database!
    All BG Volumina scripts do not require and do not use any external Perl modules so you need only the Perl interpreter itself.
  • A Java enabled browser with Unicode, CSS and web forms support.
  • It is currently supposed that Your database has AUTHOR, TITLE, PLACE, JOURNAL, VOLUME, YEAR, PAGES structure. You could modify the scripts according to your database specific structure.

    • LIMITATION
    It's not possible to use the scripts with Unicode (UTF-8) encoded single file database larger than 5,500 records. Consider splitting the database in two or more consecutive files.

    CREDITS
  • I started developing the scripts for the needs of The Ancient History, Thracology and Medieval History Cathedra of The Faculty of History of The Sofia University "St. Kliment Ohridski" and I thank to all friends and colleagues for their ideas and sugestions.
  • Indigo Perl 5.8.3.
    http://www.indigostar.com/indigoperl.htm
  • XAMPP Perl Add-On 1.4.12 (Perl 5.8.6).
    http://www.apachefriends.org/en/xampp-windows.html#644
  • Jurgen Guntherodt - Open Perl IDE.
    http://open-perl-ide.sourceforge.net
  • Florian Balmer - Notepad2 1.0.12.
    http://www.flos-freeware.ch/notepad2.html
  • Paul Lutus - Arachnophilia 4.0 (Build 5310).
    http://www.arachnoid.com/arachnophilia/
  • iMatix Corporation - Xitami/2.5c1 web server for Windows.
    http://www.xitami.com/
  • Klaus Knopper - Knoppix 3.3 Live Linux on CD.
    http://www.knopper.net/knoppix/
  • Andrew Johnson "Sorting in Perl II (Schwartzian Transform)".
    http://www.itworld.com/nl/perl/11302000/ (11/30/2000).
  • Nik Silver "Perl Tutorial".
    ftp://agora.leeds.ac.uk/scs/doc (05/09/2004) Obsolete.
  • Ray Street "Multiple Search Results Pages in Perl".
    http://www.creativefundamentals.com (06/02/2004) The relevant page is removed.
  • WWW.CGISCRIPT.NET - CSS code (buttons, fields, textarreas).
    http://www.cgiscript.net/ (06/01/2004) The relevant pages are removed.
  • CSS button code from
    http://www.createafreewebsite.net/html_tutorial/buttons.html (05/16/2004).
  • The CAS scripts
    http://www.createafreewebsite.net/downloads/cas_scripts.zip (05/16/2004).
  • The JavaScript Source site - miscellaneous Java code:
    fieldfocus, restriction for some characters in forms, updown buttons, previous page hyperlink.

    • PROGRAM NAME
    Volumina is a Latin word in plural meaning papyrus or pergament roll.

    HISTORY
    This is the first public release of the script kit. It is already v. 0.3 because I already made many improvments to the initial versions.

    TO DO
  • Debugging of any currently unknown bugs.
  • Writing help.
  • Better fonts for Linux esp. in 1024x768 screen resolution.

    • AUTHOR
    Dimitar D. Mitov ddmitov@yahoo.com