tema: 6c41a0b43e58 misc/manual-ru-old/index.html

view misc/manual-ru-old/index.html @ 2:6c41a0b43e58

Tema 0.3 (imported from CVS).

author	Mikhail Kryshen <mikhail@kryshen.net>
date	Tue, 19 Feb 2008 20:32:17 +0300
parents
children

line source

1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

2 "DTD/xhtml1-transitional.dtd">

4 <html>

6 <head>

7 <title>Макропроцессор TEMA</title>

8 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

9 </head>

11 <body>

12 <h1>Макропроцессор TEMA</h1>

14 Макропроцессор TEMA обрабатывает заданные шаблоны текстовых файлов и

15 заменяет найденные в них инструкции на результаты их выполнения.

16

17 Особенности:

18

19 <ul>

20 <li>Расширяемость: возможно динамически подключать новые функии,

21 реализованные в виде классов на Java.</li>

22 <li>Работа с базами данных: использование SQL-запросов для получения

23 данных.</li>

24 <li>Поточная обработка данных: инструкции обрабатываются по мере

25 чтения текста без необходимости загрузки файла в оперативную память

26 и выполнения полного синтаксического разбора.</li>

27 </ul>

29 Формат инструкций

31 <blockquote>

32 <code><%список_функций{:|\|`}данные%></code>

33 </blockquote>

34

35 где

37 <code>список_функций</code> - список имен функций, разделенных

38 пробелами. Может быть пустым.

39 <code>данные</code> - данные, передаваемые функции.

40

42 Формат данных

44 <blockquote>

45 <code>

46 [список_аргументов][текст]

47 </code>

48 </blockquote>

49

50 где

52 <code>список_аргументов</code> - список аргументов функции, разделенных пробелами.

53 Может быть пустым.

54 <code>текст</code> - текст, передаваемый функции без разбиения на аргументы.

55 Может быть пустым. Количество аргументов, после которого следует

56 текст, зависит от функции.

57

58 Разделитель между списком функций и данными определяет, как должны

59 обрабатываться данные функции:

60

61 <code>:</code> - рекурсивная обработка,

62 <code>\</code> или <code>`</code> - передать без обработки.

63

64 Если в списке функций задано две и более функции, они выполняются,

65 начиная с последней, так что каждая функция получает в качестве данных

66 результат выполнения следующей функции.

67

68 Каждая функция имеет код возврата - целое число. Код возврата

69 инструкции - код возврата первой в списке функции. Код возврата,

70 получаемый при обработке текста - сумма кодов возврата обработанных

71 инструкций (как правило, смысл этого значения - количество инструкций,

72 замененных на непустой текст).

73

74 Кроме скобок '<', '>', можно использовать скобки '[', ']'.

75

78 <h2>Функции</h2>

80 <code>set</code>

82 <table>

83 <tr><td>Аргументы:</td>

84 <td>имя</td></tr>

86 <tr><td>Текст:</td>

87 <td>значение</td></tr>

89 <tr><td>Действие:</td>

90 <td>Устанавливает значение переменной имя.</td></tr>

92 <tr><td>Результат:</td>

93 <td>имя</td></tr>

95 <tr><td>Код возврата:</td>

96 <td>1</td></tr>

97 </table>

99 <code>define</code>

100

101 <table>

102 <tr><td>Аргументы:</td>

103 <td>имя</td></tr>

104

105 <tr><td>Текст:</td>

106 <td>шаблон</td></tr>

107

108 <tr><td>Действие:</td><td>Определяет новую функцию имя, при

109 вызове которой обрабатывается шаблон. При обработке доступны

110 функции <code>nextarg</code> для получения очередного аргумента

111 вызываемой функции и <code>data</code> для получения текста.</td></tr>

112

113 <tr><td>Результат:</td>

114 <td>имя</td></tr>

115

116 <tr><td>Код возврата:</td>

117 <td>1</td></tr>

118 </table>

119

120 <code>load</code>

121

122 <table>

123 <tr><td>Аргументы:</td>

124 <td>имя имя_класса</td></tr>

125

126 <tr><td>Действие:</td>

127

128 <td>Определяет новую функцию имя. Реализация функции определена

129 Java-классом имя_класса, наследующим класс

130 <code>kryshen.tema.Function</code>.</td></tr>

131

132 <tr><td>Результат:</td>

133 <td>имя</td></tr>

134

135 <tr><td>Код возврата:</td>

136 <td>1</td></tr>

137 </table>

138

139 <code>prepare</code>

140

141 <table>

142 <tr><td>Аргументы:</td>

143 <td>имя</td></tr>

144

145 <tr><td>Текст:</td>

146 <td>запрос</td></tr>

147

148 <tr><td>Действие:</td>

149 <td>Подготавливает SQL-запрос запрос для выполнения, записывает

150 подготовленный запрос в переменную имя.</td></tr>

151

152 <tr><td>Результат:</td>

153 <td>имя</td></tr>

154

155 <tr><td>Код возврата:</td>

156 <td>1</td></tr>

157 </table>

158

159 <code>query</code>

160

161 <table>

162 <tr><td>Аргументы:</td>

163 <td>имя_запроса шаблон парам1 ... парамN</td></tr>

164

165 <tr><td>Действие:</td>

166 <td>Выполняет запрос с параметрами, подготовленный с помощью функции

167 prepare. Значения параметров подставляются в запрос вместо символа

168 '?'. Значения полей ответа доступны с помощью функции <code>db</code>,

169 как переменные шаблона шаблон. При обработки шаблона также

170 определяется переменная <code>number</code>, содержащая номер текущей

171 строки ответа.</td></tr>

172

173 <tr><td>Результат:</td>

174 <td>результат обработки шаблона шаблон для каждой строки

175 ответа.</td></tr>

176

177 <tr><td>Код возврата:</td>

178 <td>Количество полученных строк ответа.</td></tr>

179 </table>

180

181 <code>optional</code>

182

183 <table>

184 <tr><td>Текст:</td>

185 <td>данные</td></tr>

186

187 <tr><td>Результат:</td><td>данные, если при обработке данных

188 был получен код возврата отличный от 0, иначе - пустая

189 строка.</td></tr>

190

191 <tr><td>Код возврата:</td>

192 <td>1, если результат - пустая строка, 0 - иначе.</td></tr>

193 </table>

194

195 <code>image</code>

196

197 <table>

198 <tr><td>Аргументы:</td>

199 <td>исх_файл кон_файл формат [макс_ширина

200 [макс_высота]]</td></tr>

201

202 <tr><td>Действие:</td>

203 <td>Загружает изображение из файла исх_файл (путь определяется

204 относительно конфигурационного параметра "resource_base") и

205 преобразует его в указанный формат, сохраняя результат в

206 кон_файл. Если заданы максимальная высота и ширина, большие

207 изображения будут уменьшены.</td></tr>

208

209 <tr><td>Результат:</td>

210 <td>кон_файл при успешном выполнении, пустая строка - иначе.</td></tr>

211

212 <tr><td>Код возврата:</td>

213 <td>1 при успешном выполнении, 0 - иначе.</td></tr>

214 </table>

215

216

217 <code>copy</code>

218

219 <table>

220 <tr><td>Аргументы:</td><td>исх_файл кон_файл</td></tr>

221

222 <tr><td>Действие:</td><td>Копирует файл исх_файл в файл

223 кон_файл (путь исх_файл определяется относительно

224 конфигурационного параметра "resource_base").</td></tr>

225

226 <tr><td>Результат:</td><td>кон_файл при успешном выполнении,

227 пустая строка - иначе.</td></tr>

228

229 <tr><td>Код возврата:</td><td>1 при успешном выполнении, 0 -

230 иначе.</td></tr>

231 </table>

232

233 <code>write</code>

234

235 <table>

236 <tr><td>Аргументы:</td><td>имя_файла</td></tr>

237

238 <tr><td>Текст:</td><td>данные</td></tr>

239

240 <tr><td>Действие:</td><td>Записывает данные в файл

241 исх_файл.</td></tr>

242

243 <tr><td>Результат:</td><td>кон_файл при успешном выполнении,

244 пустая строка - иначе.</td></tr>

245

246 <tr><td>Код возврата:</td><td>1 при успешном выполнении, 0 -

247 иначе.</td></tr>

248 </table>

249

250 <code>read</code>

251

252 <table>

253 <tr><td>Текст:</td><td>имя_файла</td></tr>

254 <tr><td>Действие:</td><td>Читает файл имя_файла.</td></tr>

255 <tr><td>Результат:</td><td>прочитанные данные при успешном выполнении,

256 пустая строка - иначе.</td></tr>

257 <tr><td>Код возврата:</td><td>1 при успешном выполнении, 0 -

258 иначе.</td></tr>

259 </table>

260

261 <code>include</code>

262

263 <table>

264 <tr><td>Текст:</td><td>имя_файла</td></tr>

265 <tr><td>Действие:</td><td>включает шаблон из файла

266 имя_файла.</td></tr>

267 <tr><td>Результат:</td><td>результат обработки шаблона.</td></tr>

268 <tr><td>Код возврата:</td><td>код возврата, полученный при обработке

269 шаблона.</td></tr>

270 </table>

271

272 <code>!</code>

273

274 <table>

275 <tr><td>Текст:</td><td>данные</td></tr>

276

277 <tr><td>Действие:</td><td>нет.</td></tr>

278

279 <tr><td>Результат:</td><td>нет.</td></tr>

280

281 <tr><td>Код возврата:</td><td>код возврата, полученный при обработке

282 текста данных.</td></tr>

283 </table>

284

285 <code>replace</code>

286

287 <table>

288 <tr><td>Аргументы:</td><td>стр1 стр2</td></tr>

289

290 <tr><td>Текст:</td><td>данные</td></tr>

291

292 <tr><td>Результат:</td><td>данные, с замененными вхождениями подстроки

293 стр1 на стр2.</td></tr>

294

295 <tr><td>Код возврата:</td><td> код возврата, полученный при обработке

296 текста данных.</td></tr>

297 </table>

298

299 <code>xml_escape</code>

300

301 <table>

302 <tr><td>Текст:</td><td>данные</td></tr>

303 <tr><td>Результат:</td><td>текст данные, в котором символы

304 '&', '<', '>', '`', '\' заменены на соответствующие сущности

305 XML.</td></tr>

306

307 <tr><td>Код возврата:</td><td> код возврата, полученный при обработке

308 текста данных.</td></tr>

309 </table>

310

311 <code>xml_cdata</code>

312

313 <table>

314 <tr><td>Текст:</td><td>данные</td></tr>

315

316 <tr><td>Результат:</td><td>данные в виде блока XML CDATA.</td></tr>

317

318 <tr><td>Код возврата:</td><td> код возврата, полученный при обработке

319 текста данных. </td></tr>

320 </table>

321

322

323 Макропроцессор TEMA расширяем: возможно добавление в систему новых

324 функций, реализованных в виде классов на языке Java.

325

326

327 <h2>Запуск</h2>

328

329 java -jar tema.jar [опции]

330

331 Опции:

332

333 <table>

334 <tr><td>-d[emo]</td><td>Демонстрационный режим</td></tr>

335 <tr><td>-v[ersion]</td><td>Вывод версии</td></tr>

336 <tr><td>-h[help] -u[sage]</td><td>Вывод справки</td></tr>

337 </table>

338

339

340 При запуске читается файл "tema.properties" из текущего каталога.

341 Пример файла "tema.properties":

342

343

344 <pre>

345 # Настройка источника данных

346 # resource : jdbc:odbc:database

347 # driver : sun.jdbc.odbc.JdbcOdbcDriver

348

349 # Базовый каталог ресурсов

350 # resource_base : .

351

352 # Шаблон, с которого начинается обработка

353 main_template : main.template

354

355 # Кодировки файлов

356 # input_encoding : UTF-8

357 # output_encoding : UTF-8

358

359 # Кэширование шаблонов

360 # cache_read : true

361

362 # Вывод результата разбора шаблона main.template в stderr

363 # output : stderr

364

365 # Вывод сообщений об ошибках в файл

366 # log : dbreader.log

367 </pre>

368

369 </body>

370 </html>

Mercurial > hg > tema

view misc/manual-ru-old/index.html @ 2:6c41a0b43e58