Help:Editing pages: Difference between revisions
No edit summary (change visibility) |
|||
Line 27: | Line 27: | ||
===ROMS CPP Options=== | ===ROMS CPP Options=== | ||
:All [[Options | ROMS cpp options]] technical description can be found in a single large page to facilitate printing. This page is organized in alphabetic order | :All [[Options | ROMS cpp options]] technical description can be found in a single large page to facilitate printing. This page is organized in alphabetic order. Each option has an '''anchor tag''' to enable linking within any wiki page. For example, a link of the form | ||
::'''<nowiki>[[Options#UV_ADV | UV_ADV]]</nowiki>''' | ::'''<nowiki>[[Options#UV_ADV | UV_ADV]]</nowiki>''' | ||
:will link to [[Options#UV_ADV | UV_ADV]] | :will link to [[Options#UV_ADV | UV_ADV]] on the CPP options single page. Notice tha a single page for each option is built using the following transclusion synthax: | ||
::'''<nowiki>{{#lst:Options|UV_ADV}}</nowiki>''' | |||
:that allows you to reference this option from any wiki page using the regular double-bracket syntax, '''<nowiki>[[UV_ADV]]</nowiki>'''. The grouping of options for specific physical processes, numerical algorithms, configuration strategies, idealized and realistic applications, and various model drivers is documented [[cppdefs.h]] page. | |||
===ROMS Variables=== | ===ROMS Variables=== |
Revision as of 19:38, 31 May 2007
On a wiki, it is customary to allow readers to edit content and structure. Changes are tracked, and are revertible. You will need to log on to edit pages.
Editing basics
Review policy and conventions
- Make sure that what you want to write belongs where you want to put it. The operator of the site likely has specific plans for the site, and your content might be deleted or unappreciated. You can always use the talk pages to ask questions or check to see if your idea will be accepted.
Start editing
- To start editing a MediaWiki page, click the Edit this page (or just edit) link at one of its edges. This brings you to the edit page: a page with a text box containing the wikitext: the editable source code from which the server produces the webpage. If you just want to experiment, please do so in the sandbox, not here.
Enter the page title
- In order to facilitate our special needs when it comes to page titles, we have disabled the automatic display of page titles. At the top of the document enter the following: <div class="title">[ARTICLE TITLE]</div> where [ARTICLE TITLE] is the text you would like displayed as the page's title.
Type your changes
- You can just type your text. However, also using basic wiki markup (described in the next section) to make links and do simple formatting adds to the value of your contribution.
Summarize your changes
- Write a short edit summary in the small field below the edit-box. You may use shorthand to describe your changes, as described in the Edit_summary_legend .
Preview before saving
- When you have finished, click Show preview to see how your changes will look -- before you make them permanent. Repeat the edit/preview process until you are satisfied, then click Save page and your changes will be immediately applied to the article.
WikiROMS special editing Guidelines
As described in the "Enter the page title" section above, WikiROMS has specific needs that require non-standard formatting. Below are descriptions and examples of other special cases.
ROMS CPP Options
- All ROMS cpp options technical description can be found in a single large page to facilitate printing. This page is organized in alphabetic order. Each option has an anchor tag to enable linking within any wiki page. For example, a link of the form
- [[Options#UV_ADV | UV_ADV]]
- will link to UV_ADV on the CPP options single page. Notice tha a single page for each option is built using the following transclusion synthax:
- {{#lst:Options|UV_ADV}}
- that allows you to reference this option from any wiki page using the regular double-bracket syntax, [[UV_ADV]]. The grouping of options for specific physical processes, numerical algorithms, configuration strategies, idealized and realistic applications, and various model drivers is documented cppdefs.h page.
ROMS Variables
- All ROMS variables can be found in a single large page to facilitate printing. This page is organized in alphabetic order sub-sections. Each ROMS variable has an anchor tag to enable linking from any wikipage. For example, links in the form
- [[Variables#zeta | zeta]]
- will link to a variable named zeta in this page.
Scientific References
- All the scientific references are entered in the Bibliography page to facilitate printing. This page is organized in alphabetic order sub-sections. Notice that each reference has a unique anchor tag to facilitate citation from any wikipage. The anchor tag has the author lastname, firstname initial(s), underscore, publication year, and a lowercase letter enclosed with the span tag. For example,
- <span id="SverdrupHU_1947a"></span> Sverdrup, H. U., 1947: Wind-driven currents in a baroclinic ocean, with application to the equatorial currents of the eastern Pacific, Proc. Natl. Acad. Sci. U. S. A., 33 (11), 318-326.
- The lowercase letter is used to distinguish between different publications from the same author in a year. To citate from any wikipage use:
- [[Bibliography#SverdrupHU_1947a | Sverdrup (1947)]]
Most frequent wiki markup explained
Here are the 6 most frequently used wiki markups. If you need more help see:
What it looks like | What you type |
---|---|
You can italicize text by putting 2 apostrophes on each side. 3 apostrophes will bold the text. 5 apostrophes will bold and italicize the text. (4 apostrophes don't do anything special -- there's just 'one left over'.) |
You can ''italicize text'' by putting 2 apostrophes on each side. 3 apostrophes will bold '''the text'''. 5 apostrophes will bold and italicize '''''the text'''''. (4 apostrophes don't do anything special -- there's just ''''one left over''''.) |
You should "sign" your comments on talk pages: |
You should "sign" your comments on talk pages: <br> - Three tildes give your user name: ~~~ <br> - Four tildes give your user name plus date/time: ~~~~ <br> - Five tildes give the date/time alone: ~~~~~ <br> |
Section headings
Headings organize your writing into sections. The Wiki software can automatically generate a table of contents from them. Subsection
Using more equals signs creates a subsection. A smaller subsection
Don't skip levels, like from two to four equals signs. Start with 2 equals signs not 1 because 1 creates H1 tags which should be reserved for page title. |
== Section headings == ''Headings'' organize your writing into sections. The Wiki software can automatically generate a table of contents from them. === Subsection === Using more equals signs creates a subsection. ==== A smaller subsection ==== Don't skip levels, like from two to four equals signs. Start with 2 equals signs not 1 because 1 creates H1 tags which should be reserved for page title. |
marks the end of the list.
|
* ''Unordered lists'' are easy to do: ** Start every line with a star. *** More stars indicate a deeper level. *: Previous item continues. ** A new line * in a list marks the end of the list. * Of course you can start again. |
A new line marks the end of the list.
|
# ''Numbered lists'' are: ## Very organized ## Easy to follow A new line marks the end of the list. # New numbering starts with 1. |
Here's a link to a page named Official position. You can even say official positions and the link will show up correctly. |
Here's a link to a page named [[Official position]]. You can even say [[official position]]s and the link will show up correctly. |
The weather in Moscow is a page that doesn't exist yet. You could create it by clicking on the link. |
[[The weather in Moscow]] is a page that doesn't exist yet. You could create it by clicking on the link. |
You can link to a page section by its title: If multiple sections have the same title, add a number. #Example section 3 goes to the third section named "Example section". |
You can link to a page section by its title: *[[List of cities by country#Morocco]]. If multiple sections have the same title, add a number. [[#Example section 3]] goes to the third section named "Example section". |
Further reading
Editing help
Wiki markups and codes
- Help:Wikitext examples
- Help:Wikitext reference
- Help:Reference card - a one-page summary of important commands, to be printed out and used next to the computer
- Help:HTML in wikitext
- HTML elements - introduction to HTML
Page management
- Help:Starting a new page
- Merging and moving pages
- Protecting pages
- Deletion policy
- For others, look at the table ("tools" part) on your right hand side