Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The contents of the forecast table can be configured using the forecastTable key. The schema for this section is as follows:

The time zone can be specified with the TimeZone key; for now, only "GMT" is supported.

Using the Header header key, the column headers of columns in the forecast table can be specified. A column can be added with the the Column column key. The value of this key is used as the name in the header of that column. For each column an id attribute must be specified. Furthermore, the following optional attributes may be specified for a column:

  • unit: a string containing the unit for the column (e.g. "cm" for a water level),
  • isEditable: a flag with value true or false indicating whether the column is editable for the user (e.g. the user can enter the forecast in this column),
  • isExport: a flag with value true or false indicating whether the column must be exported to file if the forecast is published (editable columns are exported by default),
  • exportName: a string containing the name that must be used for exporting the column to file.,
  • lang: a string that specifies the language of the header; this attribute behaves the same as for the Title title keys.

For example, the header section in the forecast table may look like:

Code Block
xml
xml
<Header><header>
   <Column<column id="station">station</Column>column>
   <Column<column id="date">date</Column>column>
   <Column<column id="time">time</Column>column>
   <Column<column id="astro_level" isExport="true" exportName="H.tidal.astronomic" unit="cm">astronomical water level</Column>column>
   <Column<column id="water_level" isEditable="true" exportName="H.tidal.peak" unit="cm">water level</Column>column>
   <Column<column id="discharge" isEditable="true" exportName="Q" unit="m^3/s">discharge</Column>column>
</Header>header>

Rows can be added to the forecast table by specifying the Row row key. The number of rows is arbitrary. For each row, an identifier must be specified using the id attribute. Content for a row is added using the Cell cell key, where each cell must correspond to a column in the header. This can be achieved with the columnId attribute of the Row row key. For example:

Code Block
xml
xml
<Row<row id="Vlissingen">
   <Cell<cell columnId="station">Vlissingen</Cell>cell>
   <Cell<cell columnId="date">12 Mar</Cell>cell>
   <Cell<cell columnId="time">17h16</Cell>cell>
   <Cell<cell columnId="astro_level">237</Cell>cell>
</Row>row>

The Cell cell key also supports a lang attribute that behaves the same as for the Title title keys.

Example

A complete example of a script configuration is given here:

...