View source for Template:Soft hyphen/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page. -->

{{Template shortcut|shy|SHY}}
<!--{{lua|Module:Separated entries}}-->

== Function ==

This template inserts {{code|&shy;}}, which is a {{unichar|00ad|SOFT HYPHEN|nlink=Soft hyphen|html=}}.
A soft hyphen is an "optional" hyphen{{nbsp}}{{en dash}} 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 {{Wikipedia|heuristic}}s, 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.)

==Adding formatting==
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 {{tick}} this:

<pre>
''{{Soft hyphen|ital|icized}}''
</pre>

instead of {{cross}} this:

<pre>
{{Soft hyphen|''ital|icized''}}
</pre>

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

<pre>
{{Soft hyphen|''ital''|icized}}
</pre>

==Examples==

===Individual insertions===

Soft hyphens have been inserted in the following text, like this:
*<code><nowiki>super{{shy}}califrag{{shy}}ilistic{{shy}}expiali{{shy}}docious</nowiki></code>
*<code><nowiki>antidis{{shy}}establish{{shy}}mentarian{{shy}}ism</nowiki></code>
*<code><nowiki>pneumono{{shy}}ultra{{shy}}micro{{shy}}scopic{{shy}}silico{{shy}}volcano{{shy}}conioses</nowiki></code>
*<code><nowiki>wocka{{shy}}wocka{{shy}}wocka{{shy}}wocka{{shy}}</nowiki></code>

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:
<blockquote>
[[Pac Man]] goes ''wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka&shy;wocka.''
</blockquote>

''Many or most'' browser configurations will break long words in the passage below using hyphens{{zero width joiner em dash zero width non joiner}}whether and where will vary from browser to browser, and may depend on local settings and preferences:
<blockquote>
[[Mary Poppins (character)|Mary Poppins]], [[Church of England|religious officials]], and [[epidemiology|epidemiologists]] say
[[Supercalifragilisticexpialidocious | super{{shy}}califrag{{shy}}ilistic{{shy}}expiali{{shy}}docious]]
[[antidisestablishmentarianism | antidis{{shy}}establish{{shy}}mentarian{{shy}}ism]]
[[pneumonoultramicroscopicsilicovolcanoconioses | pneumono{{shy}}ultra{{shy}}micro{{shy}}scopic{{shy}}silico{{shy}}volcano{{shy}}conioses]]
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
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
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
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.
</blockquote>

===Alternative syntax===

A word or phrase is enclosed within a single "shy", with each <code>|</code> being a potential hyphenation point:
*<code><nowiki>Mary Poppins sings {{shy|super|califrag|ilistic|expiali|docious}} as she dances.</nowiki></code>

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

== TemplateData ==
{{TemplateData header}}
<!--<templatedata>-->
<syntaxhighlight lang="json">
{
	"description": "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.\n\nWhen parameters are specified, they are displayed in order, separated by optional hyphens. Any number of parameters can be used.",
	"params": {
		"1": {
			"label": "Fragment 1",
			"type": "string"
		},
		"2": {
			"label": "Fragment 2",
			"type": "string"
		},
		"3": {
			"label": "Fragment 3",
			"type": "string"
		},
		"4": {
			"label": "Fragment 4",
			"type": "string"
		},
		"5": {
			"label": "Fragment 5",
			"type": "string"
		}
	},
	"format": "inline"
}
</syntaxhighlight>
<!--</templatedata>-->

== See also ==

* {{tlx|Non breaking hyphen}}
* {{tlx|Zero width space}}

<includeonly>{{sandbox other||
<!-- Categories below this line, please: -->
[[Category:Character-substitution templates]]

}}</includeonly>