Template:Str sub new

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Str sub new/doc.

This template returns a substring of the input string, specified by the start and end parameters. It allows the usage of negative indices to conveniently specify lengths counting from the end of the string.

Usage

{{str sub new |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.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

---

Wikipedia's help about TemplateData • Commons-specific information

This template returns a substring of the input string, specified by the start and end parameters. It allows the usage of negative indices to conveniently specify lengths counting from the end of the string.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
string	1	The string to work with. Any leading and trailing whitespace is removed (the “length of the string” for other parameters refers to the length of the trimmed string).	String	required
start	2	The 1-based index of the first character of the string returned. If negative, it counts from the end of the string. Its absolute value must not be larger than the length of the input string. Default 1	Line	suggested
end	3	The 1-based index of the last character of the string returned. If negative, it counts from the end of the string. Its absolute value must not be larger than the length of the input string, and, after converted to a positive value, it must not be strictly smaller than the start index. Default -1	Line	suggested
no category	nocategory	If set to 'true' or 1, no category will be added if an error is generated. Default 0	Boolean	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: all users

Example

{{str sub new|1234567890|3|-3}}

renders as:

345678

Localization

This template is not intended to be localized.