Guide:Game Making Tools Wiki: Difference between revisions

From Game Making Tools Wiki
m (Rjt moved page Style Guide to Guide:Game Making Tools Wiki: Reconextualising it as not just a 'style guide')
(WIP save)
Line 1: Line 1:
Rough guide to keeping things looking uniform.
Information about editing this wiki.


Feel free to discuss anything on this page, and make suggestions if you think there are better ways of doing things.
If you have any more questions make a post on the [[Guide_talk:Game_Making_Tools_Wiki|Talk page]].


==Code==
==General Tips==
For blocks of code you can use the <nowiki><pre></nowiki> tag. For inline code snippets, or keyboard/inputs you can use <nowiki><code></nowiki>. A bit wrong-sounding, I know!
* Editing a wiki can always seem a bit daunting at first, but don't worry, you can't break anything :)
* Some good things to do to get used to things is to fix any errors like broken links or typos you see. It's also really helpful!
* You can create pages under your username by added a forward slash '/' and whatever you want to call the page. For example [[User:Rjt/draft]]. This is useful for drafts and experiments or whatever; maybe you want to put an essay there or something!


==Colours==
==Basic Syntax==
The colours used in the logo are: <span style=background:#ed1c24;color:white;padding:2px;>#ed1c24</span>, <span style=background:#ffaec9;padding:2px;>#ffaec9</span> and <span style=background:#fff200;padding:2px;>#fff200</span>


==Categories==
===Headings===
Categories should be on the bottom of a page.


The order is: Software kind, 2-D/3-D, genre, x, operating system. 'X' being space for whatever else.
===Links===


<nowiki>[[Category:Game Builder]][[Category:2-D]][[Category:Adventure]][[Category:Browser]][[Category:Browser_Export]]</nowiki>
===Lists===


Some times I use linebreaks after groupings of categories to make it a bit easier to read, this doesn't effect how it appears on the page.
===Styling Text===


==Infoboxes==
''Infoboxes'' are the rectangles you see on the right of most pages, used to summarise useful information.


There are a series onf ''infobox'' ''templates'', each for different kinds of pages. They usually have a title, at least one kind of image, and details about file format support, creators, and release details.


Images come in three kinds:
==Advanced Syntax==


* 'logo' for software logos,
===Code===
* 'screenshot' for images of the software,
For blocks of code you can use the <nowiki><pre></nowiki> tag. For inline code snippets, or keyboard/inputs you can use <nowiki><code></nowiki>. A bit wrong-sounding, I know!
* and 'image' which is both a fallback to the older infobox design and for misc. images.


To add an image you can use code like this. Though use your discretion as all of it may not be needed, often just the filename and size are enough:
===Categories===
 
Categories should be on the bottom of a page.
<nowiki>[[File:filename.extension|220px|thumb|left]]</nowiki>
 
Category links for fields like 'runs_on' and 'exports_to' looks like this:
 
<nowiki>[[:Category:Linux_export|]]</nowiki>
 
To add a bullet point / list simple make a new line and enter and asterix and a space, then your text
 
<nowiki>| item5_description = text text text
* text text text</nowiki>
 
To make a new line without a bullet use <nowiki><br></nowiki>


<br>
I tend to order them (Software kind, 2-D/3-D, genre, x, operating system. 'X' being space for whatever else), but it doesn't matter. And sometimes I use linebreaks after groupings of categories to make it a bit easier to read, this doesn't effect how it appears on the page.
<hr>
<br>


Current infoboxes are:
Example:


* [[Template:infobox_software|infobox_software]] - For [[:Category:Game Builder|game builder]] software.
<nowiki>[[Category:Game Builder]][[Category:2-D]]
<nowiki>{{ infobox_software
[[Category:Adventure]]
| title        =
[[Category:Browser]]
| logo        =
[[Category:Browser_Export]]</nowiki>
| image        =
| screenshot  =
| release_date =
| made_by      =
| runs_on      =
| exports_to  =
}}</nowiki>


* [[Template:infobox_assetsoftware|infobox_assetsoftware]] - For [[:Category:Asset_Creation|asset creation]] software.
===Media===
<nowiki>{{ infobox_assetsoftware
====Embedding====
| title        =  
| logo        =  
| image        =  
| screenshot  =  
| release_date =  
| made_by      =  
| runs_on      =  
| imports      =  
| exports      =  
}}</nowiki>
 
* [[Template:infobox_leveleditor|infobox_leveleditor]] - For [[:Category:Level_Editor|level editors]].
<nowiki>{{ infobox_leveleditor
| title        =  
| logo        =
| image        =
| screenshot  =
| release_date =
| made_by      =
| availability =
}}</nowiki>
 
* [[Template:infobox_updates|infobox_updates]] - For the [[Main_Page|front page]].
<nowiki>{{ infobox_updates
| item1            =
| item1_date        =
| item1_description =
| item2            =
| item2_date        =
| item2_description =  
| item3            =
| item3_date        =
| item3_description =
| item4            =
| item4_date        =
| item4_description =
| item5            =
| item5_date        =
| item5_description =
}}</nowiki>
 
==Media==
===Embedding===
You can embed videos using the installed [https://www.mediawiki.org/wiki/Extension:EmbedVideo EmbedVideo extension].
You can embed videos using the installed [https://www.mediawiki.org/wiki/Extension:EmbedVideo EmbedVideo extension].


The simplest way to use it is: <code><nowiki>{{#ev:youtube|videourl}}</nowiki></code>. You can also leave out most of the URL and just add the ID string fro mthe end.
The simplest way to use it is: <code><nowiki>{{#ev:youtube|videourl}}</nowiki></code>. You can also leave out most of the URL and just add the ID string fro mthe end.


===Images===
====Images====
To keep things organised please start an image's filename with something like the name of the section it's used in, then an underscore, then a description of the file.
To keep things organised please start an image's filename with something like the name of the section it's used in, then an underscore, then a description of the file.


Line 120: Line 52:
  <nowiki>solarus_logo.png</nowiki>
  <nowiki>solarus_logo.png</nowiki>


====Galleries====
=====Galleries=====
I've just inserted my first gallery! I think they look a bit better without the lines, but otherwise use them as you see fit.
I've just inserted my first gallery! I think they look a bit better without the lines, but otherwise use them as you see fit.


Line 135: Line 67:
Captions can have links and w/e
Captions can have links and w/e


==Nota Bene==
==Conventions==
 
For inserting notes that need to stand-out a bit.
 
<nowiki>{{nb|note}}</nowiki>
 
—where you replace 'note' with the note you wish to highlight.
 
==Quotation==
 
For in-line quotes the <nowiki><q></nowiki> element should suffice, but for blockquotes you should use the [[Template:blockquote|blockquote template]]:—


<nowiki>{{blockquote|quote|source}}</nowiki>
==Trivia==
* The colours used in the logo are: <span style=background:#ed1c24;color:white;padding:2px;>#ed1c24</span>, <span style=background:#ffaec9;padding:2px;>#ffaec9</span> and <span style=background:#fff200;padding:2px;>#fff200</span>


—where you replace 'quote' with the text you're quoting, and 'source' with the name and location (URL, etc.) of the source.
==See Also==
* [https://www.mediawiki.org/wiki/Help:Formatting Help:Formatting] on the MediaWiki wiki.
* [[Wikipedia:Help:Wikitext|Help:Wikitext]] on Wikipedia.
* [https://workingwithmediawiki.com/book/chapter4.html MediaWiki syntax] on the 'Working with MediaWiki' website.
* [[Guide:Game_Making_Tools_Wiki/Templates]]
* [[Guide:Game_Making_Tools_Wiki/Infoboxes]]

Revision as of 00:38, 18 June 2021

Information about editing this wiki.

If you have any more questions make a post on the Talk page.

General Tips

  • Editing a wiki can always seem a bit daunting at first, but don't worry, you can't break anything :)
  • Some good things to do to get used to things is to fix any errors like broken links or typos you see. It's also really helpful!
  • You can create pages under your username by added a forward slash '/' and whatever you want to call the page. For example User:Rjt/draft. This is useful for drafts and experiments or whatever; maybe you want to put an essay there or something!

Basic Syntax

Headings

Links

Lists

Styling Text

Advanced Syntax

Code

For blocks of code you can use the <pre> tag. For inline code snippets, or keyboard/inputs you can use <code>. A bit wrong-sounding, I know!

Categories

Categories should be on the bottom of a page.

I tend to order them (Software kind, 2-D/3-D, genre, x, operating system. 'X' being space for whatever else), but it doesn't matter. And sometimes I use linebreaks after groupings of categories to make it a bit easier to read, this doesn't effect how it appears on the page.

Example:

[[Category:Game Builder]][[Category:2-D]]
[[Category:Adventure]]
[[Category:Browser]]
[[Category:Browser_Export]]

Media

Embedding

You can embed videos using the installed EmbedVideo extension.

The simplest way to use it is: {{#ev:youtube|videourl}}. You can also leave out most of the URL and just add the ID string fro mthe end.

Images

To keep things organised please start an image's filename with something like the name of the section it's used in, then an underscore, then a description of the file.

EG:

blender_decimate.png
solarus_logo.png
Galleries

I've just inserted my first gallery! I think they look a bit better without the lines, but otherwise use them as you see fit.

I used this simple code:

<gallery mode="packed">
File:filename.png|caption
File:filename.png|caption
File:filename.png|caption
</gallery>

Does seem to centre it though. Would look nicer left-aligned.

Captions can have links and w/e

Conventions

Trivia

  • The colours used in the logo are: #ed1c24, #ffaec9 and #fff200

See Also