Help:Tutorial

From ILSTRAT
Jump to: navigation, search

Here is a guide to help you learn the ropes of creating and editing pages in ILSTRAT. The markup language for all mediawiki sites is called "wikitext." It is a bit different from HTML, but the principle is similar.
Edits will not "go live" until approved by the appropriate page administrator.

Requesting access to edit

To request access to ILSTRAT please send an email to ilstrat@isgs.illinois.edu.

Levels of users

Standard user

You will be able to log in and edit any page, but the edit will not be view-able to non-logged in users of ILSTRAT. The changes you make must be approved by a person in the "Reviewer" level of users.

Reviewer

Only a select group of people (ISGS section heads or their designee) will be granted this access. You will be assigned a list of "watched" pages (by request or assumed subject matter) and when these pages are changed you will receive an email requesting that you review changes submitted by a member of the "Standard user". If approved, the wiki page will be updated and will then be view-able by non-logged-in users of ILSTRAT and the old version of the page will get stored on the "View history" tab. (Do not confuse this with the "Historical" tab- the page in the "Historical" tab will never change.)

If the changes are not approved, they will be discarded.

Basics of wikitext

Once you are granted access to ILSTRAT, you can edit pages.

Quick mark-up guide

What it looks like What you type

To get a hard return at the end of the line
text line two

Italicize text with 2 apostrophes.

3 apostrophes embolden.

5 apostrophes embolden and italicize the text.

underline the text or underline and embolden.

To get a hard return at the end of the line<br>
text line two

''Italicize text'' with 2 apostrophes. 

3 apostrophes '''embolden'''. 

5 apostrophes '''''embolden and italicize''''' the text.

<u>underline</u> the text or '''<ins>underline and embolden</ins>'''. 

Wiki code tip: insert two apostrophes('') before and after a word to italicize the word. Do not use the quotation mark!

Lists and indents

What it looks like What you type
  • Unordered lists are easy to do:
    • Start every line with a star.
    • Stick to two levels please.
  • Previous item continues.
  • Make as many as you like.
* ''Unordered lists'' are easy to do:
** Start every line with a star.
** Stick to two levels please.
* Previous item continues.
* Make as many as you like.
  1. Numbered lists are:
    1. Very organized
    2. Easy to follow
  2. Previous item continues
  3. A new line will end the series
  4. You can even
    • Have unordered lists
    • Just mix the item markers
      1. Like
      2. This
  5. Easy!
# ''Numbered lists'' are:
## Very organized
## Easy to follow
# Previous item continues
# A new line will end the series
# You can even
#* Have unordered lists
#* Just mix the item markers
#*# Like
#*# This
# Easy!
A colon (:) indents a line or paragraph.

A newline starts a new paragraph.
. And for indenting equations (always)

We use 1 colon to indent once.
We use 2 colons to indent twice.
3 colons to indent 3 times, and so on.
: A colon (:) indents a line or paragraph.
A newline starts a new paragraph. <br>
Often used for discussion on talk pages.
And for indenting equations (always)
: We use 1 colon to indent once.
:: We use 2 colons to indent twice.
::: 3 colons to indent 3 times, and so on.
A semi-colon
introduces items in a

dictionary-style definition list.

Start each item
with a semi-colon and

continue with a colon and the definition part of the item.

; A semi-colon: introduces items in a 
dictionary-style definition list.
; Start each item: with a semi-colon and
continue with a colon and the
definition part of the item.

Linking

What it looks like What you type

Here's a link to the Herrin Coal Member.

But be careful - capitalization counts!

Here's a link to the [[Herrin Coal Member]].

Here is how to change the link that appears from Herrin Coal Member to Herrin Coal.

[[Herrin Coal Member|Herrin Coal]]

Intentionally permanent red link is a page that doesn't exist yet. You could create it by clicking on the link.

[[Intentionally permanent red link]] 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 placing a "#" before its title:


You can link to a page section by its title:

* [[Help:Tutorial#Images]].

External Link Carbonate

[http://en.wikipedia.org/wiki/Carbonate Carbonate]

Page sections

Click here to learn what type of information each section should contain.


Creating a new page

Currently, the way ILSTRAT is set up, it does not support the use of some punctuation marks (quotation marks, apostrophes, or commas (periods are fine)) in the page name.
Most users are not allowed to create pages. Please contact ilstrat@isgs.illinois.edu with the page name, whether the unit is formal or informal, and who should be in charge of approvals. A blank page will be created for you, and then you can edit it. This is a needed step so the page can be set up properly with stratcodes, redirects, and monitoring of edits for approval.

Create a page with a form (for site administrators and approved reviewers only)

  1. Navigate to "Special Pages" Special:SpecialPages, and from there navigate to "Start of Form" Special:FormStart.
  2. Enter the name of page in the first box.
    Select from the drop-down box:
    "Entry" - for a normal approved unit
    "Inform" - for an informal named unit
    Howto start of form.jpg
  3. Click "Create or edit"

Full page edits

  1. Navigate to the page you wish to edit.
  2. Click the "Edit with form" tab (the first edit tab) located at the top of the page to edit with forms or "Edit" tab (the second edit tab) at the top of the page to edit the raw wiki code.
Howto edit tab.JPG

Section edits (recommended)

This is preferred because it minimizes the risk of unintentional alteration of the wiki code.

  1. Click the edit link next to the section you wish to add data to. This method cannot be used in the "ISGS Codes" section. Use one of the whole page edit methods mentioned above.
Howto edit sections.JPG

Moving an Informal unit to a Formal unit

This should only be done by site administrators or approved reviewers.

  1. Make sure the page name is correct (check the capitalization).
    If the title needs to be corrected, move the page to the correct page using the Move command in the "More" tab.
    Howto edit move page.jpg
  2. Correct the page name and make sure the box next to "Leave a redirect behind" is unchecked.
    Howto edit move page settings.jpg
  3. Edit the page using the whole page edit option.
    Replace {{editwithformin}} with {{editwithform}}
    This change (removing the informal information from the page) may not happen immediately. If you followed the instructions correctly the changes will eventually show up.
    Howto edit move page code.jpg
  4. You will also need to update the strat code redirect page to point at this renamed page.


Uploading images

To insert an image into an article, you must first upload the image Upload file. Make note of the name as you will need it later to insert the image in the page. See file naming conventions below.

Summary field

This field will be used as the caption for the image.
example:

 Fig. 21 -- Fossils present in the Herrin Coal Seam.

Image size restrictions

Uploads are limited to 50mb

Image dimensions

Please try to limit the image sizes (in pixels) to something reasonable. See Help:Image Sizes for examples.

File naming convention

fig_strat code_heading_###.jpg

  • Strat code: is the 4 digit internal ISGS code, found at the bottom of each page.
  • Heading: is the section heading on the page where you want to insert the image.
  • ###: is a sequential number starting at 001 for each section (include the zeros).

example:

 fig_2660_fossils_021.jpg

Translation- the figure is on the Herrin Coal Member page, in the Fossils section, and is image number 21 (of the Fossils section).

Supported media types for images

The following file formats are supported by default:

  • .jpg or .jpeg : bitmap image compressed in the standard JPEG format (this lossy format is most suitable for photographs).
  • .png : bitmap image in the Portable Network Graphics|Portable Network Graphics format (specified by the W3 Consortium).
  • .gif : bitmap image in the legacy Graphics Interchange Format.

ILSTRAT image (gallery) code

This is the code that ILSTRAT uses to insert images into pages

<center>
{| class="wikitable" style="text-align: center;"
|-
|<gallery caption="" widths=250px heights=250px perrow=4>
Figure_Pc-1.jpg|{{file:Figure_Pc-1.jpg}}
</gallery>
|}
</center>

What the above code yields

Explanation of the code

Figure P-13.jpg|{{file:Figure P-13.jpg}}
  • Figure P-13.jpg--file name
  • {{file:Figure P-13.jpg}}--this calls the "summary" from the image page and is used as the caption.
  • If you want different text to appear as the caption replace {{:Figure P-13.jpg}} or everything after the pipe | with the new text
Best practice is to make sure the image page has the correct info on it and not to alter this coding.

Multiple images

To insert more than one image duplicate the line Figure P-13.jpg|{{file:Figure P-13.jpg}} and edit for each image accordingly.

<center>
{| class="wikitable" style="text-align: center;"
|-
|<gallery caption="Text that you want to call the collection of images (optional)" widths=250px heights=250px perrow=4>
Figure P-13.jpg|{{file:Figure P-13.jpg}}
...more images following the code above in needed
</gallery>
|}
</center></nowiki>

Adding a gallery caption

Change the gallery caption="Text that you want to call the collection of images (optional) - this is primarily only used if the images you are inserting are a supposed to be grouped as a single figure. Example using caption="Fig. P-3 -- Exposures of Pennsylvanian rocks."

<center>
{| class="wikitable" style="text-align: center;"
|-
|<gallery caption="Fig. P-3 -- Exposures of Pennsylvanian rocks." widths=250px heights=250px perrow=4>
Figure P-3A.jpg|{{file:Figure P-3A.jpg}}
Figure P-3B.jpg|{{file:Figure P-3B.jpg}}
</gallery>
|}
</center>

Yields

In-text linking

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 (|):

[[:file:Figure P-13.jpg|Fig. P-13]]
becomes Fig. P-13

Other image codes

Usage
To include a file in a page, use a link in one of the following forms:

  • [[File:File.jpg]] to use the full version of the file
  • [[File:File.png|200px|thumb|left|alt text]] to use a 200 pixel wide rendition in a box in the left margin with "alt text" as description
  • [[Media:File.ogg]] for directly linking to the file without displaying the file

For more info see
Image Help on mediawiki.org

Clickable images

Click here to learn about making clickable images

Tables and equations

Tables and equations

Still confused?

Send and email to ilstrat@isgs.illinois.edu and an administrator will help you out.

External links