SklogWiki style guide: Difference between revisions

From SklogWiki
Jump to navigation Jump to search
(New page: ==Acronyms== Try to '''avoid the use of acronyms'''. You yourself may be over-familiar with a particular set of acronyms. However, SklogWiki is open to all, and acronyms can be confusing ...)
 
mNo edit summary
Line 2: Line 2:
Try to '''avoid the use of acronyms'''. You yourself may be over-familiar with a particular set of acronyms.
Try to '''avoid the use of acronyms'''. You yourself may be over-familiar with a particular set of acronyms.
However,  SklogWiki is open to all, and acronyms can be confusing and/or off-putting.
However,  SklogWiki is open to all, and acronyms can be confusing and/or off-putting.
SklogWiki pages have no space restrictions, unlike published papers; so always expand your acronym.  
SklogWiki pages have no space restrictions, unlike published papers; so always try expand your acronym.
At the very least, any  acronym must be defined within the page it is used.
==Notation==
==Notation==
Try try use, where possible, the [http://www.iupac.org/ International Union of Pure and Applied Chemistry] approved [http://www.iupac.org/general/FAQs/ns.html nomenclature and symbols].  
Try try use, where possible, the [http://www.iupac.org/ International Union of Pure and Applied Chemistry] approved [http://www.iupac.org/general/FAQs/ns.html nomenclature and symbols].  
For example, in the [http://goldbook.iupac.org/index.html IUPAC Compendium of Chemical Terminology], popularly known as the ''Gold Book'', the Helmholtz free energy is now known as the [[Helmholtz energy function | Helmholtz energy (function)]] (<math>A</math>).
For example, in the [http://goldbook.iupac.org/index.html IUPAC Compendium of Chemical Terminology], popularly known as the ''Gold Book'', the Helmholtz free energy is now known as the [[Helmholtz energy function | Helmholtz energy (function)]] (<math>A</math>).
==Equations==
==Equations==
Indent equations by placing a colon before the equation.  
The equations are formed using [[LaTeX math markup]].
Indent equations by placing a colon before the equation.
==DOI and References==
==DOI and References==
Link to published papers by using (when possible) its [http://www.doi.org/ Digital Object Identifier]. The Digital Object Identifier
of an online paper can almost always be found somewhere in the online abstract of an article.
By placing this code after  http://dx.doi.org/ one is led directly to the online version of the paper.
At the moment references are made roughly as follows
At the moment references are made roughly as follows


  #[ http://dx.doi.org/---DOI--- Author, "Title", Journal, '''volume''', pp. pages-pages (year)].
  #[ http://dx.doi.org/---DOI--- Author, "Title", Journal, '''volume''', pp. firstPage-lastPage (year)].
==Material from Wikipedia==
 
==Professional==
==Professional==
SklogWiki is a 'professional' Wiki; comments of a personal nature are not permitted.
SklogWiki is a 'professional' Wiki; comments of a personal nature are not permitted.

Revision as of 13:02, 26 February 2007

Acronyms

Try to avoid the use of acronyms. You yourself may be over-familiar with a particular set of acronyms. However, SklogWiki is open to all, and acronyms can be confusing and/or off-putting. SklogWiki pages have no space restrictions, unlike published papers; so always try expand your acronym. At the very least, any acronym must be defined within the page it is used.

Notation

Try try use, where possible, the International Union of Pure and Applied Chemistry approved nomenclature and symbols. For example, in the IUPAC Compendium of Chemical Terminology, popularly known as the Gold Book, the Helmholtz free energy is now known as the Helmholtz energy (function) ().

Equations

The equations are formed using LaTeX math markup. Indent equations by placing a colon before the equation.

DOI and References

Link to published papers by using (when possible) its Digital Object Identifier. The Digital Object Identifier of an online paper can almost always be found somewhere in the online abstract of an article. By placing this code after http://dx.doi.org/ one is led directly to the online version of the paper.

At the moment references are made roughly as follows

#[ http://dx.doi.org/---DOI--- Author, "Title", Journal, volume, pp. firstPage-lastPage (year)].

Material from Wikipedia

Professional

SklogWiki is a 'professional' Wiki; comments of a personal nature are not permitted.