Difference between revisions of "Template:SettingSummary"
Jump to navigation
Jump to search
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
<includeonly><!-- |
<includeonly><!-- |
||
| − | -->[[Category:WeBWorK configuration settings|{{{name |
+ | -->[[Category:WeBWorK configuration settings|{{{name}}}]]<!-- |
-->[[Category:WeBWorK configuration settings {{{version_min|version unknown}}}|<!-- |
-->[[Category:WeBWorK configuration settings {{{version_min|version unknown}}}|<!-- |
||
| − | -->{{{name |
+ | -->{{{name}}}<!-- |
-->]]<!-- |
-->]]<!-- |
||
| − | --></includeonly> |
+ | --></includeonly> |
| − | + | {{#if: {{{version_max|}}} |
|
| − | + | |{{obsolete|{{{version_max}}} |
|
| − | + | |name={{{name}}} |
|
| + | |newvarlink={{{newvarlink|}}} |
||
| + | |newvarname={{{newvarname|}}}}} |
||
| − | -->{{#if: {{{section|}}} |<!-- |
||
| + | }} |
||
| + | |||
| + | {{#if: {{{section|}}} |<!-- |
||
-->{{#switch: {{lc: {{{section}}} }}| |
-->{{#switch: {{lc: {{{section}}} }}| |
||
| − | seed=[[ |
+ | seed=[[Category:Seed variables|{{{name}}}]]| |
| − | path=[[ |
+ | path=[[Category:Path variables|{{{name}}}]]| |
email settings=[[Category:Email variables|{{{name}}}]]| |
email settings=[[Category:Email variables|{{{name}}}]]| |
||
feedback=[[Category:Feedback variables|{{{name}}}]]| |
feedback=[[Category:Feedback variables|{{{name}}}]]| |
||
Latest revision as of 09:59, 2 June 2010
| WeBWorK Setting: SettingSummary | |
|---|---|
| Please edit this page to enter a summary. | |
| Introduced in version: | Unknown |
| Removed in version: | still in use |
| Allowed values: | Unspecified |
| Defined in: | Unspecified |
| Default value: | Unspecified |
Other settings: Alphabetical | By Function
Copy and paste template
{{SettingSummary
|name =
|summary =
|section =
|version_min =
|version_max =
|range =
|file =
|default =
|newvarlink =
|newvarname =
}}
Usage notes
- name
- The name of the setting. E.g. $externalPrograms{latex}
- summary
- A short description of the setting's purpose.
- More detailed descriptions are desirable, and should be added to the main page content.
- If you update the short description, please also update the two tables at Configuration settings and Configuration settings (alphabetical).
- section
- The category that this setting comes under. This is automatically made into a link to the correct section in Configuration settings, so make sure you use an existing heading (or a new heading that you may add).
- version_min, version_max
- The version of WeBWorK the setting was introduced in (version_min) and the version it was removed in (version_max). Leave out version_max if the setting is still in use. If the setting is no longer used, this template automatically adds the {{obsolete}} template to the top of the page. Only include official versions - beta versions, release candidates, etc. should not be mentioned here (use the rev_introduced field if you want to give full precision).
- rev_introduced
- The revision this feature is introduced, only displayed if version_min is defined. Don't include the leading 'r' (i.e. use
rev_introduced=1509, notrev_introduced=r1509)
- range
- The range of allowable values, e.g. "0 - 255", "boolean", "string containing a URL or """.
- default
- The default value defined in the appropriate *.dist config file. If this is different in different versions of the software, then such variations should be noted.
- file
- The file in which the variable is defined, e.g. global.conf, webwork-apache2.config, etc.
- newvarlink
- For obsolete settings replaced by another setting, the link to the variable page that took its place
- newvarname
- For obsolete settings replaced by another setting, the new setting name
If the 'range' or 'default' sections are more than a couple of lines long, then simply put (see below) and fill in the details in the main body of the page.
