Template:Individual data

From 'City of Adelaide' History and Genealogy Site
Jump to navigation Jump to search

This template contains various independently retrievable data items about [[{{{article|{{{1}}}}}}]] in the form of parameter values of a variable template of choice, in a standardized fashion. It is a member of a family of templates, those with names starting with "Data" in Category:Data templates. The system used is similar to that of Wikipedia:WikiProject Flag Template. The corresponding template of that project is Template:Country data .

Parameters

Do not use all these parameters for any one person. The list is long to cover a wide range of people. Only use those parameters that convey essential or notable information about the subject. The parameters highlighted in yellow provide the most functionality for the website and are the most important (but not critical). Any parameters left blank or omitted will not be displayed. If a data field has more than one parameter name which can be used, the preferred name is listed first in bold print.

Parameter Value Explanation
tng_person_id Is a genealogy code used to uniquely identify an individual such as "I159" for Edelsten, Frederick Alexander - I159. This code can only be allocated by an administrator. It is also the last part of template name, used to identify it within the family of templates.[1]
tng_family_id Is a genealogy code used to uniquely identify a family such as "F2001" for Bruce Family - F2001. This code can only be allocated by an administrator.
first_names First name(s) of person.
last_name Common last name of person (provide maiden_name or married_name (below) if different from last_name).
nationality Nationality.
travel_class First, Second, Steerage or leaving blank are only options. Leaving blank or omitted will not display this parameter.
maiden_name Birth name or maiden/nee name of person. For genealogy purposes on this website, it is normally preferred that the maiden name is used for the last_name above and so this parameter would be left blank.
married_name Married name if different from last_name. It is normally preferred for genealogy purposes on this website that the maiden name is used for last_name and so this field provides opportunity to capture married name.
gender Gender - either male or female.
hon_prefix {{{hon_prefix}}} To appear on the line above the person's name
hon_suffix {{{hon_suffix}}} To appear on the line below the person's name
image Pessoa_Neutra.png Image name: abc.jpg, xpz.png, 123.gif, etc. If an image is desired but not available, one may use Image:Replace this image male.png, Image:Replace this image female.png or other placeholder images, or just leave blank for no image to display.
image_size {{{image_size}}} Size to display image: 200px (set width), x300px (set height), or 200x300px (max width & max height). This defaults to frameless (default is 220px, but logged in users can change this by clicking on "my preferences" and adjusting thumbnail size) if empty or omitted. This parameter should not normally need to be set.
alt Alt text for image, for visually impaired readers. See WP:ALT.
caption Caption for image, if needed. Try to include date of photo and the photographer.
birth_date Date of birth: {{birth date and age|1930|1|15}} (if living) or {{birth date|1930|1|15}} (if dead). See Template:Birth date for details.
birth_place Place of birth: city, administrative region, sovereign state.
born_at_sea {{{born_at_sea}}} Any text entered here will be visible in the passenger's Infobox. Typical examples, yes or City of Adelaide (1873).
died_at_sea {{{died_at_sea}}} Any text entered here will be visible in the passenger's Infobox. Typical examples, yes or Fell overboard 17 June 1873.
death_date Date of death: {{death date and age|1995|10|9|1930|1|15}} (if birth date is known) or {{death date|1995|10|9}} (if birth date unknown). See Template:Death date for details.
death_cause Cause of death.
resting_place Mainly intended for recording passengers who have died at sea, but could alternatively be used to record place of burial, ash-scattering, etc.
rp_coords {{{rp_coords}}} Mainly intended for recording coordinates of burials at sea, but could also be used coordinates of place of burial, ash-scattering etc. Use {{coord}} template.
residence Location(s) where the person notably resides/resided, if different from birth place.
other_names Other notable names for the person, if different.
known_for A brief description of why the person is notable.
occupation Occupation.
title Multiple uses:
term Years the person held the title listed above.
predecessor Person who previously held the title listed above.
successor Person who subsequently held the title listed above.
religion If known, then religion is used by template to inject a Category:Religion category into page.
spouse Name of spouse(s), followed by years of marriage. Use the format Name (1950–present) for current spouse and Name (1970–1999) for former spouse(s). Separate entries with a line break (<br />). For deceased persons still married at time of death, close the date range with death year.
partner For unmarried life partners (of any gender or sexual preference), not business partners. Use same format as spouse.
children Number of children (i.e. 3), or list of names if notable, in which case, separate entries with a line break (<br />).
father Name of father.
mother Name of mother.
relatives {{{relatives}}} Names of siblings or other relatives. Include the relationship in parentheses after the name (sister, uncle, etc). Separate entries with a line break (<br />).
website Unlikely to be useful, but if there is a significant website relating to the person can be recorded here. Unofficial websites should be placed under ==External links== in the body of the article. Use {{Url}} as {{Url|www.example.com}}.
footnotes Notes about any of the infobox data.
port_embarked Name of the Port where the passenger embarked the City of Adelaide if different from voyage origin. For example, might be Plymouth for a voyage from London to Adelaide. Only use for passengers who have undertaken only one voyage on the City of Adelaide. Leaving blank or omitted will not display this parameter.
port_disembarked Name of the Port where the passenger disembarked the City of Adelaide if different from voyage destination. For example, might be Cape Town for a voyage from Adelaide to London. Only use for passengers who have undertaken only one voyage on the City of Adelaide. Leaving blank or omitted will not display this parameter.
rich_and_famous yes If the passenger might reasonably be considered to be either rich or famous, then set this parameter to yes.
logbook_mention yes If the passenger is mentioned in the ship's log book, then set this parameter to yes.
stowaway yes If the passenger was a stowaway, then set this parameter to yes.
voy_to_adl_1864 {{{voy_to_adl_1864}}} If the passenger was on the Voyage to Adelaide in 1864, then set this parameter to yes.
voy_to_lon_1865 {{{voy_to_lon_1865}}} . . .
voy_to_adl_1865 {{{voy_to_adl_1865}}} . . .
voy_to_lon_1866 {{{voy_to_lon_1866}}} . . .
voy_to_adl_1866 {{{voy_to_adl_1866}}} . . .
voy_to_lon_1867 {{{voy_to_lon_1867}}} . . .
voy_to_adl_1867 {{{voy_to_adl_1867}}} . . .
voy_to_lon_1868 {{{voy_to_lon_1868}}} . . .
voy_to_adl_1868 {{{voy_to_adl_1868}}} . . .
voy_to_lon_1869 {{{voy_to_lon_1869}}} . . .
voy_to_adl_1869 {{{voy_to_adl_1869}}} . . .
voy_to_lon_1870 {{{voy_to_lon_1870}}} . . .
voy_to_adl_1870 {{{voy_to_adl_1870}}} . . .
voy_to_lon_1871 {{{voy_to_lon_1871}}} . . .
voy_to_adl_1871 {{{voy_to_adl_1871}}} . . .
voy_to_lon_1872 {{{voy_to_lon_1872}}} . . .
voy_to_adl_1872 {{{voy_to_adl_1872}}} . . .
voy_to_lon_1873 {{{voy_to_lon_1873}}} . . .
voy_to_adl_1873 {{{voy_to_adl_1873}}} . . .
voy_to_lon_1874 {{{voy_to_lon_1874}}} . . .
voy_to_adl_1874 {{{voy_to_adl_1874}}} . . .
voy_to_lon_1875 {{{voy_to_lon_1875}}} . . .
voy_to_adl_1875 {{{voy_to_adl_1875}}} . . .
voy_to_lon_1876 {{{voy_to_lon_1876}}} . . .
voy_to_adl_1876 {{{voy_to_adl_1876}}} . . .
voy_to_lon_1877 {{{voy_to_lon_1877}}} . . .
voy_to_adl_1877 {{{voy_to_adl_1877}}} . . .
voy_to_lon_1878 {{{voy_to_lon_1878}}} . . .
voy_to_adl_1878 {{{voy_to_adl_1878}}} . . .
voy_to_lon_1879 {{{voy_to_lon_1879}}} . . .
voy_to_adl_1879 {{{voy_to_adl_1879}}} . . .
voy_to_lon_1880 {{{voy_to_lon_1880}}} . . .
voy_to_adl_1880 {{{voy_to_adl_1880}}} . . .
voy_to_lon_1881 {{{voy_to_lon_1881}}} . . .
voy_to_adl_1881 {{{voy_to_adl_1881}}} . . .
voy_to_lon_1882 {{{voy_to_lon_1882}}} . . .
voy_to_adl_1882 {{{voy_to_adl_1882}}} . . .
voy_to_lon_1883 {{{voy_to_lon_1883}}} . . .
voy_to_adl_1883 {{{voy_to_adl_1883}}} . . .
voy_to_lon_1884 {{{voy_to_lon_1884}}} . . .
voy_to_adl_1884 {{{voy_to_adl_1884}}} . . .
voy_to_lon_1885 {{{voy_to_lon_1885}}} . . .
voy_to_adl_1885 {{{voy_to_adl_1885}}} . . .
voy_to_lon_1886 {{{voy_to_lon_1886}}} . . .
voy_to_adl_1886 {{{voy_to_adl_1886}}} . . .
voy_to_lon_1887 {{{voy_to_lon_1887}}} If the passenger was on the Voyage to London in 1887, then set this parameter to yes.

Throughout the family of templates, fixed names are used for the parameters. (The parameter names are kept short to reduce counts for the post expand include size and the template argument size in cases where these are applicable.) However, not necessarily all parameters have been given a value: some parameters may not be applicable, while for some other parameters the value may just have not been specified yet. The table shows all parameters, and for each the value, if specified.


Related data templates

Derived data

Retrieval of data items

{{data |pst2|land area}}, using parameter selection template Template:Pst2, gives the parameter land area, etc.

For retrieval of more data items it is more efficient to prepare a template for that, to be used as follows:

{{data |template name|..|..|..|..}}

so that this data template needs to be called only once.[2] The default template is Template:Show data individuals, producing this page.

The four parameters are optional, they are passed on to the prepared template as parameters 2-5.

Special templates:

A parameter being undefined or empty typically means the same, see below. {{data ..|pst2|..}} gives the empty string and the text "{{{..}}}", respectively. Therefore an application checking the parameter has to check both. Checking whether a result is equal to e.g. the text "{{{popinc}}}" cannot be done directly with #ifeq in a template which itself has also a parameter with that name, because if that is defined, there would be a comparison with the value instead of the text itself. Instead, it can be checked whether the first character of the result is "{", e.g.: {{#ifeq:{{padleft:|1|{{data {{{continent}}}|pst2|popinc}}}}|{|..|..}}.

Creating new data templates

Template:Data individuals/preload can be used to create new data templates. On the page of the data template of a province, if there is no data template yet for the country, a link appears to create that, preloading this template. Otherwise the wikitext can be copied to the new data template. For parameters which are not applicable, such as country for a country, the parameter definition "country=" can be deleted. For parameters to be filled in later the parameter definition like "popinc=" (specifying the empty string as value) can be left in the wikitext to be filled in later. Do not forget parameter 1.

Efficiency

In this template system each template contains various properties of a single entity, as opposed to the other common system, where a template contains one property (e.g. population or area) of many entities. Although that other system can be convenient if updates of a property for all these entities become available together, in the case of large-scale use of data on one page that other system can be problematic due to its inefficiency. This is because of the following:

  • There are often more entities than properties, and page counts (or in the case of #switch, average page counts) are proportional to the number of data items in the data template (if they are stored in a linear way, not in a tree, and not stored as unnamed parameters).
  • In the case of large-scale use of data on one page there are usually one or more tables, where an entity forms a row and a property a column, because there are often more entities than properties, and because this way the sorting feature allows sorting entities based on a property. In this template system this allows producing a row with only one call of the data template, making the count not grow faster than proportional to the average number of data items stored per data template, times the number of entities in the table.

The include part of the data template of an entity does not contain a long list of its sub-entities or their properties, because that would make this method inefficient too.

Notes

  1. It may seem odd, but a template cannot retrieve its own name (PAGENAME only provides this on the template page itself), and even if it could, a string operation would be needed to remove "Data ". Putting the name of the entity in the data template removes the need to supply it as a parameter when the data template is called (in the cases that it would need this name).
  2. See the first two rows of the first table in w:Help:Array#Summary of counts for template limits.

Until here the documentation is automatically generated by Template:Individual showdata.


References