Cleachdaiche:Kibi78704/sandbox/DocTest-01

Background

This template is one of a set of language manipulating templates, all of which may be found in .

Uiclair needs a quick and easy way to correct grammatical and typological errors across its pages because there are so few native Gàidhlig speakers and because mistakes are so easy to make. It is easier to repair systemic typos and grammatical errors when there are fewer places to edit them. Another benefit of using templates is that they create isomorphic pages; that is, consistent formatting across definition pages makes for easier reading. Using templates to generate definition pages also makes it easy to automatically categorize the definitions by language, part of speech, or even by topic; this automatic categorization in turn makes it easy to gather statistics about the definitions, their languages, and the parts of speech that have been defined. Finally, automatically categorized pages, templates, and categories, themselves, make for easy access.

Naming Conventions

Template Names

Use abbreviations and language codes when naming templates for easier editing. See for the existing templates.

• Template names delimited by equal signs indicate that they affect the highest order headings. E.g., {{=x=}}.
• Template names delimited by dashes indicate that they affect a subheading. E.g., {{-x-}}.
• Template names consisting only of a language code are called language templates. I.e., {{language code}} is the format of a language template name. These templates overload the language code function to return data and metadata in Scottish Gaelic, ISO 639-5 codes, and English about the language in question. The language template names may be ISO 639-2, -3, or -5 language codes.

Category Names

Spell things out in category names for legibility and clarity. See (root category).

Description

The family of templates to which this one belongs, the language templates, store data and metadata about the languages used in definitions. This information can be useful for many applications beyond generating definitions.
These templates are handy for non-native Gaelic speakers: if it turns out that the wording is wrong in this particular template, all the pages and page names that employ it may be changed immediately simply by editing this one specific template. However, be warned that changing template-based Roinn-seòrsa\Category names is tricky as they need substantially more preparatory work before their names can be modified. See the Troubleshooting section below for more information on changing Roinn-seòrsa\Category names.

This template can either:

blah, blah, blah

• blah, blah, blah

• List_of_ISO_639-2_codes - language codes; includes ISO 639-3 codes (i.e., 3 character codes)
• List_of_ISO_639-5_codes - language family codes

• Return the preceding terms in English for documentation purposes.

This template always

• Adds itself to .

Parameters

Parameter 1 (optional). Makes use of several constant input values to achieve various results. The output value has neither formatting nor delimiters; that is, the returned text is completely plain and bare. This is true for all returned text from this template.

blah, blah, blah

• blah, blah, blah

• Use for documentation

• Parameter values 3-6 are currently used for documentation purposes.

Troubleshooting

Please note that we have not generated language templates for all known languages.

Creating Language Templates

• Look in to find your language template.
  • If your language template is missing, you must create one, or ask someone to create it for you before you can begin working in your language.
    • You may need to consult a list of ISO 639 codes to determine the family lineage for your particular language. At the time of this writing, ISO 639-* lists can be found at:
      • List_of_ISO_639-2_codes - language codes; includes ISO 639-3 codes (i.e., 3-character language codes)
      • List_of_ISO_639-5_codes - language family codes

Editing Language Templates

If your language template is incorrect, you must edit it, or ask someone to edit it for you. However, be very careful, especially with Scottish Gaelic genitives.

• You may need to consult a list of ISO 639-* codes to determine the family lineage code(s) for your particular language. See the previous section for a list of links. We also consulted Wikipedia language pages, and other sources, to generate the concatenated strings.

Editing the Gaelic Genitive Language Name

If the Gaelic genitive of your specified language name is incorrect or missing, edit your language template. Please note that this will affect every page that uses your language template.

• Please consult Sònraichte:WhatLinksHere/ of the page in question before editing.
• Please consult Sònraichte:CategoryTree or Sònraichte:Categories for help parsing the category tree before editing.

Caveat Editor: The Effect of Editing the Gaelic Genitive Language Name on Categories

Changing the Gaelic genitive noun phrase will empty and delete all categories based on the genitive noun phrase of your language and will remove those categories from any categories to which they belonged. In other words, know both what links to your language template and your language category tree before editing the Gaelic genitive noun phrase in the language template.

• N.B.: It is far, far easier to edit the category link in every member item item that appears in every category to be renamed before you change the Gaelic genitive noun phrase of your language name. This cannot be stressed strongly enough. Be warned that this may be a very lengthy process.

Sorting Issues within Roinn-seòrsa\Categories

If you are seeing sorting issues with your language's name, format the embedded category link with a parameter of your language name (e.g., [[Roinn-seòrsa:Faclan a-rèir cànain|Gaidhlig]]). Consider using unaccented characters in your language name parameter to make it sort properly in the category you are creating.

A Final Word on Editing Gaelic Genitive Language Names

• Don't forget to save the page you have just edited.
• Verify that all the recategorized items appear in the new category.
• Verify that your renamed categories appear in all the categories of which they were previous members.

Heading 1

blah, blah, blah

Heading 2

blah, blah, blah

Description

The family of templates to which this one belongs, the language templates in , mostly store data and metadata about the languages used in definitions. This information can be useful for many applications beyond generating definitions. There are a handful of templates in that are used to format definition entries; this template is an example of a Formatting template.
These templates are handy for non-native Gaelic speakers: if it turns out that the wording is wrong in this particular template, all the pages and page names that employ it may be changed immediately simply by editing this one specific template.
Formatting templates are also useful for creating isomorphic pages; that is, we want consistent formatting across definition pages to create a consistent look and feel because it's easier to read when the reader knows what to expect.

This template: