SPDocKit Consultant
Try it for FreeContact UsProduct Site
  • SPDocKit Consultant by Syskit
  • Product Updates
    • SPDocKit Consultant 12
    • SPDocKit Consultant 11.1.0
    • SPDocKit Consultant 11
    • SPDocKit Consultant 10
    • SPDocKit Consultant 9.1.0
    • SPDocKit Consultant 9
    • SPDocKit Consultant 8.0.3
    • SPDocKit Consultant 8
  • Requirements
    • SharePoint On-Premises User Permissions Requirements
    • Supported SharePoint Editions
    • System Requirements
    • Server Load Permission Requirements
    • Service Application Permission Requirements
  • Installation
    • Installation Guide
    • Upgrade to the Latest Version
    • Uninstallation Guide
    • PowerShell Guide
  • Activation
    • Activation Privacy Statement
    • Online Activation
    • Offline Activation
    • Manage License
    • Activation FAQ
    • Consultant License FAQ
  • Get To Know SPDocKit Consultant
    • Backstage Screen
      • Options Wizard
      • Compare Wizard
    • Farm Explorer Screen
      • Farm Dashboard
      • Farm Explorer Reports
      • Passwords and Product keys
    • Best Practices Screen
    • Snapshots Screen
    • PowerShell Commands
  • How To
    • Create Snapshot
    • Farm Documentation
      • Create Farm Documentation
      • Customize Documentation Template
    • Compare Wizard
      • Compare Farms
      • Compare Servers
      • Compare Web Applications
      • Compare Site Collections
      • Compare Web.Config Files
    • Best Practices
      • Available Best Practices Reports
      • Create Custom Best Practices Reports
      • Personalize Best Practices Reports
    • Generate an AutoSPInstaller XML Configuration File
  • FAQ
    • Miscellaneous
    • Security
    • Troubleshooting
      • RPC Server is Unavailable
      • Could not access content database
      • Error occurred while loading Web Application
      • Error occurred while trying to load ‘Problems and Solutions’ and ‘Rule Definitions’
      • Error while loading IIS Settings Information
      • Errors while trying to load the SharePoint farm
      • Errors while loading server information
      • Failed at retrieving SQL Accounts from the following servers
      • The service application 'UPA Name' does not have any proxies that are default in a proxy group
      • SQL Server is unavailable
  • Known Issues
    • CREATE TABLE permissions denied
    • Distributed Cache loading issue
    • Load crashes with NullReference exception
    • Available Windows updates
    • PowerPivot FileNotFoundException issue
    • Unaccounted differences in the UPA settings
Powered by GitBook
On this page
  • Quick guide
  • Customizing styles
  • Customizing Table Styles

Was this helpful?

  1. How To
  2. Farm Documentation

Customize Documentation Template

This article describes how to use a documentation template (.dotx) to generate SharePoint Farm documentation with SPDocKit Consultant.

PreviousCreate Farm DocumentationNextCompare Wizard

Last updated 2 years ago

Was this helpful?

Quick guide

To prepare a template for your documentation, you need to prepare a Word document template and customize Word styles. SPDocKit Consultant uses Word styles to generate customized output to match your corporate branding.

  1. Create a custom Word document template (.dotx). Use your existing template or download our

    We recommend you use the Medium Shading 1 – Accent 1 table style with this template. Customize the following styles to match your corporate branding: Heading1, Heading2, Heading3, Heading4, Normal and Hyperlink (you can make any changes required as long as these changes are performed over the style itself).

  2. Customize the table styles to match your branding.

  3. Customize headers and footers to add your company name, page numbers, etc.

  4. Customize the front page.

  5. Remove extra content except for the custom front page (or first few pages) that you wish to be included in every document.

  6. Start SPDocKit Consultant.

  7. In the Home ribbon, click Change Styles.

  8. Select Upload a Custom Template. Click Next to continue.

  9. Browse your Word template (.dotx) and choose the table style you want to use when generating tables (we recommend you use Medium Shading 1 – Accent 1 with ).

  10. Click Finish to save.

Customizing styles

SPDocKit Consultant uses the following default Word styles to generate documentation:

  • Heading1, Heading2, Heading3 and Heading4 – used to generate section headings.

  • Normal – used to generate paragraph text.

  • Hyperlink – used for hyperlinks.

SPDocKit Consultant styles need to be customized to match your corporate or other desired branding. To modify a Style in Microsoft Word do the following:

  1. From the Styles ribbon right-click the style you want to customize.

  2. From the context menu choose Modify.

  3. A new dialog will open. Use it to make the desired changes (font, size, etc.)

Customizing Table Styles

To brand tables used in SharePoint farm documentation, you need to customize one of the built-in table styles. We currently support these styles:

  • Table Grid

  • Light Shading

  • Light Shading – Accent 1

  • Light Shading – Accent 3

  • Light Shading – Accent 4

  • Light Shading – Accent 5

  • Medium Shading 1 – Accent 1

  • Medium Shading 1 – Accent 4

  • Medium Shading 1 – Accent 5

  • Light Grid – Accent 6

  • Medium Grid 1 – Accent 4

  • Medium Grid 1 – Accent 5

  • Medium List 2 – Accent 1

  • Medium Grid 2 – Accent 2

  • Medium Grid 2 – Accent 3

To customize the table style do the following:

  1. Insert a table into the template document. (the table will be removed in the last step)

  2. From the Table Tools contextual ribbon, expand Table Styles.

  3. Right-click the style you want to change and choose Modify Table Style.

  4. Make the changes to the table style to match your desired branding. Pay special attention to the formatting of the whole table, header row, odd and even banded rows.

  5. Remove the table you inserted in step 1.

You can read more about

sample documentation template.
our template
style basics in Word here.