Scite documentation in CHM format?

57 views
Skip to first unread message

zetah

unread,
Jan 13, 2013, 3:37:44 PM1/13/13
to scite-i...@googlegroups.com
I think that almost all documentation generators provide option for CHM output.

I personally find CHM handy as it's fast, doesn't require opening whole browser, nor Internet connection, and it's just great help system - it's very very light, has TOC, index, search pane and bookmark pane and is very flexible being generated from HTML. It's also available on any platform, thou maybe non-Windows users aren't aware of it. Can be also called on specific indexed keyword automatically as Scite provides special subsystem for CHM files.

In Scite source however I can't see how documentation is generated. There are ready made HTML files (some generated by Python scripts) that are declared as XHTML, but half of these files aren't XHTML and can't be accessed by XML tools without manually changing or deleting parts. Some I guess aren't auto-generated from source, but who knows...
So before even considering script for generating CHM project files from available sources, maybe there is already such option and I don't see it?

Neil Hodgson

unread,
Jan 13, 2013, 3:49:20 PM1/13/13
to scite-i...@googlegroups.com
zetah:

> In Scite source however I can't see how documentation is generated.

The HTML files are mostly hand-edited and there are some parts generated by Python scripts.

> There are ready made HTML files (some generated by Python scripts) that are declared as XHTML, but half of these files aren't XHTML and can't be accessed by XML tools without manually changing or deleting parts.

Fixing XHTML bugs may be worthwhile.

Neil

zetah

unread,
Jan 13, 2013, 4:22:03 PM1/13/13
to scite-i...@googlegroups.com, nyama...@me.com
On Sunday, January 13, 2013 9:49:20 PM UTC+1, Neil Hodgson wrote:
   Fixing XHTML bugs may be worthwhile.

I guess I can provide fixed versions, as most XHTML errors can be corrected safely, except "SciTEDoc.html" which contains IDs with illegal character - "*", i.e. "id='property-autocomplete.*.start.characters'"
In "other.properties", default help call for .properties file's "keywords", depends on these ids

Reply all
Reply to author
Forward
0 new messages