©Daniel Amyot, September 1996
lot2mml - translates a LOTOS specification into a MML document
readable by FrameMaker
lot2mml [-d DefFile] [InFile] [>OutFile]
lot2mml is a filter for documentation of LOTOS specifications.
It outputs a simple MML document enhencing the readability of the
specification when using FrameMaker. The resulting MML documents can
be imported and included in larger documents.
The filter has a number of features:
- Keywords and comments are enhanced
with user-defined tags.
- Default settings are implemented, but MML macros/tags used for
enhancement are fully configurable via a simple definition
- The structure of the specification and upper/lowercase characters
remain unchanged. No syntactical or grammatical checking is done.
lot2mml can be used as an independent application, or as a filter
(it can use standard input and output).
Included here are the default definitions in the input format
for DefFile: a set of MML macros. 2 pairs of macros (BKW,
EKW, BCom, ECom) must be defined by the user.
Macros S, LC and p must not be modified.
Macros code (character definition) and LotosCode (paragraph
definition) can be modified, but they must be present.
Please, read the Maker Markup Language (MML) Reference Manual from
Adobe (FrameMaker) for more details on how to define macros.
NOTE: You should make sure that the End tag variable (E??)
contains a MML macro that matches the one in the Begin tag variable (B??).
<Comment *** lot2mml.def *** - Macro definitions>
<Comment Daniel Amyot, September 14, 1996>
<Comment - Do not modify this section>
<!DefineMacro S "<HardSpace>">
<!DefineMacro LC "<LotosCode>">
<!DefineMacro p "<S><par>">
<Comment - These macros can be modified but MUST BE DEFINED>
<Comment - Make sure that Begin and End tags match!>
<Comment - BeginKeyWord, EndKeyWord>
<!DefineMacro BKW "<bold>">
<!DefineMacro EKW "<nobold>">
<Comment - BeginComment, EndComment>
<!DefineMacro BCom "<oblique>">
<!DefineMacro ECom "<nooblique>">
<Comment - End of definitions>
lot2mml is written in GNU flex. It should be easy to port it to
any platform. It has been tested under SunOS 4, DOS 6 (with GO32)
and Linux. In order to compile, you need flex and gcc or something
flex -i lot2mml.lex
gcc -O2 lexyy.c -o lot2mml.exe
flex -i lot2mml.lex
gcc -O2 lex.yy.c -o lot2mml
MML does not have the color and hyperlink capacities of MIF (Maker
Interchange Format, a more complex language) or HTML. Therefore,
this filter is simpler than lot2html.
Version 0.2, September 14, 1996
Other filter: lot2html(7)
Configuration file: lot2mml.def
Source file: lot2mml.lex
Created: 14 September, 1996
Last Updated: 14 September, 1996.