The Skin
The Project Skin
The Skin of a project defines the overall appearance of the User-Interface. It contains the company logo and is purpose-designed to align with the theme of other published company documentation.
The colours and textures within the Skin generally use company-branded colours and its output generally resembles a web page containing an index (table of contents) the content and a browser tab. A FavIcon can be used in the browser tab which is generated from the company's logo.
The style elements and features of the Skin are updated in the resident skin in the project, found in Project \ Skins.
The Skin is required to be designated in the Target.
When the content is generated, an output which is web, tablet and mobile responsive is automatically generated in the output folder.
Updating the project Skin is done by opening the required skin file in the Project \ Skins folder.
The following Skin style elements can be updated from within the editor :
-
Global
-
Header
-
Side Navigation
-
Search Results
-
Topic Properties
The FavIcon
The FavIcon is the branding logo which appears in the tab browser when the documentation is opened. It is incorporated into the main Skin by assigning a FavIcon in the Target.
The FavIcon can be resized for multiple outputs such as a Windows or iOS/Android application and a general web browser. A sample is shown below.
Creating the FavIcon
-
To update the FavIcon, open this file from the Project \ Skins folder in the editor.
-
Make sure the image file is correctly assigned in the Main FavIcon field.
-
Select the Options dropdown under each application and update the icon file or the size as required.
See Also