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.

For information on the Review Process, see the User Documentation Review Process page.

Step 1. Layout and format - create a template

...

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 screen shots

   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. 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 screen shot for each step?

   3. Use borderlines around the image to make it more visible - Yes

   4. 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

...