Difference between revisions of "Template:Code/Doc"

From Octave
Jump to navigation Jump to search
(note about Template:File)
(example for no description)
Line 1: Line 1:
This template is for code. The first argument is the title of the code block. The actual code still needs to be inside a <nowiki><pre>...</pre></nowiki> block. To markup code that is the contents of specific files, use [[Template:File]] instead.
+
This template is for code. The first argument is the title of the code block but can be left blank.
  
Example:
+
* Note that the actual code still needs to be inside a <nowiki><pre>...</pre></nowiki> block;
 +
* To markup code that is the contents of specific files, use [[Template:File]] instead.
 +
 
 +
==Example 1==
 
<pre>{{Code|input check example|<pre>
 
<pre>{{Code|input check example|<pre>
 
   if (nargin < 1 || nargin > 4)
 
   if (nargin < 1 || nargin > 4)
 
     print_usage;
 
     print_usage;
  elseif (!isnumeric (arg1))
 
    error ("first argument should be numeric");
 
 
   endif
 
   endif
 
&lt;/pre>}}</pre>
 
&lt;/pre>}}</pre>
  
Will produce:
+
Will produce 1:
 
{{Code|input check example|<pre>
 
{{Code|input check example|<pre>
 
   if (nargin < 1 || nargin > 4)
 
   if (nargin < 1 || nargin > 4)
 
     print_usage;
 
     print_usage;
  elseif (!isnumeric (arg1))
 
    error ("first argument should be numeric");
 
 
   endif
 
   endif
 
</pre>}}
 
</pre>}}
 +
 +
==Example 2 ==
 +
Note the empty code description.
 +
<pre>{{Code| |<pre>
 +
  x (x > 20) = 34;
 +
&lt;/pre>}}</pre>
 +
 +
Will produce:
 +
{{Code| |<pre>
 +
  x (x > 20) = 34;
 +
</pre>}}
 +
 
<noinclude>[[Category:Template Documentation]]</noinclude>
 
<noinclude>[[Category:Template Documentation]]</noinclude>

Revision as of 15:40, 15 December 2011

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

Example 1

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

Will produce 1:

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

Example 2

Note the empty code description.

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

Will produce:

  x (x > 20) = 34;