Project:Terminology

From PsychonautWiki
Jump to: navigation, search

Usage

The Terminology page

By default Lingo will mark up any page with the terms and definitions defined on the Terminology page of your wiki (or the respective page in the language of your wiki; see the Special:Version page of your wiki for the actual Terminology page name). Just create that page and insert some entries using the following syntax:

;FTP:File Transfer Protocol
;AAAAA:American Association Against Acronym Abuse
;ACK:Acknowledge
;AFAIK:As Far As I Know
;AWGTHTGTATA:Are We Going To Have To Go Through All This Again
;HTTP:HyperText Transfer Protocol

You can use any characters in a term (including punctuation, spaces, all UTF-8 characters, but excluding the colon (:) of course), you are not limited to only letters.

To give some structure to the Terminology page you are also allowed to have Terms and Definitions on separate lines. Any lines not starting with a ; or a : are ignored, so go ahead and insert empty lines, headlines, explanatory text.

Using this format you may assign one definition to multiple terms, i.e., to cover grammatical variants (see the U.S.A. example below) and multiple definitions to one term, i.e., to cover different meanings (see the ACK example). You may even combine this, i.e., have multiple definitions for a set of multiple terms. Finally, you may also use transclusion, i.e., to have different glossaries for different topics and pull them all together on the Terminology page.

;FTP
:File Transfer Protocol

;AAAAA
:American Association Against Acronym Abuse

;ACK
:Acknowledge
:Acklington railway station

;U.S.A.
;USA
:United States of America

Pull in more terminology from elsewhere:
{{:MoreTerminology}}

Excluding text from markup

You can exclude an article from markup by including the magic word __NOGLOSSARY__ anywhere in that article's text.

In some cases it may be necessary to exclude only portions of a page, i.e., because Lingo interferes with some JavaScript. This can be achieved by wrapping that part in an HTML element (e.g. a span or a div) and specifying class="noglossary". As a shorthand for <span class="noglossary"> you can just use the <noglossary> tag.