-
Notifications
You must be signed in to change notification settings - Fork 2
/
README
220 lines (162 loc) · 8.32 KB
/
README
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# Document $Id$
# Summary Important infos about the chemical-mime-data project.
0. Content
==========
0. Content
1. About chemical-mime-data
2. Copyright and License
3. Introduction and configuration
4. Supported MIME types
5. Download and Installation
6. Associate your chemical application with a chemical MIME type
7. TODO
8. Footnotes
1. About chemical-mime-data
===========================
The chemical-mime-data [1] package is a collection of data [2] files to add
support for various chemical MIME types on Linux/UNIX desktops, such as
KDE [3] and GNOME [4].
Chemical MIMEs [5] were proposed [6] in 1995, though it seems they have never
been registered with IANA [7]. But they are widely used and the project's aim
is, to support these important, but unofficial MIME types.
2. Copyright and License
========================
Copyright (C) 2004-2008 Daniel Leidert <[email protected]>.
Copyright (C) 2004-2006 Egon Willighagen <[email protected]>.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Please see the file COPYING or visit http://www.gnu.org [8] to obtain a
copy of the GNU Lesser General Public License.
Initial data was taken from »The Chemical MIME Home Page« of Henry Rzepa [5],
but this compilation is written and continuously extended by Egon Willighagen,
Daniel Leidert and others (see the distributed AUTHORS and THANKS files for a
list of who has contributed to this project).
3. Introduction and configuration
=================================
Newer desktop systems need to know the MIME type to associate applications
with it. Writers of chemical applications can, will and make use of this
feature too. But there are several systems [9], which first need to be
prepared. During the development of Jmol [10] and CDK [11] we came to the
problem, to integrate these applications into the Linux desktop. This issue
raised up the chemicalMIME [12] project, which is the forerunner of the
chemical-mime-data [1] project.
freedesktop.org [13] project system
Newer GNOME [4] and ROX [14] desktops use the Shared MIME-info
Database [15] to determine MIMEs. We provide a file
chemical-mime-data.xml, which has to be installed into the database at
$XDG_DATA_DIRS/mime/packages and follows the freedesktop.org
specification [16]. After running update-mime-database the MIME types are
registered. This should work for all systems and applications mentioned
at [17]. You will need the shared-mime-info package [18] for your
distribution.
To associate an icon for a MIME type, the icon has to be installed into
the hicolor-theme [19] and named e.g.:
gnome-mime-chemical-x-xyz.png
gnome-mime-chemical-x-cml.png
The syntax is:
gnome-<icon-type>-<mime-media-type>-</mime-sub-type>.png
If the icon naming scheme follows this direction, the MIME type is
automatically associated with the icon.
GNOME [4] <= 2.4
Older GNOME [4] desktops use the ${datadir}/mime-info path with .keys and
.mime files [20] to determine [21] MIME stuff. Icons are determined the
same way.
KDE [3] < 4
KDE [3] desktops use the ${datadir}/mimelnk [22] path with .desktop files
to determine MIME stuff. Icons are determined the same way.
If you need more information, checkout the documentation section [23] of the
projects website.
4. Supported MIME types
=======================
Please check the large table form you can find at [2]. This table is also
shipped with the package.
5. Download and Installation
============================
To build and install chemical-mime-data from SVN:
(1) install autoconf, automake, intltool/gettext, xsltproc
(2) get the SVN sources
(3) run autogen.sh (./autogen.sh)
(4) see next part ...
The latest release can always be found in the download section [24] of the
project's website. Make sure to also download the MD5 sum file (.md5) to check
the files integrity. For e.g. the .tar.gz tarball check it with:
md5sum -c chemical-mime-data-<version>.tar.gz.md5
To build and install chemical-mime-data from release tarballs:
(1) Get the required applications:
- intltool/gettext (I18N)
- pkg-config
- xsltproc (create .desktop, .mime, ... files from XML)
- gnome-mime-data
- shared-mime-info (contains update-mime-database)
(2) Configure and compile:
(see ./configure --help for possible configure options)
$ ./configure [options-you-like-most-here]
$ make
(3) Install everything (probably needs root permissions):
$ su
# make install
($: means user-shell, #: means root-shell)
The file INSTALL contains some generic installation instructions.
6. Associate your chemical application with a chemical MIME type
================================================================
To associate the chemical MIME types with a special application, you need to
do the following:
* KDE: [25][26][27] ([25] only for KDE 3.3 and above)
* GNOME [25][28][29][30][31] ([25-28] for GNOME > 2.4, [31] for <= 2.4)
The desktop-file-utils package [32] contains the command-line tool
desktop-file-validate to validate, manipulate and install .desktop files and
to update the database, which holds information about applications and
associated MIME types.
If you need more information, checkout the documentation section [23] of the
projects website.
7. TODO
=======
For a list of things, that need to be done in the near future or for later
releases, refer to TODO.
If you want to have an overview, which features need to be implemented or
which bugs need to be fixed, check the projects tracker [33] page.
8. Footnotes
============
[1] http://sourceforge.net/projects/chemical-mime
[2] http://chemical-mime.sourceforge.net/chemical-mime-data.html
[3] http://www.kde.org
[4] http://www.gnome.org
[5] http://www.ch.ic.ac.uk/chemime/
[6] https://datatracker.ietf.org/public/idindex.cgi?command=id_detail&id=928
[7] http://www.iana.org/assignments/media-types/
[8] http://www.gnu.org/licenses/lgpl.html
[9] http://www.freedesktop.org/wiki/Standards_2fOtherSystems
[10] http://www.jmol.org
[11] http://cdk.sourceforge.net
[12] http://cdk.cvs.sourceforge.net/cdk/chemicalMIME/
[13] http://www.freedesktop.org
[14] http://rox.sourceforge.net
[15] http://www.freedesktop.org/wiki/Standards_2fshared_2dmime_2dinfo_2dspec
[16] http://standards.freedesktop.org/shared-mime-info-spec/latest/
[17] http://www.freedesktop.org/wiki/Standards_2fshared_2dmime_2dinfo_2dspec#head-3aa1d93d613d40c76fc8990ce8985119496b917e
[18] http://www.freedesktop.org/software/shared-mime-info/
[19] http://standards.freedesktop.org/icon-theme-spec/latest/
[20] http://www.freedesktop.org/wiki/Standards_2fOtherSystems#head-84abb4e7909f64bc187f2734fe98576848f7dffd
[21] http://web.archive.org/web/20041024185231/http://www.gnome.org/learn/admin-guide/latest/ch05s02.html
[22] http://www.freedesktop.org/wiki/Standards_2fOtherSystems#head-b4621d6841f56c8aecb7eab95c28aa5a33dc41e0
[23] http://sourceforge.net/docman/?group_id=159685
[24] http://sourceforge.net/project/showfiles.php?group_id=159685
[25] http://standards.freedesktop.org/desktop-entry-spec/latest/
[26] http://www.kde.org/areas/sysadmin/fsh.php
[27] http://developer.kde.org/documentation/tutorials/dot/servicemenus.html
[28] http://www.gnome.org/learn/admin-guide/latest/mimetypes-registering.html
[29] http://www.gnome.org/learn/admin-guide/latest/menustructure-desktopentry.html
[30] http://www.gnome.org/learn/admin-guide/latest/mimetypes-9.html
[31] http://web.archive.org/web/20041024190358/http://www.gnome.org/learn/admin-guide/latest/ch05s03.html
[32] http://freedesktop.org/Software/desktop-file-utils
[33] http://sourceforge.net/tracker/?group_id=159685
# UTF-8