| 1 |
# Document $Id: HACKING,v 1.3 2007/01/28 17:58:41 dleidert Exp $ |
| 2 |
# Summary Hacking on and contributing to the project. |
| 3 |
|
| 4 |
Terms like "MAY", "MUST", "MUST NOT", "RECOMMEND", "SHALL" and "SHOULD" are |
| 5 |
based on RFC 2119 (http://www.ietf.org/rfc/rfc2119.txt). |
| 6 |
|
| 7 |
1. General |
| 8 |
2. MIME type database |
| 9 |
3. Icons, Graphics and Art |
| 10 |
4. Stylesheets |
| 11 |
5. Website |
| 12 |
|
| 13 |
|
| 14 |
1. General |
| 15 |
========== |
| 16 |
|
| 17 |
All source files MUST be UTF-8 encoded. |
| 18 |
|
| 19 |
All source files MUST contain a copyright and a short license information. A |
| 20 |
copyright is granted with significant changes (don't forget to add or update |
| 21 |
the copyright information in such a situation). |
| 22 |
|
| 23 |
All source files SHOULD contain an ID and summary line at the top of the file |
| 24 |
or at least in the head section. It's format SHALL be for text files: |
| 25 |
|
| 26 |
# Document $Id: HACKING,v 1.3 2007/01/28 17:58:41 dleidert Exp $ |
| 27 |
# Summary ...summary... |
| 28 |
|
| 29 |
and for XML files: |
| 30 |
|
| 31 |
<!-- |
| 32 |
Document $Id: HACKING,v 1.3 2007/01/28 17:58:41 dleidert Exp $ |
| 33 |
Summary ...summary... |
| 34 |
--> |
| 35 |
|
| 36 |
Files of the build system, like e.g. Makefile.am, configure.ac or XSLT |
| 37 |
stylesheets, SHALL be licensed with a non-restrictive all-permissive |
| 38 |
license: |
| 39 |
|
| 40 |
# This file is free software. The copyright owner gives unlimited |
| 41 |
# permission to copy, distribute and modify it. |
| 42 |
|
| 43 |
ChangeLog entries MUST follow the GNU coding standards |
| 44 |
http://www.gnu.org/prep/standards/html_node/Change-Logs.html. |
| 45 |
|
| 46 |
CVS commit messages MUST be created from the related ChangeLog entry for a |
| 47 |
change. |
| 48 |
|
| 49 |
Before a release, the NEWS file MUST be updated. |
| 50 |
|
| 51 |
Releases MUST be created from `make distcheck' to ensure an error-free build. |
| 52 |
|
| 53 |
|
| 54 |
2. MIME type database |
| 55 |
===================== |
| 56 |
|
| 57 |
The chemical MIME types, global pattern and acronyms SHALL be in alphabetical |
| 58 |
order without dividing between supported and unsupported MIME types. |
| 59 |
|
| 60 |
The database XML file MUST have an indentation with one tab per indentation |
| 61 |
level. |
| 62 |
|
| 63 |
Every MIME type entry, that is considered to be supported, MUST have a |
| 64 |
non-empty `added' attribute. |
| 65 |
|
| 66 |
The DTD MUST be documented for easy understanding. |
| 67 |
|
| 68 |
|
| 69 |
3. Icons, Graphics and Art |
| 70 |
========================== |
| 71 |
|
| 72 |
Another important part of the package are basic graphics. Users SHOULD be able |
| 73 |
to identify chemical files ideally on the spur of the moment. Good icons shown |
| 74 |
in nautilus, konqueror or thunar can help here. Icons MAY show if a file |
| 75 |
contains: |
| 76 |
|
| 77 |
- 2D or 3D data |
| 78 |
- spectra or structure data |
| 79 |
- crystal or molecule data |
| 80 |
- XML, plain text or binary data |
| 81 |
- simple (SMILES) strings data |
| 82 |
- sequence data (DNA, ...) |
| 83 |
- MM results |
| 84 |
- MDL or CambridgeSoft (or ...) data (showing their icons) |
| 85 |
- ... |
| 86 |
|
| 87 |
So there are no boundaries set to your creativity - with a few exceptions |
| 88 |
|
| 89 |
(1) Only icons for the generic hicolor theme and the general pixmaps |
| 90 |
location are accepted. If you want to create icons (or if you already |
| 91 |
have icons) for specific KDE and GNOME themes, they SHALL go directly |
| 92 |
into these themes (upstream) and MUST NOT go into the chemical-mime-data |
| 93 |
package. Despite this limitation you MAY create different icons for KDE |
| 94 |
and GNOME. |
| 95 |
|
| 96 |
(2) Theme icons for the hicolor theme MUST be in scalable vector graphics. |
| 97 |
Raster images MUST be in PNG format. |
| 98 |
|
| 99 |
(3) Your images MUST be available at least under an OSI-approved license |
| 100 |
compatible to the license used for the chemical-mime-data package - this |
| 101 |
is currently the GNU Lesser General Public License (LGPL) 2.1 (see |
| 102 |
COPYING). |
| 103 |
|
| 104 |
|
| 105 |
4. Stylesheets |
| 106 |
============== |
| 107 |
|
| 108 |
Stylesheets MUST have an indentation with one tab per indentation level. |
| 109 |
|
| 110 |
Named templates MUST contain a meaningful template name and an introducing |
| 111 |
documentation of the kind: |
| 112 |
|
| 113 |
<!-- * ...comment... --> |
| 114 |
|
| 115 |
The order of templates/elements is: |
| 116 |
|
| 117 |
- xsl:import |
| 118 |
- xsl:output |
| 119 |
- xsl:(preserve|strip)-space |
| 120 |
- matching xsl:templates beginning with the root element followed by the |
| 121 |
other in alpabetical order, ended with those, which are not processed |
| 122 |
- named xsl:templates beginning with a root template (if any) followed by |
| 123 |
the other in alphabetical order |
| 124 |
|
| 125 |
Common templates used by more than one stylesheet SHOULD go into the generic |
| 126 |
cmd_common.xsl stylesheet. |
| 127 |
|
| 128 |
|
| 129 |
5. Website |
| 130 |
========== |
| 131 |
|
| 132 |
It is RECOMMENDed that variable content is created automatically via (e.g.) |
| 133 |
XSLT to ease and reduce maintenance work. |
| 134 |
|
| 135 |
|
| 136 |
# UTF-8 |