Glue3D Wiki:Beginner's guide/Manual of style

The Manual of Style is a set of rules that keeps every page on the Glue3D Wiki looking and feeling consistent. Following these guidelines makes the Wiki more professional and easier to read. For more explanation, look at: https://en.wikipedia.org/wiki/Wikipedia:Simplified_Manual_of_Style

Or for a more detailed explination, I recommend looking at: https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style

(this covers everything, so stuff might be off-topic for Glue3D)

Tone and Voice

Always write from a neutral, third-person perspective.

DON'T write	DO write
"I think this mod is really cool"	"This mods adds real time multiplayer to Glue3D."
"You should download this right now"	"The download links are available on the mod's GitHub repository." (although, we usually just add the link in the infobox)
"My mod is best for optimization"	"This mod focuses on optimizing certain aspects of the engine."

Avoid opinions, commands ("you must"), and first-person pronouns ("I", "we", "my"). Just describe what exists how it works.

Standard Article Layout

Most Glue3D Wiki articles should follow this structure:

'''Page Name''' is a [definition sentence] that does [stuff explain in a simplified matter, or the main objective of the thing you're talking about].

== Features ==
What does it do? List key capabilities.

== Usage ==
How does someone actually use it? (For mods/tools)

== History ==
When was it created? Major updates?

== See Also ==
* [[Related Page 1]]
* [[Related Page 2]]

[[Category:Modifications]]

Adjust sections as needed. Some pages might need <code>Syntax</code> or <pre>With multiple lines of codes</pre>. But always start with the bolded definition and end with categories.

Main article: Block Plugin

This wiki also supports the ScratchBlocks extension, so you can "write" Scratch blocks instead of having to screenshot them (and possibly have a low quality image).

Example:

define dance (speed)
set [dist v] to ((speed) * (distance to (mouse-pointer v)))
if <(distance to [mouse-pointer v]) > (10)> then
repeat until <(timer) > [10]>
  move (dist) steps
  next costume
  play note (pick random (40) to (100)) for (0.5) beats
  say [Wow! Scratch scripts on the Wiki!]
end
end

Code:

define dance (speed)
set [dist v] to ((speed) * (distance to (mouse-pointer v)))
if <(distance to [mouse-pointer v]) > (10)> then
repeat until <(timer) > [10]>
  move (dist) steps
  next costume
  play note (pick random (40) to (100)) for (0.5) beats
  say [Wow! Scratch scripts on the Wiki!]
end
end

Capitalization & Page Titles

Type of page	Rule	Example
Mod names	Title Case (capitalize major words)	[[Glue3D Community Edition]], not [[Glue 3d commmunity edition]]
General concepts	lowercase, except proper nouns	...[[custom blocks]]
Tutorials	Sentence case	[[How_to:Export_a_model]]

One more rule: Page titles should be singular not plural. Use [[Shader]], not [[Shaders]].

Images & Media

A wiki without images is boring. Here's how to add them:

Step 1 ΓÇô Upload:

Go to Special:Upload. Choose your image file (.png, .jpg or .webm recommended). Give it a descriptive name like Glue3D_model_example.png.

Step 2 ΓÇô Insert:

In the editor, type:

[[File:Glue3D_model_example.png|thumb|480x360px|right|This a custom model imported in the engine.]]

Parameter example	What it does
thumb	Creates a framed, resizable thumbnail
480x360px	Sets width and height in pixels
right	Floats the image to the right of text, there's also left and center, but right
caption text	Displayed below the image

Keep screenshots clear and relevant. No memes or off-topic images.

So remember, Don't Be Like Matt

Next: Learn how to discuss changes with other editors → Talk Pages