How to contribute: Difference between revisions

From KBwiki
Jump to navigation Jump to search
(New page: =How to contribute material to the Knowledge Base=)
 
No edit summary
Line 1: Line 1:
=How to contribute material to the Knowledge Base=
== Contributing material to the QNET Knowledge Base ==
In this article, the basic procedures for authoring content for the QNET Wiki are described.  These notes are intended for those QNET users who have previously submitted a request to contribute a QNET article (eg, for an AC or UFR).  The procedure for requesting new content is not described here but is outlined elsewhere on this site [].  Therefore, the basic assumption is that a new QNET article has already been set up with individual links between the article pages in place.  The notes contained here are intended to help the contributor to populate these pages with the basic technical content he or she wishes to add.
 
The information on this page is also of interest to visitors who wish to leave short comments on the Discussion page of each Wiki article.
 
== Basic Steps ==
 
=== General Advice ===
* '''Keep it simple!'''  Each AC or UFR is intended to be the size of typical journal article and Each page within an AC or UFR should be no more than 3-4 screen-fulls of text at most.  If your reader is scrolling up and down
 
== Adding Images ==
* Save the image you need to a file on your machine, giving it a memorable name- whatever you deem appropiate.
* In the editing page make sure your cursor is in the required location for your image then on the top where all the tool icons are, click on the icon that looks like a little picture frame, titled "embedded file".
This will generate an internal image link which looks like this; [[Image:Example.jpg]]
To upload the image you have saved go to the left hand navigation bar and click on "Upload file" under the "Tool Box" folder.
Click on "Browse" to find the saved image and then once located click on "Upload File".
The desired image should come up with its precise location name. This is important because if you don't put the exact name of the uploaded picture into the image link, the picture will not be viewed in the wiki, instead a red link will come up showing that something is wrong with this image file. The name of the uploaded file will be shown in blue under the picture once you have clicked on the "Upload File" button.
Go back into your editing page by clicking on the back bar, and type into the image link the name of your uploaded image ie; [[Image:wavevortex_1.gif]]; [[Image:wave_vortex_1.GIF]];  [[Image:Wave vortex1.gif]]
These examples are to show you how to enter your image name. Make sure you leave in Image:. Just to clarify the uploaded image name could have underscores, capitol letters, spaces, numbers etc you have to make sure that when you name the image link it must be exactly the same name as the uploaded image.
Then click on save at the bottom of the editing page and the image should appear in the wiki. If all you get is a red link instead of a picture it is probably because the name has not been recongnised.
 
 
== Adding Tables ==
 
== Adding Equations ==
 
 
== References ==

Revision as of 12:39, 2 July 2009

Contributing material to the QNET Knowledge Base

In this article, the basic procedures for authoring content for the QNET Wiki are described. These notes are intended for those QNET users who have previously submitted a request to contribute a QNET article (eg, for an AC or UFR). The procedure for requesting new content is not described here but is outlined elsewhere on this site []. Therefore, the basic assumption is that a new QNET article has already been set up with individual links between the article pages in place. The notes contained here are intended to help the contributor to populate these pages with the basic technical content he or she wishes to add.

The information on this page is also of interest to visitors who wish to leave short comments on the Discussion page of each Wiki article.

Basic Steps

General Advice

  • Keep it simple! Each AC or UFR is intended to be the size of typical journal article and Each page within an AC or UFR should be no more than 3-4 screen-fulls of text at most. If your reader is scrolling up and down

Adding Images

  • Save the image you need to a file on your machine, giving it a memorable name- whatever you deem appropiate.
  • In the editing page make sure your cursor is in the required location for your image then on the top where all the tool icons are, click on the icon that looks like a little picture frame, titled "embedded file".

This will generate an internal image link which looks like this; Example.jpg To upload the image you have saved go to the left hand navigation bar and click on "Upload file" under the "Tool Box" folder. Click on "Browse" to find the saved image and then once located click on "Upload File". The desired image should come up with its precise location name. This is important because if you don't put the exact name of the uploaded picture into the image link, the picture will not be viewed in the wiki, instead a red link will come up showing that something is wrong with this image file. The name of the uploaded file will be shown in blue under the picture once you have clicked on the "Upload File" button. Go back into your editing page by clicking on the back bar, and type into the image link the name of your uploaded image ie; File:Wavevortex 1.gif; File:Wave vortex 1.GIF; File:Wave vortex1.gif These examples are to show you how to enter your image name. Make sure you leave in Image:. Just to clarify the uploaded image name could have underscores, capitol letters, spaces, numbers etc you have to make sure that when you name the image link it must be exactly the same name as the uploaded image. Then click on save at the bottom of the editing page and the image should appear in the wiki. If all you get is a red link instead of a picture it is probably because the name has not been recongnised.


Adding Tables

Adding Equations

References