Difference between revisions of "Help:StyleGuide"

From Community Pnut.io Wiki
Jump to: navigation, search
(Created page)
 
(Added complication)
Line 1: Line 1:
 +
__NOTOC__
 
== A short guide to formatting text for this Wiki ==
 
== 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.
 +
 +
Use the Preview button. Use it often. The preview button is your friend.
 +
 +
<hr>
 +
 +
=== Section headings ===
 +
Note: Heading 1 is used as the page title.
 +
 +
== Heading 2 ==
 +
<pre>==Heading 2 ==</pre>
 +
 +
=== Heading 3 ===
 +
<pre>=== Heading 3 ===</pre>
 +
 +
==== Heading 4 ====
 +
<pre>==== Heading 4 ====</pre>
 +
 +
<hr>
  
 
=== Basic styles ===
 
=== Basic styles ===
Line 8: Line 30:
 
<pre>Monospaced text:</pre>
 
<pre>Monospaced text:</pre>
 
  <<nowiki />pre>Monospaced text<<nowiki />/pre> for code, explanations. (Or start a line with a space.)
 
  <<nowiki />pre>Monospaced text<<nowiki />/pre> for code, explanations. (Or start a line with a space.)
(Some html tags can also be used.)
 
  
 
=== Links ===
 
=== Links ===
Line 16: Line 37:
 
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>
 +
 +
=== Banners ===
 +
To draw the reader’s attention to facts about a page add a:
 +
{{Template:Banner|‽|Banner!}}
 +
<pre>{{Template:Banner|'''‽'''|Banner!}}</pre>
 +
 +
=== Other ===
 +
Some html tags can also be used.
  
 
Hopefully useful.
 
Hopefully useful.

Revision as of 11:32, 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.

Use the Preview button. Use it often. The preview button is your friend.


Section headings

Note: Heading 1 is used as the page title.

Heading 2

==Heading 2 ==

Heading 3

=== 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]

Banners

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

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

Other

Some html tags can also be used.

Hopefully useful.