Difference between revisions of "Style Guide"

From Game Making Tools Wiki
(Embedding video info)
(nb template)
 
Line 17: Line 17:
  
 
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.
 
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.
 
==Media==
 
===Embedding===
 
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.
 
 
===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:
 
 
<nowiki>blender_decimate.png</nowiki>
 
 
<nowiki>solarus_logo.png</nowiki>
 
 
====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:
 
 
<nowiki><gallery mode="packed">
 
File:filename.png|caption
 
File:filename.png|caption
 
File:filename.png|caption
 
</gallery></nowiki>
 
 
Does seem to centre it though. Would look nicer left-aligned.
 
 
Captions can have links and w/e
 
  
 
==Infoboxes==
 
==Infoboxes==
Line 134: Line 104:
 
| item5_description =  
 
| item5_description =  
 
}}</nowiki>
 
}}</nowiki>
 +
 +
==Media==
 +
===Embedding===
 +
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.
 +
 +
===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:
 +
 +
<nowiki>blender_decimate.png</nowiki>
 +
 +
<nowiki>solarus_logo.png</nowiki>
 +
 +
====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:
 +
 +
<nowiki><gallery mode="packed">
 +
File:filename.png|caption
 +
File:filename.png|caption
 +
File:filename.png|caption
 +
</gallery></nowiki>
 +
 +
Does seem to centre it though. Would look nicer left-aligned.
 +
 +
Captions can have links and w/e
 +
 +
==Nota Bene==
 +
 +
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==
 
==Quotation==

Latest revision as of 05:31, 3 March 2021

Rough guide to keeping things looking uniform.

Feel free to discuss anything on this page, and make suggestions if you think there are better ways of doing things.

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!

Colours

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

Categories

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.

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

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.

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:

  • 'logo' for software logos,
  • 'screenshot' for images of the software,
  • 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:

[[File:filename.extension|220px|thumb|left]]

Category links for fields like 'runs_on' and 'exports_to' looks like this:

[[:Category:Linux_export|]]

To add a bullet point / list simple make a new line and enter and asterix and a space, then your text

| item5_description = text text text
* text text text

To make a new line without a bullet use <br>




Current infoboxes are:

{{ infobox_software
| title        = 
| logo         = 
| image        = 
| screenshot   = 
| release_date = 
| made_by      = 
| runs_on      = 
| exports_to   = 
}}
{{ infobox_assetsoftware
| title        = 
| logo         = 
| image        = 
| screenshot   = 
| release_date = 
| made_by      = 
| runs_on      = 
| imports      = 
| exports      = 
}}
{{ infobox_leveleditor
| title        = 
| logo         = 
| image        = 
| screenshot   = 
| release_date = 
| made_by      = 
| availability = 
}}
{{ 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 = 
}}

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

Nota Bene

For inserting notes that need to stand-out a bit.

{{nb|note}}

—where you replace 'note' with the note you wish to highlight.

Quotation

For in-line quotes the <q> element should suffice, but for blockquotes you should use the blockquote template:—

{{blockquote|quote|source}}

—where you replace 'quote' with the text you're quoting, and 'source' with the name and location (URL, etc.) of the source.