Difference between revisions of "Template:SettingSummary"
Jump to navigation
Jump to search
(Template for documenting webwork system/course settings) |
|||
Line 38: | Line 38: | ||
{| style="text-align: left; border: 1px solid black; border-collapse: collapse;" cellpadding="5" |
{| style="text-align: left; border: 1px solid black; border-collapse: collapse;" cellpadding="5" |
||
|- |
|- |
||
− | ! colspan="2" style="font-size: 120%; padding: 0.5em; text-align: center; background-color: #ccccff;" | [[ |
+ | ! colspan="2" style="font-size: 120%; padding: 0.5em; text-align: center; background-color: #ccccff;" | [[Configuration settings#{{{section|top}}}|{{{section|WeBWorK Setting}}}]]: {{BASEPAGENAME}} |
|- |
|- |
||
| colspan="2" style="text-align: center; margin: 0.3em;" |{{{summary|Please edit this page to enter a summary.}}}<br> |
| colspan="2" style="text-align: center; margin: 0.3em;" |{{{summary|Please edit this page to enter a summary.}}}<br> |
Revision as of 23:03, 23 May 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.