Table of Contents
|
Here is a large selection of examples for using semantic markup to make wiki nodes look nice and function well.
Basic formatting
This describes how to modify text to make it stand out beyond normal font styles.
What it looks like | What you type |
---|---|
You can italicize text by putting 2 apostrophes on each side. 3 apostrophes will bold the text. 5 apostrophes will bold and italicize the text. (4 apostrophes don't do anything special -- there's just 'one left over'.) |
You can ''italicize text'' by putting 2 apostrophes on each side. 3 apostrophes will bold '''the text'''. 5 apostrophes will bold and italicize '''''the text'''''. (4 apostrophes don't do anything special -- there's just ''''one left over''''.) |
A single newline has no effect on the layout. But an empty line starts a new paragraph. |
A single newline has no effect on the layout. But an empty line starts a new paragraph. |
You can break lines |
You can break lines<br /> without a new paragraph.<br /> Please use this sparingly. |
Some useful ways to use HTML:
Put text in a typewriter font. The same
font is generally used for Superscripts and subscripts: X2, H2O |
Some useful ways to use HTML: Put text in a <tt>typewriter font</tt>. The same font is generally used for <code> computer code</code>. Superscripts and subscripts: X<sup>2</sup>, H<sub>2</sub>O |
Organizing your writing
This section disusses how to arrange and organize text to make it more readable. A full discussion of tables is not given here, but a good reference is the Wikipedia article on tables.
What it looks like | What you type |
---|---|
Section headingsHeadings organize your writing into sections. The Wiki software can automatically generate a table of contents from them. SubsectionUsing more equals signs creates a subsection. A smaller subsectionDon't skip levels, like from two to four equals signs. Start with 2 equals signs not 1 because 1 creates H1 tags which should be reserved for page title. |
== Section headings == ''Headings'' organize your writing into sections. The Wiki software can automatically generate a table of contents from them. === Subsection === Using more equals signs creates a subsection. ==== A smaller subsection ==== Don't skip levels, like from two to four equals signs. Start with 2 equals signs not 1 because 1 creates H1 tags which should be reserved for page title. |
marks the end of the list.
|
* ''Unordered lists'' are easy to do: ** Start every line with a star. *** More stars indicate a deeper level. *: Previous item continues. ** A newline * in a list marks the end of the list. * Of course you can start again. |
A newline marks the end of the list.
|
# ''Numbered lists'' are also good: ## Very organized ## Easy to follow A newline marks the end of the list. # New numbering starts with 1. |
Another kind of list is a definition list:
|
Another kind of list is a ''definition list'': ; Word : Definition of the word ; Here is a longer phrase that needs a definition : Phrase defined ; A word : Which has a definition : Also a second one : And even a third |
|
* You can even do mixed lists *# and nest them *# inside each other *#* or break lines<br />in lists. *#; definition lists, however *#: cannot be nested |
A newline after that starts a new paragraph.
|
: A colon (:) indents a line or paragraph. A newline after that starts a new paragraph. : We use 1 colon to indent once. :: We use 2 colons to indent twice. ::: We use 3 colons to indent 3 times, and so on. |
You can make horizontal dividing lines (----) to separate text. But you should usually use sections instead, so that they go in the table of contents. |
You can make horizontal dividing lines (----) to separate text. ---- But you should usually use sections instead, so that they go in the table of contents. |
You can add footnotes to sentences using the ref tag -- this is especially good for citing a source.
References:
|
You can add footnotes to sentences using the ''ref'' tag -- this is especially good for citing a source. :There are over six billion people in the world. <ref>CIA World Factbook, 2006.</ref> References: <references/> |
Links
You will often want to make clickable links to other pages.
What it looks like | What you type |
---|---|
Here's a link to a page named About Wiki. |
Here's a link to a page named [[About Wiki]]. |
Links can have path information. A leading slash "/" indicates absolute path in the project's web space, as in /public/Home. Relative paths can be created too. If you want to go up one directory, use ../Home |
Links can have path information. A leading slash "/" indicates absolute path in the project's ''web space'', as in [[/public/Home]]. Relative paths can be created too. If you want to go up one directory, use [[../Home]] |
You can put formatting around a link. Example: Index. |
You can put formatting around a link. Example: ''[[Index]]''. |
The weather in Moscow is a page that doesn't exist yet. You could create it by clicking on the link. |
[[The weather in Moscow]] is a page that doesn't exist yet. You could create it by clicking on the link. |
You can link to a page section by its title: If multiple sections have the same title, add a number. #Example section 3 goes to the third section named "Example section". |
You can link to a page section by its title: *[[About Subversion#Subversion Development]]. If multiple sections have the same title, add a number. [[#Example section 3]] goes to the third section named "Example section". |
You can make a link point to a different place with a "piped link". Put the link target first, then the pipe character "|", then the link text. Or you can use the "pipe trick" so that only the node name is displayed. |
You can make a link point to a different place with a "piped link". Put the link target first, then the pipe character "|", then the link text. *[[/public/Home|Home Node]] *[[About Subversion#Subversion Development|SVN development]] Or you can use the "pipe trick" so that only the node name is displayed. *[[/path/to/Spinning (textiles)#Section|]] |
You can make an external link just by typing a URL: http://www.nupedia.com You can give it a title: Nupedia Or leave the title blank: http://www.nupedia.com |
You can make an external link just by typing a URL: http://www.nupedia.com You can give it a title: [http://www.nupedia.com Nupedia] Or leave the title blank: [http://www.nupedia.com] |
Linking to an e-mail address works the same way: mailto:someone@domain.com or someone |
Linking to an e-mail address works the same way: mailto:someone@domain.com or [mailto:someone@domain.com someone] |
Images
Image linking and display are explained in Image Examples.
Citation of Sources
Citation is explained in-depth in Citation Examples.
Non-wiki Formatting
The following examples cannot have their sources shown properly because the tools used precede the pre tags used to display the markup source. To 'fix' this, the tags used in the "What you type" column have spaces inserted after the opening left bracket (eg. "<this" must be shown as "< this").
What it looks like | What you type |
---|---|
Invisible comments to editors ( ) only appear while editing the page. |
Invisible comments to editors ( < !-- here --> ) only appear while editing the page. < !-- Note to editors: blah blah blah. --> |
text ''italics'' [[link]] |
* don't interpret special wiki markup * reformat text (removing newlines and multiple spaces) < nowiki> text ''italics'' [[link]] < /nowiki> |
text ''italics'' [[link]] |
* don't interpret special wiki markup * don't reformat text < pre> text ''italics'' [[link]] < /pre> |