Adding styles to the template
When Clarify generates a DOCX file it assigns certain styles to the content. You will need to add these styles to your DOCX template in order for the content to look correct.
Note that some of the styles listed are only applicable to ScreenSteps and not Clarify. These styles are listed so that you can add them in case you ever want to use the template with ScreenSteps.
You will need to add the following styles to your document.
- Chapter Heading: Styles chapter titles. [ScreenSteps only]
- Article Description: Styles article descriptions.
- Article Heading: Styles article titles.
- Step Heading: Styles step titles.
- Substep Heading: Styles sub-step titles.
- Step Instructions: Styles step text.
- ScreenSteps Code: Styles code blocks in step text.
- ScreenSteps Code Run: Styles instances of code within paragraph text.
- ScreenSteps List Number, ScreenSteps List Number 2, ScreenSteps List Number 3, ...: Styles numbered lists. Create as many entries as levels of nesting your documents may have. The templates included with Clarify go up to ScreenSteps List Number 5.
- ScreenSteps List Bullet, ScreenSteps List Bullet 2, ScreenSteps List Bullet 3, ...: Styles bullet lists. Create as many entries as levels of nesting your documents may have. The templates included with Clarify go up to ScreenSteps List Bullet 5.
- Step Image: Styles step images.
Opening the Styles editor (Word 2013 on Windows)
Manage Styles
Chapter Heading, Article Heading, Step Heading, and Substep Heading
For the heading styles you can base them off of existing heading styles that come with Word.
If you are creating a manual template then base Chapter Heading on Heading 1, Article Heading on Heading 2, etc.
If you are creating an article template then you can base Article Heading on Heading 1, Step Heading on Heading 2, etc.
Article Description and Step Instructions
ScreenSteps Code
The ScreenSteps Code style is used to format code blocks and is based on the Normal style.
Here are some baseline settings you can use for code blocks:
- Font: Courier New, color set to 51,51,51.
- Border: Box with a solid line set to 1 pt thick with color set to 208,208,208. The border padding is set to 8 pt on top, left, bottom, and right. The shading is set to 245,245,245. This provides the background color.
ScreenSteps Code Run
The ScreenSteps Code Run style is used to format instances of code within a paragraph and is a Character type based on the Default Paragraph Font style.
Here are some baseline settings you can use for code blocks:
- Font: Courier New, color set to 187,0,0.
- Border: Go to the Shading tab and set the Fill to 224,224,224.
Step Image
The Step Image style can be based off of Normal. Use this style to add padding around the image. For example, you might set the Space Before and Space After in the paragraph settings to 18pt.
ScreenSteps List Bullet, ScreenSteps List Bullet 2, ScreenSteps List Bullet 3, ScreenSteps List Bullet 4, ScreenSteps List Bullet 5, ...
ScreenSteps List Number, ScreenSteps List Number 1, ScreenSteps List Number 2, ScreenSteps List Number 3, ScreenSteps List Number 4, ScreenSteps List Number 5, ...
Example Settings
Here are some example settings for list numbers.
0 Comments
Add your comment