Difference between revisions of "Template:First word/doc"
Jump to navigation
Jump to search
imported>Andy M. Wang ({{high-use|35000+}}) |
imported>Zyxw (Removed note about parameter not starting with leading spaces, no longer applies since template was converted to use Module:String, added example to show this. Added note about using 1= for first parameter when string may contain equals sign. Added blank templates in usage section.) |
||
| Line 4: | Line 4: | ||
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE----> | <!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE----> | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | This template returns the first word of the first parameter. Use {{para|1}} for the first parameter if the string may contain an [[equals sign]] (=). By default, words are delimited by spaces, but the optional parameter {{para|sep}} can set the separator to any character. | |
| − | |||
| − | == | + | ==Usage== |
| − | + | One parameter (space as separator): | |
| − | + | * <code>'''{{{{BASEPAGENAME}}|'''<var>string</var>'''}}'''</code> | |
| − | * {{ | + | * <code>'''{{{{BASEPAGENAME}}|1='''<var>string</var>'''}}'''</code> |
| − | |||
| − | * {{ | ||
| − | |||
| − | |||
| − | ===See also | + | Two parameters (user-defined character as separator): |
| + | * <code>'''{{{{BASEPAGENAME}}|'''<var>string</var>'''|sep='''<var>character</var>'''}}'''</code> | ||
| + | * <code>'''{{{{BASEPAGENAME}}|1='''<var>string</var>'''|sep='''<var>character</var>'''}}'''</code> | ||
| + | |||
| + | ==Examples== | ||
| + | * <code>{{{{BASEPAGENAME}}|Foo bar baz}}</code> → {{{{BASEPAGENAME}}|Foo bar baz}} | ||
| + | * <code>{{{{BASEPAGENAME}}| Foo bar baz}}</code> → {{{{BASEPAGENAME}}| Foo bar baz}} | ||
| + | * <code>{{{{BASEPAGENAME}}|Foo}}</code> → {{{{BASEPAGENAME}}|Foo}} | ||
| + | * <code>{{{{BASEPAGENAME}}|Foo-bar-baz}}</code> → {{{{BASEPAGENAME}}|Foo-bar-baz}} | ||
| + | * <code>{{{{BASEPAGENAME}}|Foo-bar-baz|sep=-}}</code> → {{{{BASEPAGENAME}}|Foo-bar-baz|sep=-}} | ||
| + | * <code>{{{{BASEPAGENAME}}|34,000,500|sep=,}}</code> → {{{{BASEPAGENAME}}|34,000,500|sep=,}} | ||
| + | * <code>{{{{BASEPAGENAME}}|Hear ye, users|sep=,}}</code> → {{{{BASEPAGENAME}}|Hear ye, users|sep=,}} | ||
| + | * <code>{{{{BASEPAGENAME}}|1=len = a+b|sep==}}</code> → {{{{BASEPAGENAME}}|1=len = a+b|sep==}} | ||
| + | |||
| + | ==See also== | ||
{{String-handling templates |trim}} | {{String-handling templates |trim}} | ||
Revision as of 23:01, 31 July 2018
| This is a documentation subpage for Template:First word. It contains usage information, categories and other content that is not part of the original template page. |
| This template is used on 254,000+ pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
| This template uses Lua: |
This template returns the first word of the first parameter. Use |1= for the first parameter if the string may contain an equals sign (=). By default, words are delimited by spaces, but the optional parameter |sep= can set the separator to any character.
Usage
One parameter (space as separator):
{{First word|string}}{{First word|1=string}}
Two parameters (user-defined character as separator):
{{First word|string|sep=character}}{{First word|1=string|sep=character}}
Examples
{{First word|Foo bar baz}}→ Foo{{First word| Foo bar baz}}→ Foo{{First word|Foo}}→ Foo{{First word|Foo-bar-baz}}→ Foo-bar-baz{{First word|Foo-bar-baz|sep=-}}→ Foo{{First word|34,000,500|sep=,}}→ 34{{First word|Hear ye, users|sep=,}}→ Hear ye{{First word|1=len = a+b|sep==}}→ len
See also