Difference between revisions of "Template:Code/Doc"

From Octave
Jump to navigation Jump to search
(documentation for code template)
 
(octavified example)
Line 1: Line 1:
This template is for code.
+
This template is for code. The first argument is the title of the code block or text file. The actual code still needs to be inside a <nowiki><pre>...</pre></nowiki> block.
  
 
Example:
 
Example:
<pre>{{Code|xorg.conf|<pre>
+
<pre>{{Code|input check example|<pre>
Section "Monitor"
+
  if (nargin < 1 || nargin > 4)
        Identifier  "Monitor0"
+
    print_usage;
        VendorName   "Monitor Vendor"
+
   elseif (!isnumeric (arg1))
        ModelName    "Monitor Model"
+
     error ("first argument should be numeric");
        Modeline     "800x480" 29.58  800 816 896 992  480 481 484 497  -HSync +Vsync
+
  endif
EndSection
 
 
&lt;/pre>}}</pre>
 
&lt;/pre>}}</pre>
  
 
Will produce:
 
Will produce:
{{Code|xorg.conf|<pre>
+
{{Code|input check example|<pre>
Section "Monitor"
+
  if (nargin < 1 || nargin > 4)
        Identifier  "Monitor0"
+
    print_usage;
        VendorName   "Monitor Vendor"
+
   elseif (!isnumeric (arg1))
        ModelName    "Monitor Model"
+
     error ("first argument should be numeric");
        Modeline     "800x480" 29.58  800 816 896 992  480 481 484 497  -HSync +Vsync
+
  endif
EndSection
 
 
</pre>}}
 
</pre>}}
 
 
<noinclude>[[Category:Template Documentation]]</noinclude>
 
<noinclude>[[Category:Template Documentation]]</noinclude>

Revision as of 17:50, 6 December 2011

This template is for code. The first argument is the title of the code block or text file. The actual code still needs to be inside a <pre>...</pre> block.

Example:

{{Code|input check example|<pre>
  if (nargin < 1 || nargin > 4)
    print_usage;
  elseif (!isnumeric (arg1))
    error ("first argument should be numeric");
  endif
</pre>}}

Will produce:

Code: input check example
  if (nargin < 1 || nargin > 4)
    print_usage;
  elseif (!isnumeric (arg1))
    error ("first argument should be numeric");
  endif