Template:File/Doc: Difference between revisions

From Octave
Jump to navigation Jump to search
m (moved note about [[Template:Path] to top)
No edit summary
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
This template is used to include the contents of files. The first argument is the filename/filepath. Note that the actual code still needs to be inside a <nowiki><pre>...</pre></nowiki> block. To markup ''only'' the name of a file (e.g., {{path|/etc/conf.d/915resolution}}), use [[Template:Path]] instead.
This template is used to include the contents of files. The first argument is the filename/filepath but can be left blank.


Example: <pre>{{File|~/.octaverc|<pre>
* the actual code still needs to be inside a {{Codeline|<nowiki><pre> ... </pre></nowiki>}} block.
* to markup ''only'' the name of a file (e.g., {{path|/etc/octave3.2.conf}}), use [[Template:Path]] instead.
 
Example:
<pre>{{File|~/.octaverc|<pre>
## make prompt look like python
## make prompt look like python
PS1(">>> ")
PS1(">>> ")
Line 30: Line 34:
</pre>}}
</pre>}}


<noinclude>[[Category:Template Documentation]]</noinclude>
[[Category:Template with documentation]]

Latest revision as of 10:52, 30 November 2013

This template is used to include the contents of files. The first argument is the filename/filepath but can be left blank.

  • the actual code still needs to be inside a <pre> ... </pre> block.
  • to markup only the name of a file (e.g., /etc/octave3.2.conf), use Template:Path instead.

Example:

{{File|~/.octaverc|<pre>
## make prompt look like python
PS1(">>> ")
PS2("... ")

## alias help to man
function man (name)
  help (char (name))
endfunction

## load all packages
pkg load all;
</pre>}}

Will produce:

File: ~/.octaverc
## make prompt look like python
PS1(">>> ")
PS2("... ")

## alias help to man
function man (name)
  help (char (name))
endfunction

## load all packages
pkg load all;