Help:Formatting

From Unify Community Wiki
(Difference between revisions)
Jump to: navigation, search
(Improved and updated instructions)
Line 1: Line 1:
== General Guidelines ==
+
= General Guidelines =
  
 
* Please check for spelling, punctuation and grammatical errors in your work before submitting it. All text should also be in English.
 
* 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.
 
* 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 [http://meta.wikimedia.org/wiki/Help:Category category] tags at the bottom of the page. Please try to use them logically and look at existing pages for use examples.
 
* Place relevant [http://meta.wikimedia.org/wiki/Help:Category 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).
 
  
[[Help:Contents| More editing help.]]
 
  
== Sample Code ==
+
= Code =
  
Small snippets of code, like for example <code> int health = 100</code>, can be denoted using the simple <code>&lt;code&gt;&lt;/code&gt;</code> tag but for full blocks of code and proper syntax highlighting you should use <code>&lt;syntaxhighlight lang="csharp"&gt;&lt;/syntaxhighlight&gt;</code> instead. Which will produce the following formatting:
+
* Small snippets of code, like for example <code> int health = 100</code>, can be denoted using the simple <code>&lt;code&gt;&lt;/code&gt;</code> tag.
 +
 
 +
* 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).
 +
 
 +
* For full blocks of code and proper syntax highlighting use <code>&lt;syntaxhighlight lang="csharp"&gt;&lt;/syntaxhighlight&gt;</code> instead. Which will produce the following:
  
 
<syntaxhighlight lang="csharp">
 
<syntaxhighlight lang="csharp">
Line 31: Line 32:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
The <code>&lt;syntaxhighlight lang=""&gt;</code> 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.
+
[[Help:Contents| More editing help.]]

Revision as of 23:13, 18 October 2020

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.


Code

  • Small snippets of code, like for example int health = 100, can be denoted using the simple <code></code> tag.
  • 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).
  • For full blocks of code and proper syntax highlighting use <syntaxhighlight lang="csharp"></syntaxhighlight> instead. Which will produce the following:
using UnityEngine;
 
public class MyScript : MonoBehaviour
{
    public int value = 943;
 
    // Update is called once per frame.
    private void Update()
    {
        if (value > 0)
        {
            value--;
        }
    }
}

More editing help.

Personal tools
Namespaces

Variants
Actions
Navigation
Extras
Toolbox