Difference between revisions of "Help:StyleGuide"

From Community Pnut.io Wiki
Jump to: navigation, search
m (Fiddled with formatting, added lists)
m (Renamed History PnutHistory)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
== A <strike>short</strike> guide to formatting text for this Wiki ==
+
== <strong>A <strike>short</strike> guide to formatting text for this wiki</strong> ==
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.
+
(Formatting help specific to this network and this wiki.)
 +
 
 +
It may seem a bit odd to launch straight into the specifics first, but this part is possibly going to be referred to by most once familiar with the basics. Scroll for the [[#Basic_formatting|Basic formatting section.]]
 +
 
 +
If you absolutely '''must''' create a page to test something major, please create it using <code>@yourusername/Sandbox</code> and add <code><nowiki>[[Category:Sandbox]]</nowiki></code> to automatically add it to the [[:Category:Sandbox]] Page.
 +
 
 +
=== Your Wiki user page ===
 +
If you [[:Category:User|want to be listed as a Wiki editor/creator]] please create your Wiki page with <code>@yourusername</code> as the title and copy the text from [[Template:User]].  If you don't wish to follow that template please at least add <code><nowiki>[[Category:User]]</nowiki></code> at the bottom of the markup.
 +
 
 +
=== Username at pnut.io ===
 +
<code><nowiki>[https://pnut.io/{@username} @username]</nowiki></code> - for example, <code><nowiki>[https://pnut.io/@pnut @pnut]</nowiki></code> - gives [https://pnut.io/@pnut @pnut]
 +
 
 +
=== Hashtag at pnut.io ===
 +
<code><nowiki>[https://pnut.io/tags/{tag} tag]</nowiki></code> - for example, <code><nowiki>[https://pnut.io/tags/ThemeMonday #ThemeMonday]</nowiki></code> - gives [https://pnut.io/tags/ThemeMonday #ThemeMonday]
 +
 
 +
=== Hashtag RSS feed at pnut.io ===
 +
<code><nowiki>https://pnut.io/feed/rss/posts/tags/{tag}</nowiki></code> - for example, <code><nowiki>https://pnut.io/feed/rss/posts/tags/ThemeMonday</nowiki></code> - gives https://pnut.io/feed/rss/posts/tags/ThemeMonday
 +
 
 +
=== Add a Calendar ===
 +
For calendar usage, see the [https://m.mediawiki.org/wiki/Extension:SimpleCalendar SimpleCalendar MediaWiki Extension.]  (Please use infrequently, it creates badly-named pages by default. The intention is to supersede it with something even better.)
 +
 
 +
=== Banners ===
 +
To draw the reader’s attention to facts about a page add a:
 +
{{Template:Banner|‽|Banner!}}
 +
(This is not a default Mediawiki item.)
 +
<pre>{{Template:Banner|'''‽'''|Banner!}}</pre>
 +
 
 +
<hr>
 +
 
 +
== <strong>Basic formatting</strong> ==
 +
(Yet another [https://mediawiki.org/wiki/Help:Formatting guide to Mediawiki markup.])
 +
 
 +
It’s not necessary to learn a complex markup language to create good-looking wiki pages. MediaWiki markup is different to DokuWiki markup and both are, of course, different to Markdown. Plain text will work just as well to create useful, informative content; 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.
 
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 ===
 
=== Things to remember ===
 
+
# When you're editing use the Preview button. Use it often. The preview button is your friend.
# Use the Preview button. Use it often. The preview button is your friend.
+
# If all else fails look at someone else’s page for clues.
# Look at someone else’s page for clues.
+
# Don’t be frightened to break something, changes can be reverted if necessary.
# Don’t be frightened to break something, it can be reverted if necessary.
 
 
# Try not to break anything (see the first edict above.)
 
# Try not to break anything (see the first edict above.)
  
Line 27: Line 58:
 
==== Heading 4 ====
 
==== Heading 4 ====
 
<pre>==== Heading 4 ====</pre>
 
<pre>==== Heading 4 ====</pre>
 +
 +
'''Note that the presence of 3 or more section headings in a page automatically generates a table of contents.'''
 +
It can be disabled by addition of the <code><nowiki>__NOTOC__</nowiki></code> Magic Word (preferred location: top of page.)
  
 
<hr>
 
<hr>
Line 41: Line 75:
 
(Red links are links to pages that don’t exist yet.)
 
(Red links are links to pages that don’t exist yet.)
 
Wiki pages, e.g. [[Events]]: <pre>[[Events]]</pre>
 
Wiki pages, e.g. [[Events]]: <pre>[[Events]]</pre>
Wiki pages with friendlier names, e.g. [[History|The past is past]], with a pipe between URL and text: <pre>[[History|The past is past]]</pre>
+
Wiki pages with friendlier names, e.g. [[PnutHistory|The past is past]], with a pipe between URL and text: <pre>[[PnutHistory|The past is past]]</pre>
 
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 is a nice site], with a space between URL and text: <pre>[https://pnut.io is a nice site]</pre>
  
 
=== Lists ===
 
=== Lists ===
Line 61: Line 95:
 
  * Bar
 
  * Bar
 
  * Baz
 
  * Baz
 
=== Banners ===
 
To draw the reader’s attention to facts about a page add a:
 
{{Template:Banner|‽|Banner!}}
 
(This is not a default Mediawiki item.)
 
<pre>{{Template:Banner|'''‽'''|Banner!}}</pre>
 
  
 
=== Other ===
 
=== Other ===
 
A number of html formatting tags can also be used, such as
 
A number of html formatting tags can also be used, such as
 
  hr, pre, strike, strong
 
  hr, pre, strike, strong

Latest revision as of 15:03, 18 October 2017

A short guide to formatting text for this wiki

(Formatting help specific to this network and this wiki.)

It may seem a bit odd to launch straight into the specifics first, but this part is possibly going to be referred to by most once familiar with the basics. Scroll for the Basic formatting section.

If you absolutely must create a page to test something major, please create it using @yourusername/Sandbox and add [[Category:Sandbox]] to automatically add it to the Category:Sandbox Page.

Your Wiki user page

If you want to be listed as a Wiki editor/creator please create your Wiki page with @yourusername as the title and copy the text from Template:User. If you don't wish to follow that template please at least add [[Category:User]] at the bottom of the markup.

Username at pnut.io

[https://pnut.io/{@username} @username] - for example, [https://pnut.io/@pnut @pnut] - gives @pnut

Hashtag at pnut.io

[https://pnut.io/tags/{tag} tag] - for example, [https://pnut.io/tags/ThemeMonday #ThemeMonday] - gives #ThemeMonday

Hashtag RSS feed at pnut.io

https://pnut.io/feed/rss/posts/tags/{tag} - for example, https://pnut.io/feed/rss/posts/tags/ThemeMonday - gives https://pnut.io/feed/rss/posts/tags/ThemeMonday

Add a Calendar

For calendar usage, see the SimpleCalendar MediaWiki Extension. (Please use infrequently, it creates badly-named pages by default. The intention is to supersede it with something even better.)

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!}}

Basic formatting

(Yet another guide to Mediawiki markup.)

It’s not necessary to learn a complex markup language to create good-looking wiki pages. MediaWiki markup is different to DokuWiki markup and both are, of course, different to Markdown. Plain text will work just as well to create useful, informative content; 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. When you're editing use the Preview button. Use it often. The preview button is your friend.
  2. If all else fails look at someone else’s page for clues.
  3. Don’t be frightened to break something, changes 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 ====

Note that the presence of 3 or more section headings in a page automatically generates a table of contents. It can be disabled by addition of the __NOTOC__ Magic Word (preferred location: top of page.)


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:

[[PnutHistory|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. is a nice site, with a space between URL and text:

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

Lists

Numbered list:

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

Bulleted list:

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

Other

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

hr, pre, strike, strong