Template:DocTemplateParameter
Categories: Internal Templates
Description
DocTemplateParameter template is used to define general info of parameters.
This template should never be used directly on a profile. Its purpose is to make other templates based on it.
Info
| Name: | DocTemplateParameter |
| Type: | Internal |
| Group: | System |
| Subgroup: | Documentation |
| Status: | Approved |
| Project: | Project:Templates |
| Usage: | Pages using the template |
| Parameters usage stats: | Parameter usage on profiles |
| Map of Profiles: | WikiTree+ Maps |
| Edit: | Template Documentation |
Parameters
| Parameter | Usage | Type | Description | Example | Values |
|---|---|---|---|---|---|
| 1 information type | Optional | Text | Type of the parameter definition. No parameter is for parameter definition and header, footer are for begin end end of parameters table. noparams should be used if there are no parameters for the template. | info | , header, footer, noparams |
| name | Required | Text | Exact name of the parameter. It is case sensitive For numbered parameters, it should be meaningful name | location | |
| type | Required | Text | Type of the parameter. Defined the default handling of it. | Text | Text,Category,Year,TOC |
| usage | Required | Text | Defines if parameter is required, good to have and optional | Optional | Required,Preferred,Optional |
| numbered | Optional | Text | Index of numbered parameter. Starts with 1. | 1 | |
| help | Required | Text | Help describing the parameter. | ||
| example | Optional | Text | Example of the parameter. | ||
| values | Optional | Text | predefined values of the parameter. | ||
| group | Optional | Text | Name of the parameter group | ||
| initial | Optional | Text | RegEx expression defining initial value of the parameter. | ||
| validation | Optional | Text | Validation directive for suggestions. | list,num:4,num:3-5,hex:1-4,hex:hh-hhh,regex:^.*$ |
This page was last modified 07:46, 18 August 2021. This page has been accessed 60 times.