Snippets appear as XML (text) files, sometimes with a version number in the file name. This version number is the OpenMalaria schema version that the snippet was written for or checked against, however most snippets will be forward-compatible. The XML snippets are stored in separate folders corresponding to the main XML elements that make up a valid scenario file.
In addition to the XML snippets, there are also XML templates corresponding to each OpenMalaria schema version e.g. 'scenario_33.xml'. A fully functional scenario file is constructed by pasting a complete set of snippets into one of the templates........
Each file contains some comments and a chunk of XML code which can be pasted into a larger OpenMalaria scenario XML.
Some special comments may appear at the beginning of the file:
<!-- min-version: 30 -->
<!-- max-version: 36 -->
<!-- snippet: om:demography -->
The min- and max-version tags specify limits to the range of compatible OpenMalaria versions. They do not need to appear; e.g. if the snippet is compatible with the latest version it doesn't make sense to specify the max-version (unless it is expected that the next version will be incompatible).
The snippet: tag is used to specify where the snippet may appear; e.g. there should be a comment like the following somewhere in another snippet (a
template):
<!-- placeholder: om:demography -->
Variations on this hint at how many items can be inserted here (optional: zero or one, any: zero or more, multiple: one or more):
<!-- placeholder-optional: om:pharmacology -->
<!-- placeholder-any: om:intervention-elt -->
<!-- placeholder-multiple: om:vector-pop-intervention -->
In addition, each file should contain some commentry of its source, its purpose and how its parameters were obtained.
Contributions of new publishable and documented snippets are welcomed. If you can edit this wiki you should also be able to amend this library yourself, by cloning the git repository with this git-specific link: git://github.com:SwissTPH/openmalaria.snippets; alternatively contact the OpenMalaria developer.
If you need to consult XML elements and attributes for a certain version select the appropriate version from here