Template:Definition/doc: Difference between revisions

From Indian River Lagoon Project
(Created page with "This is the Template Definition documentation page.")
 
mNo edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
This is the Template Definition documentation page.
This is the Template Definition documentation page.
<templatedata>
{
"params": {
"Term": {
"label": "Term",
"description": "Glossary word. Auto-filled at form start.",
"type": "string",
"required": true
},
"Abb": {
"label": "Abb",
"description": "Term abbreviation.",
"type": "string"
},
"Definition": {
"label": "Definition",
"description": "Glossary term definition.",
"type": "string",
"required": true
},
"SourceURL": {
"label": "Source URL",
"description": "Full url (https://...) of the definition source.",
"type": "url",
"required": true
},
"Type": {
"label": "Word Case",
"description": "Word case of the term.",
"type": "string"
},
"Pronunciation": {
"description": "Pronunciation",
"type": "string"
},
"AudioFile": {
"label": "Audio File",
"description": "Enter or upload a MP3 audio pronunciation.",
"type": "wiki-file-name"
},
"Synonym": {
"label": "Synonym",
"description": "Enter similar words separated by a comma.",
"type": "string"
},
"Sentence": {
"label": "Sentence",
"description": "Enter an example sentence.",
"type": "string"
},
"Article": {
"label": "Article",
"description": "Enter or select a Page Title from this site.",
"type": "wiki-page-name"
},
"RelatedURL": {
"label": "Web Link",
"description": "Enter the full url (https://...) of a relevant web site.",
"type": "url"
},
"ImageFile": {
"label": "Image",
"description": "Enter or upload a relevant image file name.",
"type": "wiki-file-name"
},
"Poster": {
"label": "Poster",
"description": "Name of the original poster. Auto-filled.",
"type": "string",
"default": "current_user"
},
"Postdate": {
"label": "Posted",
"description": "Original publish date. Admin Only",
"type": "string",
"default": "{{LOCALTIMESTAMP}}"
},
"TermID": {
"label": "Term ID",
"description": "Term identifier for coding. Admin only.",
"type": "string"
}
},
"description": "This template uses Page Forms to collect and store glossary word details, and create/edit a word's page."
}
</templatedata>

Latest revision as of 14:09, October 29, 2020

This is the Template Definition documentation page.

This template uses Page Forms to collect and store glossary word details, and create/edit a word's page.

Template parameters

ParameterDescriptionTypeStatus
TermTerm

Glossary word. Auto-filled at form start.

Stringrequired
AbbAbb

Term abbreviation.

Stringoptional
DefinitionDefinition

Glossary term definition.

Stringrequired
Source URLSourceURL

Full url (https://...) of the definition source.

URLrequired
Word CaseType

Word case of the term.

Stringoptional
PronunciationPronunciation

Pronunciation

Stringoptional
Audio FileAudioFile

Enter or upload a MP3 audio pronunciation.

Fileoptional
SynonymSynonym

Enter similar words separated by a comma.

Stringoptional
SentenceSentence

Enter an example sentence.

Stringoptional
ArticleArticle

Enter or select a Page Title from this site.

Page nameoptional
Web LinkRelatedURL

Enter the full url (https://...) of a relevant web site.

URLoptional
ImageImageFile

Enter or upload a relevant image file name.

Fileoptional
PosterPoster

Name of the original poster. Auto-filled.

Default
current_user
Stringoptional
PostedPostdate

Original publish date. Admin Only

Default
{{LOCALTIMESTAMP}}
Stringoptional
Term IDTermID

Term identifier for coding. Admin only.

Stringoptional