Difference between revisions of "Template:Str sub old/doc"

From Ava Zinn Wiki
Jump to: navigation, search
[unchecked revision][unchecked revision]
m (Migrating 11 interwiki links, now provided by Wikidata on d:Q5622224)
(added templatedata)
Line 4: Line 4:
 
=== Usage ===
 
=== Usage ===
 
<code><nowiki>{{str_sub|</nowiki>''text''|''start''|''length''<nowiki>}}</nowiki></code> = Substring of ''text'' starting at ''start'' and containing ''length'' characters. Base 0: the first character is numbered 0, and so on, e.g. <nowiki>{{str_sub|20090624130510|8|2}}</nowiki> returns the 2 characters starting at the 9th, i.e. "{{str_sub|20090624130510|8|2}}"
 
<code><nowiki>{{str_sub|</nowiki>''text''|''start''|''length''<nowiki>}}</nowiki></code> = Substring of ''text'' starting at ''start'' and containing ''length'' characters. Base 0: the first character is numbered 0, and so on, e.g. <nowiki>{{str_sub|20090624130510|8|2}}</nowiki> returns the 2 characters starting at the 9th, i.e. "{{str_sub|20090624130510|8|2}}"
 +
 +
==Template data==
 +
<templatedata>
 +
{
 +
        "description": "The template takes a substring of ''text'' starting at ''start'' and containing ''length'' characters.",
 +
        "params": {
 +
                "text": {
 +
                        "label": "Text",
 +
                        "description": "The substring to be trimmed.",
 +
                        "type": "string",
 +
                        "required": true
 +
                },
 +
                "start": {
 +
                        "label": "Numeric position",
 +
                        "description": "Numeric position of the starting character within the string",
 +
                        "type": "number",
 +
                        "required": true
 +
                },
 +
                "length": {
 +
                        "label": "Count",
 +
                        "description": "Number of characters for the substring",
 +
                        "type": "number",
 +
                        "required": true
 +
                }
 +
        }
 +
}
 +
</templatedata>
  
 
=== See also ===
 
=== See also ===

Revision as of 15:57, 29 June 2013

Usage

{{str_sub|text|start|length}} = 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|20090624130510|8|2}} returns the 2 characters starting at the 9th, i.e. "{{safesubst:#invoke:String|sublength|s=20090624130510|i=8|len=2}}"

Template data

The template takes a substring of ''text'' starting at ''start'' and containing ''length'' characters.

Template parameters

ParameterDescriptionTypeStatus
Texttext

The substring to be trimmed.

Default
empty
Example
empty
Auto value
empty
Stringrequired
Numeric positionstart

Numeric position of the starting character within the string

Default
empty
Example
empty
Auto value
empty
Numberrequired
Countlength

Number of characters for the substring

Default
empty
Example
empty
Auto value
empty
Numberrequired

See also

Template:Navbox string handling templates