Skip to main content

Wiki Syntax — wiki

The pygame wiki includes all the typical wiki syntax via HTML.

formatting

coderesult
<i>italics</i>
italics
<b>bold</b>
bold
<u>underline</u>
underline
<s>strike</s>
strike
<tt>monospaced</tt>
monospaced

for any wiki or web link

<a href="link"> link</a>

or for any wiki link -- with automatic title substitution

[[link]]

wiki links may contain [a-zA-Z0-9_-\.]+

if the link contains a period it is assumed to be a file. if the link contains .jpg, .jpeg, .gif, or .png it is assumed to be an image.

sections

coderesult
<h1>heading 1</h1>

heading 1

<h2>heading 2</h2>

heading 2

<h3>heading 3</h3>

heading 3

<h4>heading 4</h4>

heading 4

<h5>heading 5</h5>
heading 5

typically, you should not use h1, as it is reserved for the title of the page which is printed automatically.

images

a basic image

<img src="image.gif" />

an image that will be automatically resized

<img src="image.gif" width="120" height="80" />

images will be displayed, as well as link to a page where the full sized image can be viewed and edited. images must be named .jpg, .jpeg, .gif, .png for the wiki to acknowledge them as images

files

to link to a file, create a link

<a href="file.zip"> file</a>

for files to be recognized as files, they must contain a . within their name.

lists

coderesult
<ul>
    <li>apples
    <li>pears
    <li>peaches
    </ul>
  • apples
  • pears
  • peaches
<ol>
    <li>first
    <li>second
    <li>third
    </ol>
  1. first
  2. second
  3. third

tables

coderesult
<table>
    <tr><th>header<th>header
    <tr><td>one<td>two
    </table>
headerheader
onetwo

code

coderesult
<pre><code>
x = [1,2,3]
print x
</code></pre>
x = [1,2,3] 
print x

grabbers

a special feature included in the pygame wiki is the ability to grab a section of content from another wiki page.

NOTE: currently broken. https://github.com/pygame/pygameweb/issues/32
coderesult
{{syntax}}
{{syntax}}
{{syntax#test}}
{{syntax#test}}

test

this is just a test section to demo a section grabber.

sandbox

go here to try things out.