view dist/biotopes/doc/readme.txt @ 1:548a93c24e55

Tema 0.1jk - Javakonkurs edition (imported from CVS).
author Mikhail Kryshen <mikhail@kryshen.net>
date Thu, 14 Dec 2006 23:22:05 +0300
parents
children
line source
1 text/plain; charset=UTF-8
3 Установка программы
4 -------------------
6 1. Распаковать архив.
8 2. Установить источник данных:
9 в Windows 2000: Панель управления/Администрирование/Источники данных (ODBC), добавить biotopes.mdb.
11 3. Настроить программу:
12 В файле dbreader.properties указать имя, присвоенное источнику данных:
13 "resource: jdbc:odbc:<имя>"
14 и путь к каталогу, относительно которого программа будет искать изображения (содержащий biotopephotos и maps):
15 "resource_base: C:\\biotopes"
16 (символ '\' необходимо дублировать)
18 4. Запуск программы: dbreader.bat или "java -jar dbreader.jar"
19 Для запуска необходима Java Runtime Environment (JRE) 5.0, можно скачать с http://java.sun.com/j2se/1.5.0/download.jsp. Возможно, будет работать и со старыми версиями JRE - не проверял.
21 Все значения файла конфигурации можно переопределять при запуске программы:
22 команда "java -Dru.karrc.dbreader.<ключ>=<значение> -jar dbreader.jar"
23 (например: "java -Dru.karrc.dbreader.log=dbreader.log -jar dbreader.jar")
26 Работа программы
27 ----------------
29 Программа выполняет запрос biotope.sql (или другой, указанный в dbreader.properties), после чего обрабатывает файл biotope.template, заменяя найденные в нем инструкции на результаты их выполнения.
31 Формат инструкций: "<%список_функций[:|\]данные%>", список функций - имена функций разделенные пробелом, список может быть пустым. Если указано несколько функций, они выполняются начиная с последней.
33 Разделители между списком функций и данными:
34 ':' - данные будут обрабатываться рекурсивно.
35 '\' - данные будут переданы функции без обработки. Можно использовать для экранирования комбинаций символов "<%" и "%>" ("<%\<%%>" и "<%\%%>>").
37 Функции:
38 <%get:<имя>%> - заменяется на значение встроенной переменной или колонки запроса.
40 <%optional:<текст>%>
41 Заменяется на <текст>, если в нем найдены инструкции, заменившиеся на непустые строки, иначе заменяется на пустую строку.
43 <%escape:<текст>%>
44 Заменяет в тексте "опасные" символы (таблица замен задается в файле конфигурации).
46 <%invoke:<имя> <парам1> <парам2> ... <парамN>%>
47 Выполняет запрос с параметрами <имя>.sql и заменяется на результаты обработки шаблона <имя>.template. Значения параметров подставляются в запрос вместо символа '?'.
49 <%image:<исх_файл> <кон_файл> <формат> [<макс_ширина>] [<макс_высота>]%>
50 Загружает изображение из файла <исх_файл> (путь определяется относительно конфигурационного параметра "resource_base") и преобразует его в указанный формат, сохраняя результат в <кон_файл>. Если заданы максимальная высота и ширина, большие изображения будут уменьшены.
51 При успешном выполнении, инструкция "<%!image ...%>" будет заменена на значение <кон_файл>, иначе - на пустую строку.
53 <%copy:<исх_файл> <кон_файл>%>
54 Копирует файл <исх_файл> (путь определяется относительно конфигурационного параметра "resource_base").
55 При успешном выполнении, инструкция "<%!copy ...%>" будет заменена на значение <кон_файл>, иначе - на пустую строку.
57 Встроенные переменные:
58 NUMBER - порядковый номер строки результата выполнения запроса.
59 Чтобы обратиться к переменной запроса, из которого обрабатываемый шаблон был вызван с помощью функции invoke, перед именем переменной нужно добавить "SUPER." (например: "SUPER.NUMBER").
61 Пример:
62 Следующая инструкция получит значение из столбца name и заменит в нем специальные символы:
63 <%escape get:name%>