Difference between revisions of "Help:StyleGuide"

From Community Pnut.io Wiki
Jump to: navigation, search
m (Updated intent of basic formatting link)
m (Added placeholder for wiki user pages, removed work-in-progress banner as superfluous)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
{{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. 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.
 
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.
Line 18: Line 16:
 
== Formatting help specific to this network and 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 [[Help:StyleGuide#Basic_formatting|Basic formatting section.]]
 
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_formatting|Basic formatting section.]]
 +
 +
=== Your Wiki user page ===
 +
If you [[:Category:User|want to be listed as a Wiki editor/creator]] please create your Wiki page with your pnut.io '@username' 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.
  
 
=== Hashtag at pnut.io, example ===
 
=== Hashtag at pnut.io, example ===

Revision as of 05:19, 6 October 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. 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 formatting section.

Your Wiki user page

If you want to be listed as a Wiki editor/creator please create your Wiki page with your pnut.io '@username' 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.

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