command line usage (for v2.0)

Xilize version 2.0 only. See here for version 3.0 command line.

• introduction
• general syntax
• natural mode examples
• classic mode examples
• config file only example

Creating Xilize markup within jEdit is the most efficient way to work, and translating .xil files to .html is done in that environment at the touch of a button. However, an automated build procedure for a web site requires command line execution. From the command line, Xilize has no dependency on any other library — not even the jEdit jar.

introduction

The -h switch on the command line

java -jar /home/andy/.jedit/jars/Xilize.jar -h

produces this usage message:

Usage:
      Xilize [-env config_file] file path_to_file
      Xilize [-env config_file] dir path_to_directory
      Xilize [-env config_file] tree path_to_directory
      Xilize [-env config_file] natural path_to_directory [branch [file]]
      Xilize -env config_file
  see http://www.centeredwork.com/xilize2 for more information

Each of these options is explained below.

general syntax

The general syntax for the Xilize command line is

java -jar /path/to/Xilize.jar [-env configFile] ( natural|tree|dir|file ) path/to/target

As a special case, you can also give just a configuration file

java -jar /path/to/Xilize.jar -env configFile

natural mode examples

java -jar /path/to/Xilize.jar natural /home/andy/myProject

Translates all .xil files in /home/andy/myProject and all of its subdirectories to their corresponding .html files using natural mode processing.

java -jar /path/to/Xilize.jar natural /home/andy/myProject myDoc/intro

Translates all .xil files in /home/andy/myProject/myDoc/intro and all of its subdirectories to their corresponding .html files using natural mode processing assuming /home/andy/myProject is the project root directory.

Note: myDoc/intro is interpreted as a path relative to /home/andy/myProject.

java -jar /path/to/Xilize.jar natural /home/andy/myProject myDoc/intro index.xil

Translates /home/andy/myProject/myDoc/intro/index.xil to /home/andy/myProject/myDoc/intro/index.html using natural mode processing assuming /home/andy/myProject is the project root directory.

java -jar /path/to/Xilize.jar -env /home/andy/xilize/my.config natural /home/andy/myProject

Note: my.config file does not have to reside in the same directory as the target even though XAA expects that when running in jEdit. Thus, you can have more than one .config file for the same project.

classic mode examples

java -jar /path/to/Xilize.jar file /home/andy/myProject/myDoc/chapterOne.xil

Translates /home/andy/myProject/myDoc/chapterOne.xil to /home/andy/myProject/myDoc/chapterOne.html

java -jar /path/to/Xilize.jar dir /home/andy/myProject/myDoc

Translates all .xil files in /home/andy/myProject/myDoc to their corresponding .html files.

java -jar /path/to/Xilize.jar tree /home/andy/myProject

Translates all .xil files in /home/andy/myProject and all of its subdirectories to their corresponding .html files.

With each of these commands you can also provide a .config file which might, for example, set the footnote styling used in the translation.

java -jar /path/to/Xilize.jar -env /home/andy/xilize/my.config tree /home/andy/myProject

Note that the .config file does not have to reside in the same directory as the target even though XAA expects that when running in jEdit. Thus, you can have more than one .config file for the same project.

config file only example

java -jar /path/to/Xilize.jar -env /home/andy/xilize/my.config

You can execute Xilize giving it only a .config file if the config file defines at least _Mode_ and _Target_ and _Target_ is an absolute path.