Template:Str left/doc: Difference between revisions

Revision as of 22:46, 13 May 2009

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Str left.

This template returns a certain number of characters from the start of a text string.

first parameter (compulsory) the text string to truncate
second parameter the number of characters to return. If invalid or empty, an empty string is returned. If undefined, it defaults to 1.

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
 <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+This template returns a certain number of characters from the start of a text string.
-<nowiki>{{str_left|</nowiki>''text''<nowiki>|</nowiki>''number''<nowiki>}}</nowiki> = Grabs the first ''number'' characters from ''text''.  ''Number'' defaults to 1.
+=== Usage ===
+*'''first parameter''' ''(compulsory)'' the text string to truncate
+*'''second parameter''' the number of characters to return. If invalid or empty, an empty string is returned. If undefined, it defaults to 1.
+===Examples===
+*<tt><nowiki>{{Str left| lorem ipsum dolor sit amet | 10 }}</nowiki></tt> &rarr; {{Str left| lorem ipsum dolor sit amet | 10 }}
+*<tt><nowiki>{{Str left| lorem ipsum dolor sit amet | 1 }}</nowiki></tt> &rarr; {{Str left| lorem ipsum dolor sit amet | 1 }}
+*<tt><nowiki>{{Str left| lorem ipsum dolor sit amet | foo }}</nowiki></tt> &rarr; {{Str left| lorem ipsum dolor sit amet | foo }}
+*<tt><nowiki>{{Str left| lorem ipsum dolor sit amet | }}</nowiki></tt> &rarr; {{Str left| lorem ipsum dolor sit amet | }}
+*<tt><nowiki>{{Str left| lorem ipsum dolor sit amet }}</nowiki></tt> &rarr; {{Str left| lorem ipsum dolor sit amet }}
+=== See also ===
 Equivalent to [[Template:Trunc]].  One is superior to the other - which?
 <includeonly>
 <!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->