View source for Template:Lang-fa/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{high-use|78200+}}
{{for|[[Middle Persian]] text (Pahlavi language)|Template:lang-pal}}
{{for|[[Old Persian language|Old Persian]]|Template:lang-peo}}
{{see also|Template:Old Persian cuneiform}}

== Usage ==
Template {{tlf|'''lang-fa'''|nolink=yes}} indicates to readers the original form of a term or phrase in [[Persian language|Persian]]. The term or phrase is the only mandatory parameter. The text is formatted according to recommendations in [[Wikipedia:Manual of Style/Text formatting#Foreign terms]] (italics for Latin-script languages, regular for others).

The parameter {{Para|links|no}} prevents the language name from being linked.

The parameter {{Para|lit}} enables a literal translation to be given.

==Syntax==
:'''<nowiki>{{lang-fa</nowiki>'''
::'''|{{var|Persian text}}''' – using Persian. ''(mandatory)''
::'''|{{var|<nowiki>links=value</nowiki>}}''' – valid values: '''yes''' to have the language name linked (default) and '''no''' to prevent the language name from being linked. '' (optional)''
::'''|{{var|<nowiki>lit=string</nowiki>}}''' – valid strings are English phrases of Persian. ''(optional)''
::'''|{{var|<nowiki>translit=string</nowiki>}}''' – valid strings are transliterations (with the [[Latin script]]) of Persian text. ''(optional)''
:'''<nowiki>}}</nowiki>'''

== Examples ==
:{| class="wikitable"
|-
! Code
! Result
|-
|{{tlf|lang-fa|هزار افسان}}
| {{lang-fa|هزار افسان}}
|-
| {{tlf|lang-fa|دهه فجر|lit{{=}}ten days of dawn}}
| {{lang-fa|دهه فجر|lit=ten days of dawn}}
|-
| {{tlf|lang-fa|Persian|transliteration|lit{{=}}literal|links{{=}}no}}
| {{lang-fa|Persian|transliteration|lit=literal|links=no}}
|}

== See also ==
* {{Tl|lang}}, and its opposite, {{Tl|Language with name/for}}
* {{tlp|rtl-lang|fa}}, for untransliterated Persian-language strings without preceding "[[Persian language|Persian]]:" link.
* {{tlp|script|Arab|...}} for Arabic script without specifying a language.
* {{Tl|link language}}
* {{Tl|fa icon}}

{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Text",
			"description": "The foreign text to display.",
			"type": "string",
			"required": true
		},
		"links": {
			"label": "Display link",
			"description": "Set to no to disable the link to the article's language.",
			"type": "boolean"
		},
		"lit": {
			"label": "Literal translation"
		},
		"translit": {
			"label": "Transliteration",
			"description": "A Latin alphabet respelling of Persian text",
			"type": "string"
		}
	},
	"description": "Insert Persian text. Indicates to readers the original form of a term or phrase in Persian."
}
</templatedata>

<includeonly>
[[Category:Lang-x templates]]
[[Category:Afro-Asiatic multilingual support templates|{{PAGENAME}}]]
[[Category:Indo-Iranian multilingual support templates|{{PAGENAME}}]]
</includeonly>
<noinclude>[[Category:Documentation shared content templates]]</noinclude>