Module:HTMLParse/doc: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(document capitalize) |
||
(7 intermediate revisions by one other user not shown) | |||
Line 3: | Line 3: | ||
This module parses and manipulates HTML strings. | This module parses and manipulates HTML strings. | ||
There is currently | There is currently 4 functions: | ||
* pluralize | * pluralize | ||
* make_possessive | |||
* strip_formatting | |||
* capitalize | |||
== | == pluralize == | ||
Pluralizes an HTML string by inserting an "s" between the final alphabetic character and closing tag </ | Pluralizes an HTML string by inserting an "s" between the final alphabetic character and closing tag </ | ||
For example, <code><nowiki><span>book</span></nowiki></code> becomes <code><nowiki><span>books</span></nowiki></code> | For example, <code><nowiki><span>book</span></nowiki></code> becomes <code><nowiki><span>books</span></nowiki></code>. | ||
Won't pluralize anything that already ends in "s" | Notes: | ||
* Won't pluralize anything that already ends in "s". | |||
* Won't pluralize anything that doesn't lua pattern match <code>%a</</code> | |||
* If passing a template that uses a cargo query as the '''html''' parameter, be sure that the cargo query is marked with <code>no html</code> or this Module might not be able to expand the template correctly. | |||
===Usage=== | ===Usage=== | ||
<nowiki>{{#invoke: HTMLParse | pluralize | html = (html string here) }}</nowiki> | <nowiki>{{#invoke: HTMLParse | pluralize | html = (html string here) }}</nowiki> | ||
===Examples=== | ===Examples=== | ||
{| class="wikitable" | {| class="wikitable" | ||
!style="padding:10px;text-align:left;"|wikitext | |||
!style="padding:10px;text-align:left;"|result | |||
|- | |- | ||
|< | |style="padding:10px;"|<syntaxhighlight lang="html">{{#invoke: HTMLParse | pluralize | html = {{Qud text|&Cultra-light &brobot| notxml }} }}</syntaxhighlight> | ||
|{{#invoke: HTMLParse | pluralize | html = <span style="color:red">big </span><span style="color:green">book</span> }} | |style="padding:10px;"|{{#invoke: HTMLParse | pluralize | html = {{Qud text|&Cultra-light &brobot| notxml }} }} | ||
|- | |||
|style="padding:10px;"|<syntaxhighlight lang="html">{{#invoke: HTMLParse | pluralize | html = <span style="color:red">big </span><span style="color:blue">book</span> }}</syntaxhighlight> | |||
|style="padding:10px;"|{{#invoke: HTMLParse | pluralize | html = <span style="color:red">big </span><span style="color:green">book</span> }} | |||
|- | |- | ||
|} | |} | ||
== make_possessive == | |||
Identical to <code>pluralize</code> except that instead of inserting an <code>s</code>, make_possessive inserts an <code>'s</code> | |||
== strip_formatting == | |||
Strips HTML tags from the input string. For example, <code><nowiki><span style="color:red;">help!</span></nowiki></code> becomes <code>help!</code>. | |||
Example: | |||
<pre>{{#invoke: HTMLParse | strip_formatting | html = <span style="color: #d74200;">c</span><span style="color: #cfc041;">r</span><span style="color: #00c420;">a</span><span style="color: #0096ff;">y</span><span style="color: #da5bd6;">o</span><span style="color: #77bfcf;">n</span><span style="color: #FFFFFF;">s</span> }}</pre> | |||
Result: | |||
{{#invoke: HTMLParse|strip_formatting|html=<span style="color: #d74200;">c</span><span style="color: #cfc041;">r</span><span style="color: #00c420;">a</span><span style="color: #0096ff;">y</span><span style="color: #da5bd6;">o</span><span style="color: #77bfcf;">n</span><span style="color: #FFFFFF;">s</span>}} | |||
== capitalize == | |||
Capitalizes the word while preserving HTML formatting. It only takes one argument. | |||
<pre><nowiki>{{#invoke: HTMLParse | capitalize | html = {{qud text|&Cbrinestalk &Gstalks}} }}</nowiki></pre> | |||
{{qud text|&Cbrinestalk &Gstalks}} turns into: | |||
{{#invoke: HTMLParse | capitalize | html = {{qud text|&Cbrinestalk &Gstalks}} }} | |||
<includeonly> | <includeonly> | ||
<!-- Template categories/interwiki here --> | <!-- Template categories/interwiki here --> |
Latest revision as of 02:47, 5 January 2021
Documentation
[purge]
This module parses and manipulates HTML strings.
There is currently 4 functions:
- pluralize
- make_possessive
- strip_formatting
- capitalize
pluralize
Pluralizes an HTML string by inserting an "s" between the final alphabetic character and closing tag </
For example, <span>book</span>
becomes <span>books</span>
.
Notes:
- Won't pluralize anything that already ends in "s".
- Won't pluralize anything that doesn't lua pattern match
%a</
- If passing a template that uses a cargo query as the html parameter, be sure that the cargo query is marked with
no html
or this Module might not be able to expand the template correctly.
Usage
{{#invoke: HTMLParse | pluralize | html = (html string here) }}
Examples
wikitext | result |
---|---|
{{#invoke: HTMLParse | pluralize | html = {{Qud text|&Cultra-light &brobot| notxml }} }}
|
ultra-light robots |
{{#invoke: HTMLParse | pluralize | html = <span style="color:red">big </span><span style="color:blue">book</span> }}
|
big books |
make_possessive
Identical to pluralize
except that instead of inserting an s
, make_possessive inserts an 's
strip_formatting
Strips HTML tags from the input string. For example, <span style="color:red;">help!</span>
becomes help!
.
Example:
{{#invoke: HTMLParse | strip_formatting | html = <span style="color: #d74200;">c</span><span style="color: #cfc041;">r</span><span style="color: #00c420;">a</span><span style="color: #0096ff;">y</span><span style="color: #da5bd6;">o</span><span style="color: #77bfcf;">n</span><span style="color: #FFFFFF;">s</span> }}
Result:
crayons
capitalize
Capitalizes the word while preserving HTML formatting. It only takes one argument.
{{#invoke: HTMLParse | capitalize | html = {{qud text|&Cbrinestalk &Gstalks}} }}
brinestalk stalks turns into: Brinestalk stalks