Difference between revisions of "Editing Quickstart Guide"

From eLinux.org
Jump to: navigation, search
(Add stuff about basic formatting and links)
Line 1: Line 1:
 +
This page exists to get new wiki contributors up and running quickly.  There
 +
are three main things you need to know in order to start adding useful content
 +
to a page:
 +
# basic formating, including sections
 +
# adding links to other pages and external web sites
 +
# uploading files
 +
 +
For more advanced topics, like creating tables
 +
 +
== Basic formatting ==
 +
Here are some very basic MediaWiki formatting helps:
 +
 +
{| border="1"
 +
|- MediaWiki markup cheatsheet
 +
!markup!!result
 +
|-
 +
|<nowiki>'''bold''' ''italic''</nowiki>||'''bold''' ''italic''
 +
|-
 +
|preceding spaces||preformat (present exactly as shown in page source)
 +
|-
 +
|<nowiki><nowiki>text</nowiki></nowiki>||''don't process markup''
 +
|-
 +
|<nowiki>== Section heading ==</nowiki>||''See section headings on this page''.  Number of '=' signs indicates section level.  You should use level 2 or more on the page.
 +
|}
 +
 +
== Adding Links ==
 +
To make a word or phrase into an internal link, just use the link syntax:
 +
'''<nowiki>[[word or phrase]]</nowiki>'''.  Use a pipe if you wish to show slightly
 +
different text to the user for the link: '''<nowiki>[[word|alt text]]</nowiki>'''
 +
 +
To link to external material, use a direct link:
 +
<nowiki>http://www.google.com/</nowiki>
 +
To use different cover text, use brackets and a pipe:
 +
<nowiki>[http://www.google.com/|Google]</nowiki>
 +
 
== Uploading files ==
 
== Uploading files ==
 
To upload a file, click on the "Upload file" link in the toolbox in the left sidebar.
 
To upload a file, click on the "Upload file" link in the toolbox in the left sidebar.

Revision as of 12:30, 5 December 2006

This page exists to get new wiki contributors up and running quickly. There are three main things you need to know in order to start adding useful content to a page:

  1. basic formating, including sections
  2. adding links to other pages and external web sites
  3. uploading files

For more advanced topics, like creating tables

Basic formatting

Here are some very basic MediaWiki formatting helps:

markup result
'''bold''' ''italic'' bold italic
preceding spaces preformat (present exactly as shown in page source)
<nowiki>text</nowiki> don't process markup
== Section heading == See section headings on this page. Number of '=' signs indicates section level. You should use level 2 or more on the page.

Adding Links

To make a word or phrase into an internal link, just use the link syntax: [[word or phrase]]. Use a pipe if you wish to show slightly different text to the user for the link: [[word|alt text]]

To link to external material, use a direct link: http://www.google.com/ To use different cover text, use brackets and a pipe: [http://www.google.com/|Google]

Uploading files

To upload a file, click on the "Upload file" link in the toolbox in the left sidebar. Then enter the filename to upload and click submit.

Files uploaded can be presented in 3 ways to the user:

  1. an image can be inlined on the page.
  2. a page describing the file can be displayed
  3. a link can be provided to directly download the file to a client's computer

To inline an image, use the syntax: [[Image:filename.jpg]] If the image is clicked on, then the description page will be shown. To present a direct-download link, use the syntax: [[Media:filename.ext]]

For files with a well-known type, use a template to show an icon for the file type. Here is an example using the PDF template: {{pdf|media:pdf-filename.pdf|alternate text}}