Help:Editing
From HGWiki
HGWiki is a Wiki, which means that anyone can easily edit any unprotected and save those changes immediately to that page. After your first edit, you are a HGWiki editor!
Contents |
Wiki markup
The wiki markup is the syntax system you can use to format a HGWiki page.
Most of the commands or syntax of Wiki Markup is case sensitive.
The table below is an outline of various edits. The left column shows the effects available. The right column shows the wiki markup used to achieve them. For a quick guide of the most commonly used functions; please view our Crib Sheet
You may want to keep this page open in a separate browser window for reference. If you want to try out things without danger of doing any harm, you can do so in the Sandbox. Try opening the Sandbox in a separate window or tab and keeping this page open for reference.
Examples
What it looks like | What you type |
New section
Subsection
Sub-subsection
|
==New section== ===Subsection=== ====Sub-subsection==== |
A single newline generally has no effect on the layout. These can be used to separate sentences within a paragraph. Some editors find that this aids editing and improves the function diff (used internally to compare different versions of a page). But an empty line starts a new paragraph.
|
A single newline generally has no effect on the layout. These can be used to separate sentences within a paragraph. Some editors find that this aids editing and improves the function ''diff'' (used internally to compare different versions of a page). But an empty line starts a new paragraph. |
You can break lines
|
You can break lines<br/> without starting a new paragraph. |
marks the end of a list item.
|
* It's easy to create a list: ** Start every line with a star. *** More stars means deeper levels. **** A newline in a list marks the end of a list item. * An empty line starts a new list. |
|
# Numbered lists are also good ## very organized ## easy to follow ### easier still |
|
; Definition list : list of definitions ; item : the item's definition ; another item : the other item's definition |
|
* You can even create mixed lists *# and nest them *#* like this *#*; can I mix definition list as well? *#*: yes *#*; how? *#*: it's easy as *#*:* a *#*:* b *#*:* c |
A manual newline starts a new paragraph.
|
: A colon indents a line or paragraph. A manual newline starts a new paragraph. |
When there is a need for separating a block of text The blockquote command will indent both margins when needed instead of the left margin only as the colon does. This is useful for (as the name says) inserting blocks of quoted (and cited) text. |
<blockquote> The '''blockquote''' command will indent both margins when needed instead of the left margin only as the colon does. </blockquote> |
|
IF a line starts with a space THEN it will be formatted exactly as typed; in a fixed-width font; lines will not wrap; END IF |
|
<center>Centered text.</center> |
A horizontal dividing line: this is above it and this is below it. |
A horizontal dividing line: this is above it ---- and this is below it. |
Links and URLs
What it looks like | What you type |
---|---|
Ascension has Beetle Caves.
|
Ascension has [[Beetle Caves]]. |
Neverwinter also has lots of beetle caves.
|
Neverwinter also has [[Beetle Caves| lots of beetle caves]]. |
National sarcasm society is a page that does not exist yet.
|
[[National sarcasm society]] is a page that does not exist yet. |
When adding a comment to a Talk page, you should sign it by adding three tildes to add your user name: or four to add user name plus date/time:
Five tildes gives the date/time alone:
|
When adding a comment to a Talk page,you should sign it by adding three tildes to add your user name: : ~~~ or four for user name plus date/time: : ~~~~ Five tildes gives the date/time alone: : ~~~~~ |
A user's Contributions page can be linked as: Special:Contributions/UserName or Special:Contributions/192.0.2.0 |
A user's '''Contributions''' page can be linked as: [[Special:Contributions/UserName]] or [[Special:Contributions/192.0.2.0]] |
|
[[Category:HGWiki]] |
|
[[:Category:HigherGround1]] |
Three ways to link to external (non-wiki) sources:
|
Three ways to link to external (non-wiki) sources: # Bare URL: http://www.dormantwarrior.com/ (bad style) # Unnamed link: [http://www.dormantwarrior.com/] (only used within article body for footnotes) # Named link: [http://www.dormantwarrior.com dormantwarrior] |
Date formats:
|
Date formats: # [[July 20]], [[1969]] # [[20 July]] [[1969]] # [[1969]]-[[07-20]] # [[1969-07-20]] |
Images
Only images that have been uploaded to HGWiki can be used. To upload images, use the upload page. You can find the uploaded image on the image list.
What it looks like | What you type |
---|---|
A picture: | A picture: [[Image:wiki.png]] |
With alternative text: | With alternative text: [[Image:wiki.png|wiki wiki]]
|
Floating to the right side of the page and with a caption:
| Floating to the right side of the page and with a caption: [[Image:wiki.png|frame|wiki wiki]]
|
Floating to the right side of the page without a caption: | Floating to the right side of the page ''without'' a caption: [[Image:wiki.png|right|wiki wiki]] |
A picture resized to 30 pixels... | A picture resized to 30 pixels... [[Image:wiki.png|30 px]] |
Linking directly to the description page of an image: | Linking directly to the description page of an image: [[:Image:wiki.png]]
(such as any of the ones above) also leads to the description page |
Linking directly to an image without displaying it: | Linking directly to an image without displaying it: [[media:wiki.png|Image of the wiki]]
|
Using the div tag to separate images from text (note that this may allow images to cover text): | Example: <div style="display:inline; width:220px; float:right;"> Place images here </div> |
Using wiki markup to make a table in which to place a vertical column of images (this helps edit links match headers, especially in Firefox browsers): | Example: {| align=right |- | Place images here |} |
Character formatting
What it looks like | What you type |
---|---|
Emphasized text |
''Emphasized text'' '''Strong emphasis''' '''''Even stronger emphasis''''' |
A typewriter font for monospace text
or for computer code:
|
A typewriter font for <tt>monospace text</tt> or for computer code: <code>int main()</code> |
You can use small text for captions. |
You can use <small>small text</small> for captions. |
Better stay away from big text, unless it's within small text. |
Better stay away from <big>big text</big>, unless <small> it's <big>within</big> small</small> text. |
You can You can also mark
|
You can <s>strike out deleted material</s> and <u>underline new material</u>. You can also mark <del>deleted material</del> and <ins>inserted material</ins> using logical markup. For backwards compatibility better combine this potentially ignored new <del>logical</del> with the old <s><del>physical</del></s> markup. |
Suppressing interpretation of markup:
|
<nowiki>Link → (''to'') the [[HGWiki FAQ]]</nowiki> |
Commenting page source:
|
<!-- comment here --> |
Commercial symbols:
|
™ © ® ¢ € ¥ £ ¤ |
Subscripts:
|
x<sub>1</sub> x<sub>2</sub> x<sub>3</sub> |
Superscripts:
|
x<sup>1</sup> x<sup>2</sup> x<sup>3</sup> |
No or limited formatting - showing exactly what is being typed
A few different kinds of formatting will tell the Wiki to display things as you typed them - what you see, is what you get!
What it looks like | What you type | |
---|---|---|
<nowiki> tags |
The nowiki tag ignores [[Wiki]] ''markup''. It reformats text by removing newlines and multiple spaces. It still interprets special characters: → | <nowiki> The nowiki tag ignores [[Wiki]] ''markup''. It reformats text by removing newlines and multiple spaces. It still interprets special characters: → </nowiki> |
<pre> tags |
The pre tag ignores [[Wiki]] ''markup''. It also doesn't reformat text. It still interprets special characters: → | <pre> The pre tag ignores [[Wiki]] ''markup''. It also doesn't reformat text. It still interprets special characters: → </pre> |
Leading spaces |
Leading spaces are another way to preserve formatting. Putting a space at the beginning of each line stops the text from being reformatted. It still interprets Wiki markup and special characters: → | Leading spaces are another way to preserve formatting. Putting a space at the beginning of each line stops the text from being reformatted. It still interprets [[Wiki]] ''markup'' and special characters: → |
Table of contents
At the current status of the wiki markup language, having at least four headers on a page triggers the TOC to appear in front of the first header (or after introductory sections). Putting __TOC__ anywhere forces the TOC to appear at that point (instead of just before the first header). Putting __NOTOC__ anywhere forces the TOC to disappear.
Tables
There are two ways to build tables:
- in special Wiki-markup
- with the usual HTML elements: <table>, <tr>, <td> or <th>.
Variables
Code | Effect |
---|---|
{{CURRENTWEEK}} | 51 |
{{CURRENTDOW}} | 6 |
{{CURRENTMONTH}} | 12 |
{{CURRENTMONTHNAME}} | December |
{{CURRENTMONTHNAMEGEN}} | December |
{{CURRENTDAY}} | 21 |
{{CURRENTDAYNAME}} | Saturday |
{{CURRENTYEAR}} | 2024 |
{{CURRENTTIME}} | 16:45 |
{{NUMBEROFARTICLES}} | 3,717 |
{{PAGENAME}} | Editing |
{{NAMESPACE}} | Help |
{{REVISIONID}} | 19518 |
{{localurl:pagename}} | /wiki/Pagename |
{{localurl:HGWiki:Sandbox|action=edit}} | /w-hg/index.php?title=HGWiki:Sandbox&action=edit |
{{fullurl:pagename}} | http://wiki.hgweb.org/wiki/Pagename |
{{fullurl:pagename|query_string}} | http://wiki.hgweb.org/w-hg/index.php?title=Pagename&query_string |
{{SERVER}} | http://wiki.hgweb.org |
{{SITENAME}} | HGWiki |