Template:Str sub/doc

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Str sub.

---

This template returns the substring of <text> starting at <start> and containing <length> characters.
Base 0: the first character is numbered 0, and so on, e.g. {{str sub long|20090624130510|8|2}} returns the 2 characters starting at the 9th, i.e. "13".

Usage

{{Str sub long |1= |2= |3= }}

Template parameters

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

---

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

---

Wikipedia's help about TemplateData • Commons-specific information

This template returns the substring of <text> starting at <start> and containing <length> characters.<br><span style="font-weight:normal">Base 0: the first character is numbered 0, and so on, e.g. {{str sub long|20090624130510|8|2}} returns the 2 characters starting at the 9th, i.e. "13".</span>

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
text	1	The text to get the substring from.	Unknown	required
start	2	Zero-based index of the first character returned. Default 0	Number	optional
length	3	The number of returned characters. Default 0	Number	optional

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: no user group specified

See also

Trimming templates:

• {{Trunc}} – To trim down to a specified number of characters.
• {{Trim}} — To trim any leading or trailing whitespace.
• {{Str left}} – To trim down to a specified number of characters, or duplicate the string to a specified number.
• {{Str right}}
• {{Strip}} – To strip (remove) a given number of characters from the beginning/end of the string

Analyzing templates:

• {{Str endswith}} – To check if a string ends with a given string.
• {{Str find}} – Returns the numerical location of a given string in a string, up to 50 characters.
• {{Str len}} – Returns a string's length. Can count up to 500 characters.

String length comparison templates:

• {{Str ≤ len}} – To check if a string is "shorter or equally long" or "longer" than a given length.

Sandboxes and test cases:

• {{Str len/sandbox}}
• {{Str len/testcases}}

Technical stuff:

• mw:Help:Magic words – About {{padleft:|}}.
• mw:Help:Extension:ParserFunctions – About {{#titleparts:|}}, {{#expr:|}}, {{#ifeq:|}}, etc.
• Module:String - Script with native string parsing

Localization

This template is not intended to be localized.