The VSdocman output is fully controlled by the output templates. You can modify or create your own templates to customize the output. However, this has one drawback - if a newer version of VSdocman is installed, your changes in the built-in templates may be overwritten and lost.

Therefore, if you only need to change the look of your documentation, there's another and more flexible way. The following applies only to HTML-based output formats, i.e. HTML, CHM, and MS Help Viewer.

You can create a special stylesheet file named vsdocman_overrides.css and insert your own styles or override the existing ones in it. Then you place this file in the External Files Folder which you must specify, if you haven't done it yet. That's all. VSdocman will search for vsdocman_overrides.css file in the external files folder. If it's present, it will be copied to the output folder, otherwise, an empty CSS file will be created instead.

CSS Custom Properties

In addition to the CSS rules, you can set also some predefined properties in this file. The javascript in the html_msdn2019 output will read them and change the behavior of the documentation, such as full-text search options, some links, etc. Currently, there are the following CSS Custom Properties:

Property

Meaning

--searchAlwaysWholeWord

Search option. When set to 'true', the full text search will always work in the "only whole words" mode, even when the search phrase is not inside quotes.

--headerLogoLink

The URL to which the logo in the top header part will point. The top header part is not visible by default, it must be enabled in CSS by setting 'display:block' for #header-top-parent-container1. To set the logo picture, set the CSS properties of the #headerLogo.

--headerTopCustomLineHtml

The HTML of the contents (custom text, links, ...) in the top header part. The top header part is not visible by default, it must be enabled in CSS by setting 'display:block' for #header-top-parent-container1.

By default, these properties are undefined. See the examples below.

Examples

 

 

See Also