Template:Trim brackets/doc
This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
This template trims leading and trailing square brackets and whitespace from a string. This is similar to {{delink}}, but it won't remove brackets from the middle of the string. The string should be passed as the first unnamed parameter or using |1=
if your string contains any =
signs. You may substitute this template - that is, if used as {{subst:trim brackets}}
, the resulting wikicode is "clean".
Usage[edit]
{{trim brackets|text}}
= text with any leading or trailing square brackets removed (as long as text doesn't contain any =
signs).
{{trim brackets|1=text}}
= text with any leading or trailing square brackets removed.
Example[edit]
- "
{{trim brackets|1= [[abc]] }}
" produces "abc".
- "
{{trim brackets|1= [[abc]], [[def]], and [[ghi]] }}
" produces "abc]], def, and [[ghi"
("{{delink|1= [[abc]], [[def]], and [[ghi]] }}
" produces "abc, def, and ghi").
Template data[edit]
This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.
TemplateData for Trim brackets
<templatedata> {
"description": "The template trims leading and trailing square brackets from a string.", "params": { "1": { "label": "String", "description": "The string to be trimmed", "type": "string", "required": true } }
} </templatedata>
See also[edit]
- {{delink}}, which does nearly the exact same thing, but also removes balanced pairs of square brackets that aren't leading and trailing and has additional options.
- {{trim}}
Template:String-handling templates