Help:Editing:Basics

From QMRAwiki
Jump to: navigation, search

Be bold!

Remember,

  • Content is more important than formatting. The wiki system allows more experienced proofreaders to clean up your entries if they don't have perfect formatting. Go ahead and put something in the wiki, and then ask for help if you want someone to clean up the formatting or discuss the content with you. As you gain experience you can help others with their pages.
  • You can try out different editing techniques in the Sandbox.
  • You can't mess up anything so badly that we can't go back to the previous version. QMRAwiki saves old versions of every page.
  • Use the discussion pages for guidance if you're uncertain about something
  • Editing is a collaborative effort that should strive for a neutral point of view (NPOV). We want links to your strong opinions, but these should be placed outside the main QMRAwiki site, where others can't edit them.

Editing Existing Pages

To edit a page, click either the edit tab on top of the display, or one of the edit links for a specific subsection. This will bring up an editing form. If you are having trouble editing, ask for help or use the discussion pages located in the tabs at the top of each page to express a problem to our editors.

Following a Red Link

Often, you will be reading a page that someone else created that has both Blue and Red text links. Links in red text are to pages that don't exist yet; whoever put in the link thought a page was needed, but didn't get around to creating one. If you click on such a link, you'll get an edit page for that page.

Working in Edit Mode

File:Edit buttons.jpg
Edit buttons at bottom of a page in Edit mode

Adding or editing is just like any other web form. Click or drag to select an insertion point, and just type away. Just remember don't use the TAB key to space your text. That will take you out of the editing box.

Note that you can preview your changes before saving them. This is useful, since things don't always come out as expected, but you should also be sure to save at regular intervals. If you don't, your changes could be lost if your session times out, or if someone else starts editing the page while you're working on it. The show changes button shows you what parts of the page you've changed. The Summary box allows you to put in a short description of why you edited the page. This is optional, but it can be useful for when you, or others, come back and edit the page again. For example, if you delete a material that you think is inappropriate for a page, you might want to explain that to keep others from adding it back without thinking about it. Others may disagree with you and add it back anyway, but in that case, you should work out a neutral consensus text with the other editors. Each page in the wiki has a discussion page which is a good place to work things out.

Here's a common unintended effect: 
If your text winds up in a box like this, it's because you started it on a line beginning with 
one or more blank spaces. So don't try to indent your paragraphs!

This is all you need to know to start editing. If you're just adding text or fixing typos, you can just go ahead and skip the rest of this tutorial.

Adding Links

One of the most important aspects of making a page useful are the links to other pages. These can be links to other pages in EcoliWiki or links to pages on other websites

Internal Links

To insert a link to another page in QMRAwiki, put the name of the page inside a pair of brackets.

[[Main Page]]

creates

Main Page

Note that this is case-sensitive. Main page and main page create red links, indicating no pages with those names. However, if you want different capitalization to all lead to the same page you can create those pages and have them contain only a REDIRECT statement that points to the original page.

Piped Links

Often, it is useful to have link to a page using different text than the page name. For example, at the top of this page, there is a sentence that starts with:

Use the discussion pages or...

This actually links to Help:Discussion Pages, not discussion pages. The link as made using a pipe character (|) between the PageName and the text for the link:

[[Help:Discussion Pages|discussion pages]]
Linking to a Subsection

To link to a subsection in the middle of the page, use the # sign after the PageName, followed by a subsection name. For example:

[[Help:Editing:Basics#Italics, Bold, and Bold Italics]]

gives

Help:Editing:Basics#Italics, Bold, and Bold Italics

which links to a subsection on this Help page. Of course, this can be used in a piped link too, as in how to make italics.

Linking to Category Indices

Pages can be placed into categories, and the index pages for different categories are very useful for finding content. The PageName for a Category index is Category:CategoryName, but making a link as

[[Category:Help]]

Doesn't link to the Help index, it adds the page to that category. To make a link to an index page, add a colon (:) before the PageName, like this:

[[:Category:Help]]

to get

Category:Help

Again, you can pipe this to give a link to a list of help pages.

External Links

If you just place a URL in the text, it will be converted to a link: http://example.com However, usually you want the linked text to be something other than the raw URL. To do that, put the URL and the link text, separated by a space, inside square brackets like this:

[http://wiki.camra.msu.edu QMRAwiki home page]

becomes

QMRAwiki home page

This external link method will also work for links to other pages inside QMRAwiki. However, the internal link methods described above are preferred, because they allow the system to count how the pages link to each other.

Interwiki Links

There are some external sites that we will be linking to so often that it is useful to have shortcuts for them. These are called interwiki links.

Formatting characters

Italics, Bold, and Bold Italics

One of the most common edits will be to change E. coli to E. coli, or to italicize a gene name. Occasionally, you may want to make bold text, or bold italic text. Here's how:

italics ''italics'' Text is surrounded by two single quote (') marks on each side.
bold '''bold''' Text is surrounded by three single quote (') marks on each side.
bold italics '''''bold italics''''' Text is surrounded by five (three for bold, two for italics) single quote (') marks on each side.
'italicized single quoted' '' 'italicized single quoted' '' Put a blank space in between the marks for italics and the single quotes you want to appear in the text.
Strikethrough Text <s>Strikethrough Text</s>

Most of the time on QMRAwiki, you should not need anything besides italics. However the bold font can draw attention to areas that the editor wants to emphasize.

Subheadings

One of the reasons you should not need to do much beyond italics is that you don't need bold or different font sizes to make subheadings. Subheadings at different levels are made by putting different numbers of '=' signs around text on a line, where the string of equals signs are the first thing on the line.

On QMRAwiki pages, the Page Title is a level 1 heading, so start any headings with two = signs, and increase the number for subheadings and sub-subheadings. Headings made in this way are automatically used to generate a table of contents for each page in outline format, like the one for this page:

Note that QMRA wiki uses the Headertabs extension on certain pages. On those pages, any heading using one '=' will be converted into a tab with the heading text as the tab label.

Categories

To add a page to a category, use

[[Category:CategoryName]]

This will not be rendered on the page, but will add a category link to the bottom of the page. For example, this page is in the Help category. A list of categories can be found at Special:Categories. Using a new CategoryName creates a new Category. Any given page can belong to multiple categories.

More Info

  • Basic Editing tutorial - Just enough to get started: Entering Edit mode for existing pages, creating new pages, adding Links, basic formatting (italic,bold,bold-italic), Subheadings, Categories
  • Intermediate Editing tutorial (all on one page) - For users who want more control over appearance: Indenting, Lists, Image and table basics. Basic templates, Including content from one page into another. Individual tutorials:
    • Lists
    • Images
    • Tables
    • Citations/referencing [1]
    • Templates - includes how to include content from another file, as either an editable or noneditable copy
  • Advanced Editing tutorial - Advanced topics: for those who will be building templates, and those who just want to know what else can be done