Template:Prime/doc

__EXPECTED_UNCONNECTED_PAGE__

Not to be confused with Template:Softsign.

This template produces a prime symbol ′ with leading space so it does not collide with a preceding italic character (such as produced by {{mvar}}). It is known by two names, {{′}} (which is shorter), and {{prime}} (which is easier to find on a keyboard).

Usage

For example:

• ''{{′|f}}''(''{{′|x}}'') ≥ 0 or {{math|''{{′|f}}''(''{{′|x}}'') ≥ 0}}

generates:

• f′(x′) ≥ 0 or 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 of the italic f:

• f′(x′) ≥ 0 or f′(x′) ≥ 0

The space provided is similar to {{'}} (a.k.a. {{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.

({{'}} has a second function which is not needed by {{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 ''{{'}}, without being interpreted as wiki markup for bold '''.)

• The template may be used without any arguments (a bare {{′}}), 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 (|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 (|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 ''[[π]]{{prime||π}}'' more legible than the equivalent ''{{prime|[[π]]|π}}''.
• An optional |c= argument allows a different symbol, such as a double (″) or triple (‴) prime, to be substituted. For example, 12°{{prime|34}}{{prime|56|c=″}} renders as 12°34′56″.
• An optional |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 α.

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:

Italic text		{{mvar}}			Italic text		{{mvar}}
′	{{′}}	′	{{′}}		′	{{′}}	′	{{′}}
a′ A′	a′ A′	a′ A′	a′ A′		n′ N′	n′ N′	n′ N′	n′ N′
b′ B′	b′ B′	b′ B′	b′ B′		o′ O′	o′ O′	o′ O′	o′ O′
c′ C′	c′ C′	c′ C′	c′ C′		p′ P′	p′ P′	p′ P′	p′ P′
d′ D′	d′ D′	d′ D′	d′ D′		q′ Q′	q′ Q′	q′ Q′	q′ Q′
e′ E′	e′ E′	e′ E′	e′ E′		r′ R′	r′ R′	r′ R′	r′ R′
f′ F′	f′ F′	f′ F′	f′ F′		s′ S′	s′ S′	s′ S′	s′ S′
g′ G′	g′ G′	g′ G′	g′ G′		t′ T′	t′ T′	t′ T′	t′ T′
h′ H′	h′ H′	h′ H′	h′ H′		u′ U′	u′ U′	u′ U′	u′ U′
i′ I′	i′ I′	i′ I′	i′ I′		v′ V′	v′ V′	v′ V′	v′ V′
j′ J′	j′ J′	j′ J′	j′ J′		w′ W′	w′ W′	w′ W′	w′ W′
k′ K′	k′ K′	k′ K′	k′ K′		x′ X′	x′ X′	x′ X′	x′ X′
l′ L′	l′ L′	l′ L′	l′ L′		y′ Y′	y′ Y′	y′ Y′	y′ Y′
m′ M′	m′ M′	m′ M′	m′ M′		z′ Z′	z′ Z′	z′ Z′	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 \/ italic correction, so this uses a crude approximation (from {{Italics correction/calc}}) which does not take the user's font into account.

Accessible symbols

Wikipedia previously provided templates that generated images with alt text for symbols not read by screen readers.

As of 2023, the symbols in the table below will be read in the default configuration of all three major screen readers (JAWS, Apple's VoiceOver and NVDA).

Depending on user-configured verbosity settings, a reader may hear additional characters read aloud or fewer typographic or punctuation characters read aloud.

Accessible symbols for tables

Symbol	Pronounced as	HTML entity	Template name
*	"star" or "asterisk"	*	{{asterisk}}
†	"dagger" or "single dagger"	†	{{dagger}}
‡	"double dagger"	‡	{{double-dagger}}
#	"number" or "hash tag"	#	{{number sign}} or {{hash-tag}}
°	"degree" or "degrees"	°	{{degree}}
→	"right arrow" or "rightwards arrow"	→	{{arrow}}
↓	"down arrow" or "downwards arrow"	↓	{{down-arrow}}
←	"left arrow" or "leftwards arrow"	←	{{left-arrow}}
↑	"up arrow" or "upwards arrow"	↑	{{up-arrow}}
′	"prime"	′	{{prime}}

See also

Template:Prime invokes Module:Navbox using Lua.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}

• Groups: Currently there is no technical limit to the maximum number of groups.
  • Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
• Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
• Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
  • Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
• Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
• Bullets: Create unordered lists with lines beginning with *.
• Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

• Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
  • Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
• Uncollapsed: Forces the navbox to be displayed.
  • All of the navboxes in this documentation are in the uncollapsed state.
• Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
  • Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
• Plain: Removes the "show/hide" link.

Sub-groups

• For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
• To create sub-groups within {{navbox}}, certain parameters are to be included:
  • The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
  • The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.

{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

• For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
• To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
  • The parent navbox is almost always uncollapsed (state=uncollapsed).
  • The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
  • The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
  • The nested collapsible navbox is forcefully collapsed (state=collapsed).

{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

• The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
• Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name

{{plink|Item}}

File name differs from the link

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}

Navbox with standard footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}

Navbox with styled footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.