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


Difference between revisions of "Help:Editing a page"

PetroWiki
Jump to navigation Jump to search
Line 1: Line 1:
It's very easy to edit the contents of a wiki. It only takes a few clicks. See also the slideshow covering the [http://www.slideshare.net/SPEupdates/petrowiki-the-edit-overview editing overview].
+
It's very easy to edit the contents of a wiki. It only takes a few clicks. See also the slideshow covering the [http://www.slideshare.net/SPEupdates/petrowiki-the-edit-overview editing overview].
# Log in
 
# Click the '''Edit''' link.
 
# Make changes to the text.
 
# Complete the [[PetroWiki:Acknowledgements|acknowledgements]]
 
# Click the '''Save''' button.
 
Simple as that! Of course, the guidelines below may help you to feel more confident.
 
Remember you should always aim to improve the overall contents of the wiki with your edits. If you're wondering what type of content to add, see [[PetroWiki:Appropriate content]]
 
  
==Editing overview tutorials==
+
#Log in
The following audio/visual tutorials represent the same tutorial in different formats. This is to better serve our contributors with formats that meet their individualized needs and requirements.  
+
#Click the '''Edit''' link.
 +
#Make changes to the text.
 +
#Complete the [[PetroWiki:Acknowledgements|acknowledgements]]
 +
#Click the '''Save''' button.
 +
 
 +
Simple as that! Of course, the guidelines below may help you to feel more confident. Remember you should always aim to improve the overall contents of the wiki with your edits. If you're wondering what type of content to add, see [[PetroWiki:Appropriate_content]]
 +
 
 +
== Editing overview tutorials ==
 +
 
 +
The following audio/visual tutorials represent the same tutorial in different formats. This is to better serve our contributors with formats that meet their individualized needs and requirements.
 +
 
 +
=== YouTube ===
  
===YouTube===
 
 
{{#ev:youtube|kEOhZWSossI}}
 
{{#ev:youtube|kEOhZWSossI}}
  
 
View this tutorial as a video at [http://www.youtube.com/watch?v=kEOhZWSossI YouTube]. Visit our [http://www.youtube.com/user/2012SPE YouTube Channel].
 
View this tutorial as a video at [http://www.youtube.com/watch?v=kEOhZWSossI YouTube]. Visit our [http://www.youtube.com/user/2012SPE YouTube Channel].
  
===Slideshare===
+
=== Slideshare ===
{{#widget:Slideshare|id=36766023|width=500|height=300|title=Editing Overview|user=SPEupdates}}
+
 
View this tutorial as slideshow at [http://www.slideshare.net/SPEupdates/petrowiki-the-edit-overview Slideshare]. Visit our [http://www.slideshare.net/speupdates Slideshare Channel].
+
{{#widget:Slideshare|id=36766023|width=500|height=300|title=Editing Overview|user=SPEupdates}} View this tutorial as slideshow at [http://www.slideshare.net/SPEupdates/petrowiki-the-edit-overview Slideshare]. Visit our [http://www.slideshare.net/speupdates Slideshare Channel].
 +
 
 +
=== Screencast ===
  
===Screencast===
 
 
{{#widget:Screencast|id=de0d0bf5-e614-4bdc-bcdc-18c43d092e57|width=450|height=250|folder=PetroWiki Video Tutorials|user=speinnovations}}
 
{{#widget:Screencast|id=de0d0bf5-e614-4bdc-bcdc-18c43d092e57|width=450|height=250|folder=PetroWiki Video Tutorials|user=speinnovations}}
  
Line 26: Line 30:
  
 
== Editing rules, editing conventions, and formatting ==
 
== Editing rules, editing conventions, and formatting ==
The number one rule of wiki editing is don't be afraid to try. It isn't really hard, even though wiki markup language can look intimidating.
+
 
An edit can contribute whole new paragraphs or pages of information, or it can be as simple as fixing a typo or a spelling mistake. In general, try to add or edit text so that it is clear and concise. Most importantly, make sure you are always aiming to do something which improves the contents of the wiki.
+
The number one rule of wiki editing is don't be afraid to try. An edit can contribute whole new paragraphs or pages of information, or it can be as simple as fixing a typo or a spelling mistake. In general, try to add or edit text so that it is clear and concise. Most importantly, make sure you are always aiming to do something which improves the contents of the wiki. When you need to use some type of formatting, such as for a new headings or bolding of text, you do this the edit toolbar [http://petrowiki.org/Help:RichText_editor_-_Edit_toolbar edit toolbar] above the content entry area. See [[Help:Formatting]] for some of the common types of formatting used.
When you need to use some type of formatting, such as for a new headings or bolding of text, you do this using wiki syntax or the buttons in the [[Help:Edit toolbar | edit toolbar]] above the content entry area. See [[Help:Formatting]] for some of the common types of formatting used.
 
  
 
== Edit summary ==
 
== Edit summary ==
Before you save a change, you can enter a short note in the '''{{int:summary}}''' box describing your changes. Don't worry too much about this, or spend too much time thinking about it, but try to give a little description of what you just changed e.g. "''fixed typo''" or "''added more information about sunflowers''".
 
The summary gets stored alongside your edit, and allows moderators and other users to track changes in the wiki more effectively.
 
 
==Minor edits==
 
Below the edit box, just before the [[PetroWiki:Acknowledgements|acknowledgements]] there is a check box that says "This is a minor edit."  If you have just corrected a typo or grammar, or changed a few words that don't change the meaning of the content, please check this box, which will allow for expedited handling of your edit.  If your edit adds to or changes the meaning of the content, please do not check this box.
 
  
==Use preview ==
+
Before you save a change, you can enter a short note in the '''{{int:summary}}''' box describing your changes. Don't worry too much about this, or spend too much time thinking about it, but try to give a little description of what you just changed e.g. "''fixed typo''" or "''added more information about sunflowers''". The summary gets stored alongside your edit, and allows moderators and other users to track changes in the wiki more effectively.
It's a good idea to use the Preview tab (next to Wikitext at top of center section) to see what your change will look like before you save it. This is also related to tracking changes because every time you save, this is displayed to others as a separate change. This isn't something to worry about too much, but it's good to get into the habit of eliminating mistakes in your own work by using a preview before saving, rather than saving several minor corrections afterwards.
 
  
==Show changes==
+
== Multiple browser windows (tabs) ==
Another option is the Changes tab (next to Preview at top of center section) which allows you to see the differences between the current version and your edited version.
 
  
==Multiple browser windows (tabs)==
+
When you are editing a page, it is sometimes helpful to have a help page such as this one, or formatting references, or DOI, or others open at the same time. Wikis like to do everything in the same window. So multiple browser windows (tabs) are your friend. You can have the page you are editing and several help windows open at the same time and easily switch between them to check on how to do something without having to save your content changes first.
When you are editing a page, it is sometimes helpful to have a help page such as this one, or formatting references, or DOI, or others open at the same time. Wikis like to do everything in the same window. So multiple browser windows (tabs) are your friend. You can have the page you are editing and several help windows open at the same time and easily switch between them to check on how to do something without having to save your content changes first.
 

Revision as of 13:17, 21 August 2015

It's very easy to edit the contents of a wiki. It only takes a few clicks. See also the slideshow covering the editing overview.

  1. Log in
  2. Click the Edit link.
  3. Make changes to the text.
  4. Complete the acknowledgements
  5. Click the Save button.

Simple as that! Of course, the guidelines below may help you to feel more confident. Remember you should always aim to improve the overall contents of the wiki with your edits. If you're wondering what type of content to add, see PetroWiki:Appropriate_content

Editing overview tutorials

The following audio/visual tutorials represent the same tutorial in different formats. This is to better serve our contributors with formats that meet their individualized needs and requirements.

YouTube

View this tutorial as a video at YouTube. Visit our YouTube Channel.

Slideshare

{{#widget:Slideshare|id=36766023|width=500|height=300|title=Editing Overview|user=SPEupdates}} View this tutorial as slideshow at Slideshare. Visit our Slideshare Channel.

Screencast

{{#widget:Screencast|id=de0d0bf5-e614-4bdc-bcdc-18c43d092e57|width=450|height=250|folder=PetroWiki Video Tutorials|user=speinnovations}}

View this tutorial as a video at Screencast.

Editing rules, editing conventions, and formatting

The number one rule of wiki editing is don't be afraid to try. An edit can contribute whole new paragraphs or pages of information, or it can be as simple as fixing a typo or a spelling mistake. In general, try to add or edit text so that it is clear and concise. Most importantly, make sure you are always aiming to do something which improves the contents of the wiki. When you need to use some type of formatting, such as for a new headings or bolding of text, you do this the edit toolbar edit toolbar above the content entry area. See Help:Formatting for some of the common types of formatting used.

Edit summary

Before you save a change, you can enter a short note in the Summary: box describing your changes. Don't worry too much about this, or spend too much time thinking about it, but try to give a little description of what you just changed e.g. "fixed typo" or "added more information about sunflowers". The summary gets stored alongside your edit, and allows moderators and other users to track changes in the wiki more effectively.

Multiple browser windows (tabs)

When you are editing a page, it is sometimes helpful to have a help page such as this one, or formatting references, or DOI, or others open at the same time. Wikis like to do everything in the same window. So multiple browser windows (tabs) are your friend. You can have the page you are editing and several help windows open at the same time and easily switch between them to check on how to do something without having to save your content changes first.