வார்ப்புரு:Redact/doc என்பதற்கான மூலத்தைப் பார்

{{documentation subpage}}
{{Span-based-template}}
'''{{tl|redact}}''' stylistically renders text that has been censored (see [[wikt:redact|redact]] in Wiktionary). This template will commonly be used when transcribing formerly-classified documents that have been released via a Freedom of Information Act request or similar.

==Usage==

:: <code><nowiki>{{redact}}</nowiki></code> → {{redact}}
:: <code><nowiki>{{redact|5}}</nowiki></code> →{{redact|5}}
:: <code><nowiki>{{redact|color=cyan}}</nowiki></code> → {{redact|color=cyan}}

== Parameters ==

{| class="wikitable"
! style="text-align: left" | Parameter
! style="text-align: left" | Default
! style="text-align: left" | Explanation
|-
|| length || 8 || The length, in ''em''. See [https://en.wikipedia.org/wiki/Em_(typography) Wikipedia] for more. For a '''full width''' redaction, the keyword <code>full</code> may be used.
|-
|| color || #000 || The color of the redacted text. This can be either an [https://en.wikipedia.org/wiki/Web_colors#HTML_color_names HTML color name] (eg "black" or "white"), or a RGB hexadecimal representation of a color (eg "#000" for black, "#ff0000" for red).
|-
|| replacement || || If present, a tooltip will display this text when hovering over the redacted area with the heading "replacement = ".
|-
|| text || <code>&amp;nbsp;</code> || If present, the text will be rendered on the "redacted" area. Note that this text will ''always'' be rendered in black; to be visible, utilize the {{parameter|color}} parameter to adjust the color of the redaction.
|-
|| foia-exceptions || || If present, a tooltip will display this text while hovering over the redacted area with the heading "FOIA Request Exceptions:". This is intended to be used to list exemptions to the [[Freedom of Information Act]].
|}

== Examples ==

=== Full width ===
Set the {{parameter|width}} parameter to <code>full</code> to get a full width redaction:

<code><nowiki>{{redact|full}}</nowiki></code> and <code><nowiki>{{redact|width=full}}</nowiki></code> render as:
{{redact|full}}

=== Redaction colour ===
To redact in another colour then utilise the parameter {{parameter|color}}, eg.<code> color = white</code>. This can be useful when the redaction still shows the original text.

<code><nowiki>{{redact|color=white}}</nowiki></code> renders as:
{{redact|color=white}}

=== Text content ===
If the redacted text is still visible, you can add the text with the {{parameter|text}} parameter. Note you probably need to change the colour to something other than black for it to be visible.

<code><nowiki>{{redact|color=grey|text=This was redacted}}</nowiki></code> renders as: 
{{redact|color=grey|text=This was redacted}}

=== Remarks (Tooltip) ===
By default, when hovering over a redaction, a tooltip will show that reads "redacted text". If the {{parameter|replacement}} parameter is used, this value will be added to the tooltip. Hover your mouse over the examples below.

'''NOTE: this functionality makes use of "hovering" a mouse. It is therefore {{u|not}} available to users on mobile devices, tablets, touch screens, visually impaired users with text readers, and so on. Use sparingly.'''

A regular redaction with no {{parameter|replacement}} parameter: <code><nowiki>{{redact}}</nowiki></code> → {{redact}}

A redaction with a {{parameter|replacement}} parameter: <code><nowiki>{{redact|replacement=Example Text.}}</nowiki></code> → {{redact|replacement=Example Text.}}

=== Freedom of Information Act Request Exceptions (Tooltip) ===
The US [[Freedom of Information Act]], which forces the US government to release documents, includes a number of listed exceptions. When a document is released, these exceptions may cause information to be redacted. If present and documented, this exception can be included in a tooltip on the redacted area using the {{parameter|foia-exceptions}} parameter.

This parameter ''may'' be used in conjunction with the {{parameter|remarks}} parameter.

The following redaction includes an FOIA request exception: <code><nowiki>{{redact|foia-exceptions=(b)(6), (b)(7)(c)}}</nowiki></code> → {{redact|foia-exceptions=(b)(6), (b)(7)(c)}}

== Categories ==
The template sets the following tracking categories:

* {{clc|Redacted pages with replacement text}}
* {{clc|Redacted pages with foia-exceptions}}
* {{clc|Redacted pages with custom color}}
* {{clc|Redacted pages with custom text}}
* {{clc|Redacted pages with width specified}}


==See also==
* {{tl|?}}
* {{tl|illegible}}
* {{tl|reconstruct}}

<!-- template categories and interwiki links -->
<includeonly>
[[Category:Formatting templates|{{PAGENAME}}]]

</includeonly>