Template:Glossary item/doc View history

Revision as of 09:23, 8 February 2015 by PesachZ (talk | contribs) (→‎Example: noanchor and non-display anchor)
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

A star (*) next a parameter sows it is required for proper use.

|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
|added = 2014-02-13}}


Produces ↓

Waze Glossary
(With sortable entries!)
Glossary Term Abbreviation / Acronym Description Date Updated

Date Added

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)

2014-02-13 (A)


{{/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
|added = 2014-02-13
|noanchor = yes}}


Produces a table row identical to the one above, but does not include and anchors. This method is great for entries which are actually just aliases lining to other entries.


{{/Glossary item
|term = Entry title
| ET
| Title
| Entry
| Fourth
| anchor1 = entry title
| anchor2 = Entry Title
| anchor3 = Entry titles
| anchor4 = Entry Titles
|desc = Here you put the definition and links to further information I.e. disambiguation pages and articles etc.
|updated = 2015-01-25
|added = 2014-02-13}}


Produces again a table row visually identical to the one above, but this one also includes anchor for four common misspellings of the title. This can be used for backwards compatibility to previous glossary entry anchors. This is also got practice in sober cases to include common spelling variations.

Future planned modifications

  • an in page anchor search (pipe dream)