Help:For Authors
From RHESSI Wiki
(→Adding Figures) |
(added notes on contents) |
||
| Line 4: | Line 4: | ||
All pages on this wiki are articles including the RHESSI science nuggets. In order to create a new article a title must first be chosen. The title of an article cannot be changed so choose your article title carefully! It is possible to move the content from one article to another with a different title but this is not a recommended practice. There are two main ways to create an article. | All pages on this wiki are articles including the RHESSI science nuggets. In order to create a new article a title must first be chosen. The title of an article cannot be changed so choose your article title carefully! It is possible to move the content from one article to another with a different title but this is not a recommended practice. There are two main ways to create an article. | ||
| - | *Simply search for the title of the article you wish to create using the search bar on the left. The wiki should confirm that no other articles have this title by not finding it and will give a choice to create this article. Click the link and your new article will open in edit mode. | + | *Simply search for the title of the article you wish to create using the search bar on the left. The wiki should confirm that no other articles have this title by not finding it and will give a choice to create this article. Click the link (at "you searched for") and your new article will open in edit mode. |
*Articles are organized through categories. An article is added to a category by adding meta-data into the article text. The next method for creating an article is to navigate to the category page and use the Form to create a new article in that category. The RHESSI Science Nugget category page can be found [[:Category:Nugget|here]]. The category meta-data will then automatically be included in the article text. | *Articles are organized through categories. An article is added to a category by adding meta-data into the article text. The next method for creating an article is to navigate to the category page and use the Form to create a new article in that category. The RHESSI Science Nugget category page can be found [[:Category:Nugget|here]]. The category meta-data will then automatically be included in the article text. | ||
| Line 15: | Line 15: | ||
whose results can be seen to the right. Most of these parameters should be self explanatory. The "thumb" parameters tells the wiki that this is a figure and therefore displays the figure caption. The float parameters (in this case set to "right") tells the wiki where to float the image. Possibilities include "left", "center", or "right". | whose results can be seen to the right. Most of these parameters should be self explanatory. The "thumb" parameters tells the wiki that this is a figure and therefore displays the figure caption. The float parameters (in this case set to "right") tells the wiki where to float the image. Possibilities include "left", "center", or "right". | ||
| - | [[Image:POF.jpg| | + | [[Image:POF.jpg|250px|thumb|right|'''Figure 1''': This is the figure caption. Note that the figure has properlyy appeared on the right, but that you can't really control how the text will wrap around it - that depends on the browser.]] |
If you'd like to experiment with more advanced methods read this [http://en.wikipedia.org/wiki/Image_tutorial article] on Wikipedia's website. | If you'd like to experiment with more advanced methods read this [http://en.wikipedia.org/wiki/Image_tutorial article] on Wikipedia's website. | ||
| + | |||
| + | == Style and content == | ||
| + | |||
| + | We try to write the Nuggets so that a technically literate reader won't be baffled. | ||
| + | That means that the text should appear in plain English, and that jargon is a no-no. | ||
| + | Many scientists don't realize they are writing gibberish so please be careful about this. | ||
| + | On the plus side, you can freely use cgs units if you wish. | ||
| + | Also please be aware that many of the audience are not native English speakers, so phrases like "X must have been a gutsy operator to have diagonalized those macrospicules" would not do so well. | ||
| + | Writing as though for a newspaper, rather than as for a boring archival journal, would be best - there is no need really to have complete literature | ||
| + | citation, since those ''really'' knowledgeable about the field will certainly know where to go (ADS). | ||
Revision as of 20:17, 18 May 2009
This page describes the steps necessary to create and edit your own article. This information is generally valid for creating any kind of article on this wiki but may be particularly useful to new Nugget authors.
Contents |
Creating an Article
All pages on this wiki are articles including the RHESSI science nuggets. In order to create a new article a title must first be chosen. The title of an article cannot be changed so choose your article title carefully! It is possible to move the content from one article to another with a different title but this is not a recommended practice. There are two main ways to create an article.
- Simply search for the title of the article you wish to create using the search bar on the left. The wiki should confirm that no other articles have this title by not finding it and will give a choice to create this article. Click the link (at "you searched for") and your new article will open in edit mode.
- Articles are organized through categories. An article is added to a category by adding meta-data into the article text. The next method for creating an article is to navigate to the category page and use the Form to create a new article in that category. The RHESSI Science Nugget category page can be found here. The category meta-data will then automatically be included in the article text.
Writing your article
Adding Figures
In order to add a figure it is first necessary to upload the image to the wiki. This can be done by using the link on the left titled "Upload File". Please use a descriptive name for the file and add a description of its contents. Once uploaded the file can be added to articles using the following command
[[Image:POF.jpg|200px|thumb|right|'''Figure 1''': This is the figure caption.]]
whose results can be seen to the right. Most of these parameters should be self explanatory. The "thumb" parameters tells the wiki that this is a figure and therefore displays the figure caption. The float parameters (in this case set to "right") tells the wiki where to float the image. Possibilities include "left", "center", or "right".
If you'd like to experiment with more advanced methods read this article on Wikipedia's website.
Style and content
We try to write the Nuggets so that a technically literate reader won't be baffled. That means that the text should appear in plain English, and that jargon is a no-no. Many scientists don't realize they are writing gibberish so please be careful about this. On the plus side, you can freely use cgs units if you wish. Also please be aware that many of the audience are not native English speakers, so phrases like "X must have been a gutsy operator to have diagonalized those macrospicules" would not do so well. Writing as though for a newspaper, rather than as for a boring archival journal, would be best - there is no need really to have complete literature citation, since those really knowledgeable about the field will certainly know where to go (ADS).
