View source for Template:Hyphenated word start/doc

{{Documentation subpage}}

This document covers both the {{tl|hyphenated word start}} and {{tl|hyphenated word end}} templates, which must be used together as a pair.

The abbreviated forms {{tl|hws}} and {{tl|hwe}} can also be used.

For more specialized usage—if the hyphenated word is part of an HTML link, for instance—see {{tl|linkable phrase start}} and {{tl|linkable phrase end}}.

== Usage ==

The {{tl|hyphenated word start}} template is used for the beginning of a word that is hyphenated and split between two pages; {{tl|hyphenated word end}} is used for the end of the word.  They must be used together: at the bottom of the first page, and at the top of the following page, respectively.

=== Regular version (using unnamed parameters, 1 and 2) ===

The {{tl|hyphenated word start}} template displays param 1 (1st word-fragment) followed by a hyphen (-) in the "Page" namespace, and nothing in the "main" namespace.  An optional parameter can be used to change this hyphen to something else, or suppress it entirely.

The {{tl|hyphenated word end}} template displays param 1 (2nd word-fragment) in the "Page" namespace, and param 2 in the "main" namespace.

In both cases, Param 2 (the full-word) is used as the title-attribute for the text; i.e. a tooltip appears, showing the complete word, when you mouseover the word fragments in the "Page" namespace.

=== Alternate version (using named parameters, "s" and "e") ===

The {{tl|hyphenated word start}} template displays param "s" (1st or "start" word-fragment) followed by a hyphen (-) in the "Page" namespace, and nothing in the "main" namespace.  An optional parameter can be used to change this hyphen to something else, or suppress it entirely.

The {{tl|hyphenated word end}} template displays param "e" (2nd or "end" word-fragment) in the "Page" namespace, and a concatenation of param "s" and param "e" in the "main" namespace.

In both cases, the full-word (concatenation of params "s" and "e") is used as the title-attribute for the text; i.e. a tooltip appears, showing the complete word, when you mouseover the word fragments in the "Page" namespace. 

=== Examples ===

{| class="wikitable"
! colspan="4" | Regular version (copy and paste text below)
|- width="50%" valign="top" style="vertical-align:top;"
| colspan="4" | 
:<tt><nowiki>{{hyphenated word start |  |  }}</nowiki></tt>
:<tt><nowiki>{{hws |  |  }}</nowiki></tt>
:<tt><nowiki>{{hyphenated word end |  |  }}</nowiki></tt>
:<tt><nowiki>{{hwe |  |  }}</nowiki></tt>
|- width="50%" valign="top" style="vertical-align:top;"
! colspan="4" | Alternate version (copy and paste text below)
|- width="50%" valign="top" style="vertical-align:top;"
| colspan="4" | 
:<tt><nowiki>{{hyphenated word start |s=  |e=  }}</nowiki></tt>
:<tt><nowiki>{{hws |s=  |e=  }}</nowiki></tt>
:<tt><nowiki>{{hyphenated word end |s=  |e=  }}</nowiki></tt>
:<tt><nowiki>{{hwe |s=  |e=  }}</nowiki></tt>
|- width="50%" valign="top" style="vertical-align:top;"
!
! 
! Page namespace
! Transcluded
|- width="50%" valign="top" style="vertical-align:top;"
! Example 1 (start)
| style="vertical-align: top;" |
<tt><nowiki>{{hws |antici|anticipation}}</nowiki></tt>
| style="vertical-align: top;" |
{{hws |antici|anticipation| namespace=Page }}
| style="vertical-align: top;" |
{{hws |antici|anticipation| namespace= }}
|- width="50%" valign="top" style="vertical-align:top;"
! Example 1 (end)
| style="vertical-align: top;" |
<tt><nowiki>{{hwe |pation|anticipation}}</nowiki></tt>
| style="vertical-align: top;" |
{{hwe |pation|anticipation| namespace=Page }}
| style="vertical-align: top;" |
{{hwe |pation|anticipation| namespace= }}
|- width="50%" valign="top" style="vertical-align:top;"
! Example 1a (start)
| style="vertical-align: top;" |
<tt><nowiki>{{hws |s= antici |e= pation }}</nowiki></tt>
| style="vertical-align: top;" |
{{hws |s= antici |e= pation | namespace=Page }}
| style="vertical-align: top;" |
{{hws |s= antici |e= pation | namespace= }}
|- width="50%" valign="top" style="vertical-align:top;"
! Example 1a (end)
| style="vertical-align: top;" |
<tt><nowiki>{{hwe |s= antici |e= pation }}</nowiki></tt>
| style="vertical-align: top;" |
{{hwe |s= antici |e= pation | namespace=Page }}
| style="vertical-align: top;" |
{{hwe |s= antici |e= pation | namespace= }}
|- width="50%" valign="top" style="vertical-align:top;"
! Example 2 (start)
| style="vertical-align: top;" |
<tt><nowiki>{{hws |mother|mother-in-law}}</nowiki></tt>
| style="vertical-align: top;" |
{{hws |mother|mother-in-law| namespace=Page }}
| style="vertical-align: top;" |
{{hws |mother|mother-in-law| namespace= }}
|- width="50%" valign="top" style="vertical-align:top;"
! Example 2 (end)
| style="vertical-align: top;" |
<tt><nowiki>{{hwe |in-law|mother-in-law}}</nowiki></tt>
| style="vertical-align: top;" |
{{hwe |in-law|mother-in-law| namespace=Page }}
| style="vertical-align: top;" |
{{hwe |in-law|mother-in-law| namespace= }}
|- width="50%" valign="top" style="vertical-align:top;"
! Example 2a (start)
| style="vertical-align: top;" |
<tt><nowiki>{{hws |s=mother- |hyph= |e=in-law }}</nowiki></tt>
| style="vertical-align: top;" |
{{hws |s=mother- |hyph= |e=in-law |namespace=Page }}
| style="vertical-align: top;" |
{{hws |s=mother- |hyph= |e=in-law |namespace= }}
|- width="50%" valign="top" style="vertical-align:top;"
! Example 2a (end)
| style="vertical-align: top;" |
<tt><nowiki>{{hwe |s=mother- |hyph= |e=in-law }}</nowiki></tt>
| style="vertical-align: top;" |
{{hwe |s=mother- |hyph= |e=in-law |namespace=Page }}
| style="vertical-align: top;" |
{{hwe |s=mother- |hyph= |e=in-law |namespace= }}
|- width="50%" valign="top" style="vertical-align:top;"
! Example 3 (start)
| style="vertical-align: top;" |
<tt><nowiki>{{hws |'''antici| hyph=-''' |'''anticipation'''}}</nowiki></tt>
| style="vertical-align: top;" |
{{hws |'''antici| hyph=-''' |'''anticipation'''| namespace=Page }}
| style="vertical-align: top;" |
{{hws |'''antici| hyph=-''' |'''anticipation'''| namespace= }}
|- width="50%" valign="top" style="vertical-align:top;"
! Example 3 (end)
| style="vertical-align: top;" |
<tt><nowiki>{{hwe |'''pation'''|'''anticipation'''}}</nowiki></tt>
| style="vertical-align: top;" |
{{hwe |'''pation'''|'''anticipation'''| namespace=Page }}
| style="vertical-align: top;" |
{{hwe |'''pation'''|'''anticipation'''| namespace= }}
|}

Note: in Example 1, you cannot use any blank spaces around the input data ("antici" and "anticipation", or "pation" and "anticipation").  This is due to the Mediawiki implementation of templates: leading and trailing blank spaces are not stripped when using unnamed (numbered) parameters.

Example 1a reproduces Example 1, using the alternate version with named parameters "s" and "e".  You can leave blank spaces around the input data ("antici" and "pation") for readability.  This is because in the Mediawiki implementation of templates, leading and trailing blanks are stripped when using named parameters.

This alternate version is more compact but less flexible (see Example 2).

Example 2 is a case where the hyphen must ''not'' be dropped when the two halves of a hyphenated word are joined together.  This is easily handled with the regular version; however, using the alternate version with <tt>s</tt> and <tt>e</tt> parameters in the obvious way would give "<tt>motherin-law</tt>". A workaround, shown in Example 2a, is to hardcode the hyphen into the "s" parameter and use the "hyph" parameter to set the normally-occurring hyphen to blank.

However, there are more general situations where the unsplit word is not merely a simple unmodified fusion of the split halves: cases involving ligatures or variant letterforms in non-English languages, where letters may change their form depending on the surrounding letters; or, German-language hyphenation rules prior to the 1996 orthography reform (''bäcker'' hyphenated to ''bäk-ker''). These can only be handled by the regular version, not the alternate version.

In Example 3 the word is in boldface, and we want the hyphen to be in boldface too. The <tt>hyph</tt> parameter can be used to accomplish this (the visual difference between a regular hyphen and a boldface hyphen is admittedly barely perceptible).

=== "Hyph" parameter ===

The <tt>hyph</tt> parameter is usually omitted, which results in an ordinary ASCII hyphen (U+002D) being added at the end of the first part of a split word.
*If specified, then the given character (or string of characters) is displayed instead of a hyphen, which could be useful for some situations or for non-English languages: eg, Unicode hyphen (U+2010), Armenian hyphen (U+058A), etc.
*If specified and left blank, then no hyphen at all is displayed.  '''Note''': specifying this parameter but leaving it blank '''is not the same''' as omitting it.

=== "Namespace" parameter ===

This parameter is only used for special purposes: by setting <tt>|namespace=Page</tt> you can force the templates to act as though they have been invoked within the "Page" namespace.  This can be useful for testing; it is also used within this documentation page to create the examples in the table above.

=== Notes ===

A real world example can be found with the word "approach-ing" at Page namespace [[Page:Wind in the Willows (1913).djvu/306]] and [[Page:Wind in the Willows (1913).djvu/307]]; observe also the results in the main namespace at [[The Wind in the Willows/Chapter 10]]. 

Invalid invocations are placed into [[:Category:Invalid template invocation]].

(There have been problems in the past with spurious blank lines added to main namespace versions with the use of this template. Check the template code history/discussion for the latest scoop.)

==== Formatting ====

There are occasions where formatting is required to the hyphenated word, eg. italics. Due to the means of wiki-coding, it is recommended that formatting be done ''inside'' {{tl|hyphenated word start}} and ''outside'' of {{tl|hyphenated word end}}, for example,
* <tt><nowiki>{{hyphenated word start|''format''|formatting}}</nowiki></tt>
* <tt><nowiki>''{{hyphenated word end|ing|formatting}}''</nowiki></tt>, alternatively <tt><nowiki>{{hyphenated word end|''ing''|''formatting''}}</nowiki></tt>

== See also ==
* [[Template:linkable phrase start]]

<!-- template categories and interwiki links -->
<includeonly>
[[Category:Typography templates]]
</includeonly>