Help:Editing

From HGWiki

Jump to: navigation, search

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
  • Start with a second-level heading (==); don't use first-level headings (=) (consider the article heading to be the first-level heading if you like).
  • If possible, place subsections in an appropriate order. If listing countries, place them in alphabetical order rather than, say, relative to population or some random order.
  • A Table of Contents will automatically be added to an article that has four or more sections.
==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.

  • When used in a list, a newline does affect the layout.
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
without starting a new paragraph.

  • Please use this sparingly.
  • Close markup between lines, do not start a link or italics or bold on one line and close it on the next.
You can break lines<br/>
without starting a new paragraph.
  • It's easy to create a list:
    • Start every line with a star (asterisk).
      • More stars means deeper levels.
        • A newline in a list

marks the end of a list item.

  • An empty line starts a new list.
* 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.
  1. Numbered lists are also good
    1. very organized
    2. easy to follow
      1. easier still
# 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
  • Begin with a semicolon. One item per line; a newline can appear before the colon, but using a space before the colon improves parsing.
; Definition list : list of definitions
; item : the item's definition
; another item
: the other item's definition
  • You can even create mixed lists
    1. and nest them
      • like this
        can I mix definition list as well?
        yes
        how?
        it's easy as
        • a
        • b
        • c
* 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 colon indents a line or paragraph.

A manual newline starts a new paragraph.

  • This is primarily for displayed material, but is also used for discussion on talk pages.
: 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>
  • This is useful for:
    • pasting preformatted text;
    • algorithm descriptions;
    • program source code;
    • ASCII art
  • WARNING: If you make it wide, you force the whole page to be wide and hence less readable, especially for people who use lower resolutions. Never start ordinary lines with spaces.
 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
Centered text.
  • Please note the American spelling of "center".
<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.

  • A link to another HGWiki article.
  • Internally, the first letter of the target page is automatically capitalized and spaces are represented as underscores (typing an underscore in the link has the same effect as typing a space, but is not recommended).
  • Thus the link above is to the www.HGWiki.com/wiki/Beetle_Caves, which is the HGWiki article with the name "Beetle Caves".
Ascension has [[Beetle Caves]].

Neverwinter also has lots of beetle caves.

  • Same target, different name.
  • This is a piped link.
  • The "piped" text must be placed first, then the text that will be displayed second.
Neverwinter also has
[[Beetle Caves|
lots of beetle caves]].

National sarcasm society is a page that does not exist yet.

  • You can create it by clicking on the link.
  • To create a new page:
    1. Create a link to it on some other (related) page.
    2. Save that page.
    3. Click on the link you just made. The new page will open for editing.
  • Please do not create a new article without linking to it from at least one other article.
[[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:

Zuzu Petals

or four to add user name plus date/time:

Zuzu Petals 00:18, Nov 19, 2004 (UTC)

Five tildes gives the date/time alone:

00:18, Nov 19, 2004 (UTC)
  • The first two both provide a link to your user page.
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]]
  • To put an article in a Category, place a link like the one to the right anywhere in the article. As with interlanguage links, it does not matter where you put these links while editing as they will always show up in the same place when you save the page, but placement at the end of the edit box is recommended.
[[Category:HGWiki]]
  • To link to a Category page without putting the article into the category, use an initial colon (:) in the link.
[[:Category:HigherGround1]]

Date formats:

  1. July 20, 1969
  2. 20 July 1969
  3. 1969-07-20
  4. 1969-07-20
  • Link dates in one of the above formats, so that everyone can set their own display order. If logged-in, you can use Preferences to change your own date display setting.
  • All of the above dates will appear as "20 July 1969" if you set your date display preference to "15 January 2001", but as "July 20, 1969" if you set it to "January 15, 2001", or as "1969-07-20" if you set it to "2001-01-15".
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:

Image:wiki.png

A picture: 
[[Image:wiki.png]]
With alternative text:

wiki wiki

With alternative text:
[[Image:wiki.png|wiki wiki]]
  • Alternative text, used when a mouse hovers over the image or when the image is not loaded in a text-only browser, or when spoken aloud, is strongly encouraged.
Floating to the right side of the page and with a caption:
wiki wiki
wiki wiki

Floating to the right side of the page
and with a caption:
[[Image:wiki.png|frame|wiki wiki]]
  • The frame tag automatically floats the image right.
  • The caption is also used as alternate text.
Floating to the right side of the page without a caption:
wiki wiki
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:

Image:wiki.png

Linking directly to the description page
of an image:
[[:Image:wiki.png]]
  • Clicking on an image displayed on a page

(such as any of the ones above) also leads to the description page

Linking directly to an image without displaying it:

Image of the wiki

Linking directly to an image
without displaying it:
[[media:wiki.png|Image of the wiki]]
  • To include links to images shown as links instead of drawn on the page, use a "media" link.
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
Strong emphasis
Even stronger emphasis

''Emphasized text''
'''Strong emphasis'''
'''''Even stronger emphasis'''''

A typewriter font for monospace text or for computer code: int main()

  • For semantic reasons, using <code> where applicable is preferable to using <tt>.
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 strike out deleted material and underline new material.

You can also mark deleted material and inserted material using logical markup. For backwards compatibility better combine this potentially ignored new logical with the old physical markup.

  • When editing regular HGWiki articles, just make your changes and do not mark them up in any special way.
  • When editing your own previous remarks in talk pages, it is sometimes appropriate to mark up deleted or inserted material.
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:
Link → (''to'') the [[HGWiki FAQ]]

  • Used to show literal data that would otherwise have special meaning.
  • Escape all wiki markup, including that which looks like HTML tags.
  • Does not escape HTML character references.
  • To escape HTML character references such as &rarr; use &amp;rarr;


<nowiki>Link &rarr; (''to'') 
the [[HGWiki FAQ]]</nowiki>

Commenting page source:
not shown when viewing page

  • Used to leave comments in a page for future editors.
  • Note that most comments should go on the appropriate talk pages.


<!-- comment here -->

Commercial symbols:
™ © ® ¢ € ¥
£ ¤


&trade; &copy; &reg; &cent; &euro; &yen; 
&pound; &curren;

Subscripts:
x1 x2 x3


x<sub>1</sub> x<sub>2</sub> x<sub>3</sub> 

Superscripts:
x1 x2 x3


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: &rarr;
</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: &rarr;
</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: &rarr;

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}} 8
{{CURRENTDOW}} 4
{{CURRENTMONTH}} 02
{{CURRENTMONTHNAME}} February
{{CURRENTMONTHNAMEGEN}} February
{{CURRENTDAY}} 25
{{CURRENTDAYNAME}} Thursday
{{CURRENTYEAR}} 2021
{{CURRENTTIME}} 19:08
{{NUMBEROFARTICLES}} 3,691
{{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
Personal tools