Template:COinS safe

From imedwiki
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

Description

It is to indicate whether it can be safely used in citation templates. By default, it indicates the template is safe for use.

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

Usage

To indicate a template which can be safely used in citation templates: {{COinS safe}}

To indicate a template that should NOT be used in citation templates: {{COinS safe|n}}

To add extra info after the standard message: |addtext=

Examples

Code Result
{{COinS safe}}
{{COinS safe|n}}
{{COinS safe|addtext=Here is the extra info.}}
{{COinS safe|n|addtext=Here is the extra info.}}

Explain COinS issues

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.

'"`UNIQ--templatestyles-00000005-QINU`"'<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%2Fen.imedwiki.org%3ATemplate%3ACOinS+safe" class="Z3988"></span> 

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

Sam Drucker. Title. templatestyles stripmarker in |author= at position 1 (help)

'"`UNIQ--templatestyles-0000000C-QINU`"'<cite id="CITEREFSam_Drucker" class="citation book cs1">'"`UNIQ--templatestyles-0000000B-QINU`"'<span class="smallcaps">Sam Drucker</span>. ''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=%7F%27%22%60UNIQ--templatestyles-0000000B-QINU%60%22%27%7F%3Cspan+class%3D%22smallcaps%22%3ESam+Drucker%3C%2Fspan%3E&rfr_id=info%3Asid%2Fen.imedwiki.org%3ATemplate%3ACOinS+safe" class="Z3988"></span> <span class="cs1-visible-error error citation-comment">templatestyles stripmarker in <code class="cs1-code">&#124;author=</code> at position 1 ([[Help:CS1 errors#invisible_char|help]])</span>[[Category:CS1 errors: invisible characters]]

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

This template is based (in parts) on the Template:COinS safe from the free encyclopedia wikipedia and is licensed under GNU license for free documentation and the Creative Commons Attribution/Share Alike. On wikipedia there is a List of authors accessible. More about importing from wikipedia on page Imedwiki:Importing from wikipedia.
The above documentation is transcluded from Template:COinS safe/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.
Retrieved from "https://en.imedwiki.org/w/index.php?title=Template:COinS_safe&oldid=3932"