Help:Editing advanced

From Teflpedia
(Redirected from Help:Detailed editing)

"Official" Guides[edit]


Font appearance[edit]

use two, three or five single apostrophes before and after:
''Italic'', '''bold''', '''''italic and bold'''''
Italic, bold, italic and bold

HTML tags you can use[edit]

Small text:
ordinary <small>and small text</small> example
ordinary and small text example
Big text:
ordinary <big>and big text</big> example
ordinary and big text example
Strike out text:
ordinary <s>and stricken out material</s> example
ordinary and stricken out material example
Teletype or monospace text:
ordinary <tt>and teletype text</tt> example
ordinary and teletype text example
ordinary <sup>and superscripted text</sup> example
ordinary and superscripted text example
ordinary <sub>and subscripted text</sub> example
ordinary and subscripted text example

Note: all of the above are "switched off" if a "Return" (↵) is inserted.

A line break can be forced using <br />:
This is the first line<br />and this the second
This is the first line
and this the second


same as headlines/chapters/sections

Headings use equals symbols ("==") before and after the desired heading:
==New section==

A first level (new section) heading is for example the "Word formatting" heading on this page.
The "Headings" heading above is an example of a 2nd level (subsection) heading.
The "Bullet lists" heading below is an example of a 3rd level (sub-subsection) heading.

These headings are equivalent to <h2> <h3> <h4> in HTML and <h1> is already taken for the page name line at page top; so we start with <h2> heading level (==New Section==).

Note: The "Table of contents" box you see at the top of this page will appear automatically when you have used 4 or more headings. First level headings are shown as x, 2nd level as x.x and so on.


Bullet lists[edit]

You can make bullet lists with "*":

* First level list object
** Second level list object
*** Third level list object
* Another first level list object

  • First level list object
    • Second level list object
      • Third level list object
  • Another first level list object

Numbered lists[edit]

You can make numbered lists using "#":

# First level list object
## Second level list object
## Another second level list object
### Third level list object
# Another first level list object

  1. First level list object
    1. Second level list object
    2. Another second level list object
      1. Third level list object
  2. Another first level list object

Mixed lists[edit]

You can even make mixed lists:

* You can even do mixed lists
*# and nest them
*#* like this

  • You can even do mixed lists
    1. and nest them
      • like this

Definition lists[edit]

Using ; and :
:the item's definition
;item:the item's definition

Either of which becomes:

the item's definition


To Teflpedia pages[edit]

See main article Help:Linking.

Double square brackets around a page name:
[[Main Page]]
becomes a link to that page: Main Page
You can alias the link using the "pipe" (|) symbol thus:
[[Main Page|Teflpedia main page]]
becomes: Teflpedia main page
Plural -s outside the link:
To link the plural form of a word, put "s" outside the link. It renders as part of the link but links to the singular word page. Teflpedia articles are usually titled in the singular form. This trick works with -s, -ies, and even -ing.
becomes: words (notice it links to word, not word)

To Wikipedia pages[edit]

Links to Wikipedia articles are easy using MediaWiki's interwiki links. Example: [[Wikipedia: Phoneme]] gives Wikipedia: Phoneme.

To external sites[edit]

To maintain site cohesion in Teflpedia articles we usually segregate external links to the References or External links sections.

Start with http://, or https:// for secure URLs.

Bare URL
Numbered link
becomes [1]
Named link
[ Example Site]
becomes Example Site


You can create an automatic "References" or "Notes" section to list all references or notes on a page.

At the bottom of the page, add a section with only the code <references/> in it.





That code will auto-list all references that are put within <ref>...</ref> tags on the page.

Use the format: Content you want to provide a reference for.<ref>Smith, John. Imagine it, ''ELT Wizards,'' 0(0) 2020.</ref> Do not insert space before the <ref> tag. Ref tags go after punctuation (except dash).

The references or notes between the <ref> & </ref> tags will not appear there, instead a small blue superscript box ([1]) containing a numbered link appears there. It links to the auto-generated list of references where the <references/> tag is.

All the references (or notes) will be auto listed there. Clicking on any numbered reference box in the text will take you to the appropriate reference (or note). Each entry in that list has a small blue 'up' arrow () that links back up to the place in the text that links down to it, for easy navigation between citations and their references. References are edited where they occur in the text, within the <ref> tag that defines them, not in the References (or Notes) section which is auto generated.

Write references so that people can follow them to the source.

Conteh, Jean. Translanguaging ELT Journal. 72(4), 2018, p. 445.
Crystal, David. The Cambridge encyclopedia of the English language. Cambridge University Press, 1995, p. 79.
Wikipedia: Phoneme

If the source is online, link the relevant part of your reference to the online source, but because that link may break due to link rot, provide publication, article and author names and dates that can be searched with a web search engine or in a library.

Link rot. URLs on the internet change and old links stop working as sites evolve. So please include publication, article and author names and dates so that anyone can easily search.

See also: Wikipedia's guide on citing sources.


Images are inserted using the syntax:
[[Image:filename|options|caption text]]
The options are divided usin the pipe (|) symbol
The last item that is not a recognised option will always be considered the caption text.

Bare image without text[edit]

Using no options and no caption:
Sits inline at the actual size [[Image:Teacher.jpg]]

Sits inline at the actual size Teacher.jpg

Image with text caption[edit]

You add "|caption text" after the image link. This is the text most browsers will show when you hover over the image with the mouse:
[[Image:Teacher.jpg|Teacher with no options]]Teacher with no options

Image options[edit]


Teacher with thumb option
thumbnail, thumb:
Generates an automatically resized thumbnail image (either reduced or enlarged).
Caption text is displayed directly underneath. An "enlarge"-icon is added.
If you do not specify where the image should be placed it will be placed to the right.
Example to the right:

[[Image:Teacher.jpg|thumb|Teacher with thumb option]]


The image will have a frame, regardless of whether it is a thumb, and the caption text will be included as a visible caption.
Example to the left:[[Image:Teacher.jpg|frame|left|Teacher with frame option left]]
Teacher with frame option left

Right, left, center[edit]

Makes the image right-aligned.
Same as above, but left aligned.
center (note American spelling):
Same as above, but centred.
The image will be rendered in-line, even if the thumbnail-option is set.


Renders a version of the image that's [size] pixels wide (e.g. '150px').
Height is computed to keep the aspect ratio (i.e. the shape of the image).
This allows both size reduction and enlargement.

[[Image:Teacher.jpg|50px|Teacher 50pixels wide]]Teacher 50pixels wide

WARNING: if you set very big image size, say 1000px, the image might not show at all and you might get only a link to the image. 900px size seems to work however, probably sufficient.

Combining options[edit]

You can combine the options as you like:
[[Image:Teacher.jpg|20px|thumb|left|Teacher thumb left]]
Teacher thumb left
[[[Image:Teacher.jpg|center|frame|Teacher frame center]]
Teacher frame center

To force following text below the image, use Template:clear ({{clear}}).


Tables are complex; they use a code unique to wikimedia.

As a general rule:

  1. declare a table using {|
    • add any formatting for the whole table on the same line, including parameters in double quotes
    • ↵ (return)
  2. declare each new row using |-
    • ↵ (return)
  3. begin the first column of that row using |
    • enter the data for that cell
  4. begin the second (and subsequent) columns for that row using ||
    • enter their data
    • ↵ (return)
  5. finish the table using |}

A simple 2 column, 3 row table:
{| class="wikitable"
| Given name || Humpty
| Sirname || Dumpty
| Seating || Wall top
Given name Humpty
Sirname Dumpty
Seating Wall top

See also MediaWiki table guide

It is permissible to use the HTML "table" format: you can create a table using an external program and copy it here.


Creating userboxes. Userboxes are quite simple to create. As with many computer based tasks the job consists of a series of small tasks – each very simple in its own right – but which look complicated when strung together. On this site userboxes usually have a small graphic to the left and some text to the right. You will need to upload a graphic, create a new page, copy in some userbox code, edit it a bit, preview it and save it.

  1. If you are going to use a graphic then first find an appropriate graphic and upload it. (Please do not use copyrighted material). It is a good idea to reduce the size of the image before uploading it as you are only going to display a small image. Upload the image by using the "Upload file" link to be found on the far right.
  2. Decide on the name of your userbox. When you have done this type: “Template:name of your userbox” (where “name of your userbox” is the actual name of the userbox you wish to create.)
  3. This will generate a “not found” page with a red link to the top left having the name of the page you wish to create. Click this link.
  4. Find a userbox close to the one you like, and use the “edit” button to see the code.
  5. Copy the code to the page you are creating. (If you then click “review” you should see an image of the box you copied.)
  6. Go to the image you uploaded and copy the name of the file you uploaded and paste it over the same part in the code you copied. If you click preview you should see that the image has changed. Edit the image size by changing the box numerals and keep clicking preview until you are happy.
  7. Change the text to a text you want. And review again. When you are happy press “save”.

Table of contents[edit]

If an article contains more than three headings, a Table Of Contents (TOC) will normally be created automatically.

Removing table of contents[edit]

If, for whatever reason, a TOC isn't wanted it can be switched off by including when editing: "__NOTOC__" (that's: "underscore, underscore,N,O,T,O,C,underscore,underscore" meaning NO Table Of Contents). It is usual to put this at the top of the page, it will not show in the page.

Adding table of contents manually[edit]

If "__FORCETOC__ "(2 x underscore each side) is used, then a TOC will occur before the first heading even if there are three or fewer headings.
Similarly if "__TOC__" (2 x underscore each side) is used, then a TOC will occur at the point where "__TOC__" is placed even if there are three or fewer headings. You can thus place the TOC at any point vertically or horizontally or in a table cell.

Note: "__TOC__" overrides __NOTOC__".

Table of contents in a table[edit]

The table of contents can be forced into a floating table on the right hand of the screen with this code:
{| align="right"
| __TOC__

Edit Conflict[edit]

Occasionally someone else might edit a page begining after you and saving before you. This produces an edit conflict. The software gives you the opportunity to examine the edit made by the other person and copy your version into the edit box. This doesn't happen often and can be minimised by editing sections rather than the whole page.

Additional hints[edit]

You can stop the wiki system processing the text (to avoid unwanted formatting) by putting <nowiki></nowiki> around the text you want to parse directly. If you look at this page in "edit" mode you will see <nowiki> in use.

Wikipedia's has extensive wiki markup help.

The Page Edit box has helpful widgits at top and bottom. Explore them! Practice editing the Sandbox -- that's what it's for.