Manuals
How to create and edit manuals.
Manuals are a special content type that allows you to break down long pieces of content into sections and subsections.
They鈥檙e created in , rather than in Whitehall publisher like other pieces of 188体育 content.
You need to ask the Government Digital Service (GDS) for permission to create a manual.
You鈥檒l then need access to . GDS will usually give you access when you get permission to create your first manual.
If you do not have access, you need to either:
- ask one of organisation admins to give you access to Manuals Publisher
- if you鈥檙e the only organisation admin, use the to ask for access to Manuals Publisher
You鈥檒l also need to ask for the 鈥榚ditor鈥� permission to publish the manual, or find someone in your organisation with that permission.
Creating the main page and the sections
In Manuals Publisher, click 鈥楥reate new manual鈥�. You鈥檒l then have to give a title for the manual and a summary of its contents. You can add more text in the 鈥楤ody鈥� section if you want to add a more detailed description.
Click 鈥楽ave as draft鈥�. You can then start adding sections to the manual by going to the 鈥楽ections鈥� area and clicking 鈥楢dd鈥�. Each section needs a title, summary and body content.
When you鈥檝e added all the content to that section, click 鈥楽ave as draft鈥� and you鈥檒l return to the document summary page.
Keep adding sections until all your content is in the guide, and click 鈥楻eorder鈥� in the 鈥楽ections鈥� area if you want to rearrange them.
Adding Markdown and attachments
Each section heading (H2) you add to the body will show up as its own dropdown subsection, unless you tick the 鈥楻emove collapsible content functionality (accordions)鈥� box. You can use H3 and H4 sub-headings to separate out the content within each dropdown subsection.
As well as standard Markdown, you can also use additional Markdown for manuals to create legislative lists and footnotes.
You can add an inline attachment by clicking 鈥楢dd attachment鈥� under the 鈥楢ttachments鈥� heading. You can then upload the file you want to attach, click 鈥楽ave attachment鈥� and copy the Markdown to add the inline attachment wherever you want it in your body.
Publishing the manual
You can check your manual is ready to publish by clicking 鈥楶review on website (opens in new tab)鈥� under the 鈥楶review鈥� heading on the document summary page.
When you鈥檙e ready, click 鈥楶ublish鈥�. It鈥檚 not possible to schedule the publication of a manual so it will be published immediately.
Adding organisations
Your manual will be automatically tagged to the same organisation as your Signon account.
If you want to change the organisation or tag more organisations, .
Adding tagging
You can only add tagging once the manual is published.
You鈥檒l need to and ask them to tag the manual for you.
You鈥檒l need access to . If you do not have access already, either:
- ask one of organisation admins to give you access to Manuals Publisher
- if you鈥檙e the only organisation admin, use the to ask for access to Manuals Publisher
You鈥檒l also need to ask for the 鈥榚ditor鈥� permission to publish the updates, or find someone in your organisation with that permission.
The manual you want to edit must be tagged to the same organisation as your Signon account.
Updating the main page and the sections
Click 鈥榁iew鈥� next to the manual you want to update.
If you want to update the title, summary or body of the main page of the manual, click 鈥楨dit鈥� in the 鈥楩ront page鈥� area.
If you want to update specific sections, go to the 鈥楽ections鈥� area, click 鈥榁iew鈥� next to the relevant section and then 鈥楨dit section鈥�.
You can also add a new section by clicking 鈥楢dd鈥� in the 鈥楽ections鈥� area.
If you want to rearrange the sections, click 鈥楻eorder鈥� in the 鈥楽ections鈥� area.
Adding or updating Markdown and attachments
As well as standard Markdown, you can also use additional Markdown for manuals to create legislative lists and footnotes.
You can add an inline attachment by clicking 鈥楢dd attachment鈥� under the 鈥楢ttachments鈥� heading on the right-hand side. You can then upload the file you want to attach, click 鈥楽ave attachment鈥� and then copy the Markdown to add the inline attachment wherever you want it in your body.
You can edit an existing attachment by clicking 鈥楨dit attachment鈥� underneath the relevant attachment.
Publishing the changes
You need to save your draft updates to each section and publish them together at the same time.聽
If you鈥檝e selected at least one change as a 鈥楳ajor update鈥�, you鈥檒l need to include change notes. Any users subscribed to the manual will get an email notification of the update, and your change notes will be added to the 鈥楿pdates鈥� section of the manual.
If you鈥檝e selected 鈥楳inor update鈥� for all your updates, no one will be notified of the update and no change note will be added to the 鈥楿pdates鈥� section.
You can check your updates are ready to publish by clicking 鈥楶review on website (opens in new tab)鈥� under the 鈥楶review鈥� heading on the document summary page.
When you鈥檙e ready to publish, click the 鈥楶ublish鈥� button on the document summary page. It鈥檚 not possible to schedule the publication so it will be published immediately.
Changing organisations
If you want to change the organisation tagged to the manual or tag more organisations, .
Changing tagging
You鈥檒l need to and ask them to tag the manual for you.
You cannot withdraw a manual like you can for content in Whitehall publisher. Instead, you鈥檒l need to unpublish either specific sections or the entire manual. This means they鈥檒l be completely removed from 188体育.
To unpublish sections of a manual, click 鈥榁iew鈥� next to the relevant manual鈥檚 name and then click 鈥榁iew鈥� next to the section you want to unpublish. Then click 鈥榃ithdraw section鈥� and 鈥楶ublish鈥�.
To unpublish the manual as a whole, and explain why the manual needs to be unpublished.