Introduction to YstokHelp

YstokHelp is a help compiler tool. It prepares a help book, documentation on a product or module in HTML format

YstokHelp consists of

• the set of conventions and auxiliary files,
• the software.

A well-formed book provides

• HTML browser-independence,
• jumping to correct page and fragment (anchor) when invoked an application context help,
• cross references within the book,
• convenience of reading sequentially page-by-page,
• pop-up notes.

Files and conventions

A help book author prepares source files in HTML format using CSS2. For a simple book, you need the following:

• correct folder structure,
• navigation pages,
• topic pages,
• auxiliary files.

Software

Help book compiler

The compiler converts flexible links with the non-standard help scheme into final URIs. It also compiles the table of contents (TOC) and index automatically.
The GUI application for Windows is available.

Run time library

Application program interface (API) includes a set of functions invoked by your application. The library is written in Common List and its source code is also available.