View source for Template:Lang-grc/doc

{{Documentation subpage}}
{{COinS safe|n}}
{{lua|Module:lang}}
{{hatnote|1='''This template is for tagging [[Ancient Greek|<span style="font-size:130%;">Ancient</span> Greek]] text only!''' – for Modern Greek, see {{tlx|lang-el}} and for Medieval Greek, see {{tlx|lang-gkm}} instead. For custom labels, no labels, or other uses, see {{tlx|lang}}.}}

==Usage==
{{#invoke:Lang/documentor tool|lang_xx_settings|template={{ROOTPAGENAME}}}}
The primary objective of this template (and of the other {{tlx|lang}} templates) is to tag non-English text so that ''both'' human ''and'' machine readers are able to properly interpret, display and understand non-English text as part of an effort to move towards a [[semantic web]]. To that end, proper use of these templates help web browsers to choose the correct display font, text-to-speech screen readers to select a more appropriate pronunciation, search engines to better index and relate the context of the content, translation services to properly interpret the words, spell checkers to properly allow and/or require diacritics, and so on.

===Important metadata===
''Regardless of the label that is displayed in front of the text'' (i.e.: "Ancient Greek:" vs. "Greek"), this template will ''always'' wrap the supplied Ancient Greek text inside of appropriate HTML {{tag|span}} tags – that is to say that the Ancient Greek text will be tagged using the [[ISO 639-2]] and [[ISO-639-3]] language code for '''Ancient Greek''':  "'''grc'''". The following example wikicode:
::{{tlc|lang-grc|ἄτομος|átomos|indivisible, an atom}}
produces the following HTML:
::<code><nowiki><a href="/wiki/Ancient_Greek" title="Ancient Greek">Ancient Greek</a>:</nowiki><br /></code>
::<code><nowiki><span </nowiki>'''lang="grc" xml:lang="grc"'''<nowiki>>ἄτομος</span></nowiki><br /></code>
::<code><nowiki><span title="Ancient Greek transliteration" class="Unicode" style="white-space:normal; text-decoration: none"><i>átomos</i></span></nowiki><br /></code>
::<code><nowiki>"indivisible, an atom"</nowiki></code>

This [[metadata]] identifies the enclosed text as Ancient Greek for the benefit of search engines, browsers, screen readers, translators, typesetters, and so on. To these "non-human readers", Ancient Greek (encoded as "grc") has important distinctions from Modern Greek (appropriately encoded using "ell", "gre" or "grk" by other {{tlx|lang}} templates). '''For that reason, this template should never be used with Modern or Medieval or other Greek text'''.

== Parameters ==
{{#lst:Template:Lang-x/doc/parameters|lang_xx_parameters}}

==Syntax==
:'''<nowiki>{{lang-grc</nowiki>'''
::'''|{{var|Ancient Greek text}}''' – using the Greek [[polytonic]] alphabet (with [[Greek diacritics|diacritics]]). ''(mandatory) – must be the 1st field''
::'''|{{var|transliterated text}}''' – the same text, [[transliterated]] using Latin alphabet (see [[Romanization of Greek]]). '' (optional) – must be the 2nd field''
::'''|{{var|translated text}}''' – in English. ''(optional) – must be the 3rd field''
:'''<nowiki>}}</nowiki>'''

==Examples==
:{| class="wikitable"
|-
! Code
! Result
|-
| {{tlf|lang-grc|ἄτομος}}
| {{lang-grc|ἄτομος}}
|-
| {{tlf|lang-grc|ἄτομος|átomos}}
| {{lang-grc|ἄτομος|átomos}}
|-
| {{tlf|lang-grc|ἄτομος|átomos|indivisible, an atom}}
| {{lang-grc|ἄτομος|átomos|indivisible, an atom}}
|-
| {{tlf|lang-grc|ἄτομος|&nbsp;|indivisible, an atom (lit: 'that cannot be cut')}}&nbsp;
| {{lang-grc|ἄτομος||indivisible, an atom (lit: 'that cannot be cut')}}&nbsp;
|}

==Category==
Articles using this template are automatically placed in [[:Category:Articles containing Ancient Greek-language text]].

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Text",
			"description": "The Greek text to be displayed",
			"type": "line",
			"required": true
		},
		"links": {
			"label": "Link?",
			"description": "If a link to the article Greek language is included",
			"type": "boolean",
			"default": "yes"
		},
		"lit": {
			"label": "Lit",
			"description": "English translation of Greek text",
			"type": "string"
		},
		"translit": {
			"label": "Transliteration",
			"description": "A Latin alphabet respelling of Greek text",
			"type": "string"
		}
	},
	"description": "Insert Greek text. This template should only be used with modern Greek."
}
</templatedata>

== See also ==
* {{tlx|lang-el}} for Modern Greek.
* {{tlx|lang-ell}} for Modern Greek explicitly stated and linked so in the label.
* {{tlx|lang-gkm}} for Medieval Greek.
* {{tlx|lang-grc-gre}} for which the Ancient Greek description is not satisfactory or limiting.
* {{tlx|lang-grc-koi}} for Koine Greek.
* {{tlx|lang|2=el}} and {{tlx|lang|2=ell}} tags Modern Greek text, without the label (for use with custom display, and other uses).
* {{tlx|lang|2=grc}} tags Ancient Greek text, without the label (for use with custom display, and other uses).
* {{tlx|transl|2=grc}} tags text as "Ancient Greek Transliteration" (has no visible effect other than said tag when pointer is placed on text).
* {{tlx|grc icon}}
<includeonly>
[[Category:Greek multilingual support templates|{{PAGENAME}}]]
[[Category:Lang-x templates]]
</includeonly>