Help:Formatting

From Unify Community Wiki
(Difference between revisions)
Jump to: navigation, search
(Fixed syntax highlighting tag)
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
−
==General Guidelines==
+
= General Guidelines =
−
* Please spell check your additions and check punctuation and grammar to the best of your ability.  The more people who do this the better the site will be.
+
−
* Please look at some similar topics to the one you would like to write for general guides on formatting if possible.  If it isn't possible, then just perform your best and we can turn this Wiki into an excellent resource.
+
−
* Discussion and comments about a page belong in the separate discussion page.  The more we can use useful features like this of MediaWiki the better our site will be.  This one keeps the main page clean and the "TODO" in a concise spot.  You can visit the discussion page for any page from the link at the top of the page.
+
−
*When creating linked page, use the original page as the prefix. example. Page Name, Page Name/Page1, Page Name/Page2, Page Name/Page3. This helps with indexing and search results.
+
−
* 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).
+
−
* [http://meta.wikimedia.org/wiki/Help:Category Categories] will help this project out in the long run. Please try to use them logically and look at existing pages for use examples in our project's context.
+
  
−
==Creating Script Pages==
+
* English text only.
 +
* Please check for spelling, punctuation and grammatical errors in your work before submitting it.
 +
* Do not add any author or revision information to your page. This is all automatically handled by page history.
 +
* 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.
  
−
Page layouts within the Unify Community Wiki are important. By following these guidelines you help ensure wiki pages are clear and precise.
 
  
−
* Author = This is you the person writing the page, please include any credits to people here also.
+
= Code =
−
* Description = A general description of what the script/code can do.
+
−
* Usage = How to use the script/code (please give clear precise instructions).
+
−
* Code = Use the code format below when writing you codes.
+
−
* Categories = Place the relevant category tags at the bottom of the page.
+
  
−
[[Help:Contents| More editing help.]]
+
* 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.
  
−
==Script Tags==
+
* 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).
−
=====Csharp Script Tag=====
+
  
−
<noinclude> <</noinclude><noinclude>syntaxhighlight lang="csharp"> </noinclude> Insert script text here<noinclude> </syntaxhighlight> </noinclude>
+
* 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:
  
−
The csharp tag will produce the following example.
+
<syntaxhighlight lang="csharp">
 +
using UnityEngine;
  
−
<syntaxhighlight lang="csharp">
+
public class MyScript : MonoBehaviour
−
public class TestEvent : IEvent
+
 
{
 
{
−
     public TestEvent()
+
     public int value = 943;
−
    {
+
−
    }
+
  
−
     string IEvent.GetName()
+
     // Update is called once per frame.
 +
    private void Update()
 
     {
 
     {
−
         return this.GetType().ToString();
+
         if (value > 0)
−
    }
+
        {
−
 
+
            value--;
−
    object IEvent.GetData()
+
         }
−
    {
+
−
         return "TestEvent Data goes here!";
+
 
     }
 
     }
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
  
−
=====JavaScript/UnityScript Tag=====
+
[[Help:Contents| More editing help.]]
−
 
+
−
<noinclude> <</noinclude><noinclude>syntaxhighlight lang="javascript"> </noinclude> Insert script text here<noinclude> </syntaxhighlight> </noinclude>
+
−
 
+
−
The javascript tag will produce the following example.
+
−
 
+
−
<syntaxhighlight lang="javascript">// CoUpdate script skeleton.
+
−
 
+
−
#pragma strict
+
−
 
+
−
function Start()
+
−
{
+
−
    StartCoroutine("CoStart");
+
−
}
+
−
 
+
−
function CoStart() : IEnumerator
+
−
{
+
−
    while (true)
+
−
        yield CoUpdate();
+
−
}
+
−
 
+
−
function CoUpdate() : IEnumerator
+
−
{
+
−
    // Place your update code here.
+
−
}</syntaxhighlight>
+
−
 
+
−
=====Boo Script Tag=====
+
−
 
+
−
<noinclude> <</noinclude><noinclude>syntaxhighlight lang="boo"> </noinclude> Insert script text here<noinclude> </syntaxhighlight> </noinclude>
+
−
 
+
−
The Boo script tag will produce the following example.
+
−
 
+
−
<syntaxhighlight lang="boo">
+
−
class MessageText (Message):
+
−
 
+
−
    Text:
+
−
        get:
+
−
            return _text
+
−
    _text as string
+
−
 
+
−
    def constructor (text):
+
−
 
+
−
        _text = text
+
−
 
+
−
        # send the message
+
−
        super()
+
−
</syntaxhighlight>
+

Latest revision as of 00:46, 19 October 2020

[edit] General Guidelines

  • English text only.
  • Please check for spelling, punctuation and grammatical errors in your work before submitting it.
  • Do not add any author or revision information to your page. This is all automatically handled by page history.
  • 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.


[edit] 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.

Retrieved from "http://wiki.unity3d.com/index.php?title=Help:Formatting&oldid=20616"
Personal tools
Namespaces

Variants
Actions
Navigation
Extras
Toolbox