Difference between revisions of "Template:Ins/doc"

From blackwiki
Jump to navigation Jump to search
imported>SMcCandlish
m (Incorrect heading levels)
imported>Mhiji
(Redirected page to Template:INS/doc)
Line 1: Line 1:
{{Documentation subpage}}
+
#redirect [[Template:INS/doc]]
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
 
 
__TOC__
 
{{#ifeq:{{ROOTPAGENAME}}|Del|<br>{{dablink|You may be looking for the basic speedy deletion template, {{tl|db}}.}}}}
 
 
 
== Usage ==
 
 
 
The templates {{tl|ins}} and {{tl|del}} correct the display of content marked up as inserted or deleted, when that display is improperly line-broken inside block quotations due to a bug documented below.
 
 
 
=== Syntax ===
 
 
 
<code><nowiki>{{</nowiki>ins|<var>text marked as inserted</var><nowiki>}}</nowiki></code>
 
 
 
<code><nowiki>{{</nowiki>del|<var>text marked as deleted</var><nowiki>}}</nowiki></code>
 
 
 
These templates ''must'' be used as inline elements (i.e. inside a paragraph or other block), not as block elements (i.e. not enclosing multiple paragraphs or other blocks).  To mark up multiple blocks, use multiple instances.
 
 
 
=== Rationale ===
 
 
 
The {{tl|ins}} template and its counterpart {{tl|del}} exist to [[Workaround|work around]] a [https://bugzilla.wikimedia.org/show_bug.cgi?id=15491 known bug] in the [[MediaWiki]] software's handling of the <code>&lt;ins&gt;...&lt;/ins&gt;</code> and <code>&lt;del&gt;...&lt;/del&gt;</code> &#91;X&#93;HTML elements under certain conditions.
 
 
 
The result of the bug is that the first (and only first) occurrence of either <code>&lt;ins&gt;...&lt;/ins&gt;</code> or <code>&lt;del&gt;...&lt;/del&gt;</code> inside a <code>&lt;blockquote&gt;...&lt;/blockquote&gt;</code> segment (or inside a template, like {{tl|quotation}}, that uses <code>&lt;blockquote&gt;</code>) will be rendered with an inappropriate newline preceding it.  It is recommended that all use of <code>&lt;ins&gt;</code> and <code>&lt;del&gt;</code> be replaced with {{tl|ins}} and {{tl|del}} inside block quotations not just the first occurrence (since material in articles can change at any time, and there is no guarantee that the first-occurring case will always remain the first-occurring case).
 
 
 
The workaround is not required for cases of indentation with the ":" wikimarkup style, only for actual block quotations.
 
 
 
The purpose of these elements is to show inserted or deleted text in a passage, such as quotation of a draft document. They may also be used in Wikipedia processes like [[WP:RFA|RFA]] and [[WP:AFD|AFD]] by editors to change their comments on issues up for discussion (although some editors prefer <code>&lt;s&gt;...&lt;/s&gt;</code> strike-through for deletions, and <code>&lt;s&gt;</code> does not share <code>&lt;del&gt;</code>'s block quotation bug).
 
 
 
=== Example ===
 
 
 
This example, with both deleted and inserted material marked up
 
 
 
<blockquote><code><nowiki>Lorem ipsum odionsequip feu enim tionulla commodo elit autat, elit posuere adiamiscinim, inciduipit feugiat dunt aute. {{del|Odionsequip feu enim tionulla commodo elit autat, elit posuere adiamiscinim, inciduipit feugiat dunt aute.}} {{ins|Pretium vendre atinit essequis turpis felis adionsequat alisit uteisi, loris faciduisit duismolobore.}} Pretium vendre atinit essequis turpis felis adionsequat alisit uteisi, loris faciduisit duismolobore.</nowiki></code></blockquote>
 
 
 
renders as
 
 
 
<blockquote>Lorem ipsum odionsequip feu enim tionulla commodo elit autat, elit posuere adiamiscinim, inciduipit feugiat dunt aute. {{del|Odionsequip feu enim tionulla commodo elit autat, elit posuere adiamiscinim, inciduipit feugiat dunt aute.}} {{ins|Pretium vendre atinit essequis turpis felis adionsequat alisit uteisi, loris faciduisit duismolobore.}} Pretium vendre atinit essequis turpis felis adionsequat alisit uteisi, loris faciduisit duismolobore.</blockquote>
 
 
 
while when using bare <code>&lt;del&gt;</code> and <code>&lt;ins&gt;</code> markup rather than this template as
 
 
 
<blockquote><code><nowiki>Lorem ipsum odionsequip feu enim tionulla commodo elit autat, elit posuere adiamiscinim, inciduipit feugiat dunt aute. <del>Odionsequip feu enim tionulla commodo elit autat, elit posuere adiamiscinim, inciduipit feugiat dunt aute.</del> <ins>Pretium vendre atinit essequis turpis felis adionsequat alisit uteisi, loris faciduisit duismolobore.</ins> Pretium vendre atinit essequis turpis felis adionsequat alisit uteisi, loris faciduisit duismolobore.</nowiki></code></blockquote>
 
 
 
it mis-renders as
 
 
 
<blockquote>Lorem ipsum odionsequip feu enim tionulla commodo elit autat, elit posuere adiamiscinim, inciduipit feugiat dunt aute. <del>Odionsequip feu enim tionulla commodo elit autat, elit posuere adiamiscinim, inciduipit feugiat dunt aute.</del> <ins>Pretium vendre atinit essequis turpis felis adionsequat alisit uteisi, loris faciduisit duismolobore.</ins> Pretium vendre atinit essequis turpis felis adionsequat alisit uteisi, loris faciduisit duismolobore.</blockquote>
 
 
 
(note the undesired line break before the deleted, struck-through material, but that it only happens at the first occurence, with no line break before the inserted, underlined material).
 
 
 
== See also ==
 
 
 
{{#ifeq:{{ROOTPAGENAME}}|Ins||* {{tl|ins}}}}
 
{{#ifeq:{{ROOTPAGENAME}}|Del||* {{tl|del}}}}
 
 
 
<includeonly>
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
[[Category:Typing-aid templates|{{PAGENAME}}]]
 
 
 
[[ja:Template:Ins]]
 
</includeonly>
 

Revision as of 23:13, 11 December 2010

Redirect to: