Template:Script/Documentation

Purpose

Transliterates in-game scripts from their source language (Japanese or English).

Usage

SyntaxBoilerplate

{{Script|<scriptId>|<text>|size= }}

{{Script||}}

Parameter		Status	Description	Accepted values
1	scriptId	required	Identifier for the language script. The various forms of Hylian are named after the first game in which they were released.	See Module:Script/Data
2	text	required	The text to transliterate into an in-game language. Only characters which are defined for the script are allowed. Whitespace characters are also allowed and are preserved.
size		optional	Size of the characters in px. Defaults to the script's defaultSize if defined at Module:Script/Data. Otherwise, defaults to the size of the character images.

Transliterates in-game scripts from their source language (Japanese or English).

Template parameters

Parameter		Description	Type	Status
scriptId	1	<p>Identifier for the language script.</p><p>The various forms of Hylian are named after the first game in which they were released.</p>	String	required
text	2	<p>The text to transliterate into an in-game language.</p><p>Only characters which are defined for the script are allowed. Whitespace characters are also allowed and are preserved.</p>	String	required
size	size	Size of the characters in px. Defaults to the script's <code>defaultSize</code> if defined at [[Module:Script/Data]]. Otherwise, defaults to the size of the character images.	String	optional

Examples

#	Input	Output	Categories added
Whitespace is preserved.
1	{{Script|Hylian OoT| タチツテトナニヌネニノハヒフヘホ ヘホタチツテトナニヌネノハヒフ }}
<br> and <br/> tags are allowed.
2	{{Script|Hylian OoT|ムユサツマムユ <br/> イコサツマムユリ<br/>イコサツマム}}
Using the size parameter
3	{{Script|Hylian ALBW|Big Font|size= x50px}}
4	{{Script|Hylian OoT 2|ヒツク フオント|size= x50px}}
Invalid characters are ignored and simply passed on as-is.
5	{{Script|Hylian TWW|This won't work because TWW Hylian is based on katakana.}}		Category:Articles using invalid arguments in template calls
Aside from tags, markup is not valid input.
6	{{Script|Hylian ALBW|<b>Bold</b> ''italics''}}		Category:Articles using invalid arguments in template calls
scriptId is required
7	{{Script}}		Category:Articles using invalid arguments in template calls
8	{{Script|}}		Category:Articles using invalid arguments in template calls
9	{{Script|invalid ID|foo}}		Category:Articles using invalid arguments in template calls
text can be empty, but it cannot be undefined.
10	{{Script|Hylian ALBW|}}
11	{{Script|Hylian ALBW}}		Category:Articles using invalid arguments in template calls

Supported Scripts

The full character set for each script can be found at Module:Script/Data. See #Adding Scripts for more information on adding additional character sets.

#	Input	Output
12	{{Script|Gerudo|The quick brown fox jumps over the lazy dog}}
13	{{Script|Hylian OoT|タチツテトナニヌネニノハヒフヘホ ヘホタチツテトナニヌネノハヒフ}}
14	{{Script|Hylian OoT 2|タチツテトナニヌネニノハヒフヘホ ヘホタチツテトナニヌネノハヒフ}}
15	{{Script|Hylian TWW|ァィゥェォッャュョ　。、「」！？１２３４５６７８９０}}
16	{{Script|Hylian TP|The quick brown fox jumps over the lazy dog}}
17	{{Script|Hylian SS|The quick brown fox jumps over the lazy dog}}
18	{{Script|Hylian ALBW|The quick brown fox jumps over the lazy dog}}
19	{{Script|Lorulean|The quick brown fox jumps over the lazy dog}}
20	{{Script|Sheikah|1234567890 The quick brown fox jumps over the lazy dog}}

Guidelines

Usage

When using katakana-based scripts – namely Hylian TWW – the fullwidth characters must be used for punctuation and digits (e.g. ０, not 0).

Spaces are allowed but should not be used in some circumstances. For example, the Hylian for Ravio's "Rented Out" sign has no spaces and should therefore be transcribed as {{Script|Hylian ALBW|RentedOut}} (). Note the use of PascalCase for distinguishing words. However, the "Dungeon Map" text clearly uses a space to separate the words and can thus be written as {{Script|Hylian ALBW|Dungeon Map}} ( ).

Template:H can be used as a shorthand for Hylian scripts.

Template:H shorthands

Template:H	Template:Script
{{H|OoT|text}}	{{Script|Hylian OoT|text}}
{{H|OoT2|text}}	{{Script|Hylian OoT 2|text}}
{{H|TWW|text}}	{{Script|Hylian TWW|text}}
{{H|TP|text}}	{{Script|Hylian TP|text}}
{{H|SS|text}}	{{Script|Hylian SS|text}}
{{H|ALBW|text}}	{{Script|Hylian ALBW|text}}
{{H|Lorule|text}}	{{Script|Lorulean|text}}

Adding Scripts

To add a new language script:

1. Upload the characters as individual files.
2. Update Module:Script/Data.
3. Update Template:H if the script is a form of Hylian.
4. Update Template:Script/Documentation (#Supported Scripts and #Shorthands).

For character files, SVGs are ideal as they can be scaled to any size without loss of quality. The filename should map exactly to the source character. Examples include: File:TWW Hylian ア Symbol.png, File:ALBW A.svg. When several characters in the source language map to the same character in the in-game script, use file redirects. Examples include: File:SS Z.png, File:ALBW W.svg.

This is the documentation page, it should be transcluded into the main template page. See here for more information.