Template:TNGfamily/doc: Difference between revisions

From 'City of Adelaide' History and Genealogy Site
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 4: Line 4:
== Usage ==
== Usage ==


To get data from an external database, call the following:
To get data from the TNG external database, call the following:


<pre>{{TNGfamily|familyID|attribute}}</pre>
<pre>{{TNGfamily|familyID|attribute}}</pre>
Line 12: Line 12:
* '''''familyID''''' is the unique identification number for the family.
* '''''familyID''''' is the unique identification number for the family.
* '''''attribute''''' identifies the type of data and/or format to be retrieved. Available attributes:
* '''''attribute''''' identifies the type of data and/or format to be retrieved. Available attributes:
** '''''family''''' as in {{tld|TNGfamily|F188|family}} provides {{TNGfamily|F188|family}}.
** '''''family''''' as in {{tld|TNGfamily|F188|family}} provides:
** '''''familylink''''' as in {{tld|TNGfamily|F188|familylink}} provides {{TNGfamily|F188|familylink}}.
***{{TNGfamily|F188|family}}.
** '''''husband''''' as in {{tld|TNGfamily|F188|husband}} provides {{TNGfamily|F188|husband}}.
** '''''familylink''''' as in {{tld|TNGfamily|F188|familylink}} provides: {{TNGfamily|F188|familylink}}.
** '''''husbandname''''' as in {{tld|TNGfamily|F188|husbandname}} provides {{TNGfamily|F188|husbandname}}.
** '''''husband''''' as in {{tld|TNGfamily|F188|husband}} provides: {{TNGfamily|F188|husband}}.
** '''''husbandlink''''' as in {{tld|TNGfamily|F188|husbandlink}} provides {{TNGfamily|F188|husbandlink}}.
** '''''husbandname''''' as in {{tld|TNGfamily|F188|husbandname}} provides: {{TNGfamily|F188|husbandname}}.
** '''''husbandbio''''' as in {{tld|TNGfamily|F188|husbandbio}} provides {{TNGfamily|F188|husbandbio}}.
** '''''husbandlink''''' as in {{tld|TNGfamily|F188|husbandlink}} provides: {{TNGfamily|F188|husbandlink}}.
** '''''wife''''' as in {{tld|TNGfamily|F188|wife}} provides {{TNGfamily|F188|wife}}.
** '''''husbandbio''''' as in {{tld|TNGfamily|F188|husbandbio}} provides: {{TNGfamily|F188|husbandbio}}.
** '''''wifename''''' as in {{tld|TNGfamily|F188|wifename}} provides {{TNGfamily|F188|wifename}}.
** '''''wife''''' as in {{tld|TNGfamily|F188|wife}} provides: {{TNGfamily|F188|wife}}.
** '''''wifelink''''' as in {{tld|TNGfamily|F188|wifelink}} provides {{TNGfamily|F188|wifelink}}.
** '''''wifename''''' as in {{tld|TNGfamily|F188|wifename}} provides: {{TNGfamily|F188|wifename}}.
** '''''wifebio''''' as in {{tld|TNGfamily|F188|wifebio}} provides {{TNGfamily|F188|wifebio}}.
** '''''wifelink''''' as in {{tld|TNGfamily|F188|wifelink}} provides: {{TNGfamily|F188|wifelink}}.
** '''''marrdate''''' as in {{tld|TNGfamily|F188|marrdate}} provides {{TNGfamily|F188|marrdate}}.
** '''''wifebio''''' as in {{tld|TNGfamily|F188|wifebio}} provides: {{TNGfamily|F188|wifebio}}.
** '''''marrplace''''' as in {{tld|TNGfamily|F188|marrplace}} provides {{TNGfamily|F188|marrplace}}.
** '''''marrdate''''' as in {{tld|TNGfamily|F188|marrdate}} provides: {{TNGfamily|F188|marrdate}}.
** '''''biography''''' or '''''bio''''' (default) as in {{tld|TNGfamily|F188|bio}} or {{tld|TNGfamily|F188}} provides {{TNGfamily|F188|bio}} or {{TNGfamily|F188}}.
** '''''marrplace''''' as in {{tld|TNGfamily|F188|marrplace}} provides: {{TNGfamily|F188|marrplace}}.
** '''''biography''''' or '''''bio''''' (default) as in {{tld|TNGfamily|F188|bio}} or {{tld|TNGfamily|F188}} provides: {{TNGfamily|F188|bio}} or {{TNGfamily|F188}}.


<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||

Latest revision as of 00:51, 4 November 2014

{{#invoke:Message box|mbox}}

Usage

To get data from the TNG external database, call the following:

{{TNGfamily|familyID|attribute}}

An explanation of the fields:

  • familyID is the unique identification number for the family.
  • attribute identifies the type of data and/or format to be retrieved. Available attributes:
    • family as in {{TNGfamily|F188|family}} provides:
      • {{#record:TNGfamily/family|tngfid|familyID=F188}}.
    • familylink as in {{TNGfamily|F188|familylink}} provides: {{#record:TNGfamily/familylink|tngfid|familyID=F188}}.
    • husband as in {{TNGfamily|F188|husband}} provides: {{#record:TNGfamily/husband|tngfid|familyID=F188}}.
    • husbandname as in {{TNGfamily|F188|husbandname}} provides: {{#record:TNGfamily/husbandname|tngfid|familyID=F188}}.
    • husbandlink as in {{TNGfamily|F188|husbandlink}} provides: {{#record:TNGfamily/husbandlink|tngfid|familyID=F188}}.
    • husbandbio as in {{TNGfamily|F188|husbandbio}} provides: {{#record:TNGfamily/husbandbio|tngfid|familyID=F188}}.
    • wife as in {{TNGfamily|F188|wife}} provides: {{#record:TNGfamily/wife|tngfid|familyID=F188}}.
    • wifename as in {{TNGfamily|F188|wifename}} provides: {{#record:TNGfamily/wifename|tngfid|familyID=F188}}.
    • wifelink as in {{TNGfamily|F188|wifelink}} provides: {{#record:TNGfamily/wifelink|tngfid|familyID=F188}}.
    • wifebio as in {{TNGfamily|F188|wifebio}} provides: {{#record:TNGfamily/wifebio|tngfid|familyID=F188}}.
    • marrdate as in {{TNGfamily|F188|marrdate}} provides: {{#record:TNGfamily/marrdate|tngfid|familyID=F188}}.
    • marrplace as in {{TNGfamily|F188|marrplace}} provides: {{#record:TNGfamily/marrplace|tngfid|familyID=F188}}.
    • biography or bio (default) as in {{TNGfamily|F188|bio}} or {{TNGfamily|F188}} provides: {{#record:TNGfamily/biography|tngfid|familyID=F188}} or {{#record:TNGfamily/biography|tngfid|familyID=F188}}.