Form:NetcdfGlossary: Difference between revisions
From Atomix
No edit summary |
No edit summary |
||
(17 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<noinclude> | <noinclude> | ||
This form defines mathematical variables and data channels collected by instruments. Some of the defined variables will be included in ATOMIX's NetCDF data format. | |||
= What this form does = | = What this form does = | ||
This form captures information required to define a mathematical variable or NetCDF data format. It passes the supplied fields to this [[Template:NetcdfGlossary|template]], so they can be formatted according to the template’s specifications. | This form captures information required to define a mathematical variable or NetCDF data format. It passes the supplied fields to this [[Template:NetcdfGlossary|template]], so they can be formatted according to the template’s specifications. | ||
Line 5: | Line 7: | ||
The template also automatically assigns the entry to Category:Glossary, and any (optional) instrument specific category if requested by the user. | The template also automatically assigns the entry to Category:Glossary, and any (optional) instrument specific category if requested by the user. | ||
= How to | = How to use the form= | ||
''' | First '''ensure no page already exists''' through the [[:Categories:Glossary]] category lists, or by using the search tool! | ||
* If one exists, you can '''edit with form''' on the page itself. | |||
* If none exists, '''create new page using the variable's standard/full name''', as opposed to a symbol. The supplied name is the wiki page's title. This will help make the category list more meaningful. For example, creating a page named ''Turbulent kinetic energy dissipation'' is more meaningful title than ''epsilon''. | |||
{{#forminput:form=NetcdfGlossary}} | {{#forminput:form=NetcdfGlossary}} | ||
</noinclude><includeonly> | </noinclude><includeonly> | ||
<div id="wikiPreview" style="display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;"></div> | <div id="wikiPreview" style="display: none; padding-bottom: 25px; margin-bottom: 25px; border-bottom: 1px solid #AAAAAA;"></div> | ||
Line 22: | Line 22: | ||
|- | |- | ||
! Parameter name: | ! Parameter name: | ||
! {{{field|parameter_name}}} | ! {{{field|parameter_name|mandatory}}} | ||
|- | |- | ||
| Symbol: | | Symbol: | ||
| {{{field|symbol | | {{{field|symbol|mandatory}}} | ||
| | |||
|- | |- | ||
| Description: | | Description: | ||
| {{{field|description|placeholder=Provide more information if needed.}}} | | {{{field|description|placeholder=Provide more information if needed.}}} | ||
|- | |- | ||
| Standard name: | | Standard name: | ||
| {{{field|standard_name|maxlength=100|placeholder=Use underscores to separate words, should be similar to wiki titlepage}}} | | {{{field|standard_name|mandatory|maxlength=100|placeholder=Use underscores to separate words, should be similar to wiki titlepage}}} | ||
|- | |- | ||
| Units: | | Units: | ||
| {{{field|units|placeholder= | | {{{field|units|placeholder=Can use <math></math> for TeX or just m s-1}}} | ||
|- | |- | ||
| CF-compliant: | | NetCDF CF-compliant: | ||
| {{{field|cf-compliant|input type=checkbox}}} | | {{{field|cf-compliant|input type=checkbox}}} | ||
|} | |} | ||
== Glossary subcategories (recommended) == | |||
{{{field|glossary_type|input type=radiobutton|values=Length and time scales,Nondimensional parameters,Fluid properties,Spectra,Background conditions, Turbulence}}} | |||
==Instrument categories (optional)== | ==Instrument categories (optional)== | ||
{{{field|instrument_type|input type=checkboxes|values =Velocity point-measurements,Velocity profilers,Shear probes}}} | {{{field|instrument_type| input type=checkboxes| values =Velocity point-measurements, Velocity profilers,Shear probes}}} | ||
{{{end template}}} | |||
==Free text== | ==Free text== | ||
Can include texts, images and citations. Anything that Wikimedia allows on normal pages. | Can include texts, images and citations. Anything that Wikimedia allows on normal pages. |
Latest revision as of 13:02, 18 May 2021
This form defines mathematical variables and data channels collected by instruments. Some of the defined variables will be included in ATOMIX's NetCDF data format.
What this form does
This form captures information required to define a mathematical variable or NetCDF data format. It passes the supplied fields to this template, so they can be formatted according to the template’s specifications.
The template also automatically assigns the entry to Category:Glossary, and any (optional) instrument specific category if requested by the user.
How to use the form
First ensure no page already exists through the Categories:Glossary category lists, or by using the search tool!
- If one exists, you can edit with form on the page itself.
- If none exists, create new page using the variable's standard/full name, as opposed to a symbol. The supplied name is the wiki page's title. This will help make the category list more meaningful. For example, creating a page named Turbulent kinetic energy dissipation is more meaningful title than epsilon.