As more and more HMRC editors get ready to create content on the Whitehall publisher system, we're starting to get a few questions about things like layout and formatting.
We'll try to answer some of the common queries here on the blog. This post looks at table width and the use of bold and italics.
Tables
We've had a couple of questions about how many columns a table can have when you're creating them in detailed guides and HTML publications.
In publisher there's no technical limit on table width, but you do need to make a decision about what is sensible to ask a reader to understand.
Responsive design of content on GOV.UK allows tables to stretch and compress based on the device or platform it's being viewed on, but wide tables (particularly in detailed guides, which need to make an allowance on the left-hand side of the page for navigation) aren't very user friendly or attractive.
Whilst there's no technical restriction, it's down to the editor to make it manageable and not complex for the user.
Bold and italics
We've also had a question about when it's appropriate to use bold and italics when formatting a sentence or paragraph.
Although it can be tempting to add emphasis to words and phrases by using bold or italics, it's not always good news for users. Overuse of bold and italics slows the flow of the content and can often lead to the message being lost because the user scans for the bold words, whilst ignoring the rest.
If part of a sentence or paragraph needs emphasising, you can achieve this more effectively by front-loading, shortening, or by making good use of the 'active' voice.
If you're highlighting a telephone or reference number, it might be better to place it on a new line or use an appropriate piece of markdown, eg a Call to action.
These style conventions are not confined to content on the Whitehall publisher - they apply across the whole of GOV.UK and are essential for maintaining consistency across the website.
5 comments
Comment by David posted on
A general question as I'm confused: You say "use an appropriate piece of markdown, eg a Call to action."
But doesn't using markdown do exactly what you're telling editors not to do by making the text show in **bold** or __italics__ ? (no idea if these comments support markdown). Or is there specific markdown syntax to format text as a CTA?
Thanks,
David
(HMRC editor)
Comment by Nick Cammell posted on
A general question as I'm confused: You say "use an appropriate piece of markdown, eg a Call to action."
But doesn't using markdown do exactly what you're telling editors not to do by making the text show in **bold** or __italics__ ? (no idea if these comments support markdown). Or is there specific markdown syntax to format text as a CTA?
Thanks,
David
(HMRC editor)
Hi David
Thanks for your comment.
To clarify, markdown is simply a set of symbols that you can place around a piece of content (eg a word, or an address) that applies HTML formatting to it, eg # for an H1, ## for an H2 etc. It's a quicker way of formatting your content without having to know HTML code.
There are a number of predefined pieces of markdown in publisher that you can apply to content, the full list is:
Headings, Links, Bullets, Numbered list, Images, Video links, Attachments, Tables, Charts, Call to action, Acronyms, Blockquotes, Addresses
Each one shows the symbols you need to add how it will affect the layout.
My suggestion was that you use the Call to action to highlight significant bits of content, eg a telephone number or a link to a form.
The markdown for a Call to action is:
$CTA
Phone number or link to form
$CTA
The markdown ends up looking like this.
The point still stands that we shouldn't be using bold or italics to highlight particular words in a run of text.
My Call to action suggestion is for a situation where you need to highlight an important action or step. This is different from making a word bold based on the assumption that it will re-enforce a user's understanding.
I hope that makes sense. I'm happy to provide further examples if that would help.
Thanks again.
Comment by David Potts posted on
Thanks for your reply Nick.
This:
$CTA
Phone number or link to form
$CTA
perfectly answered my question.
Regards
David
Comment by Kevin Ringer posted on
I don't like the gov.uk format and presentation compared to hmrc.gov.uk. 1, text is too large so I am continually having to scroll up and down - there is much more text on hmrc.gov.uk page so less scrolling. I also believe the smaller text is quicker and easier to read because it can jump up and down paragraphs which is easier when not scrolling. 2, if you are ever lost in hmrc.gov.uk you hit 'home' - no 'home' in gov.uk. 3. hmrc.gov.uk had search box and quick links to libraries, rates etc - no such links in gov.uk. 4, content of hmrc.gov.uk is factual with minimal spin whereas gov.uk has more spin than facts eg Employment Allownace I managed to locate a photo of David Cameron and loads of comments, but took a long time to locate the actual operational rules.
Comment by Stephen Edwards posted on
Some of the issues you are having is because the content you are looking for has not yet transitioned from the HMRC site to GOV.UK.
The design and navigation work on GOV.UK is not something we are responsible for in the HMRC transition team. Work to improve the browse and navigation issues you mention is being done by Neil Williams' team that is focusing on the needs of specialists, you can read more about this work on the Inside GOV.UK blog here: https://insidegovuk.blog.gov.uk/2014/02/20/new-specialist-sector-option-in-publisher/
Stephen