Difference between revisions of "Help:StyleGuide"

From Community Pnut.io Wiki
Jump to: navigation, search
m (Added ‘Things to Remember’ section)
m (Fiddled with formatting, added lists)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
== A short guide to formatting text for this Wiki ==
+
== A <strike>short</strike> guide to formatting text for this Wiki ==
 
It’s not necessary to learn a complex markup language to create good-looking wiki pages. Plain text will work just as well as something with too much effort expended. Content beats form every time.
 
It’s not necessary to learn a complex markup language to create good-looking wiki pages. Plain text will work just as well as something with too much effort expended. Content beats form every time.
  
Line 15: Line 15:
  
 
=== Section headings ===
 
=== Section headings ===
Note: Heading 1 is used as the page title.
+
Note: Heading 1 is used by the Mediawiki software as the page title.
  
 
== Heading 2 ==
 
== Heading 2 ==
 +
To separate text from other sections.
 
<pre>==Heading 2 ==</pre>
 
<pre>==Heading 2 ==</pre>
  
 
=== Heading 3 ===
 
=== Heading 3 ===
 +
Subsections…
 
<pre>=== Heading 3 ===</pre>
 
<pre>=== Heading 3 ===</pre>
  
Line 42: Line 44:
 
External pages, just type the URL, e.g. https://pnut.io: <pre>https://pnut.io</pre>
 
External pages, just type the URL, e.g. https://pnut.io: <pre>https://pnut.io</pre>
 
External Pages with friendlier names e.g. [https://pnut.io a nice site], with a space between URL and text: <pre>[https://pnut.io a nice site]</pre>
 
External Pages with friendlier names e.g. [https://pnut.io a nice site], with a space between URL and text: <pre>[https://pnut.io a nice site]</pre>
 +
 +
=== Lists ===
 +
Numbered list:
 +
# One
 +
# Two
 +
# More
 +
# One
 +
# Two
 +
# More
 +
 +
Bulleted list:
 +
* Foo
 +
* Bar
 +
* Baz
 +
* Foo
 +
* Bar
 +
* Baz
  
 
=== Banners ===
 
=== Banners ===
 
To draw the reader’s attention to facts about a page add a:
 
To draw the reader’s attention to facts about a page add a:
 
{{Template:Banner|‽|Banner!}}
 
{{Template:Banner|‽|Banner!}}
 +
(This is not a default Mediawiki item.)
 
<pre>{{Template:Banner|'''‽'''|Banner!}}</pre>
 
<pre>{{Template:Banner|'''‽'''|Banner!}}</pre>
  
 
=== Other ===
 
=== Other ===
Some html tags can also be used.
+
A number of html formatting tags can also be used, such as
 
+
hr, pre, strike, strong
Hopefully useful.
 

Revision as of 17:21, 22 September 2017

A short guide to formatting text for this Wiki

It’s not necessary to learn a complex markup language to create good-looking wiki pages. Plain text will work just as well as something with too much effort expended. Content beats form every time.

The toolbar at the top of the editing area is very useful and transforms a previously arcane art into something akin to using a simple text editor to create, er… complex things. What follows is a guide for those who wish to delve deeper and for those who wish to apply consistent styling across this wiki.

Things to remember

  1. Use the Preview button. Use it often. The preview button is your friend.
  2. Look at someone else’s page for clues.
  3. Don’t be frightened to break something, it can be reverted if necessary.
  4. Try not to break anything (see the first edict above.)

Section headings

Note: Heading 1 is used by the Mediawiki software as the page title.

Heading 2

To separate text from other sections.

==Heading 2 ==

Heading 3

Subsections…

=== Heading 3 ===

Heading 4

==== Heading 4 ====

Basic styles

Ordinary text:

Ordinary text

Italic text:

''Italic'' text

Bold text:

'''Bold''' text

Italic bold text:

'''''Italic bold''''' text
Monospaced text:
<pre>Monospaced text</pre> for code, explanations. (Or start a line with a space.)

Links

(Red links are links to pages that don’t exist yet.)

Wiki pages, e.g. Events:

[[Events]]

Wiki pages with friendlier names, e.g. The past is past, with a pipe between URL and text:

[[History|The past is past]]

External pages, just type the URL, e.g. https://pnut.io:

https://pnut.io

External Pages with friendlier names e.g. a nice site, with a space between URL and text:

[https://pnut.io a nice site]

Lists

Numbered list:

  1. One
  2. Two
  3. More
# One
# Two
# More

Bulleted list:

  • Foo
  • Bar
  • Baz
* Foo
* Bar
* Baz

Banners

To draw the reader’s attention to facts about a page add a:

Banner!

(This is not a default Mediawiki item.)

{{Template:Banner|'''‽'''|Banner!}}

Other

A number of html formatting tags can also be used, such as

hr, pre, strike, strong