en français

Jaxe config files

Jaxe config files specify the menus to display for a given XML language, as well as the XML schema to use for validation, and the XSL files to use for the HTML preview. They are located in the config directory, and their names end in "_Jaxe_cfg.xml".

The structure of the document must respect a certain order, defined by the XML schema. If you already have a Relax NG schema, you can transform it into a W3C XML schema with the help of Trang

Here is the description of the elements used in the config files:

JAXECFG

Root element for the config files.

DESCRIPTION

Short description for the configuration file, displayed in the new document dialog.

CONFIG

Link to another configuration file, for a language to use in combination with the one described (with different namespaces).

FICHIERXSL

XSL file to use for the HTML preview. This stylesheet must generate an HTML file. The name of the XSL file is specified in the attribute nom. Parameters can be sent to the stylesheet with the element PARAMETRE. If several FICHIERXSL elements are used, the stylesheets are used one after the other, using intermediary XML files.

PARAMETRE

Parameter for the XSL stylesheet or for the elements, specified with the attributes nom and valeur. PARAMETRE must be under FICHIERXSL or BALISE.

FICHIERSCHEMA

XML schema to use, specified with the filename in the attribute nom. If no schema is specified, a simplified description of the language can be used instead, with the elements ENSEMBLE, SOUSBALISE and ATTRIBUT.

RACINE

A possible root element. RACINE must contain an element BALISE, with the description of the root element.

ESPACE

Namespace to use with all the elements. The two attributes are uri (the namespace URI) and prefixe (the associated prefix). The URI should be the same as the schema's targetNamespace if it is specified. If targetNamespace is not specified in the schema, ESPACE should not be used.

ENCODAGE

Character encoding for new documents. ISO-8859-1 is used by default.

DOCTYPE

Document type definition, used to save XML files.

MENU

Description of a menu to display in the XML language menubar. It contains as many items as there are BALISE and FONCTION elements under MENU. The menu title is specified with the attribute titre.

FONCTION

Menu calling a function. The attributes are:

• titre: menu title
• classe: class of the function, implementing the interface jaxe.Fonction
• commande: keyboard shortcut for the menu

An example of a function is jaxe.FonctionNormal, which removes all style from a selected text.

BALISE

Informations about an element of the XML language. The attributes are:

• nom: element name
• titre: title of the menu item used for inserting this element
• type the Jaxe element type. Possible values for type are: division, zone (=area), string, vide (=empty), tableau (=spreadsheet table), tabletexte (=table), style, fichier (=file), symbole (=symbol), liste (=list), item (of a list), listechamps (list with fields), typesimple (WXS simple type), formulaire (=form), plugin.
• cache: tells whether the menu item is hidden
• commande: keyboard shortcut
• noeudtype: for a processing instruction

Types descriptions :

• division: two bars extending to the window's right side, clearly separating large areas in the document.
• zone: two tags and carriage returns, to separate areas smaller than with division.
• string: two tags to identify a small string, without any carriage return.
• vide: a single tag, typically for an empty element.
• tableau: spreadsheet style table display (with the Swing component JTable). Handy for tables of numbers, but does not allow the use of XML elements inside the cells (use tabletexte to do that).
• tabletexte: Table display allowing the use of XML elements inside the cells. Also handles the rowspan and colspan attributes to gather cells vertically and horizontally.
• style: for use in the case (very rare if the XML language encodes the meaning as opposed to the presentation) where an XML element only conveys a style information. Displays the characters in the chosen style (bold, italic, ...), without any tag. An alternative is to use the string type, which can also use a style, but displays the tags.
• fichier: displays an image based on its path on the disk coming from an attribute of the XML element. It is possible to copy/paste images and Jaxe will automatically create the XML element and the image file on the disk.
• symbole: displays an image chosen within a set of images in an image folder.
• liste: for an element representing a bulleted or ordered list. The sub-element must use the item type. The tags are displayed as for zone, with a '+' button to create new items.
• item: list item in a list displayed with the liste type. Displayed with bullets or numbers, depending on the list type.
• listechamps: list of strings that can be edited in a dialog. Does not allow any XML in the list items (use liste to do that).
• typesimple: displays an element having a simple value, in a small panel. Usable only for the elements with a simple type in the XML schema. The precise display (text field, menu or checkbox) and the validation are done based on the XML schema constraints.
• formulaire: displays an element and all its sub-elements as a form, with a field for each sub-element. Beware not to use this type with elements that could have an infinitely deep sub-tree !
• plugin: if you want to define your own Jaxe element, it is possible ! See the section "Creation of new Jaxe elements" in the developer guide for more information.

Parameters can be specified for some element types, with the PARAMETRE element under BALISE.

The elements BALISE of type division and zone can have a parameter specifying the name of the attribute to use as a title for the element display.

The elements BALISE of type fichier must have a parameter specifying the attribute with the file name.

The elements BALISE of type tableau andtabletexte must have parameters specifying the elements for the rows and the cells.

The elements BALISE of type style must have a parameter specifying the style.

The elements BALISE of type zone and string can have a parameter specifying the style, a parameter with the font family, and a parameter with the font size.

The elements BALISE of type equation must have parameters specifying the attributes to use for the equation text and the image filename. The equations text must use a specific syntax.

Here is a list of all the parameters:

type	parameter name	description
division	titreAtt	attribute for the title
zone	titreAtt	attribute for the title
tableau	trTag	element for a line
tableau	tdTag	element for a cell
tableau	thTag	element for a header cell
liste	typeListe	type of list (POINTS|NUMEROS) (bulleted/ordered)
style	style	GRAS (bold) | ITALIQUE (italic) | EXPOSANT (superscript) | INDICE (subscript) | SOULIGNE (underlined)
string	police	font family
string	taille	font size
fichier	srcAtt	attribute with the file name
plugin	classe	Java class derived from JaxeElement
item	image1	first bullet image
item	image2	second bullet image
equation	srcAtt	attribute with the image filename
equation	texteAtt	attribute with the equation text

The following elements can be used for a simplified schema (when FICHIERSCHEMA is not specified):

SOUSBALISE

Link to a BALISE element, meaning this element can be found under the parent of the SOUSBALISE element.

ATTRIBUT

Attribute (must be under BALISE). Possible attributes are nom (attribute name) and presence (obligatoire (required) or optionelle (optional)).

VALEUR

Possible value for an attribute (must be under ATTRIBUT)

ENSEMBLE

Element set, containing BALISE elements. The name of the set, which can be used in SOUSBALISE, is specified with the attribute nom.

TEXTE

Used at the same level as SOUSBALISE, means that text can be found under the current element.

This file was created with Jaxe !