Template:Glossary item/doc View history

m (future mods list)
m (added documentation for new and changed parameters)
Line 7: Line 7:
Leave an empty line between each entry template.
Leave an empty line between each entry template.


The template has three required parameters, and the optional parameters. The term, description, and date last updated are required. The three abbreviations / aliases are optional.
The template has three required parameters, and the optional parameters. The term, description, and date last updated parameters are required. The four abbreviations / aliases, four non displayed anchor names, noanchor, and date added parameters are optional.


The template will produce a table row with the aliases in the second column separate by commas. It will also add an {{tl|anchor}} for the term name, and each of the aliases/abbreviations as well at the top of the table row.
The template will produce a table row with the aliases in the second column separate by commas. It will also add an {{tl|anchor}} for the term name, each of the aliases/abbreviations, and each of the specified non-display anchor names as well at the top of the table row.
 
If you do not want an anchor to be produced for a specific entry row, you can prevent it by specifying the {{para|noanchor|yes}}




===Parameters===
===Parameters===


{{Para|term}} glossary term
{{Para|term}} *glossary term


{{Para||<abbreviation/alias>}} accepts up to 4 abbreviations/aliases as unnamed parameters
{{Para||<abbreviation/alias>}} accepts up to 4 abbreviations/aliases as unnamed parameters
Line 24: Line 26:
{{Para||<4th abbreviation/alias>}}
{{Para||<4th abbreviation/alias>}}


{{Para|description}} glossary term description.
{{Para|anchor1|<non-displayed anchor name>}}
 
{{Para|anchor2|<second non-displayed anchor name>}}
 
{{Para|anchor3|<third non-displayed anchor name>}}
 
{{Para|anchor4|<fourth non-displayed anchor name>}}
 
{{Para|description}} *glossary term description.


{{Para|date}} date last updated enter in the YYYY-MM-DD format.
{{Para|updated}} *date last updated enter in the YYYY-MM-DD format.


{{Para|added}} date first added to the glossary enter in the YYYY-MM-DD format.


===Example===
===Example===
Line 38: Line 49:
| Fourth<br/>
| Fourth<br/>
|desc = Here you put the definition and links to further information I.e. disambiguation pages and articles etc.<br />
|desc = Here you put the definition and links to further information I.e. disambiguation pages and articles etc.<br />
|date = 2015-01-25<nowiki>}}</nowiki></code>
|updated = 2015-01-25<nowiki>}}</nowiki></code>




Line 50: Line 61:
| Fourth
| Fourth
|desc = Here you put the definition and links to further information I.e. disambiguation pages and articles etc.
|desc = Here you put the definition and links to further information I.e. disambiguation pages and articles etc.
|date = 2015-01-25}}
|updated = 2015-01-25}}
|}
|}


Line 56: Line 67:
==Future planned modifications==
==Future planned modifications==


*Hidden anchors
*entries which don't produce anchors (for abbreviations
*an in page anchor search (pipe dream)
*an in page anchor search (pipe dream)
<includeonly>
<includeonly>

Revision as of 09:06, 8 February 2015

This is a documentation subpage for Template:Glossary item.
It contains usage information, categories and other content that is not part of the original template page.

This templates produces an entry for the glossary table. It should be added on a new line in the glossary page.

Add the new term in the correct place in the glossary by alphabetical order sorted by the term name.

Leave an empty line between each entry template.

The template has three required parameters, and the optional parameters. The term, description, and date last updated parameters are required. The four abbreviations / aliases, four non displayed anchor names, noanchor, and date added parameters are optional.

The template will produce a table row with the aliases in the second column separate by commas. It will also add an {{anchor}} for the term name, each of the aliases/abbreviations, and each of the specified non-display anchor names as well at the top of the table row.

If you do not want an anchor to be produced for a specific entry row, you can prevent it by specifying the |noanchor=yes


Parameters

|term= *glossary term

|<abbreviation/alias> accepts up to 4 abbreviations/aliases as unnamed parameters

|<2nd abbreviation/alias>

|<3rd abbreviation/alias>

|<4th abbreviation/alias>

|anchor1=<non-displayed anchor name>

|anchor2=<second non-displayed anchor name>

|anchor3=<third non-displayed anchor name>

|anchor4=<fourth non-displayed anchor name>

|description= *glossary term description.

|updated= *date last updated enter in the YYYY-MM-DD format.

|added= date first added to the glossary enter in the YYYY-MM-DD format.

Example

{{/Glossary item
|term = Entry Title
| ET
| Title
| Entry
| Fourth
|desc = Here you put the definition and links to further information I.e. disambiguation pages and articles etc.
|updated = 2015-01-25}}


Produces ↓

Entry Title ET, Title, Entry, Fourth Here you put the definition and links to further information I.e. disambiguation pages and articles etc. 2015-01-25 (U)


Future planned modifications

  • an in page anchor search (pipe dream)