Changes

Jump to navigation Jump to search

Help:Tutorial (view source)

Revision as of 16:59, 27 May 2015

6,032 bytes added ,  16:59, 27 May 2015
→‎Discussion
Line 1: Line 1: −
Here is a comprehensive guide to help you learn the ropes of creating and editing pages in {{SITENAME}}. This tutorial is aimed at beginners. You can experiment with what you've learned in your [[Special:MyPage/Sandbox|Sandbox]]. THIS PAGE IS STILL IN PROGRESS.
+
Here is a comprehensive guide to help you learn the ropes of creating and editing pages in {{SITENAME}}. This tutorial is aimed at beginners. You can experiment with what you've learned in your [[Special:MyPage/Sandbox|Sandbox]].  
 +
 
 +
THIS PAGE IS STILL IN PROGRESS.
 +
 
 +
==Why we need you==
 +
While we have many article on the wiki, there are still many more that need to be written, updated, or improved! Any page that has a [[red link]] needs an article. Articles classified as a <nowiki>{{stub}}</nowiki> needs more in-depth information:
 +
{{stub}}
 +
 
 +
==Where to start==
 +
* [[Special:WantedPages | Wanted pages]]
 +
* [[Special:ShortPages | Short pages & stubs]]
    
==Basics of wikitext==
 
==Basics of wikitext==
−
The markup language for all mediawiki sites is called "wikitext." It is a bit different from HTML, but the principle is similar.  
+
The markup language for all mediawiki sites is called "wikitext." It is a bit different from HTML, but the principle is similar. [[Help:Editing|Quick guide to wikitext]]
    
==Linking==
 
==Linking==
 
* Link to pages in the wiki with double brackets:  
 
* Link to pages in the wiki with double brackets:  
−
**<nowiki>[[Carbonate reservoir models: facies, diagenesis, and flow characterization]]</nowiki> becomes [[Carbonate reservoir models: facies, diagenesis, and flow characterization]]
+
<pre><nowiki>[[Carbonate reservoir models: facies, diagenesis, and flow characterization]]</nowiki></pre>
 +
::becomes [[Carbonate reservoir models: facies, diagenesis, and flow characterization]]
 
* If the page you want to link to doesn't match the text you want to link with, add a pipe after the page name with the text you want:
 
* If the page you want to link to doesn't match the text you want to link with, add a pipe after the page name with the text you want:
−
**<nowiki>[[Carbonate reservoir models: facies, diagenesis, and flow characterization|Carbonate diagenesis]]</nowiki> becomes [[Carbonate reservoir models: facies, diagenesis, and flow characterization|Carbonate diagenesis]]
+
<pre><nowiki>[[Carbonate reservoir models: facies, diagenesis, and flow characterization|Carbonate diagenesis]]</nowiki></pre>
 +
::becomes [[Carbonate reservoir models: facies, diagenesis, and flow characterization|Carbonate diagenesis]]
 
* To link to a subheading of an existing page, add a # between the page name and the subheading:
 
* To link to a subheading of an existing page, add a # between the page name and the subheading:
−
**<nowiki>[[Carbonate reservoir models: facies, diagenesis, and flow characterization#Carbonate reservoir models|Carbonate reservoir models]]</nowiki> becomes [[Carbonate reservoir models: facies, diagenesis, and flow characterization#Carbonate reservoir models|Carbonate reservoir models]]
+
<pre><nowiki>[[Carbonate reservoir models: facies, diagenesis, and flow characterization#Carbonate reservoir models|Carbonate reservoir models]]</nowiki></pre>
 +
::becomes [[Carbonate reservoir models: facies, diagenesis, and flow characterization#Carbonate reservoir models|Carbonate reservoir models]]
 
* Link to external sources with one bracket, followed by the url, a space, and the text you want displayed:
 
* Link to external sources with one bracket, followed by the url, a space, and the text you want displayed:
−
**<nowiki>[http://en.wikipedia.org/wiki/Carbonate Carbonate]</nowiki> becomes [http://en.wikipedia.org/wiki/Carbonate Carbonate]
+
<pre><nowiki>[http://en.wikipedia.org/wiki/Carbonate Carbonate]</nowiki></pre>
 +
::becomes [http://en.wikipedia.org/wiki/Carbonate Carbonate]
 +
* Please do not add links to section headings, references, or figure captions.
    
==Images==
 
==Images==
−
To insert an image into an article, you must first download the image to your computer and then hit [[Upload file]] (in lefthand menu). Once the file is uploaded, click the picture icon in the wikitext menu of the article you are working on. This will open a dialog box that will prompt you for more information. Enter the filename of the image you uploaded, and a caption. The default setting are to display the image as a thumbnail, on the right side of the page. Your wikitext will look like this:
+
*To insert an image into an article, you must first download the image to your computer and then hit [[Special:Upload|Upload file]] (in lefthand menu). Once the file is uploaded, click the picture icon in the wikitext menu of the article you are working on. This will open a dialog box that will prompt you for more information. Enter the filename of the image you uploaded, and a caption. The default setting are to display the image as a thumbnail, on the right side of the page. Your wikitext will look like this:
 +
<pre><nowiki>[[file:PinedaleFieldLandRig.png|thumb|Figure 1. Pine Dale Field Land Rig]]</nowiki></pre>
 +
::and come out looking like this: [[file:PinedaleFieldLandRig.png|thumb|none|Figure 1. Pine Dale Field Land Rig]]
   −
<nowiki>[[file:PinedaleFieldLandRig.png|thumb|Pine Dale Field Land Rig]]</nowiki> and come out looking like this: [[file:PinedaleFieldLandRig.png|thumb|Pine Dale Field Land Rig]]
+
*To link an in-text reference to the corresponding figure, add a colon (:) before "file" and the text you wish to appear after the pipe (|):
 +
<pre><nowiki>[[:file:PinedaleFieldLandRig.png|Figure 1]]</nowiki></pre>
 +
::becomes [[:file:PinedaleFieldLandRig.png|Figure 1]]
   −
==References==
+
==References & Citations==
 +
*References are a little more complicated. All reference consist of a citation and an actual reference.  The citation is a tag that contains a shorthand form of the reference, and is followed, on first use in an article, by the completed reference.
 +
*AAPG Wiki uses the Chicago Manual of Style and/or the AAPG house style for references.
 +
 
 +
===Creating a reference===
 +
*First citation in article:
 +
<pre><nowiki>Doe<ref name=Doe_1986>Doe, J., 1986, The birth of rock: AAPG Memoir 42, 27 p.</ref></nowiki></pre>
 +
::becomes Doe<ref name=Doe_1986>Doe, J., 1986, The birth of rock: AAPG Memoir 42, 27 p.</ref>
 +
*Subsequent citations:
 +
<pre><nowiki>Doe<ref name=Doe_1986 /></nowiki></pre>
 +
::will automatically create a footnote marker that will link to the original reference: Doe<ref name=Doe_1986 />
 +
*If there aren’t any references in the page, you need to create a template for a reference list:
 +
<pre><nowiki>==References==</nowiki>
 +
<nowiki>{{reflist}}</nowiki></pre>
 +
::which will make a [[Help:Tutorial#References|Reference list]] that you put at the bottom of the page (where you would look for this reference list, as well)
    
==Searching==
 
==Searching==
 +
 +
There are several ways to search within the wiki.
 +
 +
*You can use the search box in the upper right-hand corner. You can search for the name of an article, or any term that appears in an article.
 +
*Within any article, you can use CTRL (or CMD) + F and search for a term in that article.
    
==Tables and Equations==
 
==Tables and Equations==
 +
Tables and equations are fairly complicated. This is a very brief rundown. For a more thorough explanation, see Wikipedia's Help pages on [http://en.wikipedia.org/wiki/Help:Displaying_a_formula formulas] and [http://en.wikipedia.org/wiki/Help:Table tables].
 +
 +
===Tables===
 +
You can create tables manually or using the editing toolbar. By clicking the "Advanced" button, you'll get a drop down table that include, on the far right, a table. The default settings will cause this to appear in wikitext:
 +
<pre>
 +
<nowiki>{| class="wikitable"</nowiki>
 +
<nowiki>|-</nowiki>
 +
<nowiki>|+Table 1.</nowiki>
 +
<nowiki>|-</nowiki>
 +
<nowiki>! Header text 1 || Header text 2 || Header text 3</nowiki>
 +
<nowiki>|-</nowiki>
 +
<nowiki>| Example 1 || Example 2 || Example 3</nowiki>
 +
<nowiki>|-</nowiki>
 +
<nowiki>| Example A || Example B || Example C</nowiki>
 +
<nowiki>|-</nowiki>
 +
<nowiki>| Example ! || Example @ || Example # </nowiki>
 +
<nowiki>|}</nowiki>
 +
</pre>
 +
 +
which will look like this:
 +
:{| class="wikitable"
 +
|-
 +
|+Table 1.
 +
|-
 +
! Header text 1 || Header text 2 || Header text 3
 +
|-
 +
| Example 1 || Example 2 || Example 3
 +
|-
 +
| Example A || Example B || Example C
 +
|-
 +
| Example ! || Example @ || Example #
 +
|}
 +
 +
===Equations===
 +
*Equations use the LaTex markup language, and are always bounded by <nowiki><math> and </math></nowiki> tags. A simple equation will be written much as it appears:
 +
<pre><nowiki><math>A + B = C</math></nowiki></pre> will appear as
 +
::<math>A + B = C</math>
 +
*Equations that include text are set off by the <nowiki>\text</nowiki> tag, with the desired text set within {brackets}. It's the difference between:
 +
<pre><nowiki><math>Equation</math></nowiki></pre>
 +
::<math>Equation</math>
 +
:and
 +
<pre><nowiki><math>\text{Equation}</math></nowiki></pre>
 +
::<math>\text{Equation}</math>
 +
*Other important functions can include <nowiki>^ or _ for sub- or superscript, \times and \minus or - for multiplication and subtraction, and \sum for a summation.</nowiki> A typical equation might look like this in wikitext
 +
<pre><nowiki><math>\text{Hydrocarbon tilt} = \rho_w/(\rho_w - \rho_h) \times \text{potentiometric gradient}</math></nowiki></pre>
 +
:and come out looking like this:
 +
::<math>\text{Hydrocarbon tilt} = \rho_w/(\rho_w - \rho_h) \times \text{potentiometric gradient}</math>
 +
*More examples:
 +
:From [[Predicting_hydrocarbon_recovery#Calculating_oil_volume_in_place|Calculating oil volume in place]]:
 +
::<pre><nowiki><math>\text{OOIP} = \frac{7758 \times \text{A} \times \text{h} \times \Phi \times (1 - \text{S}_\text{w})}{\text{B}_\text{oi}}</math></nowiki></pre>
 +
::<math>\text{OOIP} = \frac{7758 \times \text{A} \times \text{h} \times \Phi \times (1 - \text{S}_\text{w})}{\text{B}_\text{oi}}</math>
 +
:From [[Statistics overview#Variability|Variability]]:
 +
::<pre><nowiki><math>s^2 = \frac{\sum (X - \bar{x})^2}{n}</math></nowiki></pre>
 +
:::<math>s^2 = \frac{\sum (X - \bar{x})^2}{n}</math>
    
==Tips and tricks==
 
==Tips and tricks==
 +
 +
===Discussion===
 +
Thinking about editing a page? Take a look at the Discussion tab at the top left hand side of the page. See if others have already discussed your concern, or start a discussion yourself.  This will help prevent "edit wars," where editors continually make and revert the same few changes over and over, and help editors come to a consensus about what changes, if any, need to be made.
 +
 +
===Still confused?===
 +
Want to write an article, or make a change, but can't get a handle on the wikitext? No problem. We'd still love your input. Here's a few more ways to submit articles:
 +
* copy and paste your plain text into the article. An editor will come through and format it for you.
 +
* send a word document or other version of the article to [mailto:[email protected] [email protected]] and an administrator will post & format the article.
 +
 +
==References==
 +
{{reflist}}
Retrieved from "https://wiki.aapg.org/Special:MobileDiff/6049...19412"

Navigation menu