Create and edit wiki: Difference between revisions

From Atomix
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Overview =
= Overview =
The ATOMIX wiki makes use of forms/templates to simplify the categorization of the information. Each form allows the users to add any supporting information (figures, citations). Through these forms, users can optionally assign categories for the instrument type(s). The forms then parse information through the templates, which control the formatting.


Before creating a page,  '''please make sure no page already exists''' using the search tool!


Before creating a page,  '''please make sure no page already exists''' through the [[:Category:Concept]], [[:Category:Fundamentals]], [[:Category:Glossary]] lists, alternatively using the search tool!
= Editing existing pages =
 
* 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.
 
== Editing existing pages ==
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 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.


= Forms for creating new pages =
Please use the appropriate form to create new pages. This practice will ensure the pages can be easily editable and searchable via Category pages. Only two different forms exist:
# [[Concept]] for defining short, reusable [[:Category:Concept]] or longer derivations which are categorized as [[:Category:Fundamentals]].


== Creating new pages ==
# [[Form:Processing|Processing form]] enables adding categories for the level of processing and the instrument technology (point velocities, velocity profilers, or shear probes).
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:}}

Latest revision as of 23:22, 28 October 2021

Overview

The ATOMIX wiki makes use of forms/templates to simplify the categorization of the information. Each form allows the users to add any supporting information (figures, citations). Through these forms, users can optionally assign categories for the instrument type(s). The forms then parse information through the templates, which control the formatting.

Before creating a page,  please make sure no page already exists using the search tool!

Editing existing pages

If any page has edit with form (example) [INSERT EXAMPLE PIC], please use this option to edit the page to avoid destroying the wiki's organization.

Forms for creating new pages

Please use the appropriate form to create new pages. This practice will ensure the pages can be easily editable and searchable via Category pages. Only two different forms exist:

  1. Concept for defining short, reusable Category:Concept or longer derivations which are categorized as Category:Fundamentals.
  1. Processing form enables adding categories for the level of processing and the instrument technology (point velocities, velocity profilers, or shear probes).