Help:Formatting
From Unify Community Wiki
(Difference between revisions)
m (added script tags) |
m |
||
| Line 1: | Line 1: | ||
| − | + | ==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. | ||
| + | * 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== | |
| − | + | 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. | |
| + | * 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. | ||
| − | + | [[Help:Contents| More editing help.]] | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| + | ==Script Tags== | ||
=====Csharp Script Tag===== | =====Csharp Script Tag===== | ||
Revision as of 09:02, 11 October 2011
Contents |
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.
- 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).
- 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
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.
- 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.
Script Tags
Csharp Script Tag
<csharp> Insert script text here </csharp>
The csharp tag will produce the following example.
<csharp> public class TestEvent : IEvent {
public TestEvent()
{
}
string IEvent.GetName()
{
return this.GetType().ToString();
}
object IEvent.GetData()
{
return "TestEvent Data goes here!";
}
} </csharp>
Java/Unity Script Tag
<javascript> Insert script text here </javascript>
The javascript tag will produce the following example.
<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.
}</javascript>
Boo Script Tag
<Boo> Insert script text here </Boo>
The Boo script tag will produce the following example.
<boo>class MessageText (Message):
Text:
get:
return _text
_text as string
def constructor (text):
_text = text
# send the message
super()</boo>
