Difference between revisions of "Template:MC-Basic/ErrorCode"

From SoftMC-Wiki
Jump to: navigation, search
(Draft)
(added description)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<includeonly><tr valign="top">
 
<includeonly><tr valign="top">
<td align="center">{{{1}}}</td>
+
<td align="center">{{Anchor|{{{1}}}}}</td>
 
<td>{{{2}}}</td>
 
<td>{{{2}}}</td>
 
<td>{{{3}}}</td>
 
<td>{{{3}}}</td>
Line 13: Line 13:
 
{{Template
 
{{Template
 
|description=
 
|description=
 +
Error code entry within the [[Template:MC-Basic/ErrorCodeHeader|<nowiki>{{MC-Basic/ErrorCodeHeader}}</nowiki>]] template.
  
 
|template=
 
|template=
 
<nowiki>
 
<nowiki>
{{MC-Basic/ErrorCode|date|topic|link}}
+
{{MC-Basic/ErrorCode|number|message|description|type|severity|action}}
 
</nowiki>
 
</nowiki>
  
 
|parameters=
 
|parameters=
;date
+
;number
: News date.
+
: Error number.
;topic
+
;message
: Brief description of the news.
+
: Error message.
;link
+
;description
: Link to further information.
+
: Description.
 +
;type
 +
: Error type.
 +
;severity
 +
: Error severity.
 +
;action
 +
: Error action.
  
 
|operation=
 
|operation=
 +
The error number is automatically anchored.
 +
A reference to a number within the page can be done with [[#2]].
 +
 
|examples=
 
|examples=
 +
;Input
 
<pre>
 
<pre>
{{Software/NewsHeader|October 2010|
+
{{MC-Basic/ErrorCodeHeader|
{{Software/News|2010-10-04|aico.control 1.5.0 released|[[/1.5.0|aico.control 1.5.0 release page]]}}
+
{{MC-Basic/ErrorCode|1|CPU Divide error|Generated by the CPU if the divisor is zero or the quotient overflows the result register.|ASYNC|Fatal Fault|Watchdog}}
{{Software/News|2010-10-12|next news topic|[[link]]}}
+
{{MC-Basic/ErrorCode|2|CPU Debug|Generated by the CPU after each instruction if Trap Flag is set.|ASYNC|Fatal Fault|Watchdog}}
 +
{{MC-Basic/ErrorCode|3|CPU NMI|Generated by the CPU when the input to the NMI pin is asserted|ASYNC|Fatal Fault|Watchdog}}
 
}}
 
}}
 
</pre>
 
</pre>
 +
;Output
 +
{{MC-Basic/ErrorCodeHeader|
 +
{{MC-Basic/ErrorCode|1|CPU Divide error|Generated by the CPU if the divisor is zero or the quotient overflows the result register.|ASYNC|Fatal Fault|Watchdog}}
 +
{{MC-Basic/ErrorCode|2|CPU Debug|Generated by the CPU after each instruction if Trap Flag is set.|ASYNC|Fatal Fault|Watchdog}}
 +
{{MC-Basic/ErrorCode|3|CPU NMI|Generated by the CPU when the input to the NMI pin is asserted|ASYNC|Fatal Fault|Watchdog}}
 +
}}
 +
 
}}
 
}}
  
[[Category:Template:Software]]
+
[[Category:Template:MC-Basic]]
 
</noinclude>
 
</noinclude>

Latest revision as of 09:39, 14 December 2010

Error code entry within the {{MC-Basic/ErrorCodeHeader}} template.

Template

{{MC-Basic/ErrorCode|number|message|description|type|severity|action}}

Parameters

number
Error number.
message
Error message.
description
Description.
type
Error type.
severity
Error severity.
action
Error action.

Operation

The error number is automatically anchored. A reference to a number within the page can be done with #2.

Examples

Input
{{MC-Basic/ErrorCodeHeader|
{{MC-Basic/ErrorCode|1|CPU Divide error|Generated by the CPU if the divisor is zero or the quotient overflows the result register.|ASYNC|Fatal Fault|Watchdog}}
{{MC-Basic/ErrorCode|2|CPU Debug|Generated by the CPU after each instruction if Trap Flag is set.|ASYNC|Fatal Fault|Watchdog}}
{{MC-Basic/ErrorCode|3|CPU NMI|Generated by the CPU when the input to the NMI pin is asserted|ASYNC|Fatal Fault|Watchdog}}
}}
Output
Number Message Description Type Severity Action
1 CPU Divide error Generated by the CPU if the divisor is zero or the quotient overflows the result register. ASYNC Fatal Fault Watchdog
2 CPU Debug Generated by the CPU after each instruction if Trap Flag is set. ASYNC Fatal Fault Watchdog
3 CPU NMI Generated by the CPU when the input to the NMI pin is asserted ASYNC Fatal Fault Watchdog

For more examples refer to pages, which use this template: What links here.

Help:Templates describes general usage of templates, including treatment of special characters.