Template:First word/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
← Older editNewer edit →
VisualWikitext
meta>Andy M. Wang
{{high-use|35000+}}
meta>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__
===Usage===
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.  
Returns the first word of the first parameter. By default, words are delimited by spaces, but optional parameter sep=/ can set the word separator to slash (or any other character). The parameter should ''not'' have leading spaces, unless the word separator, sep, is set to another character.


===Examples===
==Usage==
* {&#123;first word|Foo bar baz}} → {{first word|Foo bar baz}}
One parameter (space as separator):
* {&#123;first word|Foo}} → {{first word|Foo}}
* <code>'''{&#123;{{BASEPAGENAME}}|'''<var>string</var>'''}}'''</code>
* {&#123;first word|Foo-bar-baz}} → {{first word|Foo-bar-baz}}
* <code>'''{&#123;{{BASEPAGENAME}}|1='''<var>string</var>'''}}'''</code>
* {&#123;first word|Foo-bar-baz|sep=- }} → {{first word|Foo-bar-baz|sep=- }}
* {&#123;first word|34,000,500|sep=, }} → {{first word|34,000,500|sep=, }}
* {&#123;first word|1=len = a+b |sep== }} → {{first word|1=len = a+b |sep== }}
* {&#123;first word|Hear ye, users |sep=, }} → {{first word|Hear ye, users |sep=, }}


===See also===
Two parameters (user-defined character as separator):
* <code>'''{&#123;{{BASEPAGENAME}}|'''<var>string</var>'''|sep='''<var>character</var>'''}}'''</code>
* <code>'''{&#123;{{BASEPAGENAME}}|1='''<var>string</var>'''|sep='''<var>character</var>'''}}'''</code>
 
==Examples==
* <code>{&#123;{{BASEPAGENAME}}|Foo bar baz}}</code> → {{{{BASEPAGENAME}}|Foo bar baz}}
* <code>{&#123;{{BASEPAGENAME}}| Foo bar baz}}</code> → {{{{BASEPAGENAME}}| Foo bar baz}}
* <code>{&#123;{{BASEPAGENAME}}|Foo}}</code> → {{{{BASEPAGENAME}}|Foo}}
* <code>{&#123;{{BASEPAGENAME}}|Foo-bar-baz}}</code> → {{{{BASEPAGENAME}}|Foo-bar-baz}}
* <code>{&#123;{{BASEPAGENAME}}|Foo-bar-baz|sep=-}}</code> → {{{{BASEPAGENAME}}|Foo-bar-baz|sep=-}}
* <code>{&#123;{{BASEPAGENAME}}|34,000,500|sep=,}}</code> → {{{{BASEPAGENAME}}|34,000,500|sep=,}}
* <code>{&#123;{{BASEPAGENAME}}|Hear ye, users|sep=,}}</code> → {{{{BASEPAGENAME}}|Hear ye, users|sep=,}}
* <code>{&#123;{{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 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


Retrieved from "https://zoophilia.wiki/index.php?title=Template:First_word/doc&oldid=82981"