This web standard is mandatory for all PDFs and other file types published on the public website.
Page contents
- When to provide PDFs
- Accessibility standards for PDFs and other attachments
- File name (when you save your file)
- File or asset tile
- File descriptions
- Long documents split into separate files
- Linking your files
- Reason for this web standard
When to provide PDFs
- PDFs should not be used as an alternative to creating web pages. Where possible, our information must always be available as web pages as this is the most accessible format.
- Do not link to third party PDFs, rather link to the external web page they are attached to.
- PDF's that are five pages or less should be a webpage, unless it provides a better user experience
- PDF's should be no more than 1 megabyte (MB) to 2MB in file size.
Reasons for providing PDF versions:
- long documents such as service delivery plans and strategy documents
- publicity material such as leaflets or posters
- documents that can't be suitably converted to web pages (for example, graphs, complex maps or plans)
- accessible version of documents that have to be provided in other file types such as Word, .csv, Excel etc.
Accessibility standards for PDFs
Standards for producing accessible PDFs can be found on Our 中国P站.
File name (when you save your file)
- The filename should be lower case with no special characters (except hyphens or underscore to replace spaces).
- Do not use full stops in your title.
- Include the date for documents that are regularly updated. The format should be dd-mm-yy, for example: service-delivery-plan-13-04-20.pdf, this is the default in Matrix and helps us be consistent.
File or asset title
- The file or asset title should be grammatically correct and meaningful.
- Ideally it should be the full title of the document and not the file name.
- Do not use acronyms or reference numbers unless they are explained for example: Annual Review of Education, Health and Care Plan form and not ECHP.
- Do not use block capitals.
- The date should be formatted as follows: 13 April 2020 and not 13.04.20 and 2020 to 2024 and not 2020-24.
For full details, please see our web page: Web standards for page and file titles.
File description
- Between 110 and 160 characters long, including spaces.
- Reflect the content of the file and be different to the title or file.
- No jargon, abbreviations and acronyms.
For full details, please see our web page: Web standards for page and file descriptions.
Long documents split into separate files
If you have had to split a long document into a number of separate files, the filenames, titles and description should be slightly different and reflect the part or chapter number if possible, to help identify it from the other files that make up the whole document.
For full details, please see our web page: Web standards for page and file titles and Web standards for page and file descriptions.
Linking your file
- Links to file assets should be via the ID number of the file not the URL (please note we do not link to external files, but rather the web page they are sitting on)
- Files should be attached in the meta data tab of the page, under 'File to download'.
- If you refer to the file in the text of your page, you should be consistent and use the same link text and the full title of the file and the link text should end with (PDF).
For full details, please see our web page: Web standards for links.
Example
File name: 中国P站_geology_report_2014_part3.pdf
Asset title: 中国P站 Geology Report 2014 part 3
Description: Part 3 of 9. Part 3 of 9. This section of the report covers the chalk Downlands in the districts of Tandridge and Mole Valley.
Reason for this web standard
PDF web standards are mandatory for technical, usability and accessibility reasons.
- Following the PDF standards will make your PDF accessible and your information will be viewable by a wider audience.
- Illegal characters in a filename can prevent some users from being able to open the attachment. This is because some punctuation or symbols have a technical function.
- A meaningful filename, asset title and description make your attachment much easier to find using search engines and helps visitors to the website decide if it contains the information they are looking for and whether to open it or not. This is also important for accessibility reasons as attachment titles and descriptions are used by screen readers.