Template:Note/Doc: Difference between revisions
Jump to navigation
Jump to search
Carandraug (talk | contribs) (documentation for note template) |
Carandraug (talk | contribs) (octavified example) |
||
| 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| | Example:<br> | ||
<nowiki>{{Note|Note that methods of a class can be documented. The help for the constructor itself can be obtained with the constructor name, that is for the polynomial constructor @code{help polynomial} will return the help string. Also the help can be obtained by restricting the search for the help to a particular class, for example {{Codeline|help @polynomial/polynomial}}. This second method is the only means of getting help for the overloaded methods and functions of the class.}}</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|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.}} | ||
<noinclude>[[Category:Template Documentation]]</noinclude> | <noinclude>[[Category:Template Documentation]]</noinclude> | ||
Revision as of 03:06, 7 December 2011
This template is for items which should be noted by the user, but are not important enough to be a Warning.
Example:
{{Note|Note that methods of a class can be documented. The help for the constructor itself can be obtained with the constructor name, that is for the polynomial constructor @code{help polynomial} will return the help string. Also the help can be obtained by restricting the search for the help to a particular class, for example {{Codeline|help @polynomial/polynomial}}. This second method is the only means of getting help for the overloaded methods and functions of the class.}}
Will produce:
If the system reports that it is out 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.