Difference between revisions of "Template:String-handling templates"

From Ava Zinn Wiki
Jump to: navigation, search
Browse history
[unchecked revision][unchecked revision]
(/doc)
 
(31 intermediate revisions by 14 users not shown)
Line 1: Line 1:
−
<noinclude><big>List of templates in {{cat|String manipulation templates}}.</big>
+
{{Navbox with collapsible groups
−
</noinclude>==Templates==
+
| name = String-handling templates
−
===[[Trim (programming)|Trimming]] strings by counting===
+
| state = {{{state|expanded}}}
−
* {{tl|Str mid}} &mdash; To return a substring, specified by its position and length.
+
| bodyclass = plainlist
−
* {{tl|Trunc}} – To trim down to a specified number of characters.
+
| title = String-handling templates
−
* {{tl|Str left}} – To trim down to a specified number of characters, or duplicate the string to a specified number.
+
| selected = {{{selected|{{{expanded|{{{1|}}}}}}}}}
−
* {{tl|Str crop}} – To crop a specified number of characters off the end.
 
−
* {{tl|Chop head and tail}} — To crop a specified number of characters off the beginning and end.
 
−
* {{tl|Str right}} — To trim the first specified number of characters.
 
−
* {{tl|Str rightc}} — To return a number of characters from the end, returns a parameter if the string is empty.
 
−
* {{tl|Str rightmost}} — To trim down to the last specified number of characters.
 
−
* {{tl|Str sub old}} — To trim down to a specified number, starting at a given number from the left.
 
−
* {{tl|Str sub new}} — Select a substr based on starting and ending index.
 
  
−
===Trimming strings by character checking===
+
<!---------------------- Trimming ------------------------->
−
* {{tl|Trim}} — To trim any leading or trailing whitespace ({{tl|Strip whitespace}} does so too, but is less effective)
+
| abbr1 = trim
−
* {{tl|First word}} — To trim down to the first space.
+
| sect1 = [[Trimming (computer programming)|Trimming]]
−
* {{tl|Remove first word}} — To remove anything before the first space.
+
| content1 =
−
* {{tl|Str letter/trim}} — To trim down to the beginning letters.
+
{{Navbox |child
−
* {{tl|Str number/trim}} — To trim down to the beginning numbers.
 
−
* {{tl|Title without disambig}} — To trim off any parenthesis text at the end of a string.
 
−
* {{tl|Title disambig text}} – Returns text in parenthesis at the end of a string.
 
  
−
===Inserting strings===
+
  | group1 = By counting
 +
  | list1 =
 +
  {{Aligned table |fullwidth=on |style=text-align:left; |col1width=50%;
 +
    | {{Aligned table |style=padding-right:2.5em;
 +
      |col1style=width:12.5em;text-align:right;white-space:nowrap;padding-right:0.75em; |col2style=font-style:italic;
 +
      | {{tl|str mid}}      | To return a substring specified by position and length.
 +
      | {{tl|trunc}}        | To trim down to a specified number of characters.
 +
      | {{tl|str left}}      | To trim down to a specified number of characters or duplicate the string to a specified number.
 +
      | {{tl|str crop}}      | To crop a specified number of characters off the end.
 +
      | {{tl|chop head and tail}} | To crop a specified number of characters off the beginning and end.
 +
      }}
 +
    | {{Aligned table
 +
      |col1style=width:12.5em;text-align:right;white-space:nowrap;padding-right:0.75em; |col2style=font-style:italic;
 +
      | {{tl|str right}}    | To trim the first specified number of characters.
 +
      | {{tl|str rightc}}    | To return a number of characters from the end, returns a parameter if the string is empty.
 +
      | {{tl|str rightmost}} | To trim down to the last specified number of characters.
 +
      | {{tl|str sub old}}  | To trim down to a specified number, starting at a given number from the left.
 +
      | {{tl|str sub new}}  | Select a substr based on starting and ending index.
 +
      | {{tl|str index}}    | Returns a given character from a string, but not accented letters.
 +
  }} }}
  
−
* {{[[Template:Strloc insert|Strloc insert]]}} - Inserts a string at character location strloc, or appends if strloc<=0.
+
  | group2 = By checking
−
* {{[[Template:Strloc prefix|Strloc prefix]]}} - Extracts string prefix up to location strloc, or whole string if strloc<=0.
+
  | list2 =
−
* {{[[Template:Str rep|Str rep]]}} — Returns the string, after replacing the first occurrence of a specified string with another string.
+
  {{Aligned table |fullwidth=on |style=text-align:left; |col1width=50%;
−
* {{tl|Replace}} — Returns the string, after replacing ''all'' occurrences of a specified string with another string.
+
    | {{Aligned table |style=padding-right:2.5em;
−
* {{[[Template:Repeat|Repeat]]}} — Repeat character string n times
+
      |col1style=width:12.5em;text-align:right;white-space:nowrap;padding-right:0.75em; |col2style=font-style:italic;
 +
      | {{tl|trim}}               | To trim any leading or trailing whitespace
 +
      | {{tl|str letter/trim}}    | To trim down to the beginning letters.
 +
      | {{tl|str number/trim}}     | To trim down to the beginning numbers.
 +
      | {{tl|trim brackets}}      | To trim any leading or trailing square brackets.
 +
      }}
 +
    | {{Aligned table
 +
      |col1style=width:12.5em;text-align:right;white-space:nowrap;padding-right:0.75em; |col2style=font-style:italic;
 +
      | {{tl|first word}}         | To trim down to the first space.
 +
      | {{tl|remove first word}}  | To remove anything before the first space.
 +
      | {{tl|last word}}           | To trim down from the last space.
 +
      | {{tl|remove last word}}    | To remove anything after the last space.
 +
  }} }}
  
−
===Analyzing strings templates===
+
  | group3 = Dedicated
 +
  | list3 =
 +
  {{Aligned table |fullwidth=on |style=text-align:left; |col1width=50%;
 +
    | {{Aligned table |style=padding-right:2.5em;
 +
      |col1style=width:12.5em;text-align:right;white-space:nowrap;padding-right:0.75em; |col2style=font-style:italic;
 +
      | {{tl|delink}}              | Removes wikilink brackets (wikicode).
 +
      | {{tl|remove file prefix}}  | Removes "File:" (or "Image:") from filenames.
 +
      | {{tl|PAGENAMEBASE}}        | To trim off any parenthesis text at the end of a string (disambiguation).
 +
      | {{tl|title disambig text}} | Returns text in parenthesis at the end of a string (disambiguation).
 +
      }}
 +
    | {{Aligned table
 +
      |col1style=width:12.5em;text-align:right;white-space:nowrap;padding-right:0.75em; |col2style=font-style:italic;
 +
      | {{tl|WikiProjectbasename}} | Removes "WikiProject" from a pagename.
 +
      | {{tl|remove unranked}}    | Removes the string "unranked_" from the left of a string (taxonomy).
 +
      | {{tl|ship prefix}}        | Returns the length of a ship's name prefix, if listed (ship names).
 +
      | {{tl|title year}}          | Returns the 4-digit year from a pagename, if any.
 +
  }} }}
 +
}}
  
−
* {{tl|Str endswith}} – To check if a string ends with a given string.
+
<!----------- Insertion, replacement, length -------------->
−
* {{tl|Str find}} – Returns the numerical location of a given string in a string.
+
| abbr2 = IRL
−
* {{tl|Strfind short}} – Returns the numerical location of a given string in a string.  1-based
+
| sect2 = Insertion, replacement and length
−
* {{tl|Str find0}} – Zero-based substring search.
+
| content2 =
−
* {{tl|Str sub find}} – Searches a substring in a string at the given offset.
+
{{Aligned table |style=margin:0 auto 0;text-align:left;
−
* {{tl|Str index}} – Returns a given character from a string, but not accented letters.
+
  |  <!---(Insertion, replacement)--->
−
* {{tl|Str len}} – Returns a string's length.
+
    {{Aligned table |style=padding-right:2.5em;
−
* {{tl|Str letter}} — Returns the number of letters that begin a string.
+
    |col1style=text-align:right;white-space:nowrap;padding-right:0.75em; |col2style=font-style:italic;
−
* {{tl|Str number}} — Returns the number of numbers that begin a string.
+
    | {{tl|strloc insert}} | Inserts a string at character location strloc, or appends if strloc<{{=}}0.
−
* {{tl|Ship prefix}} — Returns the length of a ship name prefix, if listed.
+
    | {{tl|loop}}          | Repeat character string a specified number of times.
 +
    | {{tl|repeat}}        | Repeat a string a specified number of times.
 +
    | {{tl|replace}}       | Returns the string, after replacing ''all'' occurrences of a specified string with another string.
 +
    | {{tl|str rep}}       | Returns the string, after replacing the first occurrence of a specified string with another string.
 +
    }}
 +
  | <!---(Length)--->
 +
    {{Aligned table
 +
    |col1style=text-align:right;white-space:nowrap;padding-right:0.75em; |col2style=font-style:italic;
 +
    | {{tl|str len}}       | Returns a string's length.
 +
    | {{tl|iflenge}}       | [if len]gth [g]reater than or [e]qual to.
 +
    | {{tl|str ≥ len}}     | To check if a string is "longer or equally long" or "shorter" than a given length.
 +
    | {{tl|str ≤ len}}     | To check if a string is "shorter or equally long" or "longer" than a given length.
 +
    | {{tl|str ≠ len}}     | To check if a string is "not equal" or "equal" to a given length.
 +
    | {{tl|str ≤ ≥ len}}   | To check if a string is "shorter", "equal", or "longer" than a given length.
 +
}} }}
  
−
===String length comparison templates===
+
<!----------------- Analysis, technical ------------------->
 +
| abbr3 = anlys/tech
 +
| sect3 = Analysis and technical
 +
| content3 =
 +
{{Aligned table |style=margin:0 auto 0;text-align:left;
 +
  |  <!---(Analysis)--->
 +
    {{Aligned table |style=padding-right:2.5em;
 +
    |col1style=text-align:right;white-space:nowrap;padding-right:0.75em; |col2style=font-style:italic;
 +
    | {{tl|str endswith}}  | To check if a string ends with a given string.
 +
    | {{tl|str find}}<br/>{{tl|strfind short}} |style2.2=vertical-align:middle;|''Returns the numerical location of a given string in a string.''
 +
    | {{tl|str find0}}    | Zero-based substring search.
 +
    | {{tl|str sub find}}  | Searches a substring in a string at the given offset.
 +
    | {{tl|str letter}}    | Returns the number of letters that begin a string.
 +
    | {{tl|str number}}    | Returns the number of numbers that begin a string.
 +
    | {{tl|str gtr str}}  | Compares two strings for alphabetical order, and returns a value accordingly.
 +
    }}
 +
  |  <!---(Analysis cont'd)--->
 +
    {{Aligned table
 +
    |col1style=text-align:right;white-space:nowrap;padding-right:0.75em; |col2style=font-style:italic;
 +
    | {{tl|ASCII code}}    | Returns the ASCII value of a single character.
 +
    | {{tl|a or an}}      | Takes a noun and produces the appropriate indefinite article, based on whether the first letter is a vowel.
 +
    | &nbsp; | &nbsp;
 +
    <!---(Technical)--->
 +
    | [[Module:String]]    |
 +
    | [[mw:Help:Magic words|...Magic words]] | {{noitalic|About <code><nowiki>{{padleft:&#124;}}</nowiki></code>.}}
 +
    | [[mw:Help:Extension:ParserFunctions|...ParserFunctions]] | {{noitalic|About <code><nowiki>{{#titleparts:&#124;}}, {{#expr:&#124;}}, {{#ifeq:&#124;}}, </nowiki></code> etc.}}
 +
}} }}
  
−
* {{tl|Str ≥ len}} – To check if a string is "longer or equally long" or "shorter" than a given length.
+
<!--------------------- (disabled) ------------------------>
−
* {{tl|Str ≤ len}} – To check if a string is "shorter or equally long" or "longer" than a given length.
+
<!----
−
* {{tl|Str ≠ len}} – To check if a string is "not equal" or "equal" to a given length.
+
| group12 = Feature requests
−
* {{tl|Str ≤ ≥ len}} – To check if a string is "shorter", "equal", or "longer" than a given length.
+
| list12 =
−
 
+
* [[bugzilla:6455]] – Set $wgPFEnableStringFunctions = true on WMF wikis
−
==Test cases==
+
* [[bugzilla:26092]] – Enable or install string parsing wikimarkup functionality on WMF wikis
−
[[Wikipedia:Template sandbox and test cases|Sandboxes and test cases]]:
 
  
 +
<!----Not in a navbox:
 +
| group13 = [[Wikipedia:Template sandbox and test cases|Sandboxes, testcases]]
 +
| list13 =
 
* {{tl|Str find/sandbox}}
 
* {{tl|Str find/sandbox}}
 
* {{tl|Str index/getchar/sandbox}}
 
* {{tl|Str index/getchar/sandbox}}
Line 67: Line 147:
 
* {{tl|Str ≠ len/sandbox}}
 
* {{tl|Str ≠ len/sandbox}}
 
* {{tl|Str ≠ len/testcases}}
 
* {{tl|Str ≠ len/testcases}}
 +
----->
  
−
==Technical developments==
+
<!----------------------- below --------------------------->
−
* [[Module:String]]
+
| belowclass = hlist
−
* [[mw:Help:Magic words]] – About <code><nowiki>{{padleft:|}}</nowiki></code>.
+
| below =
−
* [[mw:Help:Extension:ParserFunctions]] – About <code><nowiki>{{#titleparts:|}}, {{#expr:|}}, {{#ifeq:|}}, </nowiki></code> etc.
+
* [[:Category:String manipulation templates]]
 +
* [[m:Category:String templates]]
 +
* [[:commons:Category:String manipulation templates]]
  
−
;Feature requests:
+
| tracking = no <!--(keep all these string templates (by /doc pages) out of the tracking category)-->
  
−
* [[bugzilla:6455]] - Set $wgPFEnableStringFunctions = true on WMF wikis
+
}}<noinclude>{{Documentation}}</noinclude>
−
* [[bugzilla:26092]] - Enable or install string parsing wikimarkup functionality on WMF wikis
 
−
<noinclude>
 
−
{{documentation}}
 
−
</noinclude>
 

Latest revision as of 01:13, 7 March 2016

String-handling templates
Documentation icon Template documentation[create]
Retrieved from "http://wiki-beta.avazinn.com/w/index.php?title=Template:String-handling_templates&oldid=8580"