GCfilms- Contributing

Import or export plugins

These plugins are used to import/export data from/to other softwares. More information about them in the documentation concerning conversions.

Implementing such a plugin is creating a Perl class. A template with some instructions is available in GCfilms sources. Once the files have been extracted from the .tar.gz archive, a templates directory will contain these models.

To test the plugin, it has to be copied into lib/gcfilms/GCImport directory (respectively lib/gcfilms/GCExport). Then GCfilms should be restarted. This directory are shown here relatively to where GCfilms is installed. In these directory, there are also some files that could be used as examples.

Search plugins

They are used to find on web sites information associated to a movie. Then some fields are automatically filled.

Creating such a plugin is done as for an import or export plugin. There is also a template. Directory where the file should be copied is lib/gcfilms/GCPlugins.

Translations

GCfilms could be translated in many languages. Every single text that is shown on screen is in a separate file (one for each language).

To create a new language file, one from lib/gcfilms/GCLang should be copied. It has to be renamed following this schema: XY.pm, where XY is the language code. The file should use a UTF-8 encoding.

HTML or XML templates

These templates are used by HTML or XML export plugins. More information about them in documentation concerning conversions.

These templates must be copied into share/gcfilms/html_models or share/gcfilms/xml_models. These directories contain also some examples that could be used as a base.

Skins

GCfilms skins let user change the graphical interface. They use the standard format for Gtk+ resource files (gtkrc).

Some examples are in share/gcfilms/style.

How to submit a contribution

When a contribution is finished, it could be submited so it may be added in GCfilms releases. This is done using patch submission form where a file may be attached.