Difference between revisions of "Template:COinS safe/doc"

From blackwiki
Jump to navigation Jump to search
(Replaced content with 'lies')
imported>Bentogoa
m (Reverted edits by 66.87.66.180 (talk) (HG) (3.1.19))
Line 1: Line 1:
lies
+
{{Documentation subpage}}
 +
<!-- Categories and interwikis go at the bottom of this page. -->
 +
 
 +
{{High-use|650}}
 +
 
 +
== Usage ==
 +
This template is a notice for templates that may be used in citation templates. By default, it indicates the template is safe for use as shown above.
 +
 
 +
To indicate a template that should not be used in a citation template:
 +
 
 +
<code><nowiki>{{COinS safe|n}}</nowiki></code>
 +
 
 +
{{COinS safe|n}}
 +
 
 +
* {{para|addtext}} — additional text shown after the main message
 +
 
 +
When the template is set to not safe, the page is placed into {{cl|Templates not safe for use in citation templates}}.
 +
 
 +
== Issue ==
 +
Citation templates such as {{cs1}} and {{cs2}} generate COinS metadata. If a template is used in a citation template field, then it may inject HTML into the metadata.
 +
 
 +
Compare the rendered HTML for {{tl|cite book}} with {{para|author}} using no template and using {{tl|smallcaps}}.
 +
 
 +
<div style="overflow:auto;">
 +
{{markup
 +
|<nowiki>{{cite book |author=Sam Drucker |title=Title}}</nowiki>
 +
|{{cite book |author=Sam Drucker |title=Title}}
 +
 
 +
{{code|{{cite book |author=Sam Drucker |title=Title}}}}
 +
 
 +
|<nowiki>{{cite book |author={{smallcaps|Sam Drucker}} |title=Title}}</nowiki>
 +
|{{cite book |author={{smallcaps|Sam Drucker}} |title=Title}}
 +
 
 +
{{code|{{cite book |author={{smallcaps|Sam Drucker}} |title=Title}}}}
 +
}}
 +
</div>
 +
The author metadata is in the {{code|rft.aulast}} field. In this case, it is percent-encoded and is rendered as <code><nowiki><span class="smallcaps" style="font-variant:small-caps;">Sam Drucker</span></nowiki></code>
 +
 
 +
Reference management software will interpret the entire span as the author name.
 +
 
 +
== See also ==
 +
 
 +
<includeonly>
 +
<!-- Categories and interwikis go here: -->
 +
[[Category:Notice and warning templates|{{PAGENAME}}]]
 +
 
 +
</includeonly>

Revision as of 06:53, 1 August 2016

Usage

This template is a notice for templates that may be used in citation templates. By default, it indicates the template is safe for use as shown above.

To indicate a template that should not be used in a citation template:

{{COinS safe|n}}

  • |addtext= — additional text shown after the main message

When the template is set to not safe, the page is placed into Category:Templates not safe for use in citation templates.

Issue

Citation templates such as Citation Style 1 and Citation Style 2 generate COinS metadata. If a template is used in a citation template field, then it may inject HTML into the metadata.

Compare the rendered HTML for {{cite book}} with |author= using no template and using {{smallcaps}}.

Markup Renders as
{{cite book |author=Sam Drucker |title=Title}}

Sam Drucker. Title.

<cite id="CITEREFSam_Drucker" class="citation book cs1">Sam Drucker. ''Title''.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Title&rft.au=Sam+Drucker&rfr_id=info%3Asid%2Fblackwiki.org%3ATemplate%3ACOinS+safe%2Fdoc" class="Z3988"></span>'"`UNIQ--templatestyles-00000004-QINU`"'

{{cite book |author={{smallcaps|Sam Drucker}} |title=Title}}

Template:Smallcaps. Title.

<cite id="CITEREFTemplate:Smallcaps" class="citation book cs1">[[:Template:Smallcaps]]. ''Title''.</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=book&rft.btitle=Title&rft.au=%3ATemplate%3ASmallcaps&rfr_id=info%3Asid%2Fblackwiki.org%3ATemplate%3ACOinS+safe%2Fdoc" class="Z3988"></span>'"`UNIQ--templatestyles-00000008-QINU`"'

The author metadata is in the rft.aulast field. In this case, it is percent-encoded and is rendered as <span class="smallcaps" style="font-variant:small-caps;">Sam Drucker</span>

Reference management software will interpret the entire span as the author name.

See also