How to use and contribute

We collated editing tips for the wiki collected from other sources and individual's experiences using the wiki. The information below provides some brief guidelines on creating and commenting ATOMIX's wiki pages.

Creating and editing wiki pages

Existing ATOMIX group members may create and edit existing wiki pages provided they have a user account.

Naming of new pages

Please follow the same guidelines as Wikipedia when providing titles for any wiki pages.

• Avoid starting titles with articles and prepositions (e.g., avoid "The" and "A")
• No acronyms unless they well known (e.g., ADCP)
• First letter is capitalised
• Title should reflect the content of the page, and not be chosen to match nicely with the text that links to it.

Linking (piping) pages

You can link to internal wiki pages via alternate text. For example writing [[Turbulence spectrum| turbulence page]] will link the words turbulence page to an internal page called Turbulence spectrum.

Format of new page

All pages should start with an introduction or lead of some sort, unless you're using the concept/fundamental form.

Peer-review and commenting

• Each page has a discussion page associated with it that allows users to discuss content about the page. It's not for tracking or versioning your edits. There's "history" toggle you can use for tracking changes and doing diffs with previous versions.
• Please take a look at discussion page for help on threaded comments to use on discussion pages.
• Using four tilde allows for automatic sign-off for each person
• Eventually, we'll be accepting comments from the community when the processing steps will be delineated on the wiki. We're in the process of establishing the how and where, but "when" is in 2022.

Citing and references

• To streamline formatting of published papers, please follow the instructions from the Cite journal template within the <ref></ref> tags.

• By default, the formatted references will appear at the bottom of the page. It's good practice to place a section ==Notes== at the bottom of the page.

• The <references/> tag inserts the text of all the citations which have defined using <ref></ref>tags up to that point in the page.

Categorizing information

There are a few categories for organising pages. Whenever possible, please include the subgroup categories:

• Category:Shear_probes
• Category:Velocity_point-measurements
• Category:Velocity_profilers‏‎

at the bottom of the page when not using "edit with forms" such as those associated with

• Category:Concept and Category:Fundamentals pages.

To add a category use [[Category|Name_of_category]]. 

This page uses the [[Category|Help]]