Help:Formatting

From Unify Community Wiki
Jump to: navigation, search

General Guidelines

  • Please check for spelling, punctuation and grammatical errors in your work before submitting it. All text should also be in English.
  • Discussions and comments about a page belong in the accompanying discussion page. You can visit or create the discussion section of any page by clicking on the "Discussion" tab at the top left corner.
  • Place relevant category tags at the bottom of the page. Please try to use them logically and look at existing pages for use examples.
  • Look to existing pages for ideas on how to format new pages and keep content consistent but also feel free to improve upon existing formats where it makes sense.
  • Don't use tabs in code examples. They are hard to type when editing in a browser and lines containing tabs have weird problems when combined with links generated by the syntax highlighter. If you have a script file with tabs and don't want to change that, you can copy the contents and then run the following line in a command shell before pasting it into the wiki: pbpaste | expand -t 4 | pbcopy (This example assumes you have set your editor to have a tab stop every 4 characters).

More editing help.

Sample Code

Small snippets of code, like for example int health = 100, can be denoted using the simple <code></code> tag but for full blocks of code and proper syntax highlighting you should use <syntaxhighlight lang="csharp"></syntaxhighlight> instead. Which will produce the following formatting:

using UnityEngine;
 
public class MyScript : MonoBehaviour
{
    public int value = 943;
 
    // Update is called once per frame.
    private void Update()
    {
        if (value > 0)
        {
            value--;
        }
    }
}

The <syntaxhighlight lang=""> tag also supports other programming languages like boo and javascript but the latest versions of Unity now only support C#. So using any language besides C# in the wiki is no longer recommended.

Personal tools
Namespaces

Variants
Actions
Navigation
Extras
Toolbox