Template:Str left/doc: Difference between revisions

Revision as of 23:21, 7 October 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.

Gives the <count> characters from the start of the string.

If <count> is 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.
 === Usage ===
-*'''first parameter''' ''(compulsory)'' the text string to truncate
+<nowiki>{{Str left|<string>|<count>}}</nowiki>
-*'''second parameter''' the number of characters to return. If invalid or empty, an empty string is returned. If undefined, it defaults to 1.
+Gives the <count> characters from the start of the string.
+If <count> is invalid or empty, an empty string is returned. If undefined, it defaults to 1.
+=== Examples ===
-===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 }}
@@ Line 16: / Line 19: @@
 === See also ===
-Equivalent to [[Template:Trunc]].  One is superior to the other - which?
+* {{Tl|Trunc}} - which is almost identical.
+* {{Tl|Str right}}
+* {{Tl|Str rightc}}
 <includeonly>