Selathco 0.91 Documentation Previous Next

3. Usage

It is recommended to add the "<install_directory>" directory to your CLASSPPATH environment variable. Otherwise you always have to change the current directory to "<install_directory>". Then, Selathco can be run from the command line:
  • on Windows 95/NT: jview selathco.Main
  • with JDK 1.1+ : java selathco.Main
Note: If you downloaded the installer for Windows, you can also use shortcuts from your "Start" menu.

3.1 Graphics user interface

If you run Selathco with no options, the following window should appear:

Tab:control

  1. Menu
    • File/New - opens a new editor:

    • File/Open - opens a new editor with specified file.
    • File/Save all files - saves files in all editors.
    • File/Close all files - closes all editors.
    • File/Set main file - opens a file dialog for specifying main LaTeX source file.
    • File/Set output directory - opens a dialog for specifying the output directory (default: output).
    • File/Close - closes Selathco immediately.
  2. Panel tabs - are:
    • Control - main panel.
    • Messages - all messages including warnings are shown here:

    • Warnings - warnings only output:

    • Unknown commands - The source TeX file name, number of occurencies (Count), Type (environment or command) and Name are displayed for each of the unknown LaTeX command:

  3. Options setup - see command line mode.
  4. Finished files list - output file names are listed here. Double click a file name to open it in the editor.
  5. Includes - see command line mode.
  6. Pass # - pass number 1 or 2.
  7. Status - shows "Ready" or "Parsing: <filename>" message.
  8. Start/Stop button - starts/stops LaTeX -> HTML conversion.
  9. Progress bar - shows progress (estimation in pass 1, real progress in pass 2).

3.2. Command line mode

Selathco can be run as described above - with no parameters (loads GUI) - with:
  • -h or --help parameter - prints help, or with:
  • <in-out> [ <options> ] parameters - meaning: 
    <in-out>  : <input directory> <main .tex file> <output directory>
<options> : -h, --help                 : displays this help and exits
            -v, --verbose              : print command names while parsing
            -f, --final                : produce only final output
            -1, --pass1only            : run pass 1 only
            -s, --forcesplit           : force file splitting in pass 1
            -i:<file>, --insert:<file> : insert <file> between <HEAD></HEAD>
            -t:<file>, --top:<file>    : write <file> in each page heading
            -b:<file>, --bottom:<file> : write <file> in each page footer
            -g, --gui                  : use graphics user interface
            -d, --debug                : debug to stderr
            -l, --log                  : log debugging messages

    Example: running Selathco
    java selathco.Main
java selathco.Main c:\latex book.tex c:\html --gui
java selathco.Main c:\latex book.tex c:\html -t:header --final

    3.3. Output files

    1. During the two-phase LaTeX source file(s) parsing, the following files are created in the <output directory>:
      • selathco.pass1.msg - contains all messages from pass 1,
      • selathco.pass2.msg - contains all messages from pass 2,
      • selathco.pass1.warn - contains warnings from pass 1,
      • selathco.pass2.warn - contains warnings from pass 2,
      • selathco.pass1.dbg - contains debug info from pass 1 (with -d option only),
      • selathco.pass2.dbg - contains debug info from pass 2 (with -d option only),
      • selathco.pass1.html - contains all converted text from pass 1 (does not contain valid forward references which are created in pass 2),
      • selathco.unknown - contains unknown commands list (from pass 1),
      • selathco.detected.properties - contains retrieved system information (useful for bug reporting),
      • 0.html - contains text read before the 1st sectioning command.
        If the original text is not divided into sections and contains no bibliography, all output will be in this file,
      • 1.html, 2.html, ..., n.html - pass 2: each "section" is written in a separate .html file,
      • toc.html - contains table of contents,
      • biblio.html - contains bibliography (if any),
      • index.html - pregenerated title page (if one does not already exists).

    2. The following files are copied to the <output directory>/images directory, if they do not yet exist:
      • arrow_prev.gif, arrow_next.gif - arrow images,
      • selathco.gif - Selathco logo.

    3. Cascade Style Sheets definitions file stylesheet.css is copied (if doesn't exist) to <output directory>, which is references by all of the HTML files and may be edited as needed.

    3.4 Selathco directives

    The source text parsing can be affected by the following directives. These directives should be written in the LaTeX comments, so they don't interfere with the regular text.
    • @IGNORE_BEGIN - from this directive all input text is ignored (means no output).
    • @IGNORE_END - end of ignoring started by @IGNORE_BEGIN.
    • @PARSE <text> - the <text> is normally parsed by Selathco (can be used to parse commands, that should not be parsed by LaTeX)
    • @HTML <text> - writes an arbitrary HTML <text> into output.
    • @MESSAGE <text> - prints a debug message.
    Example: usage of the directives
    LaTeX source... ...is converted to HTML... ...which is shown as
    \begin{itemize}
\item First 
%@HTML <TT>thing<TT> 
%@IGNORE_BEGIN
\item Second
\item {\em Third}
%@IGNORE_END
\item \foo
\end{itemize}

    <UL> 
<LI> First
<TT>thing<TT>
<LI> <FONT COLOR="RED">
     <B>\foo</B><FONT>
</UL>
    • First thing 
    • \foo