View source for Template:Prime/doc

{{Documentation subpage}}
{{tsh|′}}
{{COinS safe|n}}
{{distinguish|Template:Softsign}}
This template produces a [[prime symbol]] {{code|′}} with leading space so it does not collide with a preceding ''[[Italic type|italic]]'' character (such as produced by {{tl|mvar}}).  It is known by two names, {{tlb|code=yes|nolink=yes|′}} (which is shorter), and {{tlb|code=yes|nolink=yes|prime}} (which is easier to find on a keyboard).

== Usage ==
For example:
* <syntaxhighlight lang="moin" inline>''{{′|f}}''(''{{′|x}}'') ≥ 0</syntaxhighlight> or <syntaxhighlight lang="moin" inline>{{math|''{{′|f}}''(''{{′|x}}'') ≥ 0}}</syntaxhighlight>
generates:
* ''{{′|f}}''(''{{′|x}}'') ≥ 0  or {{math|''{{′|f}}''(''{{′|x}}'') ≥ 0}}
for comparison, without the leading space, in some browsers you end up with the prime symbol being almost indistinguishable from the [[Ascender (typography)|ascender]] of the italic ''f'':
* ''f′''(''x′'') ≥ 0 or {{math|''f′''(''x′'') ≥ 0}}

The space provided is similar to {{tn|'}} (a.k.a. {{tl|apostrophe}}), used to provide a single quote with extra space, but provides the prime (minutes of arc) symbol instead of an apostrophe, ''and'' it can take the preceding letter into account when deciding how much space to add.

({{tn|'}} has a second function which is ''not'' needed by {{tlf|prime}}: it ensures the apostrophe is not interpreted as wiki markup.  For example, it can be written immediately after the wiki markup for italics as <syntaxhighlight lang="moin" inline>''{{'}}</syntaxhighlight>, without being interpreted as wiki markup for bold <syntaxhighlight lang="moin" inline>'''</syntaxhighlight>.)

* The template may be used without any arguments (a bare {{tlc|′}}), in which case is simply displays a prime symbol with the maximum space.  It may be a bit wide in some cases, but will be intelligible.
* The first argument ({{para|1}}) is preceding text.  This is displayed before the prime symbol, and the ''last'' letter of this text is used to determine the amount of space to provide.
* The second argument ({{para|2}}) is a single letter which determines the amount of space to provide.  This defaults to the last letter of the first argument, but if the preceding text ends with markup rather than a letter to be displayed, that won't work right.  Normally if the second argument is supplied, the first one is omitted.  That is, people normally find <syntaxhighlight lang="wikitext" inline>''[[π]]{{prime||π}}''</syntaxhighlight> more legible than the equivalent <syntaxhighlight lang="wikitext" inline>''{{prime|[[π]]|π}}''</syntaxhighlight>.
* An optional {{para|c|}} argument allows a different symbol, such as a double (″) or triple (‴) prime, to be substituted.  For example, <syntaxhighlight lang="wikitext" inline>12&deg;{{prime|34}}{{prime|56|c=″}}</syntaxhighlight> renders as 12&deg;{{prime|34}}{{prime|56|c=″}}.
* An optional {{para|sp|}} argument allows you to explicitly specify the space, overriding the internal computation.  Values around 0.1em normally work well.  If this is supplied, the first argument is of little use, and the second is ignored completely.

Note that, although Greek letters are supported, it currently does ''not'' work with the corresponding [[HTML entities]] like <code>&amp;alpha;</code>.

The extra space is most needed after tall letters which, in italic, extend far to the top right.  Here is a table illustrating various combinations, to help decide:

{|class=wikitable
|-
!colspan=2| Italic text ||colspan=2| {{tl|mvar|nolink=true}}
|rowspan=15|
!colspan=2| Italic text ||colspan=2| {{tl|mvar|nolink=true}}
|-
! ′ || {{tl|′|nolink=true}} || ′ || {{tl|′|nolink=true}}
! ′ || {{tl|′|nolink=true}} || ′ || {{tl|′|nolink=true}}
|-
| ''a′ A′'' || ''{{′|a}} {{′|A}}'' || {{mvar|a′ A′}} || {{mvar|{{′|a}} {{′|A}}}}
| ''n′ N′'' || ''{{′|n}} {{′|N}}'' || {{mvar|n′ N′}} || {{mvar|{{′|n}} {{′|N}}}}
|-
| ''b′ B′'' || ''{{′|b}} {{′|B}}'' || {{mvar|b′ B′}} || {{mvar|{{′|b}} {{′|B}}}}
| ''o′ O′'' || ''{{′|o}} {{′|O}}'' || {{mvar|o′ O′}} || {{mvar|{{′|o}} {{′|O}}}}
|-
| ''c′ C′'' || ''{{′|c}} {{′|C}}'' || {{mvar|c′ C′}} || {{mvar|{{′|c}} {{′|C}}}}
| ''p′ P′'' || ''{{′|p}} {{′|P}}'' || {{mvar|p′ P′}} || {{mvar|{{′|p}} {{′|P}}}}
|-
| ''d′ D′'' || ''{{′|d}} {{′|D}}'' || {{mvar|d′ D′}} || {{mvar|{{′|d}} {{′|D}}}}
| ''q′ Q′'' || ''{{′|q}} {{′|Q}}'' || {{mvar|q′ Q′}} || {{mvar|{{′|q}} {{′|Q}}}}
|-
| ''e′ E′'' || ''{{′|e}} {{′|E}}'' || {{mvar|e′ E′}} || {{mvar|{{′|e}} {{′|E}}}}
| ''r′ R′'' || ''{{′|r}} {{′|R}}'' || {{mvar|r′ R′}} || {{mvar|{{′|r}} {{′|R}}}}
|-
| ''f′ F′'' || ''{{′|f}} {{′|F}}'' || {{mvar|f′ F′}} || {{mvar|{{′|f}} {{′|F}}}}
| ''s′ S′'' || ''{{′|s}} {{′|S}}'' || {{mvar|s′ S′}} || {{mvar|{{′|s}} {{′|S}}}}
|-
| ''g′ G′'' || ''{{′|g}} {{′|G}}'' || {{mvar|g′ G′}} || {{mvar|{{′|g}} {{′|G}}}}
| ''t′ T′'' || ''{{′|t}} {{′|T}}'' || {{mvar|t′ T′}} || {{mvar|{{′|t}} {{′|T}}}}
|-
| ''h′ H′'' || ''{{′|h}} {{′|H}}'' || {{mvar|h′ H′}} || {{mvar|{{′|h}} {{′|H}}}}
| ''u′ U′'' || ''{{′|u}} {{′|U}}'' || {{mvar|u′ U′}} || {{mvar|{{′|u}} {{′|U}}}}
|-
| ''i′ I′'' || ''{{′|i}} {{′|I}}'' || {{mvar|i′ I′}} || {{mvar|{{′|i}} {{′|I}}}}
| ''v′ V′'' || ''{{′|v}} {{′|V}}'' || {{mvar|v′ V′}} || {{mvar|{{′|v}} {{′|V}}}}
|-
| ''j′ J′'' || ''{{′|j}} {{′|J}}'' || {{mvar|j′ J′}} || {{mvar|{{′|j}} {{′|J}}}}
| ''w′ W′'' || ''{{′|w}} {{′|W}}'' || {{mvar|w′ W′}} || {{mvar|{{′|w}} {{′|W}}}}
|-
| ''k′ K′'' || ''{{′|k}} {{′|K}}'' || {{mvar|k′ K′}} || {{mvar|{{′|k}} {{′|K}}}}
| ''x′ X′'' || ''{{′|x}} {{′|X}}'' || {{mvar|x′ X′}} || {{mvar|{{′|x}} {{′|X}}}}
|-
| ''l′ L′'' || ''{{′|l}} {{′|L}}'' || {{mvar|l′ L′}} || {{mvar|{{′|l}} {{′|L}}}}
| ''y′ Y′'' || ''{{′|y}} {{′|Y}}'' || {{mvar|y′ Y′}} || {{mvar|{{′|y}} {{′|Y}}}}
|-
| ''m′ M′'' || ''{{′|m}} {{′|M}}'' || {{mvar|m′ M′}} || {{mvar|{{′|m}} {{′|M}}}}
| ''z′ Z′'' || ''{{′|z}} {{′|Z}}'' || {{mvar|z′ Z′}} || {{mvar|{{′|z}} {{′|Z}}}}
|}

Lower-case ''f'', ''l'',  and upper-case ''T'' are the worst cases; they require the full 0.15em of space.  Other letters like ''j'' and ''V'' need some space, but not as much.  And letters like ''o'', ''A'' and ''L'' look worse with any extra space.  Unfortunately there's no HTML equivalent of [[TeX]]'s <code>\/</code> italic correction, so this uses a crude approximation (from {{tl|Italics correction/calc}}) which does not take the user's font into account.

{{Accessible symbols table}}

==See also==
{{Quotation mark templates}}

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Quotation mark templates]]
[[Category:Character templates]]
}}</includeonly>