Difference between revisions of "Template:Infobox UK legislation/doc"
imported>Human. (order) |
imported>Human. (TemplateData order of params) |
||
| Line 153: | Line 153: | ||
<templatedata> | <templatedata> | ||
{ | { | ||
| − | + | "description": "An infobox for UK statute legislation.", | |
| − | + | "params": { | |
| − | + | "short_title": { | |
| − | + | "label": "Short title", | |
| − | + | "description": "The short title of the legislation, displayed at the top of the infobox. This will usually be the same as the article title.", | |
| − | + | "type": "string", | |
| − | + | "default": "{{PAGENAME}}", | |
| − | + | "suggested": true | |
| − | + | }, | |
| − | + | "type": { | |
| − | + | "label": "Type", | |
| − | + | "description": "The type of legislation, whether an Act or Statutory Instrument. Displays as a subheading at the top of the infobox.", | |
| − | + | "type": "string" | |
| − | + | }, | |
| − | + | "parliament": { | |
| − | + | "description": "The name of the parliament which made the legislation. This will be linked. This parameter will also affect which coat of arms is displayed. Valid values:\n:* \"Scottish Parliament\", for the devolved Parliament\n:* \"Northern Ireland Assembly\", for the devolved Assembly\n:* \"National Assembly for Wales\", for the devolved Assembly\n:* \"Parliament of Northern Ireland\", for the 1921–72 Parliament\n:* \"Parliament of Scotland\", for the pre-Union Parliament\n:* \"Parliament of Ireland\", for the pre-Union Parliament\n:* \"Parliament of England\", for the pre-1707 Parliament\n:* \"Parliament of Great Britain\" (1707–1800)\n Any other value (including a missing value) will denote the post-1801 Parliament of the United Kingdom in Westminster", | |
| − | + | "type": "wiki-page-name", | |
| − | + | "default": "Parliament of the United Kingdom", | |
| − | + | "suggested": true | |
| − | + | }, | |
| − | + | "long_title": { | |
| − | + | "label": "Long title", | |
| − | + | "description": "The long title of the legislation. Some are extremely long and can clutter up the infobox.", | |
| − | + | "type": "string" | |
| − | + | }, | |
| − | + | "year": { | |
| − | + | "description": "The (calendar) year of the legislation — along with \"parliament\", this parameter affects the coat of arms to be displayed.", | |
| − | + | "type": "number", | |
| − | + | "suggested": true | |
| − | + | }, | |
| − | + | "citation": { | |
| − | + | "label": "Statute book chapter", | |
| − | + | "description": "The chapter within the statute book where the legislation is to be found. Where this is before 1963, it must use the regnal year, not the calendar year; see [[Citation of United Kingdom legislation#Acts of Parliament]].", | |
| − | + | "type": "string" | |
| − | + | }, | |
| − | + | "introduced_by": { | |
| − | + | "label": "Introduced by", | |
| − | + | "description": "Who first introduced the legislation into parliament? This could be a link to an individual politician, or a political party if you do not know the individual. One could also mention whether it was a government-supported bill or a private member's bill. \n Retained for compatibility purposes and for Scottish, Welsh and NI Assembly Acts. For legislation passed by the UK parliament, where possible you should use either introduced_commons or introduced_lords.", | |
| − | + | "type": "content", | |
| − | + | "deprecated": "Retained for compatibility purposes, but where possible you should use either introduced_commons or introduced_lords." | |
| − | + | }, | |
| − | + | "introduced_commons": { | |
| − | + | "description": "Who first introduced the legislation into the House of Commons. This could be a link to an individual politician, or a political party if you do not know the individual. One could also mention whether it was a government-supported bill or a private member's bill.", | |
| − | + | "type": "content", | |
| − | + | "suggested": true | |
| − | + | }, | |
| − | + | "introduced_lords": { | |
| − | + | "description": "Who first introduced the legislation into the House of Lords. This could be a link to an individual politician, or a political party if you do not know the individual. One could also mention whether it was a government-supported bill or a private member's bill.", | |
| − | + | "type": "content", | |
| − | + | "suggested": true | |
| − | + | }, | |
| − | + | "territorial_extent": { | |
| − | + | "label": "Territorial extent", | |
| − | + | "description": "The part(s) of the United Kingdom to which the act extends.", | |
| − | + | "type": "wiki-page-name" | |
| − | + | }, | |
| − | + | "si_made_date": { | |
| − | + | "label": "Date made", | |
| − | + | "description": "The date a Statutory Instrument was made.", | |
| − | + | "type": "date" | |
| − | + | }, | |
| − | + | "si_laid_date": { | |
| − | + | "label": "Date laid before Parliament", | |
| − | + | "description": "The date a Statutory Instrument was laid before Parliament.", | |
| − | + | "type": "date" | |
| − | + | }, | |
| − | + | "royal_assent": { | |
| − | + | "label": "Royal Assent", | |
| − | + | "description": "The date the legislation received Royal Assent (only applicable in Commonwealth countries, other users may wish to copy and modify the template).", | |
| − | + | "type": "date" | |
| − | + | }, | |
| − | + | "commencement": { | |
| − | + | "description": "The date(s) at which the legislation was brought into force (but note that for acts with more than three or four commencement dates this is inappropriate to use).", | |
| − | + | "type": "content" | |
| − | + | }, | |
| − | + | "amends": { | |
| − | + | "label": "Amends", | |
| − | + | "description": "Earlier legislation that is amended by this piece of legislation.", | |
| − | + | "type": "date" | |
| − | + | }, | |
| − | + | "replaces": { | |
| − | + | "label": "Replaces", | |
| − | + | "description": "Earlier legislation that is replaced by this piece of legislation.", | |
| − | + | "type": "date" | |
| − | + | }, | |
| − | + | "primary_legislation": { | |
| − | + | "description": "The primary legislation secondary legislation is made under.", | |
| − | + | "type": "content", | |
| − | + | "label": "Primary legislation" | |
| − | + | }, | |
| − | + | "eu_directives": { | |
| − | + | "label": "EU directives", | |
| − | + | "description": "The EU directives this legislation transposes.", | |
| − | + | "type": "content" | |
| − | + | }, | |
| − | + | "amendments": { | |
| − | + | "description": "Internal links to amending or repealing legislation, or even a list of years in which the legislation has been modified (note that for acts with a great deal of amending or repealing legislation only the most significant pieces of legislation should be listed).", | |
| − | + | "type": "content" | |
| − | + | }, | |
| − | + | "related_legislation": { | |
| − | + | "label": "Related legislation", | |
| − | + | "description": "Internal links to related legislation", | |
| − | + | "type": "content" | |
| − | + | }, | |
| − | + | "repealing_legislation": { | |
| − | + | "label": "Repealing legislation", | |
| − | + | "description": "Internal links to legislation repealing this statute.", | |
| − | + | "type": "content" | |
| − | + | }, | |
| − | + | "status": { | |
| − | + | "description": "This can be one of eight values:\n* \"Current\" (for legislation still in force)\n* \"Amended\" (for legislation which has been modified by separate legislation)\n* \"Spent\" (for legislation exhausted in operation by the accomplishment of the purposes for which it was enacted)\n* \"Repealed\" (for legislation which has been repealed, or is no longer in force)\n* \"partially_repealed\" (for legislation which has only been partially repealed, but some sections are still in force)\n* \"Not_yet_in_force\" (for legislation which has not been commenced yet)\n* \"Not_fully_in_force\" (for legislation which has been partially commenced\n* \"Not_passed\" (for bills that have not been enacted). This defaults to \"Unknown\" if an illegal value is entered. The text area is colour-coded.", | |
| − | + | "default": "Unknown", | |
| − | + | "type": "string" | |
| − | + | }, | |
| − | + | "original_text": { | |
| − | + | "label": "Original text", | |
| − | + | "description": "External link to the text of the legislation as originally enacted.", | |
| − | + | "type": "string" | |
| − | + | }, | |
| − | + | "legislation_history": { | |
| − | + | "label": "Legislation history", | |
| − | + | "description": "External link to information about the passage of the legislation through the legislature.", | |
| − | + | "type": "string" | |
| − | + | }, | |
| − | + | "revised_text": { | |
| − | + | "label": "Revised text link", | |
| − | + | "description": "External link to the revised text of the statute, as amended", | |
| − | + | "type": "string" | |
| − | + | }, | |
| − | + | "theyworkforyou": { | |
| − | + | "label": "TWFY URL slug", | |
| − | + | "description": "URL slug for TheyWorkForYou link", | |
| − | + | "type": "string" | |
| − | + | }, | |
| − | + | "millbankhansard": { | |
| − | + | "label": "Hansard URL slug", | |
| − | + | "description": "URL search slug for hansard.parliament.uk, Parliament's official service for Hansard. Use this to give a link to the official record in Parliament about the legislation.", | |
| − | + | "type": "string" | |
| − | + | }, | |
| − | + | "use_new_UK-LEG": { | |
| − | + | "label": "Use new UK-LEG?", | |
| − | + | "description": "\"yes\" to use new {{tl|UK-LEG}} template to automatically produce a URI for the legislation.gov.uk service", | |
| − | + | "type": "string" | |
| − | + | }, | |
| − | + | "UK-LEG_title": { | |
| − | + | "label": "UK-LEG title", | |
| − | + | "description": "Variable for {{tl|UK-LEG}}", | |
| − | + | "type": "string", | |
| − | + | "default": "{{PAGENAME}}" | |
| − | + | }, | |
| − | + | "repeal_date": { | |
| − | + | "description": "The date the legislation was repealed.", | |
| − | + | "type": "content", | |
| − | + | "label": "Repeal date" | |
| − | + | }, | |
| − | + | "collapsed": { | |
| − | + | "label": "Collapse?", | |
| − | + | "description": "\"y\" if the infobox should be collapsed by default.", | |
| − | + | "type": "string" | |
| − | + | } | |
| − | + | }, | |
| − | + | "paramOrder": [ | |
| − | + | "short_title", | |
| − | + | "type", | |
| − | + | "parliament", | |
| − | + | "long_title", | |
| − | + | "year", | |
| − | + | "citation", | |
| − | + | "introduced_by", | |
| − | + | "introduced_commons", | |
| − | + | "introduced_lords", | |
| − | + | "territorial_extent", | |
| − | + | "si_made_date", | |
| − | + | "si_laid_date", | |
| − | + | "royal_assent", | |
| − | + | "commencement", | |
| − | + | "repeal_date", | |
| − | + | "amends", | |
| − | + | "replaces", | |
| − | + | "primary_legislation", | |
| − | + | "eu_directives", | |
| − | + | "amendments", | |
| − | + | "repealing_legislation", | |
| − | + | "related_legislation", | |
| − | + | "status", | |
| − | + | "legislation_history", | |
| − | + | "theyworkforyou", | |
| − | + | "millbankhansard", | |
| − | + | "original_text", | |
| − | + | "revised_text", | |
| − | + | "use_new_UK-LEG", | |
| − | + | "UK-LEG_title", | |
| − | + | "collapsed" | |
| − | + | ] | |
| − | |||
| − | |||
} | } | ||
</templatedata> | </templatedata> | ||
Revision as of 04:42, 4 January 2021
| This is a documentation subpage for Template:Infobox UK legislation. It contains usage information, categories and other content that is not part of the original template page. |
| This template uses Lua: |
Contents
Usage
Full syntax
This infobox takes a number of parameters:
[[Category:Template:Pagetype with short description]]
[[{{{parliament}}}]] | |
| Long title | {{{long_title}}} (The short title is authorised by section {{{citation_auth}}} of the Act.) |
|---|---|
| Citation | {{{citation}}} |
| Introduced by | {{{introduced_by}}}{{{introduced_commons}}} (Commons) {{{introduced_lords}}} (Lords) |
| Territorial extent | {{{territorial_extent}}} |
| Dates | |
| Made | {{{si_made_date}}} |
| Laid before Parliament | {{{si_laid_date}}} |
| Royal assent | {{{royal_assent}}} |
| Commencement | {{{commencement}}} |
| Repealed | {{{repeal_date}}} |
| Other legislation | |
| Amends | {{{amends}}} |
| Repeals | {{{replaces}}} |
| Made under | {{{primary_legislation}}} |
| Transposes | {{{eu_directives}}} |
| Amended by | {{{amendments}}} |
| Repealed by | {{{repealing_legislation}}} |
| Relates to | {{{related_legislation}}} |
Status: Unknown | |
| [{{{legislation_history}}} History of passage through Parliament] | |
| Records of Parliamentary debate relating to the statute from Hansard, at TheyWorkForYou | |
| Records of Parliamentary debate relating to the statute from Hansard | |
| [{{{original_text}}} Text of statute as originally enacted] | |
| [{{{revised_text}}} Revised text of statute as amended] | |
| Template:UK-LEG | |
{{Infobox UK legislation
| short_title =
| type =
| parliament =
| long_title =
| citation_auth =
| year =
| citation =
| introduced_commons =
| introduced_lords =
| territorial_extent =
| si_made_date =
| si_laid_date =
| royal_assent =
| commencement =
| repeal_date =
| amends =
| replaces =
| primary_legislation =
| eu_directives =
| amendments =
| repealing_legislation =
| related_legislation =
| status =
| status_EW =
| status_Scot =
| status_IE =
| status_NI =
| legislation_history =
| theyworkforyou =
| millbankhansard =
| original_text =
| revised_text =
| use_new_UK-LEG = yes
| UK-LEG_title =
| collapsed =
}}
Acts of Parliament
{{Infobox UK legislation
| short_title =
| type = Act
| parliament =
| long_title =
| year =
| citation =
| introduced_commons =
| introduced_lords =
| territorial_extent =
| royal_assent =
| commencement =
| repeal_date =
| amends =
| replaces =
| amendments =
| repealing_legislation =
| related_legislation =
| status =
| legislation_history =
| theyworkforyou =
| millbankhansard =
| original_text =
| revised_text =
| use_new_UK-LEG = yes
| UK-LEG_title =
}}
Statutory Instruments
{{Infobox UK legislation
| short_title =
| type = Statutory Instrument
| parliament =
| year =
| citation =
| introduced_commons =
| introduced_lords =
| territorial_extent =
| si_made_date =
| si_laid_date =
| commencement =
| repeal_date =
| amends =
| replaces =
| primary_legislation =
| eu_directives =
| amendments =
| repealing_legislation =
| related_legislation =
| status =
| legislation_history =
| theyworkforyou =
| millbankhansard =
| original_text =
| revised_text =
| use_new_UK-LEG = yes
| UK-LEG_title =
}}
Microformat
TemplateData
TemplateData for Infobox UK legislation
An infobox for UK statute legislation.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Short title | short_title | The short title of the legislation, displayed at the top of the infobox. This will usually be the same as the article title.
| String | suggested |
| Type | type | The type of legislation, whether an Act or Statutory Instrument. Displays as a subheading at the top of the infobox. | String | optional |
| Parliament | parliament | The name of the parliament which made the legislation. This will be linked. This parameter will also affect which coat of arms is displayed. Valid values:
| Page | suggested |
| Long title | long_title | The long title of the legislation. Some are extremely long and can clutter up the infobox. | String | optional |
| Year | year | The (calendar) year of the legislation — along with "parliament", this parameter affects the coat of arms to be displayed. | Number | suggested |
| Statute book chapter | citation | The chapter within the statute book where the legislation is to be found. Where this is before 1963, it must use the regnal year, not the calendar year; see [[Citation of United Kingdom legislation#Acts of Parliament]]. | String | optional |
| Introduced by | introduced_by | Who first introduced the legislation into parliament? This could be a link to an individual politician, or a political party if you do not know the individual. One could also mention whether it was a government-supported bill or a private member's bill. Retained for compatibility purposes and for Scottish, Welsh and NI Assembly Acts. For legislation passed by the UK parliament, where possible you should use either introduced_commons or introduced_lords. | Content | deprecated |
| Introduced_commons | introduced_commons | Who first introduced the legislation into the House of Commons. This could be a link to an individual politician, or a political party if you do not know the individual. One could also mention whether it was a government-supported bill or a private member's bill. | Content | suggested |
| Introduced_lords | introduced_lords | Who first introduced the legislation into the House of Lords. This could be a link to an individual politician, or a political party if you do not know the individual. One could also mention whether it was a government-supported bill or a private member's bill. | Content | suggested |
| Territorial extent | territorial_extent | The part(s) of the United Kingdom to which the act extends. | Page | optional |
| Date made | si_made_date | The date a Statutory Instrument was made. | Date | optional |
| Date laid before Parliament | si_laid_date | The date a Statutory Instrument was laid before Parliament. | Date | optional |
| Royal Assent | royal_assent | The date the legislation received Royal Assent (only applicable in Commonwealth countries, other users may wish to copy and modify the template). | Date | optional |
| Commencement | commencement | The date(s) at which the legislation was brought into force (but note that for acts with more than three or four commencement dates this is inappropriate to use). | Content | optional |
| Repeal date | repeal_date | The date the legislation was repealed. | Content | optional |
| Amends | amends | Earlier legislation that is amended by this piece of legislation. | Date | optional |
| Replaces | replaces | Earlier legislation that is replaced by this piece of legislation. | Date | optional |
| Primary legislation | primary_legislation | The primary legislation secondary legislation is made under. | Content | optional |
| EU directives | eu_directives | The EU directives this legislation transposes. | Content | optional |
| Amendments | amendments | Internal links to amending or repealing legislation, or even a list of years in which the legislation has been modified (note that for acts with a great deal of amending or repealing legislation only the most significant pieces of legislation should be listed). | Content | optional |
| Repealing legislation | repealing_legislation | Internal links to legislation repealing this statute. | Content | optional |
| Related legislation | related_legislation | Internal links to related legislation | Content | optional |
| Status | status | This can be one of eight values:
| String | optional |
| Legislation history | legislation_history | External link to information about the passage of the legislation through the legislature. | String | optional |
| TWFY URL slug | theyworkforyou | URL slug for TheyWorkForYou link | String | optional |
| Hansard URL slug | millbankhansard | URL search slug for hansard.parliament.uk, Parliament's official service for Hansard. Use this to give a link to the official record in Parliament about the legislation. | String | optional |
| Original text | original_text | External link to the text of the legislation as originally enacted. | String | optional |
| Revised text link | revised_text | External link to the revised text of the statute, as amended | String | optional |
| Use new UK-LEG? | use_new_UK-LEG | "yes" to use new {{tl|UK-LEG}} template to automatically produce a URI for the legislation.gov.uk service | String | optional |
| UK-LEG title | UK-LEG_title | Variable for {{tl|UK-LEG}}
| String | optional |
| Collapse? | collapsed | "y" if the infobox should be collapsed by default. | String | optional |