Template:Redact2/doc
 | This is a documentation subpage for Template:Redact2. It contains usage information, categories and other content that is not part of the original template page. |
Rationale
[edit]This template is designed for representing sections of blocked-out ("redacted") text. It is similar to the {{redact}} template but has more options, wraps like normal text, and degrades gracefully in color-free or non-CSS situations.
Advantages
[edit]- Bar color and/or bar outline color can be specified
- Bar can wrap across multiple lines; no running off the right side of the window or page
- Provides a textual representation (# # # # #) for HTML clients without CSS or color capability
Disadvantages
[edit]- Unit of measure for bar extent is not precisely defined, so some trial and error may be required in layout
- Bar extent has an upper limit (although this can be adjusted in the template code)
Examples
[edit] {{redact2}}
{{redact2|12}}
{{redact2|color=red}}
{{redact2|32|color=white|bordercolor=black}}
Parameters
[edit]- first, unnamed parameter = size, in units slightly less than 1 em (default: 8; sizes greater than 400 are truncated)
- color = bar color (default: black)
- bordercolor = bar outline color (default: none)
See also
[edit]