Lexikos/AutoHotkey_L-Docs — pull request #95 by Ragnar-F (2014-04-30 12:26:54+00:00)
Title: Navigation components

Since the online help is currently difficult to navigate, I thought to add navigation components, which should help the reader.
I created a [temporary sample page] (https://googledrive.com/host/0Bw_Sh-zoqtWpbTVCVG1Gb00tT2c/docs/AutoHotkey.htm) how this would look like. The German help already includes these components. Until now there were only positive feedbacks, and multiple requests to integrate them into the English help.

The navigation components are:

- a sidebar, which is similar to the one from the chm help; including content tab and index tab (the data are extracted from the .hhc and .hhk files).
- a search box; via Google in the format "search-term site: domain"
- a button to change the language
- automatically add # anchors for headings that don't have an anchor

All this is based on javascript/jquery.
The .hhc and .hhk files must be on the same level as the docs folder.
The config.xml contains currently only data for the purpose of translating and must be on the same level as content.js.
Inside a chm file, the components are not displayed due to an automatic detection.
Successfully tested in IE 8-11, Chrome and Firefox.
The performance should be ok, but it's mainly depending on browser and connection, which in case it would be noticeable especially at initial startup.
If JavaScript is disabled for some reason, the pages are displayed as before (without the components).