krypton-suite / help-files

Contains the SHFB projects, used to create offline help files.

Krypton Toolkit Help Files

Welcome to the Krypton Toolkit help files repository!

What is this repository for?

The Krypton Toolkit help files repository contains all the files required to create the end-user documentation for the Krypton Toolkit projects. You can download the latest files here.

Prerequisites

In order to build the documentation, you must have the following:-

• The latest Krypton Toolkit DLL/XML files
• The latest Sandcastle Help File Builder
• Time (plus a beverage of your choice ;-))

To build

• Open Source\Standard Toolkit\Full Documentation\Full Toolkit Documentation\Full Toolkit Documentation.shfbproj
• Remove all entries under Documentation Sources
• Add the current DLL/XML files to Documentation Sources
• Update the version number in Help File -> Help file version
• Build - Note: this will take some time

The generated output will be located in Source\Standard Toolkit\Full Documentation\Full Toolkit Documentation\Help. Rinse & repeat for the Extended Toolkit.

help-files's Issues

Help pages don't have a "Home" button

To reproduce:

• Go to: https://krypton-suite.github.io/Standard-Toolkit-Online-Help/Source/Help/Output/index.html

From here you can choose from several options but after that you can never return to the start page.

I think a Home button might be a good addition...

[Feature] Can the SHFB output also be in md format and then accessible via web links

i.e. replace the chm and html output
then add links from the other sites to this / here

Downloads from Releases are not available

Clicking on the OneDrive link on the Releases pages just says "This element is not available any more".

Maybe it would be better to add the files as assets to the releases themselves here on GitHub.

Where is the Standard Toolkit exe help file released?

Create a new help file out of the old `Help3.mshc` file

FAR5 is now free https://www.helpwaregroup.com/blog

[Request] Readme needs to state what options are needed from SHFB guided installer to get this working

and a link to https://github.com/EWSoftware/SHFB/releases