Difference between revisions of "Help:StyleGuide"

From Community Pnut.io Wiki
Jump to: navigation, search
m (Added todo banner)
m (Started to add pnut.io-specific and wiki-specific items)
Line 2: Line 2:
 
{{Template:Banner|'''?'''|Need to add markup definition to allow linking to pnut hashtags, usernames, conversations, etc.}}
 
{{Template:Banner|'''?'''|Need to add markup definition to allow linking to pnut hashtags, usernames, conversations, etc.}}
  
== A <strike>short</strike> 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. 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.
Line 9: Line 9:
 
=== Things to remember ===
 
=== Things to remember ===
  
# Use the Preview button. Use it often. The preview button is your friend.
+
# When you're editing use the Preview button. Use it often. The preview button is your friend.
# Look at someone else’s page for clues.
+
# If all else fails look at someone else’s page for clues.
# Don’t be frightened to break something, it can be reverted if necessary.
+
# Don’t be frightened to break something, changes 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.)
  
 
<hr>
 
<hr>
 +
 +
== 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 [[Help:StyleGuide#Basic_styles|Basic Styles section.]]
 +
 +
=== Hashtag at pnut.io, example ===
 +
<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]
 +
 +
=== Username at pnut.io, example ===
 +
<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]
 +
 +
<hr>
 +
 +
== Basic formatting ==
  
 
=== Section headings ===
 
=== Section headings ===
Line 45: Line 58:
 
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. [[History|The past is past]], with a pipe between URL and text: <pre>[[History|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 ===

Revision as of 06:39, 3 October 2017


?

Need to add markup definition to allow linking to pnut hashtags, usernames, conversations, etc.

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. 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.)

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 Styles section.

Hashtag at pnut.io, example

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

Username at pnut.io, example

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


Basic formatting

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. 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

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