How to use and contribute: Difference between revisions

From Atomix
Line 12: Line 12:


== Glossary ==
== Glossary ==
The glossary is for defining mathematical symbols and NetCDF variables. Please use this [[Form:NetcdfGlossary|form]] or the '''edit with form''' ([[Turbulent kinetic energy dissipation|example]]). These pages are automatically appended a category '''Glossary'''.
The glossary is for defining mathematical symbols and NetCDF variables.  
 
First '''ensure no page already exists''' through the [[:Categories:Glossary]] list, otherwise simply visit the page and '''edit with form''' ([[Turbulent kinetic energy dissipation|example]]). These pages are automatically appended a category '''Glossary'''.




If creating a new page '''please use the variable's standard/full name''' as the title instead of a symbol. The supplied name is the wiki page's title.  This will help make the list more meaningful. For example, creating a page named ''Turbulent kinetic energy dissipation'' is more meaningful title than ''epsilon''.
If creating a new page '''please use the variable's standard/full name''' as the title instead of a symbol. The supplied name is the wiki page's title.  This will help make the 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}}
Please see this [[Form:NetcdfGlossary|link]] for a full explanation of the form.


== Concept ==  
== Concept ==  

Revision as of 15:44, 17 May 2021

Contributing to the wiki

Please use the appropriate form to create new pages, so they can be searchable via Category pages. First ensure no page already exists through the Categories: Concept, Fundamentals, Glossary.

If any page has edit with form (example) [INSERT EXAMPLE PIC], please use this option to edit the page to avoid ruining the organisation of the wiki.

Forms

There are two forms i.e., page types that can be used by anyone on the wiki:

  1. Glossary for mathematical and data symbols
  2. Concept for defining short, reusable Concepts or longer derivations which are categorized as Fundamentals

The templates control the formatting, but a free form text box allows the users to add any supporting information (figures, citations). Through these forms, users can optionally assign optional category for the instrument type(s).

Glossary

The glossary is for defining mathematical symbols and NetCDF variables.

First ensure no page already exists through the Categories:Glossary list, otherwise simply visit the page and edit with form (example). These pages are automatically appended a category Glossary.


If creating a new page please use the variable's standard/full name as the title instead of a symbol. The supplied name is the wiki page's title. This will help make the list more meaningful. For example, creating a page named Turbulent kinetic energy dissipation is more meaningful title than epsilon. {{#forminput:form=NetcdfGlossary}}

Please see this link for a full explanation of the form.

Concept

For any definitions, concepts, or processing steps that need describing please use this form, but first ensure no page already exists through the Categories Concept and/or Fundamentals.

The form will ask if you are creating a Concept, or a Fundamentals page. If a concept becomes long, i.e., contains too many topics, consider making it a fundamentals page or splitting the page into smaller concepts.

{{#default_form:}}