You must log in to edit PetroWiki. Help with editing

Content of PetroWiki is intended for personal use only and to supplement, not replace, engineering judgment. SPE disclaims any and all liability for your use of such content. More information


Help:Champion basics: Difference between revisions

PetroWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 13: Line 13:
[[File:Agreements.PNG|center|Agreements]]<br/>See also: [[Help:Champion_tutorials]]
[[File:Agreements.PNG|center|Agreements]]<br/>See also: [[Help:Champion_tutorials]]


== <span style="line-height: 1.2;"><br/>Templates</span> ==
== Templates ==


{{}} reflects the inclusion of information from a template into the page. There are 3 existing templates that you may occasionally find useful to include.
{{}} reflects the inclusion of information from a template into the page. There are 3 existing templates that you may occasionally find useful to include.
Line 23: Line 23:
- this is for a newly created page that does not yet have any content, or perhaps only 1-2 sentences. It tells the reader this is a new page and suggests adding content.<br/>{{Stub|14 June 2013}}<br/>You can include any of these templates with the blue text. [Substitute the date for date of creation in the stub template, e.g., 24 September 2012.] If you are moderating a page that no longer needs the template because content has been added, just delete the<nowiki>{{text}}</nowiki>
- this is for a newly created page that does not yet have any content, or perhaps only 1-2 sentences. It tells the reader this is a new page and suggests adding content.<br/>{{Stub|14 June 2013}}<br/>You can include any of these templates with the blue text. [Substitute the date for date of creation in the stub template, e.g., 24 September 2012.] If you are moderating a page that no longer needs the template because content has been added, just delete the<nowiki>{{text}}</nowiki>
from the page.
from the page.
===  ===
== Equations ==
Equations are ugly in wikitext. [[Help:MathML]] guide includes the syntax for creating or editing equations. They will require patience and carefully checking the content. The edit toolbar includes many special characters that are needed for inclusion in equations.
== Page and heading names ==
== Page and heading names ==


Line 39: Line 33:
== References ==
== References ==


The page [http://petrowiki.org/Help:RichText_editor_-_Add_a_reference_and_add_a_reference_block Help:Formatting references] will tell you how to use the footnote function of the edit toolbar. For the section on Noteworthy papers in OnePetro, the best way the standard way to create the hyperlink is to use the DOI URL. The DOI can be found on the preview page (click the title from search results) in OnePetro, then append&nbsp;<nowiki>'''http://dx.doi.org/'''&nbsp;</nowiki><span style="line-height: 1.6;">to the beginning.</span>
The page [http://petrowiki.org/Help:RichText_editor_-_Add_a_reference_and_add_a_reference_block Help:Formatting references] will tell you how to use the footnote function of the edit toolbar. For the section on Noteworthy papers in OnePetro, the best way the standard way to create the hyperlink is to use the DOI URL. The DOI can be found on the preview page (click the title from search results) in OnePetro, then append&nbsp;
<nowiki>'''http://dx.doi.org/'''&nbsp;</nowiki>
<span style="line-height: 1.6;">to the beginning. If a DOI is not available use the full URL to the document.</span> [[File:DOIOnePetro.png|center|DOI in OnePetro]]<br/>See also: [[Help:Champion_tutorials]]
=== Here are a couple of examples: ===


[[File:DOIOnePetro.png|center|DOI in OnePetro]]
Barr, J.D., Clegg, J.M., and Russell, M.K. 1995. Steerable Rotary Drilling With an Experimental System.<br/>Presented at the SPE/IADC Drilling Conference, Amsterdam, Netherlands, 28 February-2 March.&nbsp;SPE-29382-MS. [http://dx.doi.org/10.2118/29382-MS http://dx.doi.org/10.2118/29382-MS].


<br/>See also: [[Help:Champion_tutorials]]<br/>'''Here are a couple of examples:'''
King, G. 2012. Hydraulic Fracturing 101: What Every Representative, Environmentalist, Regulator, Reporter, Investor, University Researcher, Neighbor and Engineer Should Know About Estimating Frac Risk and Improving Frac Performance in Unconventional Gas and Oil Wells.&nbsp;Presented at the SPE Hydraulic Fracturing Technology Conference, The Woodlands, Texas, 6-8 February.&nbsp;SPE-152596-MS.&nbsp;
 
Barr, J.D., Clegg, J.M., and Russell, M.K. 1995. Steerable Rotary Drilling With an Experimental System.<br/>Presented at the SPE/IADC Drilling Conference, Amsterdam, Netherlands, 28 February-2 March.<br/>SPE-29382-MS. [http://dx.doi.org/10.2118/29382-MS http://dx.doi.org/10.2118/29382-MS].
 
King, G. 2012. Hydraulic Fracturing 101: What Every Representative, Environmentalist, Regulator, Reporter, Investor, University Researcher, Neighbor and Engineer Should Know About Estimating Frac Risk and Improving Frac Performance in Unconventional Gas and Oil Wells.<br/>Presented at the SPE Hydraulic Fracturing Technology Conference, The Woodlands, Texas, 6-8 February.<br/>SPE-152596-MS.
<nowiki>http://dx.doi.orq/10.2118/152596-MS</nowiki>
<nowiki>http://dx.doi.orq/10.2118/152596-MS</nowiki>
<br/>While it would be great to have the references formatted in [http://www.spe.org/authors/| SPE style] (so students could easily copy them for use in their papers), don't get too hung up on the format. If someone submits some links that aren't in SPE style, if you're pressed for time, let them go. Someone else can always clean them up later. But do try to use the DOI to link to papers in OnePetro. '''The DOI is the most reliable and crucial information to include in a citation.'''
=== Acknowledgements ===


PetroWiki asks all contributors to make 3 acknowledgements before they can save a page - that they have any needed company permissions for material they've contributed, that this is their original work or they have permission for its inclusion, and they are transferring copyright for their contributions to SPE. Until all 3 boxes are checked, the Save button is grayed out.<br/>[[File:Acknowledgements page.PNG|border|Acknowledgements]]<br/>See [[PetroWiki:Acknowledgements]] for more information.<br/>There is no way to exempt champions from seeing these boxes and we would like to apologize for any repeated frustration and stress they may cause you. But we think you'll agree that they serve an important purpose for most contributors.
While it would be great to have the references formatted in [http://www.spe.org/authors/| SPE style] (so students could easily copy them for use in their papers), don't get too hung up on the format. If someone submits some links that aren't in SPE style, if you're pressed for time, let them go. Someone else can always clean them up later. But do try to use the DOI to link to papers in OnePetro.


=== Minor edits ===
'''The DOI is the most reliable and crucial information to include in a citation.'''


Just under the summary is a box saying this is a minor edit. This is designed for things like correcting typos, formatting, grammar, etc. Adding links, headings, content, or citations are NOT considered minor edits.
== Be brave ==


== Be brave ==
You can't break it. Wikis keep track of all changes, so virtually everything can be rolled back, undone, redone, etc. There is a page titled [[Sandbox:Sandbox|Sandbox]] where you can try things out if you're feeling unsure.


You can't break it. Wikis keep track of all changes, so virtually everything can be rolled back, undone, redone, etc. There is a page titled [[Sandbox|Sandbox]] where you can try things out if you're feeling unsure.
==Category==
[[Category:Champion Help]]

Latest revision as of 13:58, 12 October 2015

There are numerous help pages in the wiki to help you as questions arise. Initially, you may want to keep Help open in a second browser tab or window for reference. As you become more familiar with basic wikitext nomenclature you may only need to reference Help for advanced functions.

Overview

PetroWiki will have several familiar-looking icons on the toolbar that are self-explanatory. The icons (buttons) will look simular to Microsoft Word or other WYSIWYG (What You See Is What You Get) editor. Instead PetroWiki will insert visual wikitext to render the desired formatting. For more information see also: Help:Edit toolbar.

Edit content

Edit content

Agreements section

Agreements


See also: Help:Champion_tutorials

Templates

{{}} reflects the inclusion of information from a template into the page. There are 3 existing templates that you may occasionally find useful to include.


{{Expand content}}

- this includes a box noting that the page has limited content and suggesting that the reader contribute additional information on the subject.

This page has limited content. Please consider adding content to it. Help with adding content


{{Limited scope}} - if you find a page that isn't wrong, just very geographically limited, this template adds a box that suggests adding content to broaden the geographic perspective.

The content of this page has a limited geographic scope. Please consider adding content to it to provide a broader geographic perspective. Help with adding content


{{Stub|date=date of creation}} - this is for a newly created page that does not yet have any content, or perhaps only 1-2 sentences. It tells the reader this is a new page and suggests adding content.

This page is a Stub. Please consider adding content to it. Created: {{{date}}} Help with adding content


You can include any of these templates with the blue text. [Substitute the date for date of creation in the stub template, e.g., 24 September 2012.] If you are moderating a page that no longer needs the template because content has been added, just delete the{{text}}

from the page.

Page and heading names

Standard wiki nomenclature uses "sentence" case for page names and headings. This means that the initial letter is capitalized, but all other characters are lowercase, with the exception of abbreviations that would normally be uppercase (such as EOR or MWD). This approach makes it easier to link to pages without being concerned about differences in capitalization. It also helps with URL consistency.
See also: Help:Champion_tutorials

Ampersands(&)

Ampersands (&) are not allowed in page names; it is necessary to spell out "and". The page name becomes part of the URL and ampersands have special meaning in URLs, therefore they cannot be used in page names. It is a good idea to avoid them in headings as well.

References

The page Help:Formatting references will tell you how to use the footnote function of the edit toolbar. For the section on Noteworthy papers in OnePetro, the best way the standard way to create the hyperlink is to use the DOI URL. The DOI can be found on the preview page (click the title from search results) in OnePetro, then append  '''http://dx.doi.org/''' 

to the beginning. If a DOI is not available use the full URL to the document.

DOI in OnePetro


See also: Help:Champion_tutorials

Here are a couple of examples:

Barr, J.D., Clegg, J.M., and Russell, M.K. 1995. Steerable Rotary Drilling With an Experimental System.
Presented at the SPE/IADC Drilling Conference, Amsterdam, Netherlands, 28 February-2 March. SPE-29382-MS. http://dx.doi.org/10.2118/29382-MS.

King, G. 2012. Hydraulic Fracturing 101: What Every Representative, Environmentalist, Regulator, Reporter, Investor, University Researcher, Neighbor and Engineer Should Know About Estimating Frac Risk and Improving Frac Performance in Unconventional Gas and Oil Wells. Presented at the SPE Hydraulic Fracturing Technology Conference, The Woodlands, Texas, 6-8 February. SPE-152596-MS.  http://dx.doi.orq/10.2118/152596-MS

While it would be great to have the references formatted in SPE style (so students could easily copy them for use in their papers), don't get too hung up on the format. If someone submits some links that aren't in SPE style, if you're pressed for time, let them go. Someone else can always clean them up later. But do try to use the DOI to link to papers in OnePetro.

The DOI is the most reliable and crucial information to include in a citation.

Be brave

You can't break it. Wikis keep track of all changes, so virtually everything can be rolled back, undone, redone, etc. There is a page titled Sandbox where you can try things out if you're feeling unsure.

Category