Create and edit wiki: Difference between revisions

From Atomix
No edit summary
Line 15: Line 15:


== Glossary ==
== Glossary ==
The form  automatically appends a [[:Category:Glossary]], and optional subcategories.  Please visit  this [[Form:NetcdfGlossary|link]] for a full explanation of the form.   
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.   
 
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.  
  '''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.
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.

Revision as of 19:10, 17 May 2021

Overview

The ATOMIX wiki makes use of forms/templates to simplify categorisation of the information. Each form allows the users to add any supporting information (figures, citations). Through these forms, users can optionally assign optional category for the instrument type(s). The information in the form are then parsed through templates that control the formatting.

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!

  • 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.
  • 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

Most users should be editing/creating pages through two types of forms:

  1. Glossary for mathematical and data symbols, with optional subcategories.
  2. Concept for defining short, reusable Category:Concept or longer derivations which are categorized as Category:Fundamentals.


Glossary

The form automatically appends a Category:Glossary, and optional subcategories. Please visit this 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.


Concept

The 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.

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.