Difference between pages "User:StDoodle/Code sandbox" and "Template:CodeSample"
< User:StDoodle(Difference between pages)
Jump to navigation
Jump to search
imported>StDoodle m |
imported>StDoodle m |
||
| Line 1: | Line 1: | ||
| − | + | <includeonly>{{#if: {{{title|}}}|<h2>{{{title}}}</h2>}}{{#if: {{{description|}}}|<p>{{{description}}}</p>}}<div style="margin-bottom: 1em; border: dashed 1px green; padding: 1em;" title="Note: All functions (shown in blue) have their own page on the wiki you can look up for more information.">{{{code}}}</div>{{#if: {{{moreinfo|}}}|{{{moreinfo}}}}}</includeonly> | |
| − | <includeonly> | + | <noinclude> |
| − | {{#if: {{{title|}}}|<h2>{{{title}}}</h2>}} | + | <p>Uses the named parameters ''title'', ''description'' and ''code'' to display a code block & its information.</p> |
| − | {{#if: {{{description|}}}|<p>{{{description}}}</p>}} | + | <p>Note that only ''code'' is required; the ''title'' and ''description'' are optional.</p> |
| − | <div style="border: dashed 1px green; padding: 1em;"> | + | <p>A sample call to this template:</p> |
| − | {{{code}}} | + | <pre> |
| − | </ | + | {{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> | ||
| + | }} | ||
| + | </pre> | ||
| + | <p>Which produces the following:</p> | ||
| + | {{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>}} | ||
| + | |||
| + | ==Read Me== | ||
| + | Please keep the following in mind when adding a code sample: | ||
| + | * Tabs display poorly in the <nowiki><syntaxhighlight></nowiki> 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 | ||
| + | * Please avoid using cli_execute() if there is a built-in ash function | ||
| + | * Please note that incredibly long lines will break formatting on smaller screens; break things up if needed | ||
| + | * Do not modify a code sample purely to "add your own mark" to a page; if it illustrates the function, leave it be | ||
| + | |||
| + | [[Category:Basic Templates]]</noinclude> | ||
Revision as of 00:35, 11 April 2010
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.");
}
Read Me
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
- Please avoid using cli_execute() if there is a built-in ash function
- Please note that incredibly long lines will break formatting on smaller screens; break things up if needed
- Do not modify a code sample purely to "add your own mark" to a page; if it illustrates the function, leave it be