Authoring Pages

From Isis Workshop

This document will give you a brief overview of how to author a page and the MediaWiki Markup language, for a complete guide see the "see also" section at the bottom of this document.

[edit] General Editing Guidelines

In general Wiki's are all about collaboration and making multiple revisions to documents (pages).

The reasons behind using this wiki are numerous, but there are a few key ones you should be aware of:

• Consistent look and feel: Keep an eye out for how some of the other workshops look, and try to stick to similar formatting.
• Interconnectivity: Provide helpful links to other items that you reference or use.
• Powerful Markup Language: MediaWiki's markup language is wildly used and appreciated for its ease of use, stick to using it even though most HTML elements still work.

Keep in mind that if you see some formatting on any page and wonder how to do that, just click the edit tab for that page and find out!

[edit] Naming

As talked about in other sections of this page, please refrain from using generic names for pages, files, etc... The cleaner we keep the name space the easier this wiki will be to use.

Examples of names for pages and files that shouldn't be used:

• Workshop
• PICTURE_095400.png
• Example_Image.jpg
• page
• movie.mov

Please try and stay consistent with your names, look through with the rest of the wiki for an idea of the conventions.

[edit] Creating Links

Making internal links is where the wiki markup is really helpful, it is as easy as adding two square brackets around the page name.

[[Page I Wish To Link To]]
[[Page_I_Wish_To_Link_To]]
[[Page I Wish To Link To|alternative text]]

[http://en.wikipedia.org/wiki/]
[http://en.wikipedia.org/wiki/ alternative text]
http://en.wikipedia.org/wiki/

You will notice that some links appear in Red, and others in Blue. The Red links indicate pages that have no content, and the Blue are normal pages with at least some content.

[edit] Creating a new page

To create a new page it is as simple as making a link to it.

1. Find a page that you would like to link to your new page: e.g. a new workshop, so go to the IsisWorkshop page and click the edit tab.
2. Create an link to your new page e.g: [[New Page]] (See Creating Links above)
3. Preview and save the page you are currently editing once you are done adding your new link, and like the way it looks.
4. Now you will see the link appear in red (this indicates the page that this link points to dose not exist yet).
5. Click on the new link, and it will take you to your new page, where you can begin editing.

[edit] Highlighting Terms

[edit] Using the Glossary

The Glossary is a listing of every term defined on this wiki, it is a nice place to get a quick definition and link to more information. The Glossary is there to be edited and added to, so if you would like to add a term go ahead and fallow the same guidelines as every other term, and make a quick page for that term so others may link to it directly if need be.

[edit] Linking to a Term in the Glossary

Use the '#' sign to denote an anchor within a page. For Example:

ISS in the Glossary

[[Glossary#ISS|ISS in the Glossary]]

[edit] Isis Applications

Like all other commonly used terms and links, always link to the internal Application page.

This allows every workshop to link to the same place, and reducing repetitive links that have to be managed. Keep in mind that Isis Application pages are not to replace the actual documentation, they are just a quick overview and link(s) to other resources for the actual in depth documentation.

[edit] Bold and Italics

Bold and Italics are done very simply using a quoted notation.

For Example:

Italicized text

Bold text

Italicized & Bold text

''Italicized text''
'''Bold text'''
'''''Italicized & Bold text'''''

[edit] Lists

There are two main types of lists, Un-Orderd (bulleted) and Orderd (numbered) lists. Both types can be done very easily using just wiki markups.

* Item 1
** Item 1.1
** Item 1.2
*** Item 1.2.1

# Item 1
## Item 1.1
## Item 1.2
### Item 1.2.1

# Example 1
# Example 2
#: 
# Example 3

[edit] Uploading Files

Once logged in you will see an "Upload file" option in your tool box on the left tool bar. Click that link to go to the uploads page, where you can select a file and fill out a description. You do not need to make a thumbnail for an image, the wiki will handle making the thumbnail for you, so it is best to upload the full resolution image (as long as it is not too huge).

Please change the file name to something that is fitting for the image or media, (e.g. don't use IMG_5435.jpg) you will have to refer to this image by its name, and it really helps to have an intelligent name to use.

The description is really useful, so at least put a few words describing the image or other media that you are uploading.

[edit] Uploading Restrictions

There are restrictions on uploads:

• File Size: Currently the maximum allowed size is 10mb
• File Type: We have restrictions put in place to only allow uploads of the fallowing format
  • png, gif, jpg, jpeg, gz, zip, cub, txt, mov, mp4, wmv, pdf, and avi. (This list may not be up to date)
  • If you would like to upload another type of file that is currently not allowed please contact the WikiSysOp to make a request.

Note: there have been some issues uploading files with multiple extensions (ie file.gz.tar) if you run into a similar problem, try renaming the file omitting some of the un-needed file extensions.

[edit] Using Pictures

Once you have a picture uploaded and in the wiki you will need to place it on a page, and there are many ways to do this. The syntax is very similar to creating links (double square bracket notation) with a few more controls.

How it Looks	How its done
	Just the image with no formatting, defaults to left justified. [[Image:Face on mars.png]]
	Just the image with no formatting, and some alternative text defined (mouse over the image to see the alternative text). [[Image:Face on mars.png|alternative text]]
	Thumbnail 100 pixels wide. [[Image:Face on mars.png|thumb|100px]]
Description of the Image	Thumbnail 100 pixels wide, and a Description. [[Image:Face on mars.png|thumb|100px|Description of the Image]]
	Image contained within a frame with left alignment. [[Image:Face on mars.png|left]]
Description of the Image	Image within a frame with a description that is centered. [[Image:Face on mars.png|frame|center|Description of the Image]]
Image:Face on mars.png	Link to the image with the image name. [[:Image:Face on mars.png]]
Alternative text	Link to the image with Alternative text. [[:Image:Face on mars.png|Alternative text]]

[edit] Image Gallery

There is also the gallery layout format for a large number of images, and it will automatically create thumbnails for you.

<gallery>
  Image:Face on mars.png|Alternative text
  Image:Face on mars.png|Alternative text
  Image:Face on mars.png|Alternative text
  Image:Face on mars.png|Alternative text
</gallery>

Alternative text

Alternative text

Alternative text

Alternative text

[edit] Blink Applet

This site has a built in java applet that will allow the readers to blink between images interactively. The blink applet will only work with images that have been uploaded to this site. The Blink Applet allows the users to interact with the images as they blink, giving them more control. Below is an example of how it is used.

{{#blink: Face on mars.png | Face on mars Sharp.png }}  (Supports up to 5 Images)

[edit] Sections and the Table of Contents

The Table contents is built automatically from the page sections, so by using sections correctly you can save your self a lot of work.

It is easy to specify sections and sub-sections by use of the equals sign notation:

==Heading 1== 
 ...
===Heading 1.1=== 
 ...
====Heading 1.1.1==== 
 ...
==Heading 2==
 ...

It is best to not add additional bold or italics to Section Headings, the heading style will handle the formatting automatically.

[edit] Tables and formatting

[edit] Tables

The wiki markup language has its own way of making tables, which is rather easy to use:

{| align="center"
! (header 1)
! (header 2)
! (header 3)
|-
| (row 1, cell 1)
| (row 1, cell 2)
| (row 1, cell 3)
|-
| (row 2, cell 1)
| (row 2, cell 2)
| (row 2, cell 3)
|}

{| border="1"
|+ The table's caption
! Column heading 1 !! Column heading 2 !! Column heading 3
|-
! Row heading 1
| Cell 2 || Cell 3
|-
! Row heading A
|Cell B
|Cell C
|}

{| 
| A 
| B
|- 
| C
| D
|}

{|
| A || B
|-
| C || D
|}

{| border="1" cellpadding="10" align="center"
! A !! B !! C
|-
| colspan="2" | DE 
| rowspan="2" | F
|-
| G || H 
|}

See Also: wikipedia's Help:Table Page for a more in depth explanation.

[edit] Pre-Formatted Text

This wiki has Pre-Formatted text blocks that you can easily use by just indenting the beginning of a line with a space. Pre-Formatted text blocks are great for encapsulating and denoting command line instructions, text files, etc...

Example:

a block of code that spaces remain in

a block of code      that     spaces   remain in

You can also use the HTML equivalent <pre> tags to define a Pre-Formatted text block.

[edit] Including Pages

Using modular pages very useful and should be done when ever there is repetition of content. The syntax to include a page is as fallows:

{{:Page Name}}

However including a page does not include the page title's heading, so it is recommended that you define it directly above:

==Page Name==
{{:Page Name}}

[edit] Redirecting Pages

A redirecting page is a page with no content other than:

 #REDIRECT [[pagename]] 

Useful for abbreviations to redirect to the actual word.

[edit] Categories

You can tag a page with a category (one or more) by adding the fallowing text to the end of the pages body.

[[Category:Category name]]

Categories are useful for linking together similar pages, e.g. Category:Isis_Application

[edit] Advanced

This section is specific to this wiki and its custom extensions.

[edit] JavaScript Includes

To include a JavaScript file in the /IsisWorkshop/javascript/ directory use the following:

 <JavaScriptInclude>name_of_file.js</JavaScriptInclude>

[edit] Java Applets

Below is an example of how to use one of the existing java applets:

 <JavaApplet code="applets.IsisPixels.IsisPixels"  width="340" height="300" align="center"><param name="image" value="applets/IsisPixels/assets/test.jpg">
  <param name="representation" value="integer">
  <param name="zoom" value="false">
  <param name="setPixels" value="true">
  <param name="coreBM" value="false">
 </JavaApplet>

Note: Currently there is a bug, that requires the first parameter to be specified on the same line as the JavaApplet element.

[edit] See Also

• Wiki: Cheatsheet
• Wiki: How to edit a page
• mediawiki Help: Contents Index of extra help topics