User:Archimerged/PhysicsNavigation/doc

This template creates a navigation template for a larger subject when supplied with the desired topic and subtopics. It is especially purposed for browsing in a physics subfield, while mentioning all necessary topics

Usage

Please remove the parameters that are left blank.

{{PhysicsNavigation
|Name       = {{subst:PAGENAME}}
|Image      =
|Label      =
|KeyItems   =
|Topic1     =
|Items1     =
|Topic2     =
|Items2     =
  ...
|Topic8     =
|Items8     =
|Scientists =
}}

Parameters

Mandatory

Name

The name of the template, which is needed for the "v • d • e" ("view • discuss • edit") links to work properly on all pages where the template is used. You can enter {{subst:PAGENAME}} for this value as a shortcut.

Topic1

The Name or Category of the Subfields, can also be a link

Items1

The links to the subfield. Please use <br /> for line break and {{·}} for separating the fields.

Alternately, to allow the browser to decide where the line breaks will be, while preventing line breaks within links, use {{nowrap begin}} at the front, separate fields with {{·w}} or {{•w}}, and put the required {{nowrap end}} last. This is much easier than piping each link:

[[Link name|Link name]].

Put extremely long links outside the nowrap section to avoid making the whole box very wide. See also the how-to guide.

For easy editing of the list of links, use HTML comments to hide newlines from the wikitext parser. Thus, put each link in on a separate line beginning with --> and ending with <!-- followed by two newlines.

Optional

Image

An image under the name of the template. Use either Image or Label

Label

A general Label, most likely a math formula like

<math>\partial \int L ds = 0</math>.

Use either Label or Image

LabelId

Description or link of the Image or Label

KeyItems

Important links for the field at large, that will be out of collapsible boxes.

Topic2

Other subfields. Up to 8 topics (Topic2..Topic8) are supported.

Items2

The links to the subfields. See Items1 under Mandatory.

Scientists

A List of Scientists with important contributions in this field.

Examples

Example 1

{{PhysicsNavigation
|Name  = Plasma physics
|Image = Plasma.jpg
|LabelId = [[Plasma lamp]]
|KeyItems = [[Plasma]]{{·}}[[MHD]]
|Topic1 = Description
|Items1 = {{nowrap begin}}               <!--
-->{{·w}}[[Vlasov equation]]             <!--
-->{{·w}}[[MHD]]                         <!--
-->{{·w}}[[Plasma channel]]              <!--
-->{{·w}}[[Plasma parameters]]           <!--
-->{{·w}}[[Magnetohydrodynamics]]        <!--
-->{{·w}}[[Electric field screening]]    <!--
-->{{·w}}[[List of plasma physicists]]   <!--
-->{{nowrap end}}                        <!--
-->{{·w}}[[List of publications in physics#Plasma physics<!--
       -->|Important publications in plasma physics]]<!--
-->{{·w}}[[IEEE Nuclear and Plasma Sciences Society]]<!--
-->{{·w}}
}}

Example 2

{{PhysicsNavigation
|Name = Continuum mechanics
|Image = BernoullisLawDerivationDiagram.png
|KeyItems = [[Conservation of mass]]<br />[[Conservation of momentum]]<br />
[[Navier-Stokes equations]]
|Topic1 = [[Classical mechanics]]
|Items1 = [[Stress (physics)|Stress]] · [[Strain (materials science)|Strain]]
 · [[Tensor]]<br />
|Topic2 = [[Solid mechanics]]
|Items2 = [[Solid]]s · [[Elasticity (physics)|Elasticity]]<br />
[[Plasticity (physics)|Plasticity]] · [[Hooke's law]]<br />[[Rheology]] · [[Viscoelasticity]]
|Topic3 = [[Fluid mechanics]]
|Items3 = [[Fluid]]s · [[Fluid statics]]<br />[[Fluid dynamics]]
 · [[Viscosity]] · [[Newtonian fluid]]s<br />[[Non-Newtonian fluid]]s<br />[[Surface tension]]
|Scientists = [[Isaac Newton|Newton]] · [[George Gabriel Stokes|Stokes]]
 · [[Claude-Louis Navier|Navier]]
|}}

Example 3

That the navigation box automatically collapses if the user views an item which is defined inside a <italic>Topic<italic/>. You have to pass the cTopic variable to PhysicsNavigation.

cTopic = {{{cTopic}}}

for example

{{PhysicsNavigation
|Name = String theory
|Image = Point&string.png
|KeyItems = [[Superstring theory]]
|Topic1 = Theory
|Items1 = [[Bosonic string theory]]<br />[[M-theory]] ([[M-theory (simplified)|simplified]])<br />
[[type I string theory|Type I string]] · [[type II string theory|Type II string]]<br />
[[String field theory]] · [[Heterotic string]]
|Topic2 = Concepts
|Items2 = [[String (physics)|Strings]] · [[Branes]] 
|Topic3 = Related Topics
|Items3 = [[Supersymmetry]] · [[Supergravity]] · [[Quantum gravity]]
|Scientists = [[Edward Witten|Witten]]
|cTopic = {{{cTopic}}}
}}

inside the article's page, add the template plus the parameter cTopic= which is named after the browsed topic. Note both names have to match exactly ! For example, in the page about Branes add

{{String-theory|cTopic=Concepts}}

and the topic Concepts uncollapses.

Results

Example 1	Example 2	Example 3

Dot size reference list

·	<small> middot
·	middot
·	<small> bold middot
·	bold middot
•	<small> bullet
•	bullet
•	bold bullet
–	ndash
—	mdash

See also

• {{Navbox}}
• {{!}} — Permits use of piped links inside a navigation box.
• {{·}} or {{dot}} or {{middot}} — Bold middot "·" is mostly used for dotted lists, such as for link lists in navigation boxes.
• {{•}} or {{bull}} or {{bullet}} — Bullet "•" is mostly used for dotted lists that use small font sizes.
• {{ndash}} — Ndash "–" is a short dash.
• {{mdash}} — Mdash "—" is a long dash.

When making dotted lists you might need to handle proper word wrapping (line breaking):

• {{nowrap begin}} ... {{•w}} ... {{nowrap end}} — Allows wraps only after the {{•w}}, {{·w}} or {{tl:wrap}.
• Wikipedia:Line break handling — The how-to guide detailing how to handle line wrapping on Wikipedia.
• Wikipedia:Line break handling#nowrap begin