Yes. Un-check Show sections with no relevant metadata to document option
ApexSQL Doc can create documentation in 5 different output formats:
- CHM format (Compiled Help File Format)
- Linked HTML
- HXS (Help 2 Compiled Help File)
- Doc (Word document 97 - 2003)
- Docx (Word document 2007,2010)
Yes. Add all the servers and databases that will be documented. SSIS packages can be documented in the same file
Yes. Uncheck Delete chm intermediary files (applicable to chm output format only) option. The various CHM project files and the associated HTML content files will be saved in the Intermediary subfolder. These files can be edited at will. Once the edits are complete, simply compile the .chm file manually using the MS Help File Compiler – hhc.exe – located in the ApexSQL Doc installation folder. The 'hhc.exe' must be run via a command line:
hhc <filename>
where <filename> = help compiler project file *.hhp created in the project 'Intermediary' folder
Example: hhc myfile.hhp
Yes. ApexSQL Doc generates Permissions section with appropriate permissions per user or role
Yes. ApexSQL Doc decrypts encrypted functions, stored procedures, triggers and views . The user must be a system administrator
If the referenced database is not included in the documenting process, ApexSQL Doc will not document cross-database dependencies. To document such dependencies all dependent databases must be selected for documenting
Yes. Make sure Include extended properties option is selected. Select the extended property that will be shown as the custom description. The default extended property is MS_Description
Yes. To compile HTML project to CHM format, run the following command in CLI:
%ApexSQL Doc path%\hhc.exe %HTML files path%\apexdoc.hhp
Where %ApexSQL Doc path% is the installation folder of ApexSQL Doc and %HTML files
path% is the directory where the HTML files that are to be compiled are stored
To compile your HTML project to Help2 format, run the following command:
%Help 2.0 SDK path%\hxcomp.exe" -p %HTML files path%\apexdoc.HxC
Where %Help 2.0 SDK path% is the folder of Help 2.0 SDK and %HTML files path% is
the folder where the HTML files that are to be compiled are stored
Project has been already registered after generation by ApexSQL Doc. Simply run the following command:
"C:\Program Files\Common Files\Microsoft Shared\Help\dexplore.exe" /helpcol ms-help://Namespace/TitleID
Where Namespace is the help file namespace and TitleID is a title identifier of the help file