Template:GSFont/doc

This is a documentation subpage for Template:GSFont. It contains usage information, categories, and other content that is not part of the original template page.

This template can be used to display text the way it would appear in in-game interfaces and website.

Usage

Note: 'color' may be spelled without the 'u' as this is how it appears in CSS styling.

{{GSFont|text|color=optional colour}}

Additional parameters

{{GSFont|text|color=optional colour|bg=background colour|shadow=no|broadcast=yes}}

Example

{{GSFont|The quick brown fox jumps over the lazy dog.}}

Produces: The quick brown fox jumps over the lazy dog.

{{GSFont|The quick brown fox jumps over the lazy dog.|color=red}}

Produces: The quick brown fox jumps over the lazy dog.

To remove the shadow, the parameter shadow=no can be used:

{{GSFont|The quick brown fox jumps over the lazy dog.|color=red|shadow=no}}

Produces: The quick brown fox jumps over the lazy dog.

To add the Game annoucement icon the text, use broadcast=yes.

{{GSFont|The quick brown fox jumps over the lazy dog.|color=red|broadcast=yes}}

Produces: The quick brown fox jumps over the lazy dog.

To change background colour, use bg=colour. This is best combined with no shadow:

{{GSFont|The quick brown fox jumps over the lazy dog.|bg=#404040|shadow=no}}

Produces: The quick brown fox jumps over the lazy dog.

To change the size of the text, use size=12.

{{GSFont|The quick brown fox jumps over the lazy dog.|size=12}}

Produces: The quick brown fox jumps over the lazy dog.

To change the style of the text, use styling=font-style: oblique.

{{GSFont|The quick brown fox jumps over the lazy dog.|styling=font-style: oblique}}

Produces: The quick brown fox jumps over the lazy dog.

Data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date. This template can be used to display text the way it would appear in in-game interfaces. Template parameters This template prefers inline formatting of parameters. Parameter Description Type Status Text 1 The text to be formatted Example The quick brown fox jumps over the lazy dog. String required Text colour colour color The primary colour for the text Example red String optional Font size size Font size to be used Default 9 Example 10 Unknown optional Shadow shadow Turn off shadow effects Default yes Example no Unknown optional Background colour bg Background colour for the text (it is suggested to use shadow=no with this option) Example #404040 String optional Additional css styling styling Additional css styling to be applied Example font-style: oblique String optional Broadcast icon broadcast Adds the game announcement icon before the text. Example no String optional