next up previous contents
Next: Conclusion Up: Technical details Previous: Source code and API   Contents


XML document definition

Below is the layout of XML files used by guiLiner. Each of the elements is described in detail below that. Only the names of the elements are presented below, so this is not valid XML syntax. While guiLiner does do some basic checking on the well-formedness of the XML document, it does not do extensive checks. A detailed description of XML is beyond the scope of this document. For more information try http://www.xml.com/

The following pages also include reference tables with information on XML file formatting (3.1) and one describing the option types (3.2) in detail. Note that Table 3.2 includes which flag to use when specifying default values for each option type. It is a good idea to always include these tags in the option element. If no default value is desired, simply make it an empty tag.

* = required
# only applicable to some option types
< = not yet used

guiLiner*
 program*
  binary_name*
  binary_location*
  binary_html_manual_index
  binary_short_info
  binary_long_info
  gl_window_size
  wizard <
  
 options*
  subset
   subset_name
   subset_description <
    option*
     option_name*
     option_type*
     option_flag*
     option_subtext
     option_short_description
     option_long_description
     option_linker*
     option_required*
     option_can_appear_in_command*
     option_children
      option* ...
     value (see below which flag should be used)*
     selected_choice#

\begin{landscape}
% latex2html id marker 90\thispagestyle{plain}
\begin{table}...
...l element in parental heiarchy
\end{footnotesize}\end{table}\par
\end{landscape}



Table 3.2: Option types
No. Option type Flag used for value Option panel code
0 Short Text real RealPanel.java
1 Long Text string StringPanel.java
2 Min-Max Range range(2 values ``;'' separated) RangePanel.java
3 File selector file FileChooserPanel.java
4 Multi file selector file UNUSED: use complex
5 Multiple Choice choice (mult. values ``;'' separated) MultiChoicePanel.java
    selected_choice tag reqd. to store selection  
6 Arbitrary complex ComplexPanel.java
7 Information info InfoPanel.java
8 Option flag only bin BinPanel.java
9 Multiple flags w/ values values (mult. values ``;'' separated) MultiFlagPanel.java


next up previous contents
Next: Conclusion Up: Technical details Previous: Source code and API   Contents
Nicholas Manoukis 2007-11-14