GovWire

Adding acronym Markdown to a document means that when a user hovers over the acronym they see the full name as alt text.

This text has acronym Markdown applied.

You should:

• add the acronym Markdown at the end of the body copy, leaving one empty line space above it
• type an asterisk, square brackets around the acronym and a colon, then the full name, for example *[DWP]: Department for Work and Pensions
• make sure there is no space between the asterisk and the square bracket

When you have more than one acronym, list:

• each one on a new line
• both plurals and singulars, but not possessives, for example DFTs
• plurals ahead of singulars, for example HGVs before HGV

See the style guide for how to use acronyms.

For addresses use the Markdown $A above and below the address text.

Example:

$A
Put the
address in
here
$A

Do not use bold for the address title. This is not accessible because it looks like a heading and can be confusing for users of assistive technology.

There are 2 ways of using markdown to add attachments to content - inline attachments and publication box attachments.

First you need to upload your attachments. The first attachment you upload is number 1, the second number 2, and so on. The number is used in the Markdown when you want to add the attachment.

The number of an attachment does not change, even if previous attachments are deleted.

Add an inline attachment

This will add the attachment title to a sentence or bullet point as a link to download the attachment. The file type and size is shown in brackets after the title.

In the text, type [InlineAttachment:n], where n is the number of the attachment you uploaded. For example, if you want to add the first attachment you uploaded, add [InlineAttachment:1].

See an example of an inline attachment (in the Services we provide in Jerusalem section).

Add a publication box

This is a more prominent link than the inline attachment. It shows the cover of the attached document, and adds the file type and size under the title.

In the text, type !@n for a publication box, where n is the number of the attachment you uploaded. For example, if you want to add the first attachment you uploaded, add !@1.

Leave a line space above and below the Markdown.

See an example of a publication box attachment (in the Information notes section).

For more information about attachments see the creating and editing content section.

Blockquote Markdown should only be used in news stories and case studies, for quotes longer than a few sentences. Do not use blockquotes in speeches.

In news and case studies:

• introduce the blockquote with a colon
• leave one empty line space above and below your blockquote
• add > in any line spaces in the quote - if you leave it out youll get separate quotes on separate lines, not one running quote

To create a bulleted list:

• use asterisks (*) to make bullets (hyphens also work)
• make sure there is one space after the asterisk
• leave 1 empty line space before the bullets start, and one after

See the style guide to check how to punctuate bullets.

Call to action Markdown should be used for short links to actions, like applying for a licence. It creates a tinted box which highlights the task.

To create the call to action box use the Markdown $CTA above and below the link.

$CTA
It looks like this.
$CTA