501
edits
Template:Code/Doc: Difference between revisions
Jump to navigation
Jump to search
no edit summary
Carandraug (talk | contribs) (example for no description) |
No edit summary |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
This template is for code. The first argument is the title of the code block but can be left blank. | This template is for code. The first argument is the title of the code block but can be left blank. | ||
* | * the actual code still needs to be inside a {{Codeline|<nowiki><pre> ... </pre></nowiki>}} block or a {{Codeline|<nowiki><syntaxhighlight> ... </syntaxhighlight></nowiki>}} block. | ||
* | * to markup code that is the contents of specific files, use [[Template:File]] instead. | ||
== | == Code == | ||
<pre>{{Code| | <pre> | ||
{{Code | |||
|Title= | |||
|Code= | |||
}} | |||
</pre> | |||
You can omit the parameters if you respect the correct order. | |||
== Examples == | |||
{{Code|input check example|<pre> | === Example 1 === | ||
<pre>{{Code|input check example| | |||
if (nargin < 1 || nargin > 4) | |||
print_usage; | |||
endif | |||
}}</pre> | |||
Will produce: | |||
{{Code|input check example| | |||
if (nargin < 1 || nargin > 4) | |||
print_usage; | |||
endif | |||
</pre>}} | </pre>}} | ||
==Example 2 == | === Example 2 === | ||
Note the empty code description. | Note the empty code description. | ||
<pre>{{Code| | | <pre>{{Code| | ||
|x (x > 20) = 34; | |||
}}</pre> | |||
Will produce: | Will produce: | ||
{{Code| |<pre> | {{Code| | ||
|x (x > 20) = 34; | |||
</pre>}} | }} | ||
=== Example 3 === | |||
<pre> | |||
{{Code | |||
|Title = input check example | |||
|Code = if (nargin < 1 || nargin > 4) | |||
print_usage; | |||
endif | |||
}} | |||
</pre> | |||
Will produce: | |||
{{Code | |||
|Title = input check example | |||
|Code = if (nargin < 1 || nargin > 4) | |||
print_usage; | |||
endif | |||
}} | |||
=== Example 4 === | |||
<pre> | |||
{{Code | |||
|Title = | |||
|Code = if (nargin < 1 || nargin > 4) | |||
print_usage; | |||
endif | |||
}} | |||
</pre> | |||
Will produce: | |||
{{Code | |||
|Title = | |||
|Code = if (nargin < 1 || nargin > 4) | |||
print_usage; | |||
endif | |||
}} | |||
[[Category:Template with documentation]] | |||