Yeast-Translator

Copyright (c) 2011, Francisco José García Izquierdo. All Rights Reserved.

Using the translator

The translator uses the jTidy HTML (http://jtidy.sourceforge.net/) library to parse the template and transform it. During the parsing phase, some errors or warnings can be found.

The translator is packed in the ysttrl.jar java executable file. To translate a template named <file> type down the following command in the operating system console:

java -jar ysttrl.jar [-p <path>] [-o <dest_file>] [-v] <file>

where the options mean:

-v

verbose; the translator shows information about the translation process, including transformation warnings. Errors are always shown

-c

cacheable; the translated template body is stored separately in a js file. The resultant template is an skeleton-template whose body contains an script that loads the previously mentioned template body.

-p <path>

specifies a directory where the source template is taken and the translation result is stored. The default directory is “.”.

-o <dest_file>

specifies the result file name. By default ysttrl adds the “_t” suffix to the source template name, and the "_t_b" suffix to the template body if the -c option is specified.

NOTE: If you use Yeast-server to serve Yeast templates in your web application, you can configure the server to automatically translate your templates.

Examples

java -jar ysttrl.jar templ.html

Translate the template ./templ.html into the ./templ_t.html file.

java -jar ysttrl.jar -p yst -o templ2.html templ.html

Translate the template yst/templ.html into the yst/templ2.html file.

java -jar ysttrl.jar -c templ.html

Translate the template ./templ.html into the ./templ_t.html and ./templ_b.js files. The ./templ_t.html file loads ./templ_b.js.

List of changes from version 1.0

Bug reports etc.

Bug reports:
Post your reports directly sending an email to:
  francisco.garcia@unirioja.es
The home page of Yeast-Server:
Visit http://www.yeasttemplates.org

Copyright notices

Copyright (c) 2011, Francisco José García Izquierdo. All Rights Reserved.

Yeast-Translator is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or any later version.

Yeast-Server for Java is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.


Francisco J. García Izquierdo (Email: francisco.garcia@unirioja.es)
Dept. of Math. and Computing Sciences, University of La Rioja