File: README.Debian

package info (click to toggle)
xchm 0.9.7-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 1,536 kB
  • ctags: 335
  • sloc: sh: 3,745; cpp: 3,078; makefile: 81; sed: 16; xml: 7
file content (98 lines) | stat: -rw-r--r-- 4,937 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
== Desktop / MIME integration from Loic Minier <lool@dooz.org> ==

 this is quite a lot of things that I wish go in xchm:
 - GNOME <= 2.4 integration (MIME entries, application registry entries
   etc.), not tested
 - freedesktop.org integration (for GNOME 2.6 and maybe KDE),
 - icon for the Debian menu entry.

 I worked a bit on xchm MIME type declaration / integration, and I
 include hereunder a lengthy file I maintained until now:

======================================================================

 This is are MIME support enabling files for xCHM targetting better
 GNOME/KDE integration.

 I am a GNOME user, and I have only tested it with GNOME, it might
 require some additional work to integrate with KDE correctly.  If you
 want to check for support, here are the commands I used:
 - run-mailcap file.chm: will look for the MIME type for .chm files in
   /etc/mime.types or ~/.mime.types, and open the application bound to
   this type in /etc/mailcap with the syntax described in /etc/mailcap,
 - gnome-open display.chm: will look for the MIME type for .chm files in
   the GNOME MIME types database, or in the freedesktop.org shared MIME
   information database, and will open the GNOME application found in
   the GNOME application database or in the freedesktop.org shared
   application database associated to this type.

 It seems two MIME support schemes are being used in GNOME right now,
 - the old one, consisting of .keys, .mime, and .applications files (in
   /usr/share/{mime-info,mime-info,application-registry} respectively),
   seems half broken (.applications aren't picked up any more),
 - the new one, "standardized" by freedesktop.org, consisting of
   .desktop and .xml files (in /usr/share/{applications,mime/packages/}
   respectively).

 Some notes concerning the MIME support enabling files for xCHM:
 - the .dektop Categories: are Application, Viewer, and graphics as
   found on the web, in /usr/share/applications, and in grep '<Name>'
   /etc/gnome-vfs-2.0/vfolders/applications-all-users.vfolder-info,
 - looking in my Graphics directory, I see that the .desktop Name: of
   some entries isn't related to the name of the program, but to what
   they do.  I have no idea on what the GNOME HID guidelines are
   suggesting.  This program is explicitely targetting CHM files, and
   the users will probably recall they have installed xCHM to view CHM
   files anyway,
 - most viewers use the french translation "Visionneur" for "viewer",
   which isn't a french word AFAIK.  I used "Visionneuse" instead,
 - the xchm.keys, xchm.applications, and xchm.mime files have been
   guessed from a lot of sources, I couldn't find an exhaustive
   reference for them, especially for the priority of keys like
   default_action_type, open, view,
   short_list_application_ids_for_novice_user_level, and also for the
   category key

 TODO.Debian:
 - regarding MIME integration:
     - I have no idea how to submit new patterns for the
       /etc/gnome-vfs-mime-magic file to be updated, it seems we can do
       some filename based pattern matching meanwhile
     - debhelpers lacks a tool to update the shared mime-info database,
       my first attempt is #255719, but I'll have to re-submit something
       better, I've now idea when.
       (This is for /usr/share/mime, I think the correct way to extend
       /usr/share/mime/packages/freedesktop.org.xml is to package a
       /usr/share/mime/packages/xchm.xml file)
 - GNOME support: gconf, gvfs, DnD, recent-files, session mgt, ...
   (see <http://primates.ximian.com/~federico/news-2004-05.html#25>)
 - point to dummy manual page
 - Debian menu icon

 Other things to do in xCHM:
 - support for opening multiple files
 - support for opening urls (either via gvfs or standalone)
 - manual page

 Other things to do for the CHM file format:
 - register a real MIME type - at IANA:
   I have done some MIME type research for the CHM files, and
   unfortunately, nobody bothered to register it.  I have submitted
   "application/vnd.ms-chm" to the IANA on july the 11th, I have no idea
   wether they'll accept it.  I think it's ok to use the
   application/x-chm type meanwhile: I believe */x-* is meant for local
   extensions.
 - register file hinting in the appropriate databases:
   I've found that this sequence of bytes is the appropriate one for
   detecting CHM files (from /usr/share/misc/file/magic):
   0 string ITSF\003\000\000\000\x60\000\000\000\001\000\000\000
   CHM files support should be integrated in:
   - /etc/gnome-vfs-mime-magic
   - /usr/share/misc/file/magic.mime (with the appropriate MIME type)
   - the freedesktop.org equivalent of the magic file
 - register the MIME type in /etc/mime.types:
   I wrote to mime-support@packages.debian.org on Tue, 22 Jun 2004
   15:46:39 +0200.  No new mime-support package has been published
   since.

 -- Julien Lemoine <speedblue@happycoders.org>, Mon Jul 12 08:23:34 2004