Module:String2/doc

This is the documentation page for Module:String2

This is a documentation subpage for Module:String2.

It contains usage information, categories, and other content that is not part of the original module page.

This module is unused.

This module is neither invoked by a template nor required/loaded by another module. If this is in error, make sure to add {{Documentation}}/{{No documentation}} to the calling template's or parent's module documentation.

Function list
L 124 — v2p L 206 — p._escapePattern L 228 — p.strip L 258 — p.matchAny L 287 — p.hyphen_to_dash L 324 — p.hyphen2dash L 332 — p.startswith

This template is imported from Module:String2/doc on Wikipedia.

This template is imported from the English Wikipedia. Although the visual appearance might be different, the functionality is identical. Please refer to the Module:String2/doc page on Wikipedia for detailed documentation.

Module:String2 contains five general purpose calls that convert strings to upper, lower, sentence or title case. There are also two utility calls that strip leading zeros from padded numbers and transform text so that it is not interpreted as wikitext.

Functions

upper

The upper function simply converts all characters to upper case.

lower

The upper function simply converts all characters to upper case.

title

The title function capitalises the first letter of each word in the text, apart from a number of short words recommended by The U.S. Government Printing Office Style Manual: a, an, the, at, by, for, in, of, on, to, up, and, as, but, or, and nor.

sentence

The sentence function finds the first letter and capitalises it, then renders the rest of the text in lower case. It works properly with text containing wiki-markup.

ucfirst

The ucfirst function is similar to sentence; it renders the first alphabetical character in upper case, but leaves the capitalisation of the rest of the text unaltered. This is useful if the text contains proper nouns, but it will not regularise sentences that are ALLCAPS, for example. It also works with text containing piped wiki-links and with html lists.

stripZeros

The stripZeros functions finds the first number in a string of text and strips leading zeros, but retains a zero which is followed by a decimal point. For example: "0940" -> "940"; "Year: 0023" -> "Year: 23"; "00.12" -> "0.12"

nowiki

The nowiki function ensures that a string of text is treated by the MediaWiki software as just a string, not code. It trims leading and trailing whitespace.

posnq

posnq (position, no quotes) returns the numerical start position of the first occurrence of one piece of text ("match") inside another ("str").
It returns nil if no match is found, or if either parameter is blank.
It takes the text to be searched in as the first unnamed parameter, which is trimmed.
It takes the text to match as the second unnamed parameter, which is trimmed and any double quotes " are stripped out. That allows spaces at the beginning or end of the match string to be included in a consistent manner.

Usage

{{#invoke:String2 | upper |…}} - Shifts all characters to uppercase
{{#invoke:String2 | lower |…}} - Shifts all characters to lowercase
{{#invoke:String2 | sentence |…}} - Capitalizes the first character and shifts the rest to lowercase
- Although similar to magic words' {{ucfirst:}} function, this call works even with piped wiki-links because it searches beyond leading brackets and other non-alphanumeric characters.
- It now also recognises when it has an html list passed to it and capitalises the first alphabetic letter beyond the list item markup (<li>) and any piped links that may be there.
{{#invoke:String2 | ucfirst |…}} - Capitalizes the first character and leaves the rest unaltered
- Works with piped wiki-links and html lists
{{#invoke:String2 | title |…}} - Capitalizes all words, except for a, an, the, at, by, for, in, of, on, to, up, and, as, but, or, and nor.
{{#invoke:String2 | stripZeros |…}} - Removes leading padding zeros from the first number it finds in the string
{{#invoke:String2 | title |…}} - Renders the string as plain text without wikicode

Parameters

These functions take one unnamed parameter comprising (or invoking as a string) the text to be manipulated.