View source for Template:Gap/doc

{{documentation subpage}}{{template shortcut|g}}
{{high-use|180000}}
{{span-based-template|class=.wst-gap}}
==Usage==
Use this template to insert a fixed width gap in inline text. The default is 2em.

For example,
 <nowiki>Hello{{gap|3em}}world!</nowiki>
yields "Hello{{gap|3em}}world!"


If no argument is given, the default is 2em:
 <nowiki>Hello{{gap}}world!</nowiki>
yields "Hello{{gap}}world!"

For a real example of it in use, see [[Page:An introduction to physiological and systematical botany (1st edition).djvu/542]].

==Deprecated or incorrect usage==
Please note: This template is ''not'' intended to produce indented paragraphs, double spacing after full stops (periods), or offsets from the right.

===Indentation===
The house style of Wikisource is to [[Help:Beginner's guide to proofreading#Other common things to correct|separate paragraphs with a double line break]], rather than to indent them, except in cases such as poetry where the formatting might be considered part of the text.

===Offsetting right-aligned text===
Please do not use
 <nowiki>{{right|This is incorrect{{gap|4em}} }}</nowiki>

{{tl|Right}} has a parameter {{parameter|offset}} for this:
 <nowiki>{{right|This is correct|offset=4em}}</nowiki>

The reason for this is that if the line wraps, the {{tl|gap}} will go to the next line, where it will be invisible, and the text will end up right up against the right margin:

<div style="width:18em; border:1px solid red; margin: auto;">
{{right|1=The {{tl|gap}} here is in a blue box:<span style="border:1px solid blue;">{{gap|4em}}</span>}}
</div>

Compare to setting an {{parameter|offset}} of 4em:

<div style="width:18em; border:1px solid green; margin: auto;">
{{right|offset=4em|The text retains its offset even when it wraps.}}
</div>

==See also==
* {{tl|right}}
* {{tl|indent}} for a simple indented paragraph
* {{tl|wide space}} for a wider gap between adjacent words (this will also copy-paste as a space; {{tl|gap}} will not.
* {{tl|hanging indent inherit}} for paragraphs spanning Page: namespace pages
* To insert a vertical gap (i.e. extra line spacing), simply add multiple blank lines. To force a gap in situations where the Mediawiki software consumes multiple carriage returns, such as at the end of a page, use {{tl|nop}}. See also {{tl|dhr}}.
* {{tl|0}}
* {{tl|ditto}}
* {{tl|phantom}}

<!-- template categories and interwiki links -->
<includeonly>
[[Category:Formatting templates|Gap]]
</includeonly>
<templatedata>
{
	"params": {
		"1": {
			"label": "1",
			"description": "Width of gap to insert.",
			"type": "string",
			"suggested": true
		}
	},
	"format": "inline"
}
</templatedata>