How to contribute to www.SklogWiki.org: Difference between revisions

From SklogWiki
Jump to navigation Jump to search
No edit summary
m (Removed outdated material)
 
(30 intermediate revisions by 6 users not shown)
Line 1: Line 1:
==Open access==
This page is an introduction to editing [[Main Page |SklogWiki]]. SklogWiki uses the [http://www.mediawiki.org/wiki/MediaWiki MediaWiki wiki package], the very same as that used by Wikipedia. So, if you have ever contributed to Wikipedia then you are already familiar with how to edit SklogWiki. If not, then editing is fairly simple once one has had a little experience, and this page is intended to help in this process. See also the [[SklogWiki style guide]].
 
==How to edit an existing page==
Sklogwiki is, and hopefully will remain, open-access. That is to say, anybody with an internet connection
can contribute to and edit SklogWiki. Here is how to do so...  
 
==How to edit a page==
 
At the top of each page there are a number of 'tabs' with various functions:
At the top of each page there are a number of 'tabs' with various functions:
[[Image:Tabs.png|thumb|left|tabs]]<br/>
<br/>
<br/>
<br/>
To edit a page simply click on 'edit'. This will open a region at the bottom of the page  
To edit a page simply click on 'edit'. This will open a region at the bottom of the page  
in which you can work.
in which you can work.
 
==How to create a new page==
In order to create a new page, enter the name of the page into the search query box on the left, and then click on '''Go'''.
If the desired page does not exist you will see:
:'''There is no page titled "page_you_want_to_create".''' You can <FONT COLOR="#cd2626">create this page</FONT>.
Simply click on the red link and start creating the new page.
==Basic syntax==
==Basic syntax==


Line 23: Line 17:
External links are encapsulated within a single  square parenthesis, for example:<br />
External links are encapsulated within a single  square parenthesis, for example:<br />


<tt><nowiki>[http://www.example.org]</nowiki></tt> results in  [http://www.example.org]<br />
<tt><nowiki>[http://www.sklogwiki.org]</nowiki></tt> results in  [http://www.sklogwiki.org]<br />
<tt><nowiki>[http://www.example.org display text]</nowiki></tt>results in  [http://www.example.org display text]<br />
<tt><nowiki>[http://www.sklogwiki.org sklogwiki]</nowiki></tt>results in  [http://www.sklogwiki.org sklogwiki]<br />
<tt><nowiki>http://www.example.org</nowiki></tt> results in  http://www.example.org <br />
<tt><nowiki>http://www.sklogwiki.org</nowiki></tt> results in  http://www.sklogwiki.org <br />


To add '''headlines''':<br />
To add '''headlines''':<br />
Line 69: Line 63:
## two point one
## two point one
# three
# three
 
==Mathematics==
To write an equation, using [[LaTeX math markup]]:<br />
To write an equation, using [[LaTeX math markup]]:<br />
<tt><nowiki>:<math>c_{ij}(r)= \sum_{n=1} \frac{K_{ij}}{r}e^{-z_nr} ~~~~~~ \sigma_{ij} < r </math></nowiki></tt><br />
<tt><nowiki>:<math>c_{ij}(r)= \sum_{n=1} \frac{K_{ij}}{r}e^{-z_nr} ~~~~~~ \sigma_{ij} < r </math></nowiki></tt><br />
Line 75: Line 69:
:<math>c_{ij}(r)= \sum_{n=1} \frac{K_{ij}}{r}e^{-z_nr} ~~~~~~ \sigma_{ij} < r </math>
:<math>c_{ij}(r)= \sum_{n=1} \frac{K_{ij}}{r}e^{-z_nr} ~~~~~~ \sigma_{ij} < r </math>


In other words, simply place standard LaTeX between the Mediawiki metatags <nowiki><math></nowiki> and <nowiki></math></nowiki>.
==Images==
And finally, to add a 'thumbnail image on the right hand side of the page:
And finally, to add a 'thumbnail image on the right hand side of the page:


Line 82: Line 78:




The bet way to learn is to start editing. You can check the results by using '''Show preview''' before  
The best way to learn is to start editing. You can check the results by using '''Show preview''' before  
saving the page.
saving the page.


All of these functions can be accessed by typing the mark-up directly, or by using the icons located at the top
All of these functions can be accessed by typing the mark-up directly, or by using the icons located at the top
of the edit region.
of the edit region.
==Template messages==
A [[SklogWiki:Template_messages | list of template messages]].
==Adding a table to a page==
For an example of a table see the page : [[Tables]].
==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 on-line paper can almost always be found somewhere in the on-line abstract of an article.
By placing this code after  <nowiki>http://dx.doi.org/</nowiki> one is led directly to the on-line version of the paper.
Using the [http://www.mediawiki.org/wiki/Extension:Cite/Cite.php Cite] extension:
<nowiki><ref>[http://dx.doi.org/---DOI--- Author "Title", Journal '''volume''' pp. firstPage-lastPage (year)]</ref></nowiki>
There is no particular preference in SklogWiki regarding the use of the serial comma in the author list.
===Use of the Cite extension===
The extension [http://www.mediawiki.org/wiki/Extension:Cite/Cite.php Cite] allows references to be added in the body of an article in the following manner:
<nowiki><ref> Publication to be referenced </ref></nowiki>
and in the references section place the tag
<nowiki>==Refereces==</nowiki>
<nowiki><references/></nowiki>
See [http://www.mediawiki.org/wiki/Extension:Cite/Cite.php Cite] for more details, such as multiple references to the same article.
===No reference given===
Ideally almost all of the material in SklogWiki should be accompanied with a reference. However, if the original reference cannot be located, or will be added later, the please use the <nowiki>{{reference needed}}</nowiki> template, which produces a question mark citation like this {{reference needed}}.


==Jmol==
{{Jmol_general|C60.pdb|C<sub>60</sub>}}
It is also possible to add a [http://jmol.sourceforge.net/ Jmol] applet to a page. Jmol is an open-source Java viewer for chemical structures in 3D. The prefered method in SklogWiki is to also create a new page which solely  contains the molecular structure file, preferably in [http://www.rcsb.org/pdb/home/home.do Protein Data Bank] (pdb) format.
Then on the page where one wishes to display the molecule insert the following line:
:<nowiki>{{Jmol_general|File.pdb|Caption}}</nowiki>
For example, on this page, to produce the rotating [[C60]] structure on the right, we have inserted the line:
:<nowiki>{{Jmol_general|C60.pdb|C<sub>60</sub>}}</nowiki>
which reads the structural data from the page [[C60.pdb]].
[[category: Contains Jmol]]
==Open access==
Sklogwiki is, and will remain, open-access. That is to say, anybody with an internet connection
can contribute to and edit SklogWiki.


__NOTOC__
[[category:help]]

Latest revision as of 16:41, 9 January 2018

This page is an introduction to editing SklogWiki. SklogWiki uses the MediaWiki wiki package, the very same as that used by Wikipedia. So, if you have ever contributed to Wikipedia then you are already familiar with how to edit SklogWiki. If not, then editing is fairly simple once one has had a little experience, and this page is intended to help in this process. See also the SklogWiki style guide.

How to edit an existing page[edit]

At the top of each page there are a number of 'tabs' with various functions: To edit a page simply click on 'edit'. This will open a region at the bottom of the page in which you can work.

How to create a new page[edit]

In order to create a new page, enter the name of the page into the search query box on the left, and then click on Go. If the desired page does not exist you will see:

There is no page titled "page_you_want_to_create". You can create this page.

Simply click on the red link and start creating the new page.

Basic syntax[edit]

To add Bold text encapsulate the text within three apostrophes: '''Bold text'''
To add Italic text encapsulate the text within two apostrophes: ''Italic text''
To add both bold & italic text use five apostrophes: '''''bold & italic'''''
To add a link to a page within SklogWiki encapsulate the text within two square parenthesis [[page to link to]]
External links are encapsulated within a single square parenthesis, for example:

[http://www.sklogwiki.org] results in  [1]
[http://www.sklogwiki.org sklogwiki]results in sklogwiki
http://www.sklogwiki.org results in http://www.sklogwiki.org

To add headlines:

Level 1[edit]

encapsulate the heading between two 'equals' signs: == Level 1 ==

Level 2[edit]

encapsulate the heading between three 'equals' signs: === Level 2 ===

Level 3[edit]

encapsulate the heading between four 'equals' signs: ==== Level 3 ====

Level 4[edit]

encapsulate the heading between five 'equals' signs: ===== Level 4 =====

Level 5[edit]

encapsulate the heading between six 'equals' signs: ====== Level 5 ======


To create a bullet list use asterisks:
* one
* two
** two point one
* three

results in:

  • one
  • two
    • two point one
  • three

To create a numbered list use the hash symbol:
# one
# two
## two point one
# three

results in

  1. one
  2. two
    1. two point one
  3. three

Mathematics[edit]

To write an equation, using LaTeX math markup:
:<math>c_{ij}(r)= \sum_{n=1} \frac{K_{ij}}{r}e^{-z_nr} ~~~~~~ \sigma_{ij} < r </math>
reults in:

In other words, simply place standard LaTeX between the Mediawiki metatags <math> and </math>.

Images[edit]

And finally, to add a 'thumbnail image on the right hand side of the page:

[[Image:Wiki.png|thumb|Caption text]]

Caption text


The best way to learn is to start editing. You can check the results by using Show preview before saving the page.

All of these functions can be accessed by typing the mark-up directly, or by using the icons located at the top of the edit region.

Template messages[edit]

A list of template messages.

Adding a table to a page[edit]

For an example of a table see the page : Tables.

DOI and References[edit]

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

Using the Cite extension:

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

There is no particular preference in SklogWiki regarding the use of the serial comma in the author list.

Use of the Cite extension[edit]

The extension Cite allows references to be added in the body of an article in the following manner:

<ref> Publication to be referenced </ref>

and in the references section place the tag

==Refereces==
<references/>

See Cite for more details, such as multiple references to the same article.

No reference given[edit]

Ideally almost all of the material in SklogWiki should be accompanied with a reference. However, if the original reference cannot be located, or will be added later, the please use the {{reference needed}} template, which produces a question mark citation like this [?] .

Jmol[edit]

<jmol>

 <jmolApplet>
 <script>set spin X 10; spin on</script>
 <size>200</size>
 <color>lightgrey</color>
   <wikiPageContents>C60.pdb</wikiPageContents>
</jmolApplet>
</jmol>
C60


It is also possible to add a Jmol applet to a page. Jmol is an open-source Java viewer for chemical structures in 3D. The prefered method in SklogWiki is to also create a new page which solely contains the molecular structure file, preferably in Protein Data Bank (pdb) format. Then on the page where one wishes to display the molecule insert the following line:

{{Jmol_general|File.pdb|Caption}}

For example, on this page, to produce the rotating C60 structure on the right, we have inserted the line:

{{Jmol_general|C60.pdb|C<sub>60</sub>}}

which reads the structural data from the page C60.pdb.

Open access[edit]

Sklogwiki is, and will remain, open-access. That is to say, anybody with an internet connection can contribute to and edit SklogWiki.