How to use and contribute: Difference between revisions

From Atomix
No edit summary
No edit summary
Line 1: Line 1:
= Contributing to the wiki =
= Creating and editing wiki pages =
* You can create new pages and edit existing ones provided you have a user account.
* You can create new pages and edit existing ones provided you have a user account using the steps detailed [[Create and edit wiki | here]].
 
* At the moment, only [[:Category:Concept]] and [[:Category:Glossary]] pages should be edited by anyone.
[[Create and edit wiki]]
   
First '''ensure no page already exists''' through the [[:Category:Concept]], [[:Category:Fundamentals]],   
= Commenting =
[[:Category:Glossary]] lists, alternatively using the search tool!
Eventually, we'll be accepting comments from the community when the processing steps will be delineated on the wiki.
 
If any page has '''edit with form''' ([[Acoustic-Doppler_Velocimeters|example]])  [INSERT EXAMPLE PIC], please use this option to edit the page to avoid destroying the wiki's organization.
 
* If the information doesn't exist, please use the appropriate form to create new pages. This will ensure  they can be easily editable and searchable via Category pages.
 
= Forms =
There are two forms i.e., page types that can be used by anyone on the wiki:
# [[Form:NetcdfGlossary|Glossary]] for mathematical and data symbols, with optional subcategories.
# [[Form:DefineConcept|Concept]] for defining short, reusable [[:Category:Concept]] or longer derivations which are categorized as [[:Category: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 form  automatically appends a [[:Category:Glossary]], and optional subcategories.  Please visit  this [[Form:NetcdfGlossary|link]] for a full explanation of the form. 
 
If no page already exists, create one by inserting its title in the box below. 
'''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''. Mediawiki always converts the first letter into capital. Refrain from using capital letters elsewhere in the page definition.
{{#forminput:form=NetcdfGlossary}}
 
== Concept ==
The [[Form:DefineConcept| Concept form]] will ask if you are creating  a [[:Category:Concept]], or a [[:Category:Fundamentals]] page. This can be changed later using ''edit with form''. Here's an example concept for [[Acoustic-Doppler Velocimeters]] developed using the [[Form:DefineConcept|form]].
 
If a concept becomes long, i.e., contains too many topics, consider splitting the page into smaller concepts. A fundamentals page should be reserved for describing/linking multiple concepts.
Please create pages using a descriptive title page. This will help make the category list more meaningful. For example, creating a page named ''Velocity despiking'' is more meaningful title than ''despike''.
 
{{#forminput:form=DefineConcept}}
 
 




{{#default_form:}}
{{#default_form:}}

Revision as of 18:58, 17 May 2021

Creating and editing wiki pages

  • You can create new pages and edit existing ones provided you have a user account using the steps detailed here.
  • At the moment, only Category:Concept and Category:Glossary pages should be edited by anyone.

Commenting

Eventually, we'll be accepting comments from the community when the processing steps will be delineated on the wiki.


{{#default_form:}}