Template:Letter-spacing/doc

From Wikisource
Jump to navigation Jump to search

Documentation[edit]

This template simplifies formatting text that has letter-spacing.

The shorthand of this template is {{lsp}} or {{lp}}.

There is also a shorthand named {{sp}} that only takes one parameter and always uses the spacing .15em.

Parameters[edit]

  • 1 (optional): The letter spacing. Defaults to 0.15em. Always use text-relative units such as em; absolute units like px will not adjust themselves if the text size changes. See H:PXWIDTH for more details.
  • 2: The text to be spaced.
  • 3 (optional): Following unspaced text. Useful for following punctuation that butts up against the last character of the spaced text.

Extra pairs[edit]

This template optionally supports up to 5 spaced–unspaced pairs:

  • 45
  • 67
  • 89
  • 1011

These can be useful for certain lines of text that contain several unspaced punctuation marks. Remember that letter spacing always applies to the right side of every letter.

If any of these contain leading or trailing spaces, use  , or they will be removed by the parser.

Examples[edit]

Spacing[edit]

Example: Default/explicit spacing (0.15em)

* {{letter-spacing||your text goes here}}
* {{letter-spacing|0.15em|your text goes here}}
  • your text goes here
  • your text goes here

Example: Custom spacing 1.5em)

{{letter-spacing|1.5em|your text goes here}}

your text goes here

Example: Many pairs of spaced–unspaced text

{{lsp||Cha|p|. VI|I|: A New Beginnin|g.}}

Chap. VII: A New Beginning.

Last characters[edit]

If you need to exclude the last character(s) of spaced text (usually due to excess padding) but still want these characters to be wrapped (usually for clearer syntax), you can use the third parameter, which passes its input as-is. Furthermore, you can use the rest of the parameter pairs for subsequent spaced sections.

In the following examples, the coloured boxes show the extent of the "spaced" text.

C.

{{letter-spacing|1.5em|192|2.}}}}

C.

1922.

Compare to...

C.

{{letter-spacing|1.5em|1922}}.

{{letter-spacing|1.5em|C.}}

{{letter-spacing|1.5em|1922.}}}}

C.

1922.

C.

1922.

Several pairs[edit]

Comparison of syntax appearance:

These examples produce the same output, but the template syntax is clearer in the second:

{{letter-spacing|1.5em|192}}2.

{{letter-spacing|1.5em|192|2.}}

{{letter-spacing|1.5em|Cha}}p.{{letter-spacing|1.5em| I}}I.

{{letter-spacing|1.5em|Cha|p.| I|I.}}

1922.

1922.

Chap. II.

Chap. II.

See also[edit]

No description.

Template parameters

ParameterDescriptionTypeStatus
11

letter spacing (Use CSS units , but not px (pixels)

Stringrequired
22

Text on which letter spacing is to be applied.

Unknownoptional
33

no description

Unknownoptional
44

no description

Unknownoptional
55

no description

Unknownoptional