Help:Formatting
From Unify Community Wiki
(Difference between revisions)
Isaiah Kelly (Talk | contribs) (Improved and updated instructions) |
Isaiah Kelly (Talk | contribs) |
||
Line 1: | Line 1: | ||
− | + | = 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. | ||
− | |||
− | |||
− | |||
− | = | + | = Code = |
− | Small snippets of code, like for example <code> int health = 100</code>, can be denoted using the simple <code><code></code></code> tag | + | * Small snippets of code, like for example <code> int health = 100</code>, can be denoted using the simple <code><code></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 <code><syntaxhighlight lang="csharp"></syntaxhighlight></code> instead. Which will produce the following: | ||
<syntaxhighlight lang="csharp"> | <syntaxhighlight lang="csharp"> | ||
Line 31: | Line 32: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
− | + | [[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--; } } }