Template:LibraryOfMu/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 06:13, 2 November 2022

This is a documentation subpage for Template:LibraryOfMu.
It may contain usage information, categories and other content that is not part of the original template page.

This template is a wrapper around - by default - {{Cite magazine}}. It exists in order to link to articles at the Wayback Machine (or another acceptable web archive) which were transcribed by the Library of Mu.

The template must be transcluded and not subst'd.

See a monthly parameter usage report for this template in articles.

Usage

Most parameters are passed through straight to the underlying template. Not all parameters are passed through currently. Please add pass-through-parameters to the template as they become needed.

Parameters unique to this template

mu-id - The page number at the Library of Mu. Mandatory.
tl - Optional. Can be used to change the underlying template from {{Cite magazine}}. Tested, with limited parameters, tl=web to use {{Cite web}} and tl=news to use {{Cite news}}
mu-transcript-url - Optional, for use (typically with tl=interview) to provide an archive.org link to a Library of Mu transcript. If used, must be used instead of archive-url
transcripts - Optional. If a transcript url is supplied, and this parameter is set to yes, "Transcripts" will be rendered rather than "Transcript"

Other mandatory parameters

archive-url - a link to the Wayback Machine or other archive (mandatory unless mu-transcript-url is used instead)
archive-date - the archive date

Examples

Magazine

{{LibraryOfMu|mu-id=297|last=Kelly|first=Danny|authorlink=Danny Kelly (journalist)|title=Welcome To The Sheep Seats|work=[[NME]]|date=29 February 1992|archive-url=https://web.archive.org/web/20160916111310/http://www.libraryofmu.net/display-resource.php?id=297 |archive-date=16 September 2016 }}

Renders as:

Kelly, Danny (29 February 1992). "Welcome To The Sheep Seats". NME. Archived (via the Library of Mu) on 16 September 2016.

Newspaper

{{LibraryOfMu|tl=news|mu-id=387|last=Reid, Jim|title=Money to burn|work=[[The Observer]]|date=25 September 1994|archive-url=https://web.archive.org/web/20160916120338/http://www.libraryofmu.net/display-resource.php?id=387 |archive-date=16 September 2016}}

Renders as:

Reid, Jim (25 September 1994). "Money to burn". The Observer. Archived (via the Library of Mu) on 16 September 2016.

Web

{{LibraryOfMu|tl=web|mu-id=500|last=Drummond|first=Bill|authorlink=Bill Drummond|date=October 1987|title=KLF Info Sheet Oct 1987|archive-url=https://web.archive.org/web/20070311225447/http://www.libraryofmu.org/display-resource.php?id=500 |archive-date=11 March 2007 }}

Renders as:

Drummond, Bill (October 1987). "KLF Info Sheet Oct 1987". Archived (via the Library of Mu) on 11 March 2007.

List of library entries

The WikiProject has compiled a list of library records which have already been converted into references to make it easier to update/rescue old references (as you can just find the library id and copy the wikitext). The list also contains more detailed instructions. If you rescue or add a reference to a library entry which is not already present on the list, please add it to the list.

Making non-trivial changes to the template

To make non-trivial changes to the template, it is recommended to copy the text into a sandbox in userspace, and copy the text of Wikipedia:WikiProject The KLF/LibraryOfMu into another sandbox or the sandbox talk page. Temporarily change the text in the latter to use your sandboxed template instead of {{LibraryOfMu}}. Then you can test your changes by doing a dummy save of the library list and compare it to the live WikiProject list, to ensure you haven't broken any of the known existing uses. When done, copy your changes into the template and request deletion of the sandboxes by tagging them with {{db-user}} (if you're not a sysop).

Reliable sources and verification

The magazine, newspaper or other publication the library has transcribed must be considered the source. Editors wishing to verify a reference should refer to the original material.

Making a change to all instances of a library entry

Sometimes it might be desirable to make a change to all instances of a library entry. For example:

A mistake has been found
An article author has become blue linked
An article is republished on the web by the original publisher so a link to archive.org is no longer needed

@@ Line 1: / Line 1: @@
-[[File:Pyramidblaster.gif|right]]This template is a wrapper around {{tl|Cite web}}. It exists in order to link to the library "The Library of Mu" in a uniform fashion, and to allow easy changing of the url or other data if the library url is altered (as has happened before), the library closes down (as may be imminent as it is currently returning a 500 error code), or some other change is required or desired to be made uniformly. For these reasons, please do '''not''' subst the delete. Transclude it.
+{{Documentation subpage}}[[File:Pyramidblaster.gif|right]]This template is a wrapper around - by default - {{tl|Cite magazine}}. It exists in order to link to articles at the [[Wayback Machine]] (or another acceptable web archive) which were transcribed by the Library of Mu.
+The template must be transcluded and not subst'd.
-The template is not yet fully rolled out. Please do not take this to mean that the template is unused; especially as it needs to be transcluded.
+{{Template error report}}
 ==Usage==
-Most parameters are passed through straight to the underlying template. Not all parameters are passed through currently simply because of the time needed to add them all. Please add pass-through-parameters to the template as they become needed.
+Most parameters are passed through straight to the underlying template. Not all parameters are passed through currently. Please add pass-through-parameters to the template as they become needed.
-Please ensure the <code>archive-url</code> and <code>archive-date</code> parameters are used where possible with a link to e.g. [https://archive.org/web/ The Wayback Machine] to avoid [[Wikipedia:Link rot|link rot]]. This template presumably won't be caught by bots which find dead links, but that shouldn't matter as it appears likely the Library will not be available in future and therefore all instances of the template should where possible already have a link to an archived copy.
 ===Parameters unique to this template===
-*'''mu-id''' - The page number at the Library of Mu
+*'''mu-id''' - The page number at the Library of Mu. Mandatory.
+*'''tl''' - Optional. Can be used to change the underlying template from {{tl|Cite magazine}}. Tested, with limited parameters, <code><nowiki>tl=web</nowiki></code> to use {{tl|Cite web}} and <code><nowiki>tl=news</nowiki></code> to use {{tl|Cite news}}
+*'''mu-transcript-url''' - Optional, for use (typically with <code><nowiki>tl=interview</nowiki></code>) to provide an archive.org link to a Library of Mu transcript. If used, must be used ''instead of'' '''archive-url'''
+*'''transcripts''' - Optional. If a transcript url is supplied, and this parameter is set to <code>yes</code>, "Transcripts" will be rendered rather than "Transcript"
+===Other mandatory parameters===
+*'''archive-url''' - a link to the Wayback Machine or other archive (mandatory unless '''mu-transcript-url''' is used instead)
+*'''archive-date''' - the archive date
 <!--==Parameters==
 --><!-- generated by {{subst:Parameters|code|base={{subst:BASEPAGENAME}}}} ; redo if add any --- except it didn't work. LUA error. -->
-==Example==
+==Examples==
+=== Magazine===
-<code><nowiki>{{LibraryOfMu|mu-id=519 |title=Cape Wrath |author=[[K Foundation]] |date=8 December 1995 |publisher=[[The Guardian]] |archive-url=https://web.archive.org/web/20160916113827/http://www.libraryofmu.net/display-resource.php?id=519 |archive-date=16 September 2016}}</nowiki></code>
+<code><nowiki>{{LibraryOfMu|mu-id=297|last=Kelly|first=Danny|authorlink=Danny Kelly (journalist)|title=Welcome To The Sheep Seats|work=[[NME]]|date=29 February 1992|archive-url=https://web.archive.org/web/20160916111310/http://www.libraryofmu.net/display-resource.php?id=297 |archive-date=16 September 2016 }}</nowiki></code>
 Renders as:
-{{LibraryOfMu|mu-id=519 |title=Cape Wrath |author=[[K Foundation]] |date=8 December 1995 |publisher=[[The Guardian]] |archive-url=https://web.archive.org/web/20160916113827/http://www.libraryofmu.net/display-resource.php?id=519 |archive-date=16 September 2016}}
+{{LibraryOfMu|mu-id=297|last=Kelly|first=Danny|authorlink=Danny Kelly (journalist)|title=Welcome To The Sheep Seats|work=[[NME]]|date=29 February 1992|archive-url=https://web.archive.org/web/20160916111310/http://www.libraryofmu.net/display-resource.php?id=297 |archive-date=16 September 2016 }}
+=== Newspaper===
+<code><nowiki>{{LibraryOfMu|tl=news|mu-id=387|last=Reid, Jim|title=Money to burn|work=[[The Observer]]|date=25 September 1994|archive-url=https://web.archive.org/web/20160916120338/http://www.libraryofmu.net/display-resource.php?id=387 |archive-date=16 September 2016}}</nowiki></code>
+Renders as:
+{{LibraryOfMu|tl=news|mu-id=387|last=Reid, Jim|title=Money to burn|work=[[The Observer]]|date=25 September 1994|archive-url=https://web.archive.org/web/20160916120338/http://www.libraryofmu.net/display-resource.php?id=387 |archive-date=16 September 2016}}
+=== Web ===
+<code><nowiki>{{LibraryOfMu|tl=web|mu-id=500|last=Drummond|first=Bill|authorlink=Bill Drummond|date=October 1987|title=KLF Info Sheet Oct 1987|archive-url=https://web.archive.org/web/20070311225447/http://www.libraryofmu.org/display-resource.php?id=500 |archive-date=11 March 2007 }}</nowiki></code>
+Renders as:
+{{LibraryOfMu|tl=web|mu-id=500|last=Drummond|first=Bill|authorlink=Bill Drummond|date=October 1987|title=KLF Info Sheet Oct 1987|archive-url=https://web.archive.org/web/20070311225447/http://www.libraryofmu.org/display-resource.php?id=500 |archive-date=11 March 2007 }}
 ==List of library entries==
-The WikiProject has compiled a [[Wikipedia:WikiProject The KLF/LibraryOfMu|list of library records which have already been converted into references]] to make it easier to update/rescue old references, along with more detailed instructions. Please consult the list and if you rescue or add a reference to a library entry which is not already present, please add it to the list.
+The WikiProject has compiled a [[Wikipedia:WikiProject The KLF/LibraryOfMu|list of library records which have already been converted into references]] to make it easier to update/rescue old references (as you can just find the library id and copy the wikitext). The list also contains more detailed instructions. If you rescue or add a reference to a library entry which is not already present on the list, please add it to the list.
+==Making non-trivial changes to the template==
+To make non-trivial changes to the template, it is recommended to copy the text into a sandbox in userspace, and copy the text of [[Wikipedia:WikiProject The KLF/LibraryOfMu]] into another sandbox or the sandbox talk page. Temporarily change the text in the latter to use your sandboxed template instead of <code><nowiki>{{LibraryOfMu}}</nowiki></code>. Then you can test your changes by doing a dummy save of the library list and compare it to the live WikiProject list, to ensure you haven't broken any of the known existing uses. When done, copy your changes into the template and request deletion of the sandboxes by tagging them with {{tl|db-user}} (if you're not a sysop).
+==Reliable sources and verification==
+The magazine, newspaper or other publication the library has transcribed must be considered the source. Editors wishing to [[WP:V|verify]] a reference should refer to the original material.
+==Making a change to all instances of a library entry==
-==The Library of Mu==
+Sometimes it might be desirable to make a change to all instances of a library entry. For example:
-The Library of Mu is not itself a ''[[WP:RS|source]]''; it is an archive like archive.org. The magazine, newspaper or other publication the library has transcribed must be considered the source. Editors wishing to [[WP:V|verify]] a reference should refer to the original material.
+*A mistake has been found
+*An article author has become blue linked
+*An article is republished on the web by the original publisher so a link to archive.org is no longer needed