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

From Ava Zinn Wiki
Jump to: navigation, search
[unchecked revision][unchecked revision]
m (Dragons flight moved page Template:Str sub/doc to Template:Str sub old/doc: Moving quirky base-0 template to note that it doesn't follow Lua string conventions, e.g. base-1.)
 
(10 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
{{Lua|Module:String}}
 +
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE---->
 +
== 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}}"
  
=== Usage ===
+
== Template data ==
<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}}"
+
{{TemplateDataHeader}}
 +
<templatedata>
 +
{
 +
        "description": "The template takes a substring of ''text'' starting at ''start'' and containing ''length'' characters.",
 +
        "params": {
 +
                "1": {
 +
                        "label": "Text",
 +
                        "description": "The substring to be trimmed.",
 +
                        "type": "string",
 +
                        "required": true
 +
                },
 +
                "2": {
 +
                        "label": "Numeric position",
 +
                        "description": "Numeric position of the starting character within the string",
 +
                        "type": "number",
 +
                        "required": true
 +
                },
 +
                "3": {
 +
                        "label": "Count",
 +
                        "description": "Number of characters for the substring",
 +
                        "type": "number",
 +
                        "required": true
 +
                }
 +
        }
 +
}
 +
</templatedata>
  
=== See also ===
+
== See also ==
* {{String templates see also}}
+
{{String-handling templates |trim}}
  
 
<includeonly>
 
<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 +
<!----CATEGORIES BELOW THIS LINE, PLEASE:---->
 
[[Category:String manipulation templates]]
 
[[Category:String manipulation templates]]
[[Category:Lua-based templates|{{PAGENAME}}]]
 
  
[[bn:টেমপ্লেট:Str sub]]  
+
[[lt:Šablonas:Str sub]]
[[de:Vorlage:Str sub]]
+
}}
[[es:Plantilla:Str sub]]
 
[[id:Templat:Str sub]]
 
[[arz:قالب:Str sub]]
 
[[ja:Template:Str sub]]
 
[[no:Mal:Str sub]]
 
[[pt:Predefinição:Str sub]]
 
[[simple:Template:Str sub]]
 
[[sl:Predloga:Str sub]]
 
[[ur:سانچہ:Str sub]]
 
 
</includeonly>
 
</includeonly>

Latest revision as of 01:13, 7 March 2016

Gnome-utilities-terminal.svg This template uses (or will be using) Lua programming language.

Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates.

Usage[edit]

{{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[edit]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Str sub old

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

Template parameters

ParameterDescriptionTypeStatus
Text1

The substring to be trimmed.

Default
empty
Example
empty
Auto value
empty
Stringrequired
Numeric position2

Numeric position of the starting character within the string

Default
empty
Example
empty
Auto value
empty
Numberrequired
Count3

Number of characters for the substring

Default
empty
Example
empty
Auto value
empty
Numberrequired

See also[edit]