Difference between revisions of "Template:Cite NSW SHR/doc"
imported>Rangasyd m (→Optional parameters: 01849) |
imported>Kerry Raymond (changing documentation to reflect what it actually does and how we would like people to actually use it) |
||
| Line 5: | Line 5: | ||
This template creates a {{tl|cite web}} citation to [[New South Wales State Heritage Register]] and the [[Office of Environment and Heritage (New South Wales)|Heritage Office]] on the [http://www.environment.nsw.gov.au/heritageapp/ ''State Heritage Inventory''], a searchable reference source on the heritage places of [[New South Wales]], [[Australia]]. | This template creates a {{tl|cite web}} citation to [[New South Wales State Heritage Register]] and the [[Office of Environment and Heritage (New South Wales)|Heritage Office]] on the [http://www.environment.nsw.gov.au/heritageapp/ ''State Heritage Inventory''], a searchable reference source on the heritage places of [[New South Wales]], [[Australia]]. | ||
| − | <nowiki>{{cite NSW SHR | + | There is no error checking. Specifying an incorrect ID will result in a link to a non-existing record. |
| + | <!--<nowiki>{{cite NSW SHR | ||
| "database id" | | "database id" | ||
| "title" | | "title" | ||
| − | | | + | | hr = "State Heritage Register (SHR) number" |
| − | | | + | | fn = "New South Wales State Heritage Register (NSW SHR) File number" (optional) |
| − | | accessdate = </nowiki>{{ | + | | accessdate = </nowiki>{{CURRENTDAY}} {{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki> |
| − | }}</nowiki> | + | }}</nowiki>--> |
| − | There is | + | ==Parameters== |
| + | There are two mandatory unnamed parameters and one mandatory named parameter | ||
| + | * Place ID number. It is found at the end of the URL. | ||
| + | * A title. If empty it defaults to BASEPAGENAME. | ||
| + | * '''hr''': State Heritage Register (SHR) number | ||
| − | + | The optional parameters are: | |
| − | + | * The New South Wales State Heritage Register (NSW SHR) File number can be specified using the optional <code>fn</code> field (currently not displayed) | |
| − | + | * In addition, the access date can be specified using the {{para|accessdate}} parameter. | |
| − | |||
===Example=== | ===Example=== | ||
For example, the [[Sydney Conservatorium of Music]] record can be referenced using | For example, the [[Sydney Conservatorium of Music]] record can be referenced using | ||
| − | <code><nowiki>{{cite NSW SHR|5060991|Conservatorium of Music}}</nowiki></code> | + | <code><nowiki>{{cite NSW SHR|5060991|Conservatorium of Music|hr=01849|accessdate=3 November 2018}}</nowiki></code> |
resulting in: | resulting in: | ||
| − | + | {{cite NSW SHR|5060991|Conservatorium of Music|hr=01849|accessdate=3 November 2018}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | {{cite NSW SHR|5060991|Conservatorium of Music|hr | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | ==Harvard style referencing== | + | <!--==Harvard style referencing== |
| − | This template provides a simple Harvard style reference, using SHR followed by the ID number. For example, to reference the Conservatorium of Music, use {{tl2|sfn|SHR5060991}} or {{tl2|harvnb|SHR5060991}}, as appropriate. Year referencing is not supported at this time. | + | This template provides a simple Harvard style reference, using SHR followed by the ID number. For example, to reference the Conservatorium of Music, use {{tl2|sfn|SHR5060991}} or {{tl2|harvnb|SHR5060991}}, as appropriate. Year referencing is not supported at this time.--> |
<includeonly> | <includeonly> | ||
{{DEFAULTSORT:NSW SHR}} | {{DEFAULTSORT:NSW SHR}} | ||
Revision as of 09:00, 3 November 2018
| This is a documentation subpage for Template:Cite NSW SHR. It contains usage information, categories and other content that is not part of the original template page. |
| This template is a Citation Style 1 wrapper template based on {{Cite web}}. For centralised Citation Style 1 discussions, see Help talk:Citation Style 1. |
Usage
This template creates a {{cite web}} citation to New South Wales State Heritage Register and the Heritage Office on the State Heritage Inventory, a searchable reference source on the heritage places of New South Wales, Australia.
There is no error checking. Specifying an incorrect ID will result in a link to a non-existing record.
Parameters
There are two mandatory unnamed parameters and one mandatory named parameter
- Place ID number. It is found at the end of the URL.
- A title. If empty it defaults to BASEPAGENAME.
- hr: State Heritage Register (SHR) number
The optional parameters are:
- The New South Wales State Heritage Register (NSW SHR) File number can be specified using the optional
fnfield (currently not displayed) - In addition, the access date can be specified using the
|accessdate=parameter.
Example
For example, the Sydney Conservatorium of Music record can be referenced using
{{cite NSW SHR|5060991|Conservatorium of Music|hr=01849|accessdate=3 November 2018}}
resulting in:
"Conservatorium of Music". New South Wales State Heritage Register. Office of Environment and Heritage. H01849. Retrieved 3 November 2018.