Metadata File Formats

Metadata files are always pipe-delimited, and have the extension .txt.

Documentation

If you would like formatted text to appear in the Schema Browser, you can supply a “documentation” entry for groups, tables, facilities and products. The file itself can contain markdown or plain text.

Please use one of the following extensions (to denote the format of a particular documentation file):

File Extension	File Contents
.md	Contains markdown-formatted documentation.
.txt	Contains plain text-formatted documentation.

The filename must be unique, and must be referenced in its corresponding metadata file. If you do not wish to supply documentation for a particular row, leave that entry blank.

If you would like to include email addresses in your documentation, please format as:

<a class="is-mailable" data-person="john.smith" data-domain="sydney.edu.au"></a>

This is an anti-spam measure: rather than placing raw html (easily harvested by spambots), a javascript-enabled browser is required to decode the address.

Important

Remember that the documentation mentioned here is uneditable once the data are released. Documentation intended for public use and/or subject to change (e.g., with detailed descriptions of analysis or version update information) should be maintained by the survey teams in Data Central’s Documentation portal: Documentation Central.