Template:OGL-attribution/doc

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

Requirements[edit]

The requirements of the copyright holder (the British Government) to copy text into a Wikipedia article from one of their documenters can be found in "About the Open Government Licence" and "About the Open Government Licence"

When using information, other than information and material created by you, cite what information you used, where it came from and what date it was published. You should also include a link to the information you used, if this is online, and a link to the licence, under which it was used.

"About the Open Government Licence" continues:

PSI Click-Use Licence

The Open Government Licence supersedes the PSI Click-Use Licence. Any information covered by Crown copyright that was available for re-use under the PSI Click-Use Licence may now be re-used under the OGL.

You can either use the information under your existing Click-Use Licence until it expires or choose to use the information under the terms of the OGL.

The Open Government Licence v1.0
The Open Government Licence v1.0 is a perpetual licence so any past and continuing use of information authorised under v1.0 may continue. The only exception to this would be if you breached the terms of that licence; this would result in it being terminated.

Information providers/licensors will specify which version of the Open Government Licence applies to their information as they make the transition to v2.0. The terms and conditions of the two versions are in essence the same with v2.0 only introducing a few refinements and clarifications.

This template will supply an attribution prescript to place in front of a standard formatted Wikipedia citation and three parameters to alter the visual look of that prescript. The requirement of the copyright holder to provide date and linking should be added with the use of a standard citation template of similar method as described below.

Usage[edit]

This template should be placed in the References section of an article if the article incorporates text under the British Government Open Government Licence, unless the inline parameter is specified in which case the template should be placed in an inline citation next to the copied text.

This template takes four optional parameters which can be combined together or used separately:

unnamed parameter[edit]

The name of the source, along with any other details which are needed to identify the work:

A text string can be passed as the parameter:

{{OGL-attribution|''War Office: Director of Artillery, later Director of Royal Artillery: Reports and Appreciations''in the National Archive (2009)}}

or a citation template, like {{cite web}} can be used:

{{OGL-attribution|{{cite web |author=National Archives |date=12 August 2009|url=http://discovery.nationalarchives.gov.uk/SearchUI/details?uri=C14403 |title=War Office: Director of Artillery, later Director of Royal Artillery: Reports and Appreciations |accessdate=August 10, 2016}} }}

These would display as:

This article incorporates text published under the British Open Government Licence: War Office: Director of Artillery, later Director of Royal Artillery: Reports and Appreciationsin the National Archive (2009)

This article incorporates text published under the British Open Government Licence: National Archives (12 August 2009). "War Office: Director of Artillery, later Director of Royal Artillery: Reports and Appreciations". Retrieved August 10, 2016.

noicon parameter[edit]

Turns off the icon display:

This article incorporates text published under the British Open Government Licence:

version parameter[edit]

Appends a the given version number with a leading "v" to prescript:

This article incorporates text published under the British Open Government Licence v2.0:

inline parameter[edit]

Changes the wording from "This article" to "One or more of the preceding sentences":

One or more of the preceding sentences incorporates text published under the British Open Government Licence:

Hidden category[edit]

This template includes a hidden category—Category:Open Government Licence attribution —which does not appear at the bottom of an article page but does contain any article page that contains this template.