Template:CodeSample

Uses the named parameters title, description and code to display a code block & its information.

Note that only code is required; the title and description are optional.

A sample call to this template:

{{CodeSample|
title=Sample Code|
description=Some basic sample code.|
code=
<syntaxhighlight>
int i = 1; //this line is useless!
if (to_int(my_id()) > 1) {
   print("Aw, I guess you aren't Jick.");
}
</syntaxhighlight>
}}

Which produces the following:

Sample Code

Some basic sample code.

int i = 1; //this line is useless!
if (to_int(my_id()) > 1) {
   print("Aw, I guess you aren't Jick.");
}

Please keep the following in mind when adding a code sample:

• Tabs display poorly in the <syntaxhighlight> tag. Please use 3 spaces, instead.
  • Yes, some people have other preferences; I'm not going to tell you how to write your own scripts.
  • In order to make the wiki as easy-to-use as possible, it's important to keep to ONE standard, please.
• Please make sure there is one code sample (the 1st) that is as short & to-the-point as is possible.
• Please make sure that testing the code sample won't be significantly negative to the user; these are designed as hands-on examples.
  • For instance, if you must autosell items in the sample, choose something cheap.
  • Do NOT include anything that could cause "permanent" damage!
• Please follow other conventions used on other code samples as much as possible (placement of {}, etc).
• Do not modify a code sample purely to "add your own mark" to a page; if it illustrates the function, leave it be.