Valwiki:Formatting Guidelines

From Valwiki

Jump to: navigation, search

For a comprehensive list of the markup and its effects, see [Wikipedia:How to edit a page].

Contents

Sections, paragraphs, lists and lines

What it looks like What you type

New section


Subsection

Sub-subsection

* Start with a second-level heading (==); do not use first-level headings (=).

  • Do not skip levels (e.g., second-level followed by fourth-level).
==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 diff function (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 (see below).
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 ''diff'' function
(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.
You can break lines<br>
without starting a new paragraph.
  • Lists are easy to do:
    • 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.
* Lists are easy to do:
** 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
# Numbered lists are also good
## very organized
## easy to follow
  • You can even do mixed lists
    1. and nest them
      • like this
* You can even do mixed lists
*# and nest them
*#* like this
Definition list 
list of definitions
item 
the item's definition
another item
the other item's definition
  • 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
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.
IF a line starts with a space THEN
it will be formatted exactly
as typed;
in a fixed-width font;
lines won't wrap.

* 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 won't wrap.
Centered text.
<center>Centered text.</center>

A horizontal dividing line: this is above it


and this is below it.

  • Mainly useful for separating threads on Talk pages.
  • Also used to disambiguate within an article without creating a separate page.
A horizontal dividing line:
this is above it
----
and this is below it.

Links and URLs

  • Wrap an article's name in brackets [[like this]] to create a link
  • To give the link a new name use a pipe, [[like this|do this]]
  • Use a pipe to automatically hide stuff in parentheses: [[Valikorlia (nation)|]]Valikorlia
  • Use a pipe to automatically hide namespace: [[Valwiki:Formatting Guidelines|]]Formatting Guidelines
  • When adding a comment to a talk page, you should sign.
  • To redirect an article to another page, do this #REDIRECT [[Existing Page Name]]
  • To create an external link, use this syntax: [http://somepage.com alternative text]
  • To add an off-site image, paste the URL of the picture directly where you want it, with no brackets. The system will recognize it and display it.

Images

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:

Wikipedia, The Free Encyclopedia.

With alternative text:
[[Image:wiki.png|Wikipedia, The Free Encyclopedia.]]
  • Alternative text, used when the image is unavailable or when the image is loaded in a text-only browser, or when spoken aloud, is strongly encouraged.
Floating to the right side of the page using the frame attribute and a caption:
Wikipedia Encyclopedia

Floating to the right side of the page 
using the ''frame'' attribute and a caption:
[[Image:wiki.png|frame|Wikipedia Encyclopedia]]
  • The frame tag automatically floats the image right.
  • The caption is also used as alternate text.
Floating to the right side of the page using the thumb attribute and a caption:
Wikipedia Encyclopedia

Floating to the right side of the page 
using the ''thumb'' attribute and a caption:
[[Image:wiki.png|thumb|Wikipedia Encyclopedia]]
  • The thumb tag automatically floats the image right.
  • The caption is also used as alternate text.
  • An enlarge icon is placed in the lower right corner.
Floating to the right side of the page without a caption:
Wikipedia Encyclopedia
Floating to the right side of the page
''without'' a caption:
[[Image:wiki.png|right|Wikipedia Encyclopedia]]
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 jigsaw globe logo

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

Emphasize, strongly, very strongly.

  • These are double and triple apostrophes (single-quote marks), not double-quote marks.
''Emphasize'', '''strongly''', '''''very strongly'''''.

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.

You can strike out deleted material and underline new material.

You can also mark deleted material and inserted material using logical markup rather than visual markup.

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
rather than visual markup.

Commercial symbols:
™ © ® ¢ € ¥ £ ¤

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

Suppressing interpretation of markup: Link → (''to'') the [[Valwiki:Policies|]]

<nowiki>Link &rarr; (''to'') 
the [[Valwiki:Policies|]]</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 page.
<!-- comment here -->
Personal tools