Difference between revisions of "Template:Cite Earth Impact DB/doc"
imported>CharlesGillingham (Subcategorizing. This is not a "general purpose" citation template and is more similar to other templates in "Specific-source citation templates".) |
imported>Izno (add a cat) |
||
| (6 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{esoteric}} | {{esoteric}} | ||
| − | <!-- PLEASE ADD CATEGORIES | + | <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE --> |
__NOTOC__ | __NOTOC__ | ||
=== Purpose === | === Purpose === | ||
| Line 12: | Line 12: | ||
=== Usage === | === Usage === | ||
{| class="wikitable" | {| class="wikitable" | ||
| − | |- width="50% | + | |- width="50%" style="vertical-align:top;" |
! Parameter !! Instructions | ! Parameter !! Instructions | ||
| − | |- width="50% | + | |- width="50%" style="vertical-align:top;" |
| style="vertical-align:top;padding:1ex;" |<pre> | | style="vertical-align:top;padding:1ex;" |<pre> | ||
{{cite Earth Impact DB | {{cite Earth Impact DB | ||
| Line 30: | Line 30: | ||
Full retrieval date {Optional) | Full retrieval date {Optional) | ||
1 (Optional, omits category) | 1 (Optional, omits category) | ||
| − | alternate name to match EID URL (Sometimes required - when | + | alternate name to match EID URL (Sometimes required - when crater name doesn't match URL file name) |
html (Sometimes required - when .html suffix is used on a URL) | html (Sometimes required - when .html suffix is used on a URL) | ||
</pre> | </pre> | ||
| Line 38: | Line 38: | ||
If the link isn't correct, follow these notes until the generated URL matches the page at the Earth Impact Database. | If the link isn't correct, follow these notes until the generated URL matches the page at the Earth Impact Database. | ||
| − | * The '''name''' parameter should be the name of the crater. Use the page title from Earth Impact Database. For example, on a page named "xxx crater", use "name = xxx" | + | * The '''name''' parameter should be the name of the crater. Use the page title from Earth Impact Database. For example, on a page named "xxx crater", use "name = xxx". This won't always work since some page names are abbreviations. Also, multiple word names won't work. When the URL generation doesn't work for a particular page, use the linkname parameter to make it work. |
| − | * Use the '''linkname''' parameter to match the base name of the URL. That's the file name without the '.htm' or '.html' suffix. For example, with the [[Amelia Creek crater]], the linkname has to be set to "AmeliaCreek" to make the correct URL. | + | * Use the '''linkname''' parameter to match the base name of the URL. That's the file name without the '.htm' or '.html' suffix. For multiple word names, use a single word made out of the name without spaces. For example, with the [[Amelia Creek crater]], the linkname has to be set to "AmeliaCreek" to make the correct URL. |
* If the filename suffix in the URL is anything but 'htm', then use the '''suffix''' parameter to set that. (Omit the leading dot from this string.) For example, with the Amelia Creek crater again, the suffix has to be set to "html" to make the correct URL. | * If the filename suffix in the URL is anything but 'htm', then use the '''suffix''' parameter to set that. (Omit the leading dot from this string.) For example, with the Amelia Creek crater again, the suffix has to be set to "html" to make the correct URL. | ||
=== Examples === | === Examples === | ||
| − | < | + | <nowiki>{{Cite Earth Impact DB | name = Barringer | accessdate =</nowiki> {{date|2=ISO}}<nowiki>}}</nowiki> |
produces: | produces: | ||
| − | {{Cite Earth Impact DB | name = Barringer | accessdate = | + | {{Cite Earth Impact DB | name = Barringer | accessdate = {{date|2=ISO}} | nocat = 1 }} <!-- use nocat parameter so template doc page won't be added to category --> |
=== See also === | === See also === | ||
| Line 53: | Line 53: | ||
* [[List of impact craters on Earth]] | * [[List of impact craters on Earth]] | ||
| − | <includeonly> | + | <includeonly>{{Sandbox other|| |
| − | |||
[[Category:Specific-source templates]] | [[Category:Specific-source templates]] | ||
| − | </includeonly> | + | [[Category:Geology citation templates]] |
| + | [[Category:Templates that add a category]] | ||
| + | |||
| + | }}</includeonly> | ||
Latest revision as of 01:13, 12 September 2020
| 40px | This is a documentation subpage for Template:Cite Earth Impact DB. It contains usage information, categories and other content that is not part of the original template page. |
| 40x40px | This template employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, or your user space before changing anything here. |
Purpose
Provides an easy way to cite Earth Impact Database data.
The major advantage of this template is that the appearance of the citation will change to conform with {{Cite web}} which sees more frequent maintenance.
Pages using this template will automatically be added to Category:Earth Impact Database unless they use the nocat parameter.
Usage
| Parameter | Instructions |
|---|---|
{{cite Earth Impact DB
| name =
| date =
| accessdate =
| nocat =
| linkname =
| suffix =
}}
|
crater name from EID (Required)
Date of publication (Recommended)
Full retrieval date {Optional)
1 (Optional, omits category)
alternate name to match EID URL (Sometimes required - when crater name doesn't match URL file name)
html (Sometimes required - when .html suffix is used on a URL)
|
The best procedure is to edit the entire page rather than just a section. The Earth Impact Database is inconsistent about naming pages so the links generated by this template will need to be verified and sometimes adjusted. Check the link in the page preview.
If the link isn't correct, follow these notes until the generated URL matches the page at the Earth Impact Database.
- The name parameter should be the name of the crater. Use the page title from Earth Impact Database. For example, on a page named "xxx crater", use "name = xxx". This won't always work since some page names are abbreviations. Also, multiple word names won't work. When the URL generation doesn't work for a particular page, use the linkname parameter to make it work.
- Use the linkname parameter to match the base name of the URL. That's the file name without the '.htm' or '.html' suffix. For multiple word names, use a single word made out of the name without spaces. For example, with the Amelia Creek crater, the linkname has to be set to "AmeliaCreek" to make the correct URL.
- If the filename suffix in the URL is anything but 'htm', then use the suffix parameter to set that. (Omit the leading dot from this string.) For example, with the Amelia Creek crater again, the suffix has to be set to "html" to make the correct URL.
Examples
{{Cite Earth Impact DB | name = Barringer | accessdate = 2026-03-19}}
produces:
"Barringer". Earth Impact Database. Planetary and Space Science Centre University of New Brunswick Fredericton. Retrieved 2026-03-19.
See also