Versions Compared

Key

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

...

Dataset covers a limited area.


Editing the YAML File

Overview

The YAML file for each country (and the default YAML file from which they are derived), create a hierarchy:

  1. A top level Data Grid element which has
    1. One or more Category Elements (like "Admnistration" or "Population and Socio-Economic") which have
      1. One or more Subcategory Elements (like "Administrative Divisions" or "Populated Places") which have
        1. A set of rules for including and excluding datasets based on tags, dataset names, or any other query which has
          1. One or more include rules which specify one or more queries the results of which will be added to the data grid
          2. Zero or more exclude rules which specity datasets that should not be allowed in the data grid
        2. A set of metadata overrides which refer to datasets already included by the rules and define how they are displayed and comments that are displayed along with them.

In the normal practice of curation, only the include rules, exclude rules and metadata overrides need to be edited. 


Style Notes

  • Always end comment comments and descriptions with a period.  There will be some automatic notes added at the end (for freshness), so without the period, this would look odd.
  • At the beginning of a sentence say "Dataset . . . "  not "The dataset . . ."  for brevity.
  • refer to admin levels as adm1 adm2, etc
  • refer to "administrative divisions" instead of "administrative units" or "admin boundaries"