Difference between revisions of "Help:Basic MediaWiki Syntax"

From Computer History Wiki
Jump to: navigation, search
m (+cat)
(See also: A wealth of detail)
 
(7 intermediate revisions by the same user not shown)
Line 37: Line 37:
 
|-
 
|-
 
|Internal link<br />
 
|Internal link<br />
(within the Computer History wiki)
+
(within the Computer History wiki)<br />
 +
''The last two here can be combined.''
 
|
 
|
 
<tt><nowiki>[[name of page]]</nowiki></tt><br />
 
<tt><nowiki>[[name of page]]</nowiki></tt><br />
 
<tt><nowiki>[[name of page|display text]]</nowiki></tt><br />
 
<tt><nowiki>[[name of page|display text]]</nowiki></tt><br />
 +
<tt><nowiki>[[name of page#heading]]</nowiki></tt><br />
 
|
 
|
 
[[name of page]]<br />
 
[[name of page]]<br />
 
[[name of page|display text]]<br />
 
[[name of page|display text]]<br />
 +
[[name of page#heading]]<br />
 
|-
 
|-
|colspan="3" style="border-top:1px solid #cee0f2;"|
+
|colspan="2"|<span style="font-size:0.9em; text-align:center;">''Wikipedia style, followed here, is generally to only link the '''first''' instance of a term on a page.''</span>
 
|-
 
|-
 
|colspan="3" style="border-top:1px solid #cee0f2;"|
 
|colspan="3" style="border-top:1px solid #cee0f2;"|
 
|-
 
|-
 
|External link<br />
 
|External link<br />
(to other websites)
+
(to other websites)<br />
 +
''The middle one is '''much''' preferred.''
 
|
 
|
 
<tt><nowiki>[http://www.example.org]</nowiki></tt><br />
 
<tt><nowiki>[http://www.example.org]</nowiki></tt><br />
Line 61: Line 65:
 
|-
 
|-
 
|colspan="3" style="border-top:1px solid #cee0f2;"|
 
|colspan="3" style="border-top:1px solid #cee0f2;"|
 +
|-
 +
|
 +
Text can be commented out
 +
|
 +
matching <nowiki><!--</nowiki> and <nowiki>--></nowiki> around text to be ignored
 
|-
 
|-
 
|
 
|
Line 75: Line 84:
 
|Headings<br />
 
|Headings<br />
 
<span style="font-size:0.9em;">''A Table of Contents will automatically be generated when four headings are added to an article.''</span>
 
<span style="font-size:0.9em;">''A Table of Contents will automatically be generated when four headings are added to an article.''</span>
 +
 +
<span style="font-size:0.9em;">''For a reason that has been lost in the mists of time, Wikipedia (and thus here) uses '==' as the top level section marker; '=' seems to work now, but please keep up the style.''</span>
 
|
 
|
 
<tt><nowiki>== Level 1 ==</nowiki></tt><br />
 
<tt><nowiki>== Level 1 ==</nowiki></tt><br />
Line 83: Line 94:
 
|
 
|
 
__TOC__
 
__TOC__
 +
 
== Level 1 ==
 
== Level 1 ==
 
=== Level 2 ===
 
=== Level 2 ===
Line 130: Line 142:
 
==Pre-formatted text==
 
==Pre-formatted text==
  
There are a number of ways to include pre-formatted text (e.g. [[source code]] fragments):
+
There are a number of ways to include pre-formatted text (e.g. [[source code]] fragments); all of these techniques also use a fixed-width [[font]] for the text:
  
 
* Start each line with a space character; normal markups can be used; e.g.:
 
* Start each line with a space character; normal markups can be used; e.g.:
  
<nowiki>" '''This is pre-formatted''' text"</nowiki>
+
<nowiki>" This is '''pre-formatted''' text"</nowiki>
  
 
produces:
 
produces:
Line 178: Line 190:
 
==Images==
 
==Images==
  
<nowiki>[[Image:Pdp1115.jpg|thumb|150px|left|Caption text]]</nowiki>
+
Including the special form:
 +
 
 +
<nowiki>[[File:Pdp1115.jpg|thumb|150px|left|Caption text]]</nowiki>
  
 
produces:
 
produces:
  
[[Image:Pdp1115.jpg|thumb|150px|left|Caption text]]
+
[[File:Pdp1115.jpg|thumb|150px|left|Caption text]]
  
Leaving out the '150px' inserts the image full-size. The optional keywords 'left' and 'right' can be added to control the horizontal placement.
+
(The legacy keyword 'Image' may be used in place of "File".) Leaving out the "150px" inserts the image full-size. The optional keywords 'left' and 'right' can be added to control the horizontal placement.
 +
 
 +
(Notice that this text fills up around the image. Add a <nowiki><br clear=all></nowiki> after the image line to force the text to re-start below the image.)
  
 
New images can be uploaded via the 'Upload file' page (link on the left-hand side of all pages).
 
New images can be uploaded via the 'Upload file' page (link on the left-hand side of all pages).
 +
 +
A lengthy tutorial on images is [https://en.wikipedia.org/wiki/Help:Pictures here]; complete specifications for the use of the 'File' special form are available [https://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax here] and [https://www.mediawiki.org/wiki/Help:Images here].
 +
 +
==See also==
 +
 +
* [https://www.mediawiki.org/wiki/Help:Contents MediaWiki.org help pages] - a wealth of detail
 +
** [https://www.mediawiki.org/wiki/Help:Formatting Help:Formatting] - detailed help on formatting
 +
** [https://www.mediawiki.org/wiki/Help:Tables Help:Tables] - ditto for tables
  
 
[[Category: Help]]
 
[[Category: Help]]

Latest revision as of 12:26, 24 August 2023

This is a brief introduction to MediaWiki source syntax. For a more comprehensive guide, see here.

Text

Description You type You get
Applies anywhere
Italicise text

''italic''

italic

Bold text

'''bold'''

bold

Bold and italic

'''''bold & italic'''''

bold & italic

Internal link

(within the Computer History wiki)
The last two here can be combined.

[[name of page]]
[[name of page|display text]]
[[name of page#heading]]

name of page
display text
name of page#heading

Wikipedia style, followed here, is generally to only link the first instance of a term on a page.
External link

(to other websites)
The middle one is much preferred.

[http://www.example.org]
[http://www.example.org display text]
http://www.example.org

[1]
display text
http://www.example.org

Text can be commented out

matching <!-- and --> around text to be ignored

Sign your posts
on talk pages

~~~~

Your username 10:46,
28 March 2024 (UTC)

Items below only apply at the beginning of a line
Headings

A Table of Contents will automatically be generated when four headings are added to an article.

For a reason that has been lost in the mists of time, Wikipedia (and thus here) uses '==' as the top level section marker; '=' seems to work now, but please keep up the style.

== Level 1 ==
=== Level 2 ===
==== Level 3 ====
===== Level 4 =====
====== Level 5 ======

Level 1

Level 2

Level 3

Level 4
Level 5
Indented items

(used mostly on Talk: pages)

: foo
:: bar

foo
bar
Bullet list

* one
* two
** two point one
* three

  • one
  • two
    • two point one
  • three
Numbered list

# one
# two
## two point one
# three

  1. one
  2. two
    1. two point one
  3. three

Pre-formatted text

There are a number of ways to include pre-formatted text (e.g. source code fragments); all of these techniques also use a fixed-width font for the text:

  • Start each line with a space character; normal markups can be used; e.g.:

" This is '''pre-formatted''' text"

produces:

This is pre-formatted text
  • Use the HTML <nowiki> tag, with a space character before the <nowiki>. (Remember to add a matching closing tag after the pre-formatted text block).
  • Use the HTML <pre> tag (again, remember the closing tag).

Note that the HTML <blockquote> tag only indents the block; text within it will still be justified.

Tables

{| class="wikitable"
! Table !! Prototype
|-
| colspan="2" style="text-align:center;" | Headers
|-
| aa || rowspan="2" | yy
|-
| bb
|-
| cc || zz
|}

produces:

Table Prototype
Headers
aa yy
bb
cc zz

Images

Including the special form:

[[File:Pdp1115.jpg|thumb|150px|left|Caption text]]

produces:

Caption text

(The legacy keyword 'Image' may be used in place of "File".) Leaving out the "150px" inserts the image full-size. The optional keywords 'left' and 'right' can be added to control the horizontal placement.

(Notice that this text fills up around the image. Add a <br clear=all> after the image line to force the text to re-start below the image.)

New images can be uploaded via the 'Upload file' page (link on the left-hand side of all pages).

A lengthy tutorial on images is here; complete specifications for the use of the 'File' special form are available here and here.

See also