Инструкция

KGBase: установка и использование

Установка

KGBase — серверное приложение, написанное на языке PHP (PHP Hypertext Preprocessor). Для отображения данных и управления базой используется веб-интерфейс. Соответственно, для работы с системой необходимы установленный веб-сервер и интерпретатор языка PHP. Разработка системы велась в среде Microsoft Windows XP на сервере Apache 2.2.26 и версии языка PHP 5.3.27 — на интегрированной платформе для веб-разработчиков Open Server 4.9.0 (http://open-server.ru/, автор — Максим Архипов). В качестве веб-браузера использовалась Mozilla Firefox версий с 15 по 31. Также для работы с файлами базы желательно наличие текстового редактора и табличного редактора с поддержкой формата OpenDocument Spreadsheet (*.ods). В процессе разработки использовались текстовый редактор Notepad++ 6.3.3 и табличный редактор из пакета Apache OpenOffice 4. В некоторых случаях работу может упростить наличие редактора файлов формата Extensible Markup Language (*.xml) — при разработке использовался Microsoft XML Notepad 2007. Таким образом, использование системы требует небольшого набора специализированного ПО. Использование проприетарного коммерческого ПО при работе с системой является возможным, но не обязательным.

При наличии необходимой программной среды установка KGBase сводится к распаковке содержимого архива в директорию /kgbase локального сервера. При распаковке в другое место необходимо изменить значение переменной $site в начале файла index.php — она определяет расположение системы и используется для формирования ссылок внутри системы. При раздельном использовании частей системы, соответственно, требуется отдельное переназначение их расположения и используемых ресурсов. При базовой установке система будет доступна в браузере по адресу http://localhost/kgbase/index.php (http://127.0.0.1/kgbase/index.php ).

Для изменения html-кода, отображаемого при вызове корневого файла, необходимо отредактировать файлы в директории \templates.

Создание новой базы данных

Первым шагом при создании новой базы данных является создание файла с таксономическим списком. Можно как использовать один из шаблонов, прилагаемых к системе в архиве, так и создать собственный шаблон при помощи скрипта tax_build.php из директории \admin. Описание полей таблиц дано в таблице content и content synonym шаблонов *.

* Название таксона в файле с таксономией является основным, соответствующие названия в связанных полях других файлов должны _точно_ соответствовать ему. Встроенных средств проверки связности данных система в данный момент не имеет, контролируйте связность самостоятельно.

Версия 1.0

Второй шаг в создании базы данных — заполнение таблиц шаблонов collection.ods и geodata.ods. Описание полей таблиц (описываемых ими классов объектов и формата данных) даны на соответствующей странице сайта. Общий подход к формированию данных, на котором основана структура данных в таблицах, описан в статьях, представленных на сайте. Для данных о коллекционных образцах можно также использовать базы данных Microsoft Access (.accdb) – на основе шаблонов в директории генератора баз данных (\builder\src\collection). Образцы таблиц других данных также находятся в \src в директории генератора.

 Карта для отображения локалитетов мест сбора должна представлять собой отображаемой в браузере растровое изображение c названием blank.jpg с файлом привязки blank.kml. Изображение должно быть привязано в системе координат WGS-84 и охватывать всю территорию, где собирались коллекционные образцы базы. Такого рода изображения могут быть легко получены в программе SAS.Планета. В текущей версии наличие файла карты является обязательным. Карты размещаются в соответствии с настройками в файле settings.php генератора баз данных — каждый файл привязки и растровая карта в отдельной директории. Каждая база данных в текущей версии может быть связана с одной картой.

 Кроме указанных файлов, необходима правка файла collections.xml в \builder\src — в нем содержатся данные о местах хранения коллекционных образцов. В связи с чрезвычайной простотой структуры этого файла отдельный алгоритм или служебные скрипты (подпрограммы) для этого отсутствуют. Просто откройте шаблон файла из архива (можно в любом текстовом редакторе) и впишите необходимые данные (если требуется, несколько раз продублировав содержимое тега <collection></collection>).

 После формирования всех источников данных они могут быть помещены в директорию источников, которая устанавливается в настройках файла settings.php генератора баз данных. Для использования генератора баз убедительная просьба внимательно ознакомиться с инструкцией к нему (\builder\readme_rus.txt). На данный момент настройки генератора устанавливаются только правкой файла settings.php.

 После настройки и запуска генератора полученные архивы остается только распаковать в директорию \kgbase\base\bases системы. После этого они станут доступны для просмотра и поиска информации.

Версия 0.1 (устаревшая):

Второй шаг в создании базы данных — заполнение таблиц шаблонов collection.ods и geodata.ods. Описание полей таблиц (описываемых ими классов объектов и формата данных) даны на соответствующей странице сайта. Общий подход к формированию данных, на котором основана структура данных в таблицах, описан в статьях, представленных на сайте.

Третий шаг, при наличии сформированных файлов с необходимыми таблицами и данными в них — преобразование данных таблиц OpenDocument Spreadsheet в формат Extensible Markup Language. Для этого используется набор служебных скриптов из директории \admin: tx.php для файла с таксономией, c2x.php для файла с данными коллекционных образцов, g2x.php для файла с геоданными. Все скрипты имеют веб-интерфейс с формой для загрузки подготовленных файлов.

* Кроме указанных файлов, необходимо формирование файла collections.xml — в нем содержатся данные о местах хранения коллекционных образцов. В связи с чрезвычайной простотой структуры этого файла отдельный алгоритм или служебные скрипты (подпрограммы) для этого отсутствуют. Просто откройте шаблон файла из архива (можно в любом текстовом редакторе) и впишите необходимые данные (если требуется, несколько раз продублировав содержимое тега <collection></collection>).

Промежуточный шаг необходим, если в файле с данными о коллекционных образцах содержатся сведения об образцах таксонов из нескольких отдельных списков, или если желательна проверка правильности написания названий таксонов в этом файле. В таком случае запустите скрипт ext.php из директории \admin. На выходе будут получены xml-файлы с коллекционными образцами, относящимися к указанному таксономическому списку, и соответствующими им геоданными, а также текстовый перечень названий таксонов, найденных в файле с коллекционными образцами, и отсутствующими в таксономическом списке.

Четвертый и последний шаг — окончательное формирование файлов базы данных. Четыре полученных xml-файла (collections.xml, *[collection].xml, *[geodata].xml и *[taxonomy].xml) необходимо поместить в отдельную директорию внутри \base\bases в директории с KGBase. Описание базы и названия файлов с данными должны быть внесены в файл index.xml, шаблон которого прилагается. После этого база появится в списке баз данных, отображаемых при вызове корневого файла системы.

Некоторые общие замечания

— Редактирование данных о коллекции и геоданных может быть более удобным в среде СУБД Microsoft Access. Для этого достаточно воспроизвести структуру таблиц, установив между ними необходимые связи. При работе с геоданными в этом случае следует помнить об ограничении данной СУБД на введение значений в текстовое поле через пользовательский интерфейс — 256 символов. Соответственно, сохранить данные координат сложных полигонов или полилиний (или текстовые описания объектов), превышающие данный предел, в среде Microsoft Access будет невозможно. В связи с отсутствием поддержки формата OpenDocument Spreadsheet пакетом Microsoft Office содержимое таблиц будет необходимо переносить вручную. Примечание для версии KGBase 1.0: Текущая версия генератора баз данных позволяет напрямую использовать для генерации файлы Microsoft Access с данными коллекции, геоданные могут быть загружены только из OpenDocument Spreadsheet.

— В системе используется одна таблица для кодирования символов — Unicode utf-8. При использовании в системах, использующих 8-битные национальные кодировки (CP-1251 в Windows и т.п.) — возможны ошибки: среда не сможет работать с названиями файлов в utf-8, система не будет работать с данными в однобайтных кодировках. Во избежание желательно использовать в названиях создаваемых файлах только буквы латинского алфавита.

Добавить комментарий

Ваш e-mail не будет опубликован. Обязательные поля помечены *