MathFlow toolbar definition language

The tb element is the top-level wrapper for a complete toolbar description. Every configuration description consists of a single tb element.

Attributes

Specifying size=s indicates that all buttons on the toolbar and pull-down palettes should be the small size, unless otherwise indicated. Similarly, size=l (lowercase L) indicates buttons should be large, size=w should be wide, and size=ws should be wide and small.

Examples

<tb><btn>alpha</btn><incl name='#toolbox'/></tb>
                

<tb size='s'><btn>alpha</btn><incl name='#toolbox'/></tb>

The row element is the top-level wrapper for a toolbar row description. Every row description consists of a single row element, which may be inferred if the toolbar has only 1 row. Each row element is a child only of the tb element.

Attributes

Specifying size=s indicates that all buttons on the toolbar and pull-down palettes should be the small size, unless otherwise indicated. Similarly, size=l (lowercase L) indicates buttons should be large, size=w should be wide, and size=ws should be wide and small.

The btn element is used to place a button on the toolbar. The contents of the element determine the image that will appear on the button and what it does. The contents of a btn element can be:

Consult the tables of predefined Templates, Palettes, Palette Labels, and MathFlow characters for a complete listing.

When a character or character name is given as the content of the btn element, a button is created displaying that character. When clicked, the button inserts the same character at the current cursor location.

When the imagesrc attribute is present, the image indicated will be used for the button face, regardless of the element's content. The action for the button is identical to what it would be without the attribute. The image will be scaled and centered on the button.

Attributes

When creating a button to insert a character, there is an issue of what MathML code to generate. Some characters can be used as identifiers, numbers or operators, and thus should be tagged with the MI, MN, and MO MathML elements respectively. MathFlow tries to guess according to the following rules:

By specifying a type attribute on a btn element, you can override this default behavior, and specify which element you would like to have generated.

Similarly, MathFlow displays a default status line message when a reader mouses over a button on the toolbar. For characters, this default message is just the character name. For other icons and templates, the default message varies. By giving a cue attribute, you can specify your own status line message to be displayed when mousing over the button.

Children

When using a MathML string for a button, you can differentiate the MathML used to display an image on the button from the MathML that is inserted into the editor. This allows you to "tweak" the MathML to appear correctly depending on where it is displayed. The content of the btn element indicates the MathML to be displayed on the button. The optional child element insertas indicates the MathML to be inserted into the editor.

Examples

<tb><btn>A</btn><btn>alpha</btn><btn>FRAC</btn><btn>CUT</btn></tb>
                

<tb><btn type='mn'>I</btn><btn type='mn'>V</btn>
                 <btn type='mn'>X</btn><btn type='mn'>L</btn><btn type='mn'>C</btn></tb>
                

<tb><btn cue='force'>F</btn><btn cue='mass'>m</btn>
                 <btn cue='velocity'>v</btn></tb>
                

<tb>
                 <btn cue='Subscript (Ctrl+B)'>
                 <math><msub><mi>&template;</mi><mi>&template;</mi></msub></math>
                 <insertas>
                 <math><msub><template/><template/></msub></math>
                 </insertas>
                 </btn>
                </tb>

The sep element is an empty element which creates a vertical separator on the toolbar or pull-down palette. This is useful for visually grouping similar items on a toolbar or palette.

Attributes

None.

Example

<tb><btn>FRAC</btn><btn>SUP</btn><btn>SQRT</btn><sep/>
                 <btn>infin</btn><btn>angle</btn><btn>theta</btn></tb>

The incl element inserts a pre-defined toolbar component at that location in the configuration description. In effect, this element works like a bare-bones macro capability, with a collection of pre-defined macros that expand before processing.

Consult the table of pre-defined Templates and Palettes for a complete listing of pre-defined components. Most of them are complete pre-defined pull-down palettes, such as a trig palette, Greek letter palettes, and so on. Several complete toolbars are also pre-defined.

Pre-defined component names all begin with a "#" character.

Attributes

The incl is an empty element; the pre-defined component to insert is specified by the name attribute. If the value is unrecognized, the include is ignored by MathFlow

Example

<tb><btn>LCGREEKPALETTE</btn><sub size='s'><incl name='#greek'/></sub><sep/>
                 <btn>TOOLBOX</btn><sub cols='3' size='s'><incl name='#toolbox'/></sub></tb>

The Palettes toolbar has the following qualities:

The Tabbed toolbar has the following qualities:

The mini toolbar is combined on the same line as the MathML ancestry. Included on the mini toolbar are: