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