User:GiFontenelle/Info/Archive/doc
This is a documentation subpage for User:GiFontenelle/Info/Archive. It may contain usage information, categories and other content that is not part of the original user template page. |
This template uses Lua: |
Usage
[edit]{{{native_name}}} | |
[[File:{{{logo}}}|frameless|alt={{{logo_alt}}}|upright={{{logo_upright}}}]] | |
[[File:{{{image}}}|frameless|alt={{{alt}}}|upright={{{image_upright}}}]] | |
Established | {{{established}}} |
---|---|
Dissolved | {{{dissolved}}} |
Coordinates | {{{coordinates}}} |
Type | {{{type}}} |
Heritage designation | {{{type}}} |
Part of | {{{type}}} |
Has part | {{{type}}} |
Field of work | {{{type}}} |
Collection | {{{type}}} |
Collection size | {{{type}}} |
Visitors | {{{type}}} |
Founder | {{{type}}} |
Chairperson | {{{type}}} |
Director | {{{director}}} |
Owned by | {{{director}}} |
{{Infobox archive/{{{network}}} network|header}} | |
{{Infobox archive/{{{network}}} network|data}} | |
{{{nrhp}}} | |
Just add:
{{Infobox archive}}
to the top of an article, and data will be automatically included from Wikidata where they are available. These values can be overridden by passing values to the relevant parameters in the article (if need be), e.g.:
{{infobox archive | name = }}
Parameters
[edit]The full list of parameters is:
Parameter | Default | Description |
---|---|---|
suppressfields | — | Give a list of parameter names to suppress fetching them from Wikidata |
refs | no | Set to yes to show references from Wikidata |
name | Wikidata label (en) (Or Page name) |
Name of the archive |
native_name | native label (P1705) | Name of the archive in the local language, if different |
native_name_lang | native language (P103) | ISO 639-2 code for the local language, e.g. "fr" for French. If there is more than one native name, in different languages, enter those names using {{lang}}, instead. |
logo | logo image (P154) | Logo or graphic by which the archive is identified, omitting the wikilink brackets and the "file:" or "image:" namespace Example: Archives-Nationales-01.jpg |
logo_upright | Logo scaling factor | |
logo_alt | Alt text for the logo, for people who can't see the image | |
logo_caption | Caption for the logo | |
image | image (P18) | Image of the archive, omitting the wikilink brackets and the "file:" or "image:" namespace Example: Archives-Nationales-01.jpg |
image_upright | Image scaling factor | |
caption | media legend (P2096) | Image caption |
alt | Alt text for image, for people who can't see the image | |
map_type | The name of the map template used to construct location map, see Template:Location map#Available map templates Example: USA Alabama. | |
map_relief | Set this to y or any non-blank value to use a relief map image provided by the selected location map template (if a relief map is available). For additional information, see Template:Location map#Relief parameter.
| |
map_size | Specify a pixel width for the map image. The default is 220. Example: map_size=230 (not map_size=230px ).
| |
map_caption | Text displayed below the map image. Example: FooTown | |
coordinates | coordinate location (P625) | Latitude and longitude. Use {{Coord}}; see that template's documentation for usage information. |
former_name | Previous name(s) | |
established | inception (P571) | Date of the archive's establishment. Use {{Start date}}. Example: {{Start date|1997|03|31}} |
dissolved | If defunct, date the archive was dissolved. Use {{End date}}. Example: {{End date|2007|12|31}} | |
location | Location of the archive Example: [[Brazilian National Archives]], [[Rio de Janeiro]], [[Brazil]] Example: [[Brazilian National Archives]], [[Rio de Janeiro]], [[Brazil]] | |
type | instance of (P31) | Archives by type, most likely National Archive, State archive, Online archive or similar Example: [[National Archive]] |
heritage designation | Heritage designation Example: [[National historic site of Canada]] | |
part of | The holdings the archive is part of Example: [[Ministry of Justice of Brazil]] | |
has part | If the archive is part of a archive network, specify the network name to invoke one of the network templates. | |
field of work | Field of work Example: [[Online Archives]] | |
collections | Collections Example: [[Books]] Example: [[Documents]] Example: [[Photographs]] | |
collection_size | Number of objects | |
area | area (P2046) | The area of the archive |
visitors | Number of visitors Example: 417,096 (2005) | |
founder | The archive's founder Example: [[Neide De Sordi]] | |
chairperson | Alternative to "director" above | |
director | director / manager (P1037) | The archive's director Example: [[Neide De Sordi]] |
owned by | The owner of the archive Example: [[Ministry of Justice of Brazil]] | |
maintained by | The maintainer of the archive Example: [[Ministry of Justice of Brazil]] | |
website | official website (P856) | Official or primary website operated by the archive. Use the template {{URL}}. Example: {{URL|example.org}} |
embedded | — | Pass another infobox as a child template of this one |
locmapin | — | Show location map? Normally it is auto-created from Wikidata if both the coordinate and country are set. Use nomap=True to disable showing any map using info from Wikidata. |
refs | no | Set to 'yes' to show references from Wikidata |
noicon | — | Set to 'no' to hide the Wikidata edit link icons |
Microformat
[edit]The HTML markup produced by this template includes an hCard microformat, which makes the place-name and location parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to an address book. Within the hCard is a Geo microformat, which additionally makes the coordinates (latitude & longitude) parsable, so that they can be, say, looked up on a map, or downloaded to a GPS unit. For more information about the use of microformats on Wikipedia, please see the microformat project.
Sub-templates
[edit]If the place or venue has "established", "founded", "opened" or similar dates, use {{start date}} for the earliest of those dates unless the date is before 1583 CE.
If it has a URL, use {{URL}}.
Please do not remove instances of these sub-templates.
Classes
[edit]hCard uses HTML classes including:
- adr
- agent
- category
- county-name
- extended-address
- fn
- label
- locality
- nickname
- note
- org
- region
- street-address
- uid
- url
- vcard
Geo is produced by calling {{coord}}, and uses HTML classes:
- geo
- latitude
- longitude
Please do not rename or remove these classes nor collapse nested elements which use them.
Precision
[edit]When giving coordinates, please use an appropriate level of precision. Do not use {{coord}}'s |name=
parameter.
TemplateData
[edit]TemplateData for GiFontenelle/Info/Archive
An infobox for archives
Parameter | Description | Type | Status | |
---|---|---|---|---|
Name | name | Name of the archive
| Line | suggested |
Native name | native_name | Name of the archive in the local language, if different | Line | optional |
Native name language | native_name_lang | The language of the native name | Line | optional |
Logo | logo | Logo or graphic by which the archive is identified
| File | suggested |
Logo upright | logo_upright | Logo scaling factor | Number | optional |
Logo alt text | logo_alt | Alt text for the logo, for people who can't see the image | Unknown | optional |
Logo caption | logo_caption | The caption for the logo | String | optional |
Image | image | An image of the archive
| File | suggested |
Image upright | image_upright | Scaling factor for the image | Number | optional |
Image caption | caption | A caption for the image | String | optional |
Image alt text | alt | Alt text for image, for people who can't see the image | String | optional |
Map type | map_type pushpin_map | The name of the map template used to construct location map, see [[Template:Location map#Available map templates]]
| Line | suggested |
Map caption | map_caption | Text displayed below the map image, if latitude and longitude are used
| Line | optional |
Map size | map_size | Specify a pixel width for the map image
| Number | optional |
Show map relief | map_relief pushpin_relief | Set this to y or any non-blank value to use a relief map image provided by the selected location map template (if a relief map is available). For additional information, see [[Template:Location map#Relief parameter]] | Boolean | optional |
Former name | former_name | Previous name(s) | Line | suggested |
Established | established | Date of establishment, using {{Start date}}
| Template | suggested |
Dissolved | dissolved | If defunct, date the archive was dissolved. Use {{End date}}
| Template | optional |
Location | location | Location of the archive
| Line | suggested |
Coordinates | coordinates | Alternative to other coordinates parameters, taking {{Coord}} as a single value
| Template | optional |
Type | type | Type of archive, most likely National Archive, State Archive, Online Archive
| Line | suggested |
Heritage designation | heritage_designation | no description
| Line | optional |
Has part | part_of | no description
| Line | optional |
Part of | has_part | no description
| Line | optional |
Field of work | field_of_work | Important holdings
| Line | optional |
Collections | collections | The types of collections held by the archive
| String | optional |
Collection size | collection_size collection size collection | Number of objects
| Number | optional |
Visitors | visitors | Number of visitors
| Line | optional |
Founder | founder | The archive's founder
| Line | optional |
Chairperson | chairperson | The archive's chair or president | Line | optional |
Director | director | The archive's director | Line | optional |
Owned by | owned_by | The owner of the archive
| Line | optional |
maintained by | maintained_by | The maintainer of the archive
| Line | optional |
Website | website | Official or primary website operated by the archive. Use the template {{URL}}.
| Template | suggested |
Network | network | If the archive is part of a archive network, specify the network name to invoke one of the [https://en.wikipedia.org/w/index.php?title=Special%3APrefixIndex&prefix=Infobox+archive&namespace=10 network templates] | Line | optional |
nrhp | nrhp | no description | Unknown | optional |
embedded | embedded | no description | Unknown | optional |
Tracking category
[edit]