Help:ENA Templates: Difference between revisions

From Rosetta Code
Content added Content deleted
No edit summary
(Add output? template and some more info)
 
Line 3: Line 3:
!Template
!Template
!What it means
!What it means
!Adds page to [[:Category:Examples needing attention|ENA cat]]?
|-
|-
|[[Template:Broken]]
|[[Template:Broken]]
|This example is seriously broken. It does not even run/compile.
|This example is seriously broken. It does not even run/compile.
|{{yes}}
|-
|-
|[[Template:Confusing]]
|[[Template:Confusing]]
|This example is very hard to understand even though it seems to meet all task requirements.
|This example is very hard to understand even though it seems to meet all task requirements.
|{{yes}}
|-
|-
|[[Template:Eff note]]
|[[Template:Eff note]]
|This example shows a way of doing things that matches an algorithmic requirement, rather than the idioms of this language. It is probably not as efficient because it does not follow the language's patterns.
|This example shows a way of doing things that matches an algorithmic requirement, rather than the idioms of this language. It is probably not as efficient because it does not follow the language's patterns.
|{{no}}
|-
|-
|[[Template:Field attention]]
|[[Template:Field attention]]
|This example needs to be looked at by someone who knows more about the academic field it deals with.
|This example needs to be looked at by someone who knows more about the academic field it deals with.
|{{yes}}
|-
|-
|[[Template:Improve]]
|[[Template:Improve]]
|This example meets the task requirements, but can probably be done better while still doing so.
|This example meets the task requirements, but can probably be done better while still doing so.
|{{yes}}
|-
|-
|[[Template:In progress]]
|[[Template:In progress]]
|This example is a work in progress. Don't worry that it doesn't quite work yet.
|This example is a work in progress. Don't worry that it doesn't quite work yet.
|{{yes}}
|-
|-
|[[Template:Incomplete]]
|[[Template:Incomplete]]
|This example seems to have skipped some of the task requirements.
|This example seems to have skipped some of the task requirements.
|{{yes}}
|-
|-
|[[Template:Incorrect]]
|[[Template:Incorrect]]
|This example attempts to meet all task requirements, but does not meet at least one of them.
|This example attempts to meet all task requirements, but does not meet at least one of them.
|{{yes}}
|-
|-
|[[Template:Lines too long]]
|[[Template:Lines too long]]
|The lines of code in this example are too long and should be broken if possible.
|The lines of code in this example are too long and should be broken if possible.
|{{yes}}
|-
|-
|[[Template:Needs-review]]
|[[Template:Needs-review]]
|The task was recently changed and this example needs to be checked to make sure it still meets requirements.
|The task was recently changed and this example needs to be checked to make sure it still meets requirements.
|{{yes}}
|-
|-
|[[Template:Novice example]]
|[[Template:Novice example]]
|This example was created by someone who thinks they don't quite know how to do it the best way.
|This example was created by someone who thinks they don't quite know how to do it the best way.
|{{yes}}
|-
|[[Template:Output?]]
|This example looks to meet all task requirements except that it doesn't show the required output.
|{{yes}}
|-
|-
|[[Template:Untested]]
|[[Template:Untested]]
|This example was not tested. It may not work.
|This example was not tested. It may not work.
|{{yes}}
|-
|-
|[[Template:Wont work with]]
|[[Template:Wont work with]]
|This example does not work with library/OS/implementation/language X version Y.
|This example does not work with library/OS/implementation/language X version Y.
|{{no}}
|-
|-
|[[Template:Works with]]
|[[Template:Works with]]
|This example has been shown to work with library/OS/implementation/language X version Y.
|This example has been shown to work with library/OS/implementation/language X version Y.
|{{no}}
|}
|}

{{#ask: [[Category:ENA Template]]
| format=table
}}

Latest revision as of 15:45, 15 October 2012

We here at RC have a lot of templates that essentially mean that an example needs attention (ENA). Hopefully this table can help sort things out for inexperienced (or even hardened) users. Usage instructions should be on the template pages for each individual template. Many work with or without arguments.

Template What it means Adds page to ENA cat?
Template:Broken This example is seriously broken. It does not even run/compile. Yes
Template:Confusing This example is very hard to understand even though it seems to meet all task requirements. Yes
Template:Eff note This example shows a way of doing things that matches an algorithmic requirement, rather than the idioms of this language. It is probably not as efficient because it does not follow the language's patterns. No
Template:Field attention This example needs to be looked at by someone who knows more about the academic field it deals with. Yes
Template:Improve This example meets the task requirements, but can probably be done better while still doing so. Yes
Template:In progress This example is a work in progress. Don't worry that it doesn't quite work yet. Yes
Template:Incomplete This example seems to have skipped some of the task requirements. Yes
Template:Incorrect This example attempts to meet all task requirements, but does not meet at least one of them. Yes
Template:Lines too long The lines of code in this example are too long and should be broken if possible. Yes
Template:Needs-review The task was recently changed and this example needs to be checked to make sure it still meets requirements. Yes
Template:Novice example This example was created by someone who thinks they don't quite know how to do it the best way. Yes
Template:Output? This example looks to meet all task requirements except that it doesn't show the required output. Yes
Template:Untested This example was not tested. It may not work. Yes
Template:Wont work with This example does not work with library/OS/implementation/language X version Y. No
Template:Works with This example has been shown to work with library/OS/implementation/language X version Y. No