Style Guides
A style guide helps content creators and publishers maintain consistency in their content presentation. It provides guidelines on spelling, grammar, punctuation, capitalization, formatting, and other elements of written communication.
The purpose of the style guides is to provide the ability to overwrite the default PlexTrac formatting during the report export process. The style guides only apply to Jinja templates exported to Word (.doc). Style guides do not impact rich-text fields.
PlexTrac provides a default template that can be configured, leveraged, or cloned to create other style guides. There is no limit to the number of style guides.
The default style guide cannot be deleted.
The style guide consists of four tabs/sections:
- Code blocks
- Images
- Tables
- Hyperlinks
This tab defines the code block experience, including font, font size, font color, background color, border color, width, content alignment, and padding.
This tab defines the image experience, including caption font and prefix, border style, image width and alignment, and padding.
The options to add a border color and width only appear when a border style is selected. If the border style value is "None," color and width options are hidden.
When adding an image prefix label, include any desired punctuation within the "Prefix" box. For example, "Figure:".
This tab defines the table experience, including caption font and prefix, and the table justification within the content.
When adding a table prefix label, include any desired punctuation within the "Prefix" box. For example, "Table:".
This tab defines the font color of links.
Step 1: Click the box.
Step 2: Choose the desired color by clicking in the color box, dragging the circle to the desired color, or entering the hex color code in the provided box.
Step 3: Click X to remove the overlay.
Click Reset under the "Color Options" pulldown menu to revert to the previously selected color.
Step 1: From the Admin Dashboard, click Templates under "Customizations," then click the Style guides tab. Click Create style guide.
Step 2: Select if starting from the default style guide provided by PlexTrac or an existing style guide. Click Create.
If no other style guides exist, the only option in the pulldown menu will be the default style guide.
Step 3: Enter a name for the new style guide.
There is a 100-character limit to a style guide title.
Step 4: Configure the style guide to the desired experience by navigating between the four tabs. Click Create style guide when finished.
A style guide must be associated with an export template to be leveraged. The export template is then associated with a report template, which is then associated with a report. The instructions below assume all files (style guide, export template, report template, and report) exist.
Step 1: From the Admin Dashboard, click Templates under "Customizations," then click the Export templates tab and find the desired export template to associate with the style guide.
Step 2: Under the "Style Guide" column of the table of the export template, select the desired style guide from the pulldown menu.
Any report templates with this export template associated will now leverage the style guide. If no report templates are associated with this export template, continue with Step 3.
Step 3: Click the Report templates tab.
Step 4: Click Edit from the "Actions" column.
Step 5: From the pulldown menu under "Export template," select the export template from Step 1. Click Save.
Any reports associated with this report template will now leverage the style guide when exported. If no reports are associated with this report template, continue with Step 6.
Step 6: Click the Reports module from the left navigation bar. Click the row of the impacted report.
Step 7: Click the Details tab.
Step 8: Go to the "Report Template" field and select the report template in the pulldown menu from Step 4. Click Save.
The next time this report is exported (assuming it is a Jinja template), it will reflect the configuration of the associated style guide from Step 2.
Last modified 16d ago