Template:Gap/doc

This is a documentation subpage for Template:Gap.

In most cases it contains usage information, example, categories and other content that is not part of the original template page.

Usage

Use this template to insert a fixed width gap in inline text. The default is 2em.

For example, Hello{{gap|4em}}world! produces "Hello⁠world!"

If no argument is given, the default is 2em: Hello{{gap}}world! produces "Hello⁠world!"

For a real example of it in use, see this page at Wikisource

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.

Offsetting right-aligned text

Please do not use {{right|This is incorrect{{gap}} }}

{{Right}} has a parameter offset for this: {{right|This is correct|offset=2em}}

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

The {{gap}} here is in a blue box:⁠

Compare to setting an offset of 4em:

The text retains its offset even when it wraps.