name: Govspeak content description: To display long form text which has been converted from Govspeak body: | [Govspeak](https://github.com/alphagov/govspeak) is GOV.UK's extension of Markdown. This component has no control over markup, which is passed in to the component pre-generated. It only applies CSS/JS. It applies styling to standard Markdown content, eg; paragraphs, headings and lists. It also applies styling to Govspeak specific markup, like [callouts](https://github.com/alphagov/govspeak#callouts), [contacts](https://github.com/alphagov/govspeak#points-of-contact) and [highlights](https://github.com/alphagov/govspeak#highlights). Some JavaScript behaviours are applied to this component: - Progressively enhanced, accessible charts (using [Magna Charta](https://github.com/alphagov/magna-charta), derived from tabular data (see [example](./govspeak/charts)) - Progressively enhanced, accessible embedded YouTube player (see [example](./govspeak/with_youtube_embed)) accessibility_criteria: | - headings must be part of a correct heading structure for the page - text should have a text contrast ratio higher than 4.5:1 against the background colour to meet WCAG AA shared_accessibility_criteria: - link accessibility_excluded_rules: - landmark-complementary-is-top-level # Statistic headlines are generating an aside element which can not be a top level in the examples uses_component_wrapper_helper: true examples: basic_content: data: block: |

This is a title

This is some body text with a link.

inverted: description: This option currently supports basic inversion of only headings, paragraphs and links. data: inverse: true block: |

This is a title

This is some body text with a link.

context: dark_background: true with_margin_bottom: description: The component accepts a number for margin bottom from `0` to `9` (`0px` to `60px`) using the [GOV.UK Frontend spacing scale](https://design-system.service.gov.uk/styles/spacing/#the-responsive-spacing-scale). It defaults to no margin bottom, as spacing below is normally provided by elements within the component. data: margin_bottom: 9 block: |

This is a title

This is some body text with a link.

heading_levels: data: block: |

This is a h2 title

This is a h3 title

This is a h4 title

This is a h5 title
This is a h6 title
lists: data: block: |

ordered list:

  1. one
  2. two
  3. three

unordered list:

nested_lists: data: block: |

ordered list:

  1. three

unordered list:

ordered_lists_types: description: | Govspeak/markdown does not generate HTML with type and start attributes, however we still provide support for them as some advanced users write HTML directly to achieve the list formatting. data: block: |

Lowercase alphabetical list

  1. one
  2. two

Uppercase alphabetical list

  1. one
  2. two

Lowercase Roman numeral list

  1. one
  2. two

Uppercase Roman numberal list

  1. one
  2. two

Numerical list starting at 3

  1. three
  2. four

Lowercase alphabetical list, starting at 3

  1. three
  2. four
legislative_lists: data: block: |

ordered list:

  1. one
  2. two
  3. three
image_fractions: data: block: |

Number - fractions

Pupils should be taught to:

Notes and guidance (non-statutory)

Pupils use fractions as ‘fractions of’ discrete and continuous quantities by solving problems using shapes, objects and quantities. They connect unit fractions to equal sharing and grouping, to numbers when they can be calculated, and to measures, finding fractions of lengths, quantities, sets of objects or shapes. They meet 3/4 as the first example of a non-unit fraction.

Pupils should count in fractions up to 10, starting from any number and using the 1/2 and 2/4 equivalence on the number line (for example, 1 1/4 , 1 2/4 (or 1 1/2 ), 1 3/4 , 2). This reinforces the concept of fractions as numbers and that they can add up to more than 1.

text_fractions: data: block: |

If an image is not available for a particular fraction, then we'll fallback to text based fraction using sup/sub, like this 1100 example.

blockquote: data: block: |

My quote

about things

tables: data: block: |
A table with data
Group Explanation Current and continuing guidance Government support
Clinically extremely vulnerable people (all people in this cohort will have received communication from the NHS) People defined on medical grounds a clinically extremely vulnerable, meaning they are at the greatest risk of severe illness. This group includes solid organ transplant recipients, people receiving chemotherapy, renal dialysis patients and others. Follow shielding guidance by staying at home at all times and avoiding all non-essential face-to-face contact. This guidance is in place until end June. Support available from the National Shielding Programme, which includes food supplies (through food boxes and priority supermarket deliveries), pharmacy deliveries and care. Support is available via the NHS Volunteer Responders app.
Clinically vulnerable people People considered to be at higher risk of severe illness from COVID-19. Clinically vulnerable people include the following: people aged 70 or older, people with liver disease, people with diabetes, pregnant women and others. Stay at home as much as possible. If you do go out, take particular care to minimise contact with others outside your household. Range of support available while measures in place, including by local authorities and through voluntary and community groups. Support is available via the NHS Volunteer Responders app.
Vulnerable people (non-clinical) There are a range of people who can be classified as ‘vulnerable’ due to non-clinical factors, such as children at risk of violence or with special education needs, victims of domestic abuse, rough sleepers and others. People in this group will need to follow general guidance except where they are also clinically vulnerable or clinically extremely vulnerable, where they should follow guidance as set out above. For those who need it, a range of support and guidance across public services and the benefits system, including by central and local government and the voluntary and community sector.
tables_with_alignments: data: block: |
Default aligned Left aligned Center aligned Right aligned
First body part Second cell Third cell fourth cell
charts: description: | The Government Statistical Service (GSS) guidance recommends [a limit of four categories as best practice for basic data visualisations](https://gss.civilservice.gov.uk/policy-store/data-visualisation-colours-in-charts/#section-5). Note that charts which have up to 7 categories, [chart with colours](http://govuk-publishing-components.dev.gov.uk/component-guide/govspeak/chart_with_colours/preview), for example, will display subsequent bars in `#3d3d3d`, `#a285d1` and the 7th bar in the default colour of `#0b0c0c` and will still meet the colour contrast requirements for adjacent colours. Charts that have 8 or more categories will display additional bars in the default colour and will not meet colour contrast requirements for adjacent colours. data: block: |
A table with numerical data
row 110
row 215
row 32
row 448
chart_with_colours: data: block: |
Number position Apples Oranges Bananas Pears Grapes Strawberries Plums
Numbers inside bar 16 48 39 50 24 10 62
Numbers outside bar 2 1 2 1 1 2 1
stacked_chart: data: block: |
Colours Fruits Vegetables Beans Nuts Total
Red 23 9 2 1 35
Green 5 33 8 0 46
Yellow 2 10 0 15 27
chart_with_multiple_headings: data: block: |
Multiple Table
Some DataYESNOMAYBE
Testing One5611
Testing Two628
Testing Three3912
address: data: block: |

First line of address
Second line of address
75 This street
United Kindom
Phone: 07123456789

Addresses are generated when using the `$A` markdown pattern.

contact: data: block: |

Media enquiries

2 Marsham Street
London

SW1P 4DF

A comment about the contact

contact_with_surrounding_text: data: block: |

This is a title

Media enquiries

2 Marsham Street
London

SW1P 4DF

A comment about the contact

This is a paragraph.

Media enquiries

2 Marsham Street
London

SW1P 4DF

A comment about the contact

footnotes: data: block: |

This is a text with a footnote1.

  1. And here is the definition.

  2. https://www.ons.gov.uk/peoplepopulationandcommunity/birthsdeathsandmarriages/deaths/datasets/weeklyprovisionalfiguresondeathsregisteredinenglandandwales
rtl_block: data: direction: rtl block: |

قال وزير الخارجية، ويليام هيغ:

مع بدء هذا الشهر الفضيل أتمنى للمسلمين في أنحاء العالم - في آسيا وأفريقيا والشرق الأوسط وأوروبا وغيرها من مناطق العالم - شهر رمضان مبارك.

في المملكة المتحدة يُحتفل بشهر رمضان منذ أجيال عديدة، ونفتخر بروابطنا القوية مع العالم الإسلامي، سواء مع شركائنا المعهودين في الشرق الأوسط أو روابطنا التاريخية المتينة في آسيا وأفريقيا أو مواطنينا المسلمين البريطانيين المفعمين بالحيوية والنشاط.

ordered list

  1. تابع الوزير أليستر بيرت عبر تويتر
  2. تابعنا باللغة العربية عبر
  3. تابعنا باللغة العربية عبر تويتر

unordered list

السنة الدور
2020 - 2022 وزارة الخارجية والتنمية البريطانية
2016 - 2020 القنصل العام البريطاني في القنصلية البريطانية العامة في شونغشينغ
2012 - 2015 الدوحة، نائب رئيس البعثة
with_youtube_embed: data: block: |

This content has a YouTube video link, converted to an accessible embedded player by component JavaScript.

Operations: a developer's guide, by Anna Shipman

with_youtube_livestream: data: block: |

This content has a YouTube livestream link, converted to an accessible embedded player by component JavaScript.

Livestream video

with_youtube_embed_disabled: data: disable_youtube_expansions: true block: |

This content has a YouTube video link, where the govspeak expansion has been disabled

Operations: a developer's guide, by Anna Shipman

statistic_headlines: data: block: |

£6bn Total Departmental Expenditure Limit (DEL) in financial year 2015 to 2016

This includes £5.8 billion Resource DEL and £0.2 billion Capital DEL. In addition, DWP Annually Managed Expenditure (AME) in financial year 2015 to 2016 is £170.5 billion, as forecast by the Office for Budget Responsibility.

UK employment rate 74.1% between October and December 2015

specialist_content: data: block: |

Bisphosphonates

Bisphosphonates are used to treat osteoporosis, Paget’s disease, and as part of some cancer regimens, particularly for metastatic bone cancer and multiple myeloma. Individual bisphosphonates have different indications (see individual Summaries of Product Characteristics1). The following bisphosphonates are available in the UK:

Osteonecrosis of the external auditory canal

Benign idiopathic osteonecrosis of the external auditory canal is a rare condition that can occur in the absence of antiresorptive therapy and is sometimes associated with local trauma.

Advice for healthcare professionals:

Evidence for an association with bisphosphonate treatment

Evidence from the clinical literature and from cases reported to medicines regulators, including one report received via the UK Yellow Card scheme, supports a causal association between bisphosphonates and osteonecrosis of the external auditory canal. Product information is being updated to include advice for healthcare professionals and patients.

A total of 29 reports indicative of osteonecrosis of the external auditory canal in association with bisphosphonates have been identified worldwide, including 11 cases reported in the clinical literature.2 3 4 5 6 7 8 Cases have been reported with use of both intravenous or oral bisphosphonates for both cancer-related or osteoporosis indications; there is currently insufficient evidence to determine whether there is any increased risk with higher doses used for cancer-related conditions. Most cases were associated with long-term bisphosphonate therapy for 2 years or longer, and most cases had possible risk factors including: steroid use; chemotherapy; and possible local risk factors such as infection, an ear operation, or cotton-bud use. Bilateral osteonecrosis of the external ear canal was reported in some patients, as was osteonecrosis of the jaw.

The number of cases of osteonecrosis of the external auditory canal reported in association with bisphosphonates is low compared with the number of cases reported of bisphosphonate-related osteonecrosis of the jaw, a well-established side effect of bisphosphonates.9

Evidence for an association with denosumab treatment

The available data do not support a causal relation between osteonecrosis of the external auditory canal and denosumab. However, this possible risk is being kept under close review, given that denosumab is known to be associated with osteonecrosis of the jaw.

Article citation: Drug Safety Update volume 9 issue 5 December 2015: 3.

  1. Summaries of Product Characteristics can be found here on the MHRA website or on the website of the European Medicines Agency, depending whether the medicine has a national or European licence, respectively.

  2. Bast F, et al. Bilateral bisphosphonate-associated osteonecrosis of the external ear canal: a rare case. HNO. 2012; 60: 1127–29 [in German].

  3. Froelich K, et al. Bisphosphonate-induced osteonecrosis of the external ear canal: a retrospective study. Eur Arch Otorhinolaryngol 2011; 268: 1219–25.

  4. Kharazmi M, et al. Bisphosphonate-associated osteonecrosis of the auditory canal. Br J Oral Maxillofac Surg 2013; 51: e285–87.

  5. Polizzotto MN, et al. Bisphosphonate-associated osteonecrosis of the auditory canal. Br J Haematol 2006; 132: 114.

  6. Salzman R, et al. Osteonecrosis of the external auditory canal associated with oral bisphosphonate therapy: case report and literature review. Otol Neurotol 2013; 34: 209–13.

  7. Thorsteinsson AL, et al. Bisphosphonate-induced osteonecrosis of the external auditory canal: a case report. J Clin Med Case Reports 2015; 2: 3.

  8. Wickham N, et al. Bisphosphonate-associated osteonecrosis of the external auditory canal. J Laryngol Otol 2013; 127 (suppl 2): S51–53.

  9. Patient reminder cards about the risk of osteonecrosis of the jaw are being introduced for intravenous bisphosphonates and denosumab. The cards will become available at different times for individual products. They are now available for the following products: Prolia (denosumab); Xgeva (denosumab); Aclasta (zoledronic acid); Zometa (zoledronic acid); zoledronic acid 5 mg generics and zoledronic acid 4 mg generics. The cards can be viewed here.

attachment_link: description: Attachment link component rendered within Govspeak data: block: |

A reference to my <%= render "govuk_publishing_components/components/attachment_link", attachment: { url: "https://example.com/file.pdf", title: "Attachment", file_size: 1024, content_type: "application/pdf", number_of_pages: 2 } %> that is in my paragraph.

attachment: description: Attachment component rendered within Govspeak data: block: |

An attachment as a block

<%= render "govuk_publishing_components/components/attachment", attachment: { url: "https://example.com/file.odt", title: "Attachment", file_size: 1024, content_type: "application/vnd.oasis.opendocument.text" } %> inline_attachment: description: Legacy inline attachment embed used by Whitehall and Specialist Publisher data: block: |

testing my attachment testing (CSV, 65.4KB) works in the middle of copy.

whitehall_block_attachments: description: Attachments rendered by govspeak extensions within Whitehall data: block: |

PDF Attachment

Document attachment

File attachment with additional metadata

Order a copy

Previewable online example

Fly-tipping incidents and actions reported by local authorities in 2014 to 2015

This file is in an OpenDocument format

This file may not be suitable for users of assistive technology. Request an accessible format.

If you use assistive technology and need a version of this document in a more accessible format, please email defra.helpline@defra.gsi.gov.uk. Please tell us what format you need. It will help us if you say what assistive technology you use.

Summer Budget 2015

Track coronavirus cases

An external link (with all possible metadata)

Order a copy (£1.00)

Consultation outcome with published date

whitehall_block_attachment_rtl: description: Attachments rendered by govspeak extensions within Whitehall data: direction: rtl block: |

مستقبل الغذاء والزراعة: موجز تنفيذي

هذا المف قد لا يكون مناسبا لمستخدمي التكنولوجيا المساعدة على القراءة

لاستلام وثيقة مكتوبة بشكل آخر، كلغة بريل أو وثيقة صوتية أو أي نوع آخر من الوثائق، يرجى إرسال رسالة إلكترونية إلى enquiries@bis.gsi.gov.uk مع كتابة عنوانك ورقم هاتفك إلى جانب عنوان الوثيقة المطلوبة ("{title}"), and its reference (Unique reference: BIS/11/924)

example: data: block: |

Example This is an indented example block.
It may span multiple lines, contain links.

It may even span multiple paragraphs.

call_to_action: data: block: |

Call to action

information_callout: data: block: |

If you drilled a tunnel straight through the Earth and jumped in, it would take you exactly 42 minutes and 12 seconds to get to the other side.

warning_callout: data: block: |

The water in the mouth of a blue whale weighs more than its body.

form_download: data: block: |

An example form download link.

steps: data: block:
  1. Add numbers.

  2. Check numbers.

  3. Love numbers.

highlight_answer: description: | Used on: * [https://gov.uk/vat-rates](https://gov.uk/vat-rates) * [https://gov.uk/junior-individual-savings-accounts](https://gov.uk/junior-individual-savings-accounts) * [https://gov.uk/individual-savings-accounts](https://gov.uk/individual-savings-accounts) * [https://gov.uk/corporation-tax-rates](https://gov.uk/corporation-tax-rates) data: block: |

The VAT rate is 20%

In the 2017 to 2018 tax year, the savings limit for Junior ISAs is £4,128

In the 2017 to 2018 tax year, the maximum you can save in ISAs is £20,000

place: data: block: |

This is a place

buttons: data: block: |

Button Start button

image: data: block: |
Open water with only mangrove stumps showing above the water. Credit: Blue Ventures-Garth Cripps

Deforested area. Credit: Blue Ventures-Garth Cripps