Versions Compared

Key

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

Table of Contents

Configuration guidelines and

...

naming conventions

  • CamelCase, no exceptions
    Not even if the brand name uses all caps, e.g. GFS
  • MapLayerFiles
    • Use attributes and templates
    • Use the attributeId from Delft-FEWS as the column header
    • CamelCase
    • attributeIds need to be unique, so think ahead
  •  ModuleConfigFiles
    • CamelCase, no underscores between components
    • <Action><Topic>Template.xml
    • Example: ImportGfs.xml
    • Subfolders postscript _MC (e.g. Import_MC)
  • RegionConfigFiles
    • List things alphabetically when there is no impact on the GUI, e.g.
      • ModuleInstanceDescriptors.xml
      • WorkflowDescriptors.xml
  • Split out files, e.g.
    • DisplayConfigFiles
      • GridDisplay.xml
    • RegionConfigFiles 
      • Filters.xml
      • LocationSets.xml
      • Topology.xml
      • WorkflowDescriptors.xml
    • SystemConfigFiles
      • DisplayGroups.xml
  •  WorkflowConfigFiles:
    • CamelCase, underscores between components
    • Examples: Import_Gfs.xml
    • Subfolders postscript _WF (e.g. Import_WF)

...