Template:Note/Doc: Difference between revisions

From Octave
Jump to navigation Jump to search
(documentation for note template)
 
m (Capitalize first letter.)
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This template is for items which should be noted by the user, but are not important enough to be a [[Template:Warning|Warning]].
This template is for items which should be noted by the user, but are not important enough to be a [[Template:Warning|Warning]].


Example: <nowiki>{{Note|If the system <b>reports <i>that</i></b><i> it is out</i> of disk space, but still shows free space in the output of "df", the problem could by that the filesystem has run out of free inodes. In this case you might consider increasing this number when creating the filesystem.}}</nowiki>
Example:
:<nowiki>{{Note|Methods of a class can be documented but the only way to access their help text is by specifying the class as in {{Codeline|help @class/method}}.}}</nowiki>


Will produce:
Will produce:
{{Note|If the system <b>reports <i>that</i></b><i> it is out</i> of disk space, but still shows free space in the output of "df", the problem could by that the filesystem has run out of free inodes. In this case you might consider increasing this number when creating the filesystem.}}
:{{Note|Methods of a class can be documented but the only way to access their help text is by specifying the class as in {{Codeline|help @class/method}}.}}
<noinclude>[[Category:Template Documentation]]</noinclude>
 
[[Category:Template with documentation]]

Latest revision as of 14:08, 11 June 2019

This template is for items which should be noted by the user, but are not important enough to be a Warning.

Example:

{{Note|Methods of a class can be documented but the only way to access their help text is by specifying the class as in {{Codeline|help @class/method}}.}}

Will produce:

Info icon.svg
Methods of a class can be documented but the only way to access their help text is by specifying the class as in help @class/method.