This page will look better in a graphical browser that supports web standards, but is accessible to any browser or internet device.

Served by Samwise.

Cardiac Physiome Society workshop: November 6-9, 2017 , Toronto

JSim RTML Reference Manual

This page is for the current JSim version 2.0. Click here for the earlier JSim 1.6 version.

This documents provides the complete current specification for the JSim Run-Time Markup Language (RTML).

Prerequisites:

Contents:

RTML Design

Important note: RTML design is not yet finalized, so be aware that RTML created using the present document may need to be somewhat revised in for future JSim releases. The present document is not complete, but is intended to provide a starting point for a discussion of what the final RTML format should be. If you're interested in participating in this discussion, or designing tools that generate RTML, please contact the JSim development team.

RTML specifies content for a set of pages and (optionally) menus for navigating those pages. RTML pages are designed to meet the following criteria:

  1. pages are resizable based upon dynamic user magnification preference;
  2. amenable to the development of an interactive RTML editing tool (not yet available);
  3. superset of the functionality of XSIM configuration files (XSIM was a predecessor of JSim which provided model-specific markup);
  4. simplified design compared to XSIM.

RTML Document Structure

The root element of an RTML file should be named JSim . It has no supported attributes.

Within the JSim element, there may be one or more page elements and zero or one menu elements.

page elements

page elements contain the specification for content of a single RTML page. The JSim GUI currently allows the user to display only a single page at a time, although this may change at some future time.

RTML pages use an abstract coordinate system whose unit measure is the current font size of the JSim application. The default value is 12 points, but this is adjustable by the user via the "Project" tab "Preferences" menu. All items within an RTML page are rescaled whenever the use adjusts the current font size. The origin of this coordinate system is the upper left corner of the page. Coordinates are progressively larger moving right and down.

page elements support the following attributes:

The following elements are supported within an RTML page:

Example:

      <page name="Exchange vessel">
         <text pos="12 2.5" text="Very simple RTML page"/>
      </page>

text elements

A text element specifies arbitrary text within a page. This element supports the following attributes:

Example:

      <text pos="1.5 8" text="Electrolux. Better living today..."/>

table elements

A table element specifies a table of variables. Tables consist of three column: names, values and units. The vertical size of the tables is dependent upon the number of variables in the table in an, as yet, undocumented way. The width of the table is the sum of the widths of the three columns, as determined by the widths attribute. This element supports the following attributes:

A table elements must contain one or move var elements, each one representing a variable to appear in the table.

A var element represents a single variable within a table. var supports the following attributes:

Example:

      <table pos="60.4 24.6" widths="10 7 0">
        <var name="Flow">
        <var name="Vprime" text="V'">
      </table>

pageButton elements

A pageButton element specifies a hyperlink to another RTML page. This element supports the following attributes:

Example:

      <pageButton pos="10 15" name="Exchange vessel"/>

varButton elements

A varButton element specifies a button associated with a variable. Clicking the button will display additional information about the variable. Such buttons are very useful in conjunction with images to provide interactive model diagrams. This element supports the following attributes:

Example:

      <varButton pos="10 15" name="p_Kfed"/>

image elements

An image element specifies a pixel-based graphic image.

This element supports the following attributes:

Example:

      <image name="myocyte" pos="0 10" size="20 10"/>

menu elements

A menu element specifies a menu. The elements within the menu may be page references or sub-menus. There may be at most one menu in an RTML file. This menu will appear in the custom section of the "Pages" menu of the "Run Time" tab of a JSim model. If no menu is present in the custom RTML file, a default menu will be generated containing all the pages in the file. Attributes supported by menu are:

A menu item may contain only menu and page sub-elements.

A page element, within a menu, is a link to a page within the RTML document. The element supports the following attributes:

Example:

      <menu>
        <page name="head" text="Your Head"/>
        <page name="torso" text="Your Torso"/>
        <menu name="Your Legs...">
          <page name="Left"/>
          <page name="Right"/>
        </menu>
      </menu>

Comments or Questions?

[This page was last modified 06Jul12, 3:13 pm.]

Model development and archiving support at physiome.org provided by the following grants: NIH/NIBIB BE08407 Software Integration, JSim and SBW 6/1/09-5/31/13; NIH/NHLBI T15 HL88516-01 Modeling for Heart, Lung and Blood: From Cell to Organ, 4/1/07-3/31/11; NSF BES-0506477 Adaptive Multi-Scale Model Simulation, 8/15/05-7/31/08; NIH/NHLBI R01 HL073598 Core 3: 3D Imaging and Computer Modeling of the Respiratory Tract, 9/1/04-8/31/09; as well as prior support from NIH/NCRR P41 RR01243 Simulation Resource in Circulatory Mass Transport and Exchange, 12/1/1980-11/30/01 and NIH/NIBIB R01 EB001973 JSim: A Simulation Analysis Platform, 3/1/02-2/28/07.