Technote Details :: Installing help for KTML in Visual Studio
Issue
This technical note will explain what are the files provided in the distributed archive and how to use them in order to install KTML help for Visual Studio and MSDN.
Reason
The KTML package for Visual Studio has the following structure:
[bin]
InterAKT.Common.dll
InterAKT.KTML4.dll (/InterAKT.KTML4VERSION.dll)
[includes]
- files & folders required
WebForm.aspx: sample file
web.config: config file
[docs]
[chm]
InterAKT.KTML4.chm: chm doc file
[msdn]
files required for Visual Studio & MSDN integration:
register_KTML4.bat / unregister_KTML4.bat
Solution
To install the documentation and integrate it with Visual Studio and MSDN, follow the next steps:
- If you have any open Visual Studio or MSDN instances close them.
- Execute the docs\msdn\register_KTML4.bat file. This will copy all necessary files and set the correct options in order to add the KTML help into MSDN.
To remove the KTML documentation from Visual Studio and MSDN:
- Close all running instances of Visual Studio and MSDN.
- Run docs\msdn\unregister_KTML4.bat. This will remove all files and settings that integrate KTML with MSDN and Visual Studio.