View source for Template:Infobox UK legislation/doc

{{Documentation subpage}}
{{auto short description}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{Lua|Module:Infobox|Module:Check for unknown parameters}}

==Usage==
===Full syntax===
This infobox takes a number of parameters:

{{Infobox UK legislation
|short_title          = {{{short_title}}}
|type                 = {{{type}}}
|parliament           = {{{parliament}}}
|long_title           = {{{long_title}}}
|year                 = {{CURRENTYEAR}}
|citation             = {{{citation}}}
|citation_auth        = {{{citation_auth}}}
|introduced_by        = {{{introduced_by}}}
|introduced_commons   = {{{introduced_commons}}}
|introduced_lords     = {{{introduced_lords}}}
|territorial_extent   = {{{territorial_extent}}}
|si_made_date         = {{{si_made_date}}}
|si_laid_date         = {{{si_laid_date}}}
|royal_assent         = {{{royal_assent}}}
|commencement         = {{{commencement}}}
|expiry_date          = {{{expiry_date}}}
|repeal_date          = {{{repeal_date}}}
|replaces             = {{{replaces}}}
|amends               = {{{amends}}}
|primary_legislation  = {{{primary_legislation}}}
|eu_directives        = {{{eu_directives}}}
|amendments           = {{{amendments}}}
|related_legislation  = {{{related_legislation}}}
|repealing_legislation= {{{repealing_legislation}}}
|status               = {{{status}}}
|original_text        = {{{original_text}}}
|legislation_history  = {{{legislation_history}}}
|use_new_UK-LEG       = yes
|UK-LEG_title         = {{{UK-LEG_title}}}
|revised_text         = {{{revised_text}}}
|theyworkforyou       = {{{theyworkforyou}}}
|millbankhansard      = {{{millbankhansard}}}
}}
<pre style="overflow: auto;">
{{Infobox UK legislation
| short_title           = 
| type                  = 
| parliament            = 
| long_title            = 
| citation_auth         = 
| year                  = 
| citation              =
| introduced_by         =  
| introduced_commons    = 
| introduced_lords      = 
| territorial_extent    = 
| si_made_date          = 
| si_laid_date          = 
| royal_assent          = 
| commencement          = 
| expiry_date           =
| 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             = 
}}
</pre>

{{Clear}}

===Acts of Parliament===
<pre style="overflow: auto;">
{{Infobox UK legislation
| short_title           = 
| type                  = Act
| parliament            = 
| long_title            = 
| year                  = 
| citation              = 
| introduced_commons    = 
| introduced_lords      = 
| territorial_extent    = 
| royal_assent          = 
| commencement          = 
| expiry_date           = 
| repeal_date           = 
| amends                = 
| replaces              = 
| amendments            = 
| repealing_legislation = 
| related_legislation   = 
| status                = 
| legislation_history   = 
| theyworkforyou        = 
| millbankhansard       = 
| original_text         = 
| revised_text          = 
| use_new_UK-LEG        = 
| UK-LEG_title          = 
| collapsed             = 
}}
</pre>

===Acts of the Scottish Parliament (from 1999)===

Not to be used for the [[Parliament of Scotland|pre-union Parliament of Scotland]] legislation. 

<pre style="overflow: auto;">
{{Infobox UK legislation
| short_title           = 
| type                  = Scottish Act
| parliament            = Scottish Parliament
| long_title            = 
| year                  = 
| citation              = 
| introduced_by         = 
| territorial_extent    = 
| royal_assent          = 
| commencement          = 
| expiry_date           =
| 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          = 
| collapsed             = 
}}
</pre>

===Acts of the Senedd Cymru (from 2020)===

<pre style="overflow: auto;">
{{Infobox UK legislation
| short_title           = 
| type                  = Welsh Act
| parliament            = Senedd Cymru
| long_title            = 
| year                  = 
| citation              = 
| introduced_by         = 
| territorial_extent    = 
| royal_assent          = 
| commencement          = 
| expiry_date           =
| 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          = 
| collapsed             = 
}}
</pre>

===Acts of the Northern Ireland Assembly (from 1999)===

<pre style="overflow: auto;">
{{Infobox UK legislation
| short_title           = 
| type                  = NI Act
| parliament            = Northern Ireland Assembly
| long_title            = 
| year                  = 
| citation              = 
| introduced_by         = 
| territorial_extent    = 
| royal_assent          = 
| commencement          = 
| expiry_date           =
| 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          = 
| collapsed             = 
}}
</pre>

===UK statutory instruments===
<pre style="overflow: auto;">
{{Infobox UK legislation
| short_title           = 
| type                  = Statutory Instrument
| parliament            = 
| year                  = 
| citation              = 
| introduced_commons    = 
| introduced_lords      = 
| territorial_extent    = 
| si_made_date          = 
| si_laid_date          = 
| commencement          = 
| expiry_date           =
| 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          = 
| collapsed             = 
}}
</pre>

==Microformat==
{{UF-hcal|hide_subtemplates=yes}}

==TemplateData==
{{TemplateData header}}
<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, for example if it is an Act or Statutory Instrument. Displays as a subheading at the top of the infobox. Valid values are:\n:* \"act\" or \"act of parliament\", for the UK Parliament and its predecessors (including the pre-union Parliaments of Ireland and Scotland)\n:* \"si\" or \"statutory instrument\", for Statutory Instruments\n:* \"scottish act\", for Acts of the Scottish Parliament (the devolved parliament)\n:* \"welsh assembly act\", for Acts of the Welsh Assembly (2011–2020)\n:* \"welsh act\" or \"senedd act\", for Acts of Senedd Cymru,\n:* \"measure\", for Measures of the Welsh Assembly (2008–2011)\n:* \"ni act\", for Acts of the Northern Ireland Assembly\n:* \"gibraltar act\", for Acts of Parliament (Gibraltar)\n The values are not case-sensitive.",
			"type": "string",
			"suggested": true
		},
		"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 (1999–2020)\n:* \"Senedd Cymru\", \"Welsh Parliament\" or \"Senedd\", for the devolved Parliament \n:* \"Parliament of Gibraltar\", for the overseas territory's Parliament\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,
			"label": "Parliament"
		},
		"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,
			"label": "Year"
		},
		"citation": {
			"label": "Citation",
			"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 should be a link (if an article exists) to the individual or otherwise the name of the individual who introduced the legislation. If this is not known link to a political party or leave blank. One could also mention whether it was a government-supported bill or a private member's bill. For Scottish, Welsh and NI Assembly Acts, devolved secondary legislation, some English Civil War era legislation and very old English legislation where the division between the Commons and Lords did not exist. For legislation passed by the UK parliament, where possible you should use either introduced_commons or introduced_lords.",
			"type": "content"
		},
		"introduced_commons": {
			"description": "Who first introduced the legislation into the House of Commons? This should be a link (if an article exists) to the individual or otherwise the name of the individual who introduced the legislation in the Commons. If this is not known link to a political party or leave blank. 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 should be a link (if an article exists) to the individual or otherwise the name of the individual who introduced the legislation in the Lords. If this is not known link to a political party or leave blank. 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. If this is self-evident or obvious by context, this can be left blank - e.g. you do not need to state that Acts of the Scottish Parliament extend to Scotland.",
			"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.",
			"type": "date",
			"suggested": true
		},
		"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) or a link to the section of the article which explains how the legislation commences.",
			"type": "content",
			"label": "Commencement"
		},
		"amends": {
			"label": "Amends",
			"description": "Earlier legislation that is amended by this piece of legislation.",
			"type": "date"
		},
		"replaces": {
			"label": "Repeals/revokes",
			"description": "Earlier legislation that is repealed or revoked (stopped from being law) by the 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. This should not be used for legislation passed after the end of the Brexit transition period (31 December 2020).",
			"type": "content",
            "deprecated": true
		},
		"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",
			"label": "Amendments"
		},
		"related_legislation": {
			"label": "Related legislation",
			"description": "Links to related legislation",
			"type": "content"
		},
		"repealing_legislation": {
			"label": "Repealed by or Revoked by (if type is a statutory instrument)",
			"description": "Links to legislation which revokes (if a Statutory Instrument) or repeals (otherwise) the legislation.",
			"type": "content"
		},
		"status": {
			"description": "This can be one of the following 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* \"Expired\" (similar to Spent, for legislation which has expired, usually after an explicit date written in the legislation)\n* \"Repealed\" (for primary 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* \"Revoked\" (for statutory instruments which has been revoked, or are no longer in force)\n* \"partially_expired\" (for legislation which has only partially expired, but some sections have been extended)\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). \n\nThis defaults to \"Unknown\" if an illegal value is entered. The text area is colour-coded.",
			"default": "Unknown",
			"type": "string",
			"label": "Status",
			"suggested": true
		},
		"original_text": {
			"label": "Original text link",
			"description": "External link to the text of the legislation as originally enacted.",
			"type": "string"
		},
		"legislation_history": {
			"label": "Legislation history link",
			"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}}"
		},
		"expiry_date": {
			"description": "The date the legislation expired. Do not add until the legislation actually expired as there is still a possibility that legislation might be extended. Use repeal_date instead if the legislation does not explicitly state a date which it will stop being in force.",
			"type": "content",
			"label": "Expiry date"
		},
		"repeal_date": {
			"description": "The date the legislation was repealed or revoked (if it is a Statutory Instrument). This may be different from the day the legislation expired. Label shows \"Revoked\" if the legislation is a Statutory Instrument, otherwise it shows \"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",
        "expiry_date",
		"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>
*Use of one or more unrecognised parameters will place the page in {{clc|Pages using Infobox UK legislation with unknown parameters}}.

<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, THANKS -->
[[Category:Law infobox templates|UK legislation]]
[[Category:United Kingdom government infobox templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>