Difference between revisions of "Template:Code/Doc"

From Octave
Jump to navigation Jump to search
(example for no description)
 
(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.
  
* Note that the actual code still needs to be inside a <nowiki><pre>...</pre></nowiki> block;
+
* 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.
+
* to markup code that is the contents of specific files, use [[Template:File]] instead.
  
==Example 1==
+
== Code ==
<pre>{{Code|input check example|<pre>
+
<pre>
  if (nargin < 1 || nargin > 4)
+
{{Code
    print_usage;
+
|Title=
  endif
+
|Code=
&lt;/pre>}}</pre>
+
}}
 +
</pre>
 +
You can omit the parameters if you respect the correct order.
  
Will produce 1:
+
== Examples ==
{{Code|input check example|<pre>
+
=== Example 1 ===
  if (nargin < 1 || nargin > 4)
+
<pre>{{Code|input check example|
    print_usage;
+
if (nargin < 1 || nargin > 4)
  endif
+
  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>
+
<pre>{{Code|
  x (x > 20) = 34;
+
|x (x > 20) = 34;
&lt;/pre>}}</pre>
+
}}</pre>
  
 
Will produce:
 
Will produce:
{{Code| |<pre>
+
{{Code|  
   x (x > 20) = 34;
+
|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
 +
}}
  
<noinclude>[[Category:Template Documentation]]</noinclude>
+
[[Category:Template with documentation]]

Latest revision as of 03:56, 30 November 2013

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 <pre> ... </pre> block or a <syntaxhighlight> ... </syntaxhighlight> block.
  • to markup code that is the contents of specific files, use Template:File instead.

Code[edit]

{{Code
|Title=
|Code=
}}

You can omit the parameters if you respect the correct order.

Examples[edit]

Example 1[edit]

{{Code|input check example|
if (nargin < 1 || nargin > 4)
  print_usage;
endif
}}

Will produce:

Code: input check example

if (nargin < 1

Example 2[edit]

Note the empty code description.

{{Code|
|x (x > 20) = 34;
}}

Will produce:

{{{2}}}

Example 3[edit]

{{Code
|Title = input check example
|Code = if (nargin < 1 || nargin > 4)
  print_usage;
endif
}}

Will produce:

if (nargin < 1

Example 4[edit]

{{Code
|Title = 
|Code = if (nargin < 1 || nargin > 4)
  print_usage;
endif
}}

Will produce:

if (nargin < 1