Difference between revisions of "Template:First word/doc"

From blackwiki
Jump to navigation Jump to search
imported>DePiep
imported>Vanisaac
m (→‎See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
 
(11 intermediate revisions by 10 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
{{high-use|180612}}
 +
{{lua|Module:String}}
 +
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE---->
 +
__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 ===
+
==Usage==
 +
One parameter (space as separator):
 +
* <code>'''{&#123;{{BASEPAGENAME}}|'''<var>string</var>'''}}'''</code>
 +
* <code>'''{&#123;{{BASEPAGENAME}}|1='''<var>string</var>'''}}'''</code>
  
Returns first word of the first parameter. Words are delimited by spaces only. The parameter should ''not'' have whitespace.
+
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 ===
+
==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==}}
  
* {{tlc|first word|Foo bar baz}} → {{first word|Foo bar baz}}
+
==See also==
* {{tlc|first word|Foo}} → {{first word|Foo}}
+
{{String-handling templates |trim}}
* {{tlc|first word|Foo-bar-baz}} → {{first word|Foo-bar-baz}}
 
  
=== See also ===
+
<includeonly>{{Sandbox other||
{{String templates see also}}
 
  
<includeonly>
+
<!----CATEGORIES BELOW THIS LINE, PLEASE:---->
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
 
[[Category:String manipulation templates]]
 
[[Category:String manipulation templates]]
  
[[sl:Predloga:First word]]
+
}}</includeonly>
</includeonly>
 

Latest revision as of 04:47, 25 April 2020

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