Difference between revisions of "Help:MediaWiki basics/Beginner training"

From LIMSWiki
Jump to navigationJump to search
(→‎Links: Updated.)
Line 37: Line 37:
===Links===
===Links===


This is me making an internal link to the template "ombox," which is used on this page: [[Template:Ombox]]
Links provide embedded navigation to other content within the wiki or to content outside the wiki. They are an important part of wiki editing and provide convenient avenues for further user research.


This is me making an internal link to the template "ombox," but this time making different text appear for the link: [[Template:Ombox|I'm such a rebel]]
Here are four of the most common link formation methods in MediaWiki:


This is me making an external link to the same template located on Wikipedia: [http://en.wikipedia.org/wiki/Template:Ombox]
# This is an internal link to the "Laboratory" page (on this wiki): [[Laboratory]]
# This is an internal link to the "Laboratory" page, but this time making different text appear for the link: [[Laboratory|I'm such a rebel]]
# This is an external link to the same page located on Wikipedia: [https://en.wikipedia.org/wiki/Laboratory]
# This is an external link to the same page located on Wikipedia, using different link text: [https://en.wikipedia.org/wiki/Laboratory Wikipedia's page on the laboratory]


This is me making an external link to the same template located on Wikipedia, using different link text: [http://en.wikipedia.org/wiki/Template:Ombox Why is there no pipe in this type of link?]
You should notice the differences between internal and external links and how to format them:  


<pre>
* You can make an internal link by using a set of double square brackets. The title can be left as the default: <code><nowiki>[[Laboratory informatics]]</nowiki></code> yields... [[Laboratory informatics]]
You should notice the difference between these two types of links and how to format them.  


You can make an internal link by using a set of double square brackets. The title can be left as the default:
* Or you can give it a new title by adding a pipe (|) and then typing the text you want to appear in place of the original: <code><nowiki>[[Laboratory informatics|cool laboratory stuff]]</nowiki></code> yields... [[Laboratory informatics|cool laboratory stuff]]
[[Laboratory informatics]] yields...
 
</pre>
* You can make an external link by using a set of single square brackets. The title can be left blank: <code><nowiki>[http://www.nupedia.com]</nowiki></code> yields... [http://www.nupedia.com]
[[Laboratory informatics]]
 
<pre>
* However, it's better you give it a title by adding one space and typing the text you want to appear in place of the URL: <code><nowiki>[http://www.nupedia.com Nupedia.com]</nowiki></code> yields... [http://www.nupedia.com Nupedia.com]
Or you can give it a new title by adding a pipe (|) and then typing the text you want to appear in place of the original:
[[Laboratory informatics|cool laboratory stuff]] yields...
</pre>
[[Laboratory informatics|cool laboratory stuff]]
<pre>
You can make an external link by using a set of single square brackets. The title can be left blank:
[http://www.nupedia.com] yields...
</pre>
[http://www.nupedia.com]
<pre>
However, it's better you give it a title by adding one space and typing the text you want to appear in place of the URL:
[http://www.nupedia.com Nupedia] yields...
</pre>
[http://www.nupedia.com Nupedia]


Consult the relevant [[Help:Contents#Links|Help:Contents]] section for more information.
Consult the relevant [[Help:Contents#Links|Help:Contents]] section for more information.

Revision as of 20:53, 20 October 2013

Getting started with MediaWiki

Note: When opening links from wiki pages, right-click a link and choose to open it in a new tab. This should make navigating your way through the wiki less complex.

You'll notice a box with text and a big blue "i" in it above. We'll get to that in a bit. But first let's talk about...

Creating a page

A wiki is made up of parent pages and subpages, and each page has a unique title. When choosing a title for a page on LIMSwiki, the editor must be aware of the naming conventions for article titles. That previous blue link takes you to a page explaining those rules, including using lower case, using singular nouns, and avoiding abbreviations among others. Right-click that link, open it in a new tab, and read more about these naming conventions.

Done? The next thing we need to know about titles and page creation is that choosing a correct namespace is vital. Namespaces are a mechanism for grouping/separating wiki pages, differentiating between the purpose of the pages at a high level. Pages in certain namespaces can have special properties or behave differently when they interact with other pages. Namespaces are indicated in page titles by prefixing the page name with "namespace:", so the prefix "Help:" in this page's title ("Help:MediaWiki basics/Beginner training") indicates that this page is in the Help namespace. A page whose name is not prefixed by a namespace lies in the mainspace.

If you're not sure what space your page belongs in, you might want to check out Help:Namespaces.

How to create a page

The easiest way to create a new page on this site is to use this wiki's "create a new page" tool. Following the previously mentioned naming conventions, choose the correct namespace and simply enter the title of the parent page. For non-mainspace pages, be sure to add the title after the namespace prefix.

Otherwise, simply type the full title of the page you wish to create into the search box on any page and select "Go". If the page does not already exist, you'll be asked if you want to create it. For example, if you wish to create a page titled "Nuclear reactor", type it into the search box, select "Go", and you'll see "Create the page 'Nuclear reactor" on this wiki!"

Finally, to create a subpage, simply add a / and the subtitle, following the usual naming conventions. This page you are on ("Help:MediaWiki basics/Beginner training") is an example of a subpage of Help:MediaWiki basics. Subpages should be created sparingly if at all.

Examples of page titles:

Links

Links provide embedded navigation to other content within the wiki or to content outside the wiki. They are an important part of wiki editing and provide convenient avenues for further user research.

Here are four of the most common link formation methods in MediaWiki:

  1. This is an internal link to the "Laboratory" page (on this wiki): Laboratory
  2. This is an internal link to the "Laboratory" page, but this time making different text appear for the link: I'm such a rebel
  3. This is an external link to the same page located on Wikipedia: [1]
  4. This is an external link to the same page located on Wikipedia, using different link text: Wikipedia's page on the laboratory

You should notice the differences between internal and external links and how to format them:

  • You can make an internal link by using a set of double square brackets. The title can be left as the default: [[Laboratory informatics]] yields... Laboratory informatics
  • Or you can give it a new title by adding a pipe (|) and then typing the text you want to appear in place of the original: [[Laboratory informatics|cool laboratory stuff]] yields... cool laboratory stuff
  • You can make an external link by using a set of single square brackets. The title can be left blank: [http://www.nupedia.com] yields... [2]
  • However, it's better you give it a title by adding one space and typing the text you want to appear in place of the URL: [http://www.nupedia.com Nupedia.com] yields... Nupedia.com

Consult the relevant Help:Contents section for more information.

Templates

Let's get back to that box with text and a big blue "i" at the top. We call that an "infobox." That's created using the template "ombox," referenced above in the first set of example links. Open one of those links in a new tab or window to learn more about this template.

Templates are distinct because they contain two braces in front (like this: {{ ) and two in the back (like this: }} ).

Here are some internal links to pages on this wiki that utilize a variety of different templates. Let's look at each page (open in a new tab or window) and choose the "edit" option to see the code:

Consult the relevant Help:Contents section for more information.

Formatting text

Bold text

Here I bold this text for effect: Do you think it looks ok?

I can even make a link appear in bold like this: LIMS vendor

How did I do that? I simply added three apostrophes to each side like so:

'''Here I bold this text for effect'''

'''[[LIMS vendor]]'''

Italic text

Here's italic text for you: What do you think?

Like bold text, I can italicize a link like this: LIMS vendor

How did I do that? I simply added two apostrophes to each side like so:

''Here's italic text for you''

''[[LIMS vendor]]''

Preformatted text

You'll notice so far I've used several instances of gray boxes with wiki code in them on this page. How do you display that wiki code like that without the browser running it? You do it by using the preformatted text tag:

<pre>This is preformatted text. Here is the ombox code used on this page:

{{ombox
| type      = notice
| style     = width: 960px;
| text      = This is my sandbox, where I play with features and test MediaWiki code. If you wish to leave a comment for me, please see [[User_talk:Shawndouglas|my discussion page]] instead.<p></p>
}}
</pre>

So you essentially use the <pre> tag to display the code without rendering it.

But wait a minute. How did I just get the <pre> tag to show on the page without the browser running it? In this sentence and the one previous to this, I used a different technique to display the tag:

<nowiki><pre></nowiki>

I used the <nowiki> tag to display what would otherwise be rendered as code. Note that with both tags, I had to "close" their use with a corresponding duplicate but with the "/" character in front of the word.

This may seem a bit confusing at first, but don't worry. You'll get the hang of this type of formatting. I wanted to introduce it for the next topic: spacing.

Spacing

This is my first line of text. This is my second line of text.

Here's what I entered into the edit box to get the above to appear:

This is my first line of text.
This is my second line of text.

Notice what happens if I don't put a space between the lines of text in the edit screen? The lines run together. You'd think putting a line under another with a hard return would be enough, but it's not. You must add an additional hard return, creating a space between the lines in the edit box.

I actually want it to look like this:

This is my first line of text.

This is my second line of text.

So I have to edit it like this in the code:

This is my first line of text.

This is my second line of text.

There are several relevant Help:Contents sections with more information about text formatting.

Organizing text

If you are viewing the code to this page, you'll notice there are several bits of code with numerous "=" signs. These are responsible for creating headings and subheadings.

You'll notice the first example:

==Sandbox begins below==

This is the first level of headings, the section heading. You do this by placing two "=" in front and behind some text. 

NOTE: Know we have a rule here, just as in Wikipedia; with the exception of proper nouns, only the first word of the heading or subheading is capitalized! In this case, it's "Organizing text," not "Organizing Text."

If you look under the heading "Sandbox begins below," you'll notice numerous subheadings. And in the subsection "Formatting text" there is yet another subheading below that:

===Formatting text===

====Bold text====

Simply add another "=" to the front and back to create an additional subheading.

You can also create ordered and unordered lists, add definition lists, add extra spacing in the front of text (useful for commenting on talk pages), and how to sign your comments (also very important). Learn about these items and more in the relevant Help:Contents section.

Citation

To begin using citations, it's easy to start with a copy/paste of existing citation code. Inline citations are added directly after a piece of information or quote in a body of wiki text.

You'll want to use this page as your initial guide: LIMSWiki:Citation guidelines

It details the citation code you'll use on probably 95 percent of the references you make: Cite web, Cite book, and Cite journal

You can copy code from there, paste it into your edit, and then edit the values of the fields. That page also has links to the original templates in case you need additional attributes not listed in the examples.

Also, it's imperative to include a references section on any page that includes inline citations. Otherwise, pages won't show up properly. You do that by placing the following code:

==References==
<references />

Images

Wiki puzzleThis is me playing with linking to images on Wikimedia Commons. We'll get into image uploading and linking a little later.