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
m (Denisewatts moved page Help:Moderator basics to Help:Champion basics)
No edit summary
Line 9: Line 9:
[[File:Edit with advanced editing.PNG|Edit tab]]
[[File:Edit with advanced editing.PNG|Edit tab]]
<br>
<br>
See also: [[Help:Moderator tutorials]]
See also: [[Help:Champion tutorials]]
<br>
<br>
In the image above, the second row of icons are the items on the Advanced toolbar. If you don't see them, click Advanced.
In the image above, the second row of icons are the items on the Advanced toolbar. If you don't see them, click Advanced.
Line 22: Line 22:
[[File:Edit tab.PNG|Edit]]
[[File:Edit tab.PNG|Edit]]
<br>
<br>
See also: [[Help:Moderator tutorials]]
See also: [[Help:Champion tutorials]]
<br>
<br>


Line 29: Line 29:
[[File:WikiText preview.PNG|Wikitext preview]]
[[File:WikiText preview.PNG|Wikitext preview]]
<br>
<br>
See also: [[Help:Moderator tutorials]]
See also: [[Help:Champion tutorials]]
<br>
<br>


Line 47: Line 47:
[[File:Heading TOC.PNG|Headings generate the Table of Contents]]
[[File:Heading TOC.PNG|Headings generate the Table of Contents]]


See also: [[Help:Moderator tutorials]]
See also: [[Help:Champion tutorials]]


===Lists===
===Lists===
Line 88: Line 88:
In wikitext the link will not be visible, but on the preview and final page, the link will be visible.  See [[Help:Links]] for more information on links '''(internal and external)'''.  The hyperlink button in the edit toolbar simplifies the link process.
In wikitext the link will not be visible, but on the preview and final page, the link will be visible.  See [[Help:Links]] for more information on links '''(internal and external)'''.  The hyperlink button in the edit toolbar simplifies the link process.
<br>
<br>
See also: [[Help:Moderator tutorials]]
See also: [[Help:Champion tutorials]]


===Templates===
===Templates===
Line 112: Line 112:
===Page and heading names===
===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.<br>
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.<br>
See also: [[Help:Moderator tutorials]]
See also: [[Help:Champion tutorials]]


===Ampersands(&)===
===Ampersands(&)===
Line 122: Line 122:
[[File:DOI in OnePetro.PNG|DOI in OnePetro]]
[[File:DOI in OnePetro.PNG|DOI in OnePetro]]
<br>
<br>
See also: [[Help:Moderator tutorials]]<br>
See also: [[Help:Champion tutorials]]<br>




Line 147: Line 147:
See [[PetroWiki:Acknowledgements]] for more information.
See [[PetroWiki:Acknowledgements]] for more information.
<br>
<br>
There is no way to exempt moderators 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.
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.


===Minor edits===
===Minor edits===

Revision as of 13:45, 3 February 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. But they will not work exactly the same as in 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 tab

When you click the Edit tab, you will see the wiki text of the page with an editing toolbar at the top.
Edit tab
See also: Help:Champion tutorials
In the image above, the second row of icons are the items on the Advanced toolbar. If you don't see them, click Advanced.

Preview tab

The Preview tab above the editing toolbar will let you see the effect of any changes that you have made without saving the page.
Preview
You can use it and the Wikitext tab to toggle back and forth to see the effect of changes as you are making them.
Edit
See also: Help:Champion tutorials

Wikitext basics

Wikitext preview
See also: Help:Champion tutorials

As you can see from the image above, the text looks pretty much like any text, but there are a few things that are unusual, such as
[[Measurement while drilling (MWD)|measurement while drilling (MWD)]] and ==Overview==.

The following topics will give basic wikitext examples. Each section will have links to additional help sections and expanded tutorials.

Headings

== indicate headings. The page name is header level 1 which looks like this =Level 1=, so you'll be working with 2nd and possibly 3rd or 4th level headings. There's a drop down in the toolbar that you can use to highlight text and indicate the appropriate header level. But that's usually not necessary just count the equals signs.
== is a second level header,
=== is 3rd level, etc.
The equals signs come before and after the header text. The Table of Contents is built automatically from the headings. The Table of Contents will not show in the wikitext edit screen.

Headings generate the Table of Contents

See also: Help:Champion tutorials

Lists

a bulleted list looks like this
*item 1
*item 2
*item 3

a numbered list looks like this
#item 1
#item 2
#item 3

Indent

: is the indent character.:: would indent further, and 3 colons would indent further still

Hyperlinks

External

[] indicates a hyperlink to an external website. Put the URL, then a pipe (|), then the text you want to hyperlink.
Example: [http://www.petrowiki.org | PetroWiki] will result in: PetroWiki
If you want the URL to show as the hyperlink, not text, just put the full URL (starting with http://) in the text without the [] around it.
Example:http://www.petrowiki.org will result in: http://www.petrowiki.org

Internal

[[Measurement while drilling (MWD)|measurement while drilling (MWD)]]
[[ ]] indicates a link to another page in the wiki - the text before the pipe (|) is the page name of the wiki page and the text after the pipe is the text that is hyperlinked.
You may find it helpful to use a second browser window or tab to search for the name of the page you want to link to. The link tool on the Edit toolbar simplifies the linking process.
[[Measurement while drilling (MWD)|measurement while drilling (MWD)]] will look like this in the preview window measurement while drilling (MWD)
In wikitext the link will not be visible, but on the preview and final page, the link will be visible. See Help:Links for more information on links (internal and external). The hyperlink button in the edit toolbar simplifies the link process.
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.

Tables

Tables are more complex and they should be avoided where not needed because they can make it more challenging to edit a page. For more information see Help:Tables.

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

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.
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.

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.
Acknowledgements
See PetroWiki:Acknowledgements for more information.
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.

Minor edits

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

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.