473,387 Members | 1,283 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,387 software developers and data experts.

Win32 documentation in CHM?

It seems the Gods are proposing to distribute the documentation and help
for Python-2.3.1 in .chm form. I particularly detest .chm and much
prefer .html as it works across all platforms. Additionally by having a
single index.html for all of the various bits of Python help I can link
in things like Pmw, PIL and Quick Guide etc with a simple text editor.

The argument is made that .chm is a better mechanism (more searchable
indexable etc) for help/documentation than html. Is that really so? HTML
is at least an open standard.
--
Robin Becker
Jul 18 '05 #1
8 5737

"Robin Becker" <ro***@jessikat.fsnet.co.uk> schrieb im Newsbeitrag
news:CD**************@jessikat.fsnet.co.uk...
It seems the Gods are proposing to distribute the documentation and help
for Python-2.3.1 in .chm form. I particularly detest .chm and much
prefer .html as it works across all platforms. Additionally by having a
single index.html for all of the various bits of Python help I can link
in things like Pmw, PIL and Quick Guide etc with a simple text editor.

The argument is made that .chm is a better mechanism (more searchable
indexable etc) for help/documentation than html. Is that really so? HTML
is at least an open standard.


chm is more compact and nicely packaged. It in fact is basically nothing but
html and you can unpack it if you want. There are lots of tools - look for
arCHMage e.g. which is a Unix chm viewer and decompiler...

Kindly
Michael P
Jul 18 '05 #2
"Robin Becker" <ro***@jessikat.fsnet.co.uk> wrote in message
news:CD**************@jessikat.fsnet.co.uk...
The argument is made that .chm is a better mechanism (more searchable
indexable etc) for help/documentation than html. Is that really so?


I've certainly found it so in the ActiveState distribution, which packages
the Python docs, plus selected third-party docs -- win32all, Dive Into
Python -- into a unified HTML Help package. Very, very handy to be able to
quickly look things up in a common index, or search across the whole lot.

(Still waiting for a 2.3 ActiveState distro, though...)

James
Jul 18 '05 #3
In article <bi************@ID-71831.news.uni-berlin.de>, James Kew
<ja*******@btinternet.com> writes
"Robin Becker" <ro***@jessikat.fsnet.co.uk> wrote in message
news:CD**************@jessikat.fsnet.co.uk...
The argument is made that .chm is a better mechanism (more searchable
indexable etc) for help/documentation than html. Is that really so?


I've certainly found it so in the ActiveState distribution, which packages
the Python docs, plus selected third-party docs -- win32all, Dive Into
Python -- into a unified HTML Help package. Very, very handy to be able to
quickly look things up in a common index, or search across the whole lot.

(Still waiting for a 2.3 ActiveState distro, though...)

James

the previous poster mentioned decompilers, can one then add other links
and then recompile with such beasts?

I like being able to down load someone's pdf slides on meta classes
into python/doc/xtras and then add a link to them to the main help
index. I am also fairly religious about not using IE.
--
Robin Becker
Jul 18 '05 #4
> the previous poster mentioned decompilers, can one then add other links
and then recompile with such beasts?


On Windows, just use the MS HTML Help Workshop:

http://go.microsoft.com/fwlink/?LinkId=14188

Jul 18 '05 #5
> I've certainly found it so in the ActiveState distribution, which packages
the Python docs, plus selected third-party docs -- win32all, Dive Into
Python -- into a unified HTML Help package. Very, very handy to be able to
quickly look things up in a common index, or search across the whole lot.

(Still waiting for a 2.3 ActiveState distro, though...)


The pythlp.py script, available at:

http://www.orgmf.com.ar/condor/pytstuff.html

still seems to work fine for python 2.3
It'll create an HTM Help project for you, incorporating all std docs,
which you then need to compile to CHM using the HTML Help Workshop:

http://go.microsoft.com/fwlink/?LinkId=14188

Cheers,

Bernard.

Jul 18 '05 #6
Robin Becker <ro***@jessikat.fsnet.co.uk> wrote in message news:<CD**************@jessikat.fsnet.co.uk>...
It seems the Gods are proposing to distribute the documentation and help
for Python-2.3.1 in .chm form. I particularly detest .chm and much
prefer .html as it works across all platforms. Additionally by having a
single index.html for all of the various bits of Python help I can link
in things like Pmw, PIL and Quick Guide etc with a simple text editor.

The argument is made that .chm is a better mechanism (more searchable
indexable etc) for help/documentation than html. Is that really so? HTML
is at least an open standard.


I don't think there is any intention to discontinue generation of
HTML, PDF, and other formats of the documentation. You can currently
get it here:

http://www.python.org/ftp/python/doc/2.3/

and presumably http://www.python.org/ftp/python/doc/2.3.1/ once it's
released.

They are just changing the Windows default install to provide standard
Windows help files.

Windows is currently the only platform where documentation is
installed by default. A standard 'make && make install' on ohter
doesn't do anything with the documentation. Everyone else has to
download it anyways, or use the magical incantations necessary to
generate it from the LaTeX source.
Jul 18 '05 #7
In article <ma**********************************@python.org >, Tim Peters
<ti*****@comcast.net> writes
......
You cannot have used a properly constructed .chm file and seriously question
whether it's more searchable. Of course it is, including seemingly
instantaneous Boolean, proximity, wildcard, and similarity searches, across
the entire doc set with one query. I don't know of any way to search thru
more than a thousand .html files that's even arguably comparable; e.g., grep
is a slow & painful joke in comparison.

amazingly I still disagree, somehow I still prefer the html files.
Perhaps I just hate IE.
--
Robin Becker
Jul 18 '05 #8
Robin Becker wrote:

In article Tim Peters writes
.....
You cannot have used a properly constructed .chm file and seriously
question whether it's more searchable. Of course it is, including
seemingly instantaneous Boolean, proximity, wildcard, and similarity
searches, across the entire doc set with one query.


amazingly I still disagree, somehow I still prefer the html files.
Perhaps I just hate IE.


The CHM search-abilty is definitely a plus, but I am also have my
resivations. In fact I think the WinHelp file format was a much
better help system. The WinHelp view was much faster loading, less
likely to crash and also just as easily searched. The original
HtmlHelp viewer was a real step backwards in comparison.

Grnated, the newer versions of the HTML viewer are more stable, but
they are still very demanding in terms of system memory. Try using
the Microsoft MSDN and watch your system grind to a halt :(

Even today the Zeus Quick Help keywords searching is still a lot
faster if the source of the keyword is a WinHelp file compared to
a HtmlHelp file.

Jussi Jumppanen
Author of: Zeus for Windows (All new version 3.90 out now)
"The C/C++, Cobol, Java, HTML, Python, PHP, Perl programmer's editor"
Home Page: http://www.zeusedit.com
Jul 18 '05 #9

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

19
by: Dave | last post by:
Hi, I have done some research, trying to Clear The Screen in java code. The first option was the obv: system.out.print("\n\n\n\n\n\n\n\n\n\n\n\n"); then i heard about this method:...
4
by: Jed R. Mallen | last post by:
Hello, Can anyone point me to a nice tute on making python apps for win32? TIA
4
by: Matthew K Jensen | last post by:
In one of my "because I can" projects, I want to be able to see the enabled network interfaces on a machine. I have no clue as to how to do this. Any suggestions?
28
by: Grant Edwards | last post by:
I finally figured out why one of my apps sometimes fails under Win32 when it always works fine under Linux: Under Win32, the pickle module only works with a subset of floating point values. In...
2
by: Christopher Subich | last post by:
From the documentation, it looks like DParser-python will do what I need, but I'm having trouble getting it installed properly. I'm using a win32 environment, with official 2.4 Python binaries. ...
1
by: M. David Allen | last post by:
Hello, I've been using ActiveState's ActivePerl to generate Excel spreadsheets using the Win32::OLE module. The rudimentary examples that are out there on the web show the way to set up...
1
by: DrDevious | last post by:
Maybe I am doing something wrong but has anyone else here noticed a difference in the positioning of text between the Graphics.DrawString method and the Win32 GDI DrawText function? My text is...
0
by: Veli-Pekka Tätilä | last post by:
Hi, My first post here. I've found some serious accessibility flaws in the Python 2.4 docs and wish they could be rectified over time. I'm very new to Python and initially contacted docs at python...
3
by: Sygnosys | last post by:
Hi, I have a piece of code in .NET that encrypts a string. The .NET code is quite simple and through the last couple of days I've been trying to build it's equivalent in ATL playing arround...
7
by: Timothy Madden | last post by:
Hello I would like to use php-cli as a sort of shell scripting language or generic scripting language. I have php 5.2 on WindowsXP and I would like to call Win32 API functions like...
0
by: Charles Arthur | last post by:
How do i turn on java script on a villaon, callus and itel keypad mobile phone
0
by: ryjfgjl | last post by:
If we have dozens or hundreds of excel to import into the database, if we use the excel import function provided by database editors such as navicat, it will be extremely tedious and time-consuming...
0
by: ryjfgjl | last post by:
In our work, we often receive Excel tables with data in the same format. If we want to analyze these data, it can be difficult to analyze them because the data is spread across multiple Excel files...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
0
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven...
0
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.