Page Comparison

The following is a list of items to take into consideration while building out a Style Guide. Feel free to add notes or make comments on any of it.

...

1. Font

   1. style-Sans serif

   2. Font size-12 (minimum)

   3. Font has to be black on white page. Links should be blue on white page.

2. Paragraph format

   1. Line spacing

      1. around images - double space

      2. Paragraph - single

   2. Align left, no indent for paragraphs

   3. Use underline for links only.

   4. Do not use all caps.

   5. Use only one space after period.

   6. One line space between paragraphs to separate them since they are aligned left without indent.

   7. Sections/Bullets/numbering

3. Formatting headings -

   1. Page title - pre-defined by Confluence, when page is created, it will automatically set the format, It uses the preset Heading 1

   2. section titles - Manually formatted, Start with Heading 2, use Heading presets in sequential order for nested sections

4. Formatting screenshots

   1. If you upload a new image that has the same title as an existing image, the new image will replace the existing image on the published page, even if you don’t publish your edits. To avoid this, you should append the date the screenshot was created to the file name (example: AccEdits_20210315)

   2. Add alt - text to images for accessibility.

      1. If using the older editor, click on the image and select Properties to add alt text. If using the new editor, click on the image and select alt text.

      2. Tips from Web Accessibility Evaluation Tool (WAVE):

         1. “Alternative text should be succinct, yet descriptive of the content and function of an image. Lengthy alternative text (more than around 100 characters) often indicates that extraneous content or content that is not available to sighted users is being presented.”

         2. “Ensure the alternative text is succinct, yet descriptive. Ensure that no content is being presented in alternative text that is not available to sighted users viewing the image. When possible, either shorten the alternative text or provide the text alternative via another method (e.

      1. Keep it short and descriptive

         1. g., in text near the image, through a separate description page, etc.).”

      2. Do not use quotation marks(“ “) or brackets in the alt text field as they are not supported in Confluence.

      3. If using the alt-text to communicate the full message in a screenshot then it is ok for it to be longer than 100 characters. (E.g. Ensure the alternative text is succinct, yet descriptive. Ensure that no content is being presented in alternative text that is not available to sighted users viewing the image. When possible, either shorten the alternative text or provide the text alternative via another method (e.g., View of archival object in edit mode.)in text near the image, through a separate description page, etc.).

   3. Where to place

      1. Before or after a section?

      2. Immediately following the descriptive text? i.e. if we do step-by-step instructions would we want a screenshot for each step?

   4. Use borderlines around the image to make it more visible - Yes (Note, borderlines are not available in the new Confluence editor.)

   5. How much to crop out (if you crop out too much, the image loses context.)

5. Versioning a page. Pages should be versioned when edits are made to a page based on functional changes introduced in a new version.

   1. Save the page to be versioned and save it as a child of the current page. The child page will serve as instructions for users operating older versions of ArchivesSpace.

   2. Append the title of the child page with the version number of the last relevant version. Use this format: (version x.x.x)

   3. Add the following text under the title of the child page: Note: These instructions apply to an earlier release of ArchivesSpace. Please view the Table of Contents to access instructions for the current release. For information about the most current ArchivesSpace release, please visit: https://github.com/archivesspace/archivesspace/releases/latest

   4. Append the title of the parent page with the first version the instructions refer to. Use this format: (from vx.x.x)

   5. Make your edits to the parent page

   6. For an example of a versioned page, see /wiki/spaces/ArchivesSpaceUserManual/pages/1173913646

...