VariableXML_ConfigFile

Introduction

The MapVariable.xml and ChartVariable.xml configuration files controls the list of variables and tree structure in the maps and charts. NB there is some overlap with the external_config_files/CarbonesConfig_NCWMS.xml which also needs to be updated. The list can be hierarchical i.e. it can contain multiple levels of folders.

Notes

Element
Meaning
Notes

tooltip
Explanatory tooltip displayed in the maps (and perhaps in future in the graphs
The tooltip element must be the second-to-last element in its parent node element. This is due to the XML reading logic in TreePane.js (code.google.com) getTooltipFromItem

description
Caption for map tree control and graph drop-down

variablecodes.customLabel
Longer caption
Shown in the charts when the drop-down menu is collapsed. Shown in the maps at the top-left of the toolbar. The caption must be comprehensible as a brief stand-alone caption, independent of the tree structure. E.g. it should indicate whether the variable is a flux or a stock.

variablecodes.codeName
Variable code name
Used to identify the graph data in the database and the WMS layers. See the CarbonesVariablesAndCodeNames

Example

<root>
  <node>
    <description>Carbon fluxes</description>
      <node>
        <description>Net fluxes</description>
        <node>
      <description>Total carbon fluxes </description>
          <tooltip>The total net flow of carbon between the atmosphere and the ecosystem, including natural causes and human activity.</tooltip>
          <variablecodes customLabel="Total carbon fluxes" id="11"
            parentCode="CF" codeName="nc_20110818/Ftot" 
            threeHrlyUnit="GtC/hour" dailyUnit="GtC/day" 
            monthlyUnit="GtC/month" yearlyUnit="GtC/year" />
        </node>
        <!-- more nodes -->
      </node>
  </node>
</root>