Template:TemplateParam

Categories: Internal Templates

Description

TemplateParam template is used to define general info of Templates and all parameters.

This template should never be used directly on a profile. Its purpose is to make other templates based on it.

Info

Name:TemplateParam
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

ParameterUsageTypeDescriptionExampleValues
1 information type Optional Text Type of the template definition. Info is for template information, empty is for parameter definition and header, footer are for begin end end of parameters. info , info, paramheader, paramfooter, noparams, example, exampleheader, examplefooter, examplenote
templatehelp Required Text Short description of template.
templatetype Required Text Type of the template. Sticker Project Box,Sticker,Research Note Box
templategroup Required Text Further division of template. Internal shouldn't be used on a profiles and causes suggestion 845. Project Project, Location, Categories, Internal
templatesubgroup Required Text Further division of template to projects, locations teams, ... Project ,Location,Categories
templatestatus Required Text Status of the template. Approved Approved,Retired,Development
startdate Optional Year Date limit for the profiles using template 1845
enddate Optional Year Date limit for the profiles using template 1945
projectaccount Optional Text WikiTreeID of the project associated with the template. WikiTree-3
projectuserid Optional Text UserID of the project associated with the template. 167458
exampleparams Optional Text Parameters to the example template. Replace the pipe with pipe template. If it is longer than 60 letters it will display as multiline. {{!}}param1=1{{!}}param2=2
examplecategory Optional Category Category that is added to the profile. Centenarians
examplecategory1 Optional Category Another category that is added to the profile. Notables
examplecategory2 Optional Category Another category that is added to the profile. Notables
examplecategory3 Optional Category Another category that is added to the profile. Notables
examplenote Optional Text a comment to display next to example or a separator line This is an explanation
nocat Optional Yes Parameter skips the category column. Used only for information type exampleheader. yes
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.


This page was last modified 12:43, 23 January 2021. This page has been accessed 435 times.