How to use and contribute: Difference between revisions

From Atomix
mNo edit summary
Line 1: Line 1:
= Creating and editing wiki pages =
==Overview==
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.   
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 ==
=== 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.
Please follow the same [https://en.m.wikipedia.org/wiki/Wikipedia:Article_titles guidelines] as Wikipedia when providing titles for any wiki pages.
* Don’t start titles with articles and prepositions  
* Don’t start titles with articles and prepositions  
Line 9: Line 12:
* Title should reflect the content of the page, and not be chosen to match nicely with the text that links to it.
* Title should reflect the content of the page, and not be chosen to match nicely with the text that links to it.


== Linking pages ==
=== Linking 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.
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.


=Categorizing information=
* [[:Category:Concept]] and [[:Category:Fundamentals]] pages can created using the same template/forms.


= Peer-review and commenting =
== Peer-review and commenting ==


* Please take a look at [[Talk:Main_Page |discussion page]] for help on threaded comments.
* Please take a look at [[Talk:Main_Page |discussion page]] for help on threaded comments.
* 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.
* 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=
==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.
* 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.


Line 27: Line 28:
* 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.
* 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.


= Tips and tricks =
==Categorizing information==
We collated [[Editing tips|editing tips]] for the wiki collected from other sources and individual's experiences using the wiki.
* [[:Category:Concept]] and [[:Category:Fundamentals]] pages can created using the same template/forms.
 
 





Revision as of 19:15, 26 November 2021

Overview

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.

  • Don’t start titles with articles and prepositions
  • No acronyms unless they are very 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 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.


Peer-review and commenting

  • Please take a look at discussion page for help on threaded comments.
  • 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