Template:Soft hyphen

Template documentation[view] [edit] [history] [purge]

{{shy}}
{{SHY}}

This template uses Lua:

Module:Separated entries (sandbox)

Function[edit]

This template inserts , which is a U+00AD SOFT HYPHEN (). A soft hyphen is an "optional" hyphen – a point at which a word may be broken over the end of a line, with a visible hyphen inserted at line end. The ultimate decision as to whether a particular word will be broken is made by the browser, and depends on a combination of text-layout heuristics, user preferences set in the browser, and hyphenation options embedded in the page being displayed. (Different browsers apply different heuristics, and some browsers ignore soft hyphens completely.)

Simplest usage[edit]

For example, if you want to add a break point to this word in a table header: Generation. Here is the wikitext:

Gener{{shy}}ation

If needed, it will wrap, and look like this to the reader:

Gener-
ation

Adding formatting[edit]

If you want to add italic or bold (or other) formatting to the whole word contained within this template, it is recommended that you place the formatting outside of the template. Although placing the formatting inside the template does work, editors and cleanup scripts may think it is an error and "fix" it incorrectly.

Do Y this:

''{{Soft hyphen|ital|icized}}''

instead of N this:

{{Soft hyphen|''ital|icized''}}

If you want to format only a portion of a word, for emphasis or styling, wrap one of the template parameters, like this:

{{Soft hyphen|''ital''|icized}}

Examples[edit]

Individual insertions[edit]

Soft hyphens have been inserted in the following text, like this:

super{{shy}}califrag{{shy}}ilistic{{shy}}expiali{{shy}}docious
antidis{{shy}}establish{{shy}}mentarian{{shy}}ism
pneumono{{shy}}ultra{{shy}}micro{{shy}}scopic{{shy}}silico{{shy}}volcano{{shy}}conioses
wocka{{shy}}wocka{{shy}}wocka{{shy}}wocka{{shy}}

The effect will usually be visible when zooming your browser and/or adjusting the width of its window. Most browser configurations will cause this long string to be broken, using hyphens, over multiple lines:

Pac Man goes wockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawockawocka.

Many or most browser configurations will break long words in the passage below using hyphens‍—‌whether and where will vary from browser to browser, and may depend on local settings and preferences:

Mary Poppins, religious officials, and epidemiologists say supercalifragilisticexpialidocious antidisestablishmentarianism pneumonoultramicroscopicsilicovolcanoconioses supercalifragilisticexpialidocious antidisestablishmentarianism pneumonoultramicroscopicsilicovolcanoconioses supercalifragilisticexpialidocious antidisestablishmentarianism pneumonoultramicroscopicsilicovolcanoconioses supercalifragilisticexpialidocious antidisestablishmentarianism pneumonoultramicroscopicsilicovolcanoconioses supercalifragilisticexpialidocious antidisestablishmentarianism pneumonoultramicroscopicsilicovolcanoconioses.

Alternative syntax[edit]

A word or phrase is enclosed within a single "shy", with each | being a potential hyphenation point:

Mary Poppins sings {{shy|super|califrag|ilistic|expiali|docious}} as she dances.

Avoid enclosing longer phrases or entire sentences, as that makes text difficult to edit in the visual editor.

TemplateData[edit]

Insert an optional hyphen – a point at which a word may be broken over the end of a line, with a visible hyphen inserted at line end. When parameters are specified, they are displayed in order, separated by optional hyphens. Any number of parameters can be used.

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Fragment 1	`1`	no description	String	optional
Fragment 2	`2`	no description	String	optional
Fragment 3	`3`	no description	String	optional
Fragment 4	`4`	no description	String	optional
Fragment 5	`5`	no description	String	optional