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 13: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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Term | Term | Glossary word. Auto-filled at form start. | String | required |
Abb | Abb | Term abbreviation. | String | optional |
Definition | Definition | Glossary term definition. | String | required |
Source URL | SourceURL | Full url (https://...) of the definition source. | URL | required |
Word Case | Type | Word case of the term. | String | optional |
Pronunciation | Pronunciation | Pronunciation | String | optional |
Audio File | AudioFile | Enter or upload a MP3 audio pronunciation. | File | optional |
Synonym | Synonym | Enter similar words separated by a comma. | String | optional |
Sentence | Sentence | Enter an example sentence. | String | optional |
Article | Article | Enter or select a Page Title from this site. | Page name | optional |
Web Link | RelatedURL | Enter the full url (https://...) of a relevant web site. | URL | optional |
Image | ImageFile | Enter or upload a relevant image file name. | File | optional |
Poster | Poster | Name of the original poster. Auto-filled.
| String | optional |
Posted | Postdate | Original publish date. Admin Only
| String | optional |
Term ID | TermID | Term identifier for coding. Admin only. | String | optional |