How to use and contribute: Difference between revisions
From Atomix
m →Notes |
|||
| (34 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
We collated [[Editing tips|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 wiki|create and edit]] existing wiki pages provided they have a user account. | |||
=== Naming of new pages === | |||
* | Please follow the same [https://en.m.wikipedia.org/wiki/Wikipedia:Article_titles 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 <nowiki>[[Turbulence spectrum| turbulence page]]</nowiki> will link the words [[Turbulence spectrum| 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. | |||
==Watching pages== | |||
Each user has under their account profile their list of [[Special:Watchlist|watched pages]]. By default, all pages that you edit are "watched", but you can edit which ones and control how (if) you are notified about edits of these pages as they occur. | |||
== | == Peer-review and commenting == | ||
* Each page has a discussion page associated with it that allows users to discuss content about the page. | |||
** These discussion pages are '''not''' for tracking or versioning your edits. There's a "history" toggle you can use for this purpose. | |||
* Please take a look at [[Talk:How_to_use_and_contribute|discussion page]] for help on threaded comments to use on discussion pages. | |||
** Using 4 tildes <nowiki>~~~~</nowiki> will sign your username and date automatically | |||
* 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 it will be in the second half of 2022. | |||
* The [[:Form:ReviewStage|Review stage form]] and [[:Template:ReviewStage|template]] are being trialed to facilitate internal peer-reviewing. | |||
==Citing and references== | ==Citing and references== | ||
* | * To streamline formatting of published papers, please follow the instructions from the [[Template:Cite_journal| Cite journal]] template within the <nowiki><ref></ref></nowiki> tags. | ||
* | * By default, the formatted references will appear at the bottom of the page. It's good practice to place a section <nowiki>==Notes==</nowiki> at the bottom of the page. | ||
* The <nowiki><references/></nowiki> tag inserts the text of all the citations which have defined using <nowiki><ref></ref></nowiki>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 <nowiki>[[Category|Name_of_category]]</nowiki>. | |||
This page uses the <nowiki>[[Category|Help]]</nowiki> | |||
< | |||
</ | |||
[[Category:Help]] | |||
Latest revision as of 00:48, 17 December 2021
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.
Watching pages
Each user has under their account profile their list of watched pages. By default, all pages that you edit are "watched", but you can edit which ones and control how (if) you are notified about edits of these pages as they occur.
Peer-review and commenting
- Each page has a discussion page associated with it that allows users to discuss content about the page.
- These discussion pages are not for tracking or versioning your edits. There's a "history" toggle you can use for this purpose.
- Please take a look at discussion page for help on threaded comments to use on discussion pages.
- Using 4 tildes ~~~~ will sign your username and date automatically
- 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 it will be in the second half of 2022.
- The Review stage form and template are being trialed to facilitate internal peer-reviewing.
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:
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]]
