Logout

Alt-N Discussion Groups > MDaemon Discussion Groups > MDaemon API > Branding the XML API Documentation portal

 [F] Alt-N Discussion Groups  / MDaemon Discussion Groups  / MDaemon API  /

Branding the XML API Documentation portal

[Personett, Keith]
Keith Personett
Newbie
Newbie
Posts: 76
Keith Personett - 01:23pm, Jul 31 2020

Version 20.5 and newer

This feature is especially appealing in hosting scenarios, where API access for hosting customers is desired, and the admin wants to present a custom style to the portal.

Note that branding by domain will not operator correctly if the URL used to access the server is an IP address. It must be a properly resolved A or CNAME DNS record.

The Branding subdirectory should be created under the WebAdmin/Templates directory if it does not already exist. The majority of the CSS classes and ids used in the XSL transformation of the help document xml files is listed in MdMgmtWS.css.

When the documentation is accessed via the website portal, after the default CSS styles are emitted from the XSL transformation, the following script and stylesheet references are included within the HTML output stream.

/Branding/MdMgmtWS.js
/Branding/{DomainNameFromServerName}/MdMgmtWS.js
/Branding/MdMgmtWS.css
/Branding/{DomainNameFromServerName}/MdMgmtWS.css

This allows the admin to customize the documentation portal globally, and also allows for a cascade to the domain level for custom formatting by domain. A sample company.mail directory is provided under the MDaemon\Docs\API\XML API\Samples\Branding directory of your MDaemon installation.

MDAEMON\WEBADMIN\TEMPLATES\BRANDING
│ MdMgmtWS.css
│ MdMgmtWS.js
│ SmallBanner.png

├───hellfire.int
│ MdMgmtWS.css
│ MdMgmtWS.js
│ SmallBanner.png

├───oscorp.int
│ MdMgmtWS.css
│ MdMgmtWS.js
│ SmallBanner.png

└───shield.int
        MdMgmtWS.css
        MdMgmtWS.js
        SmallBanner.png

  All MessagesOldest ItemsOlder ItemsNewer ItemsNewest Items

(No messages yet.)

  All MessagesOldest ItemsOlder ItemsNewer ItemsNewest Items



 Content:

Read New | Search

 Guest:

Email to Admin



You are visiting as a Guest user.