From MobileRead
Jump to: navigation, search
User Guide Calibre2opds Developers Guide Issues
Overview Building Localization Customization

Calibre2opds Development Overview

The Calibre2Opds project is an Open Source project. This means that anyone is entitled to obtain and view the source and contribute changes, bug fixes and enhancements.

The Calibre2opds Developers Guide is intended to describe the development processes used by the Calibre2opds project.

The Calibre2opds Developers Guide is provided in the form of a wiki which means that users can make changes and improvements directly. Users are encouraged to do so to help improve the documentation in light of their own experiences.

This particular section gives a brief overview of the development processes used by calibre2opds. Other sections go into particular areas of the development process in more detail.

If you want to work on changing or enhancing the core functionality of calibre2opds then you need to be familiar with the Java programming language as this is the programming language used for calibre2opds. Changes to the look-and-feel of the HTML catalogs require understanding of technologies such as CSS and XSLT.

If you simply want to help with localization then no special skills are required other than knowledge of the target language. In that case you can ignore the remainder of this section as the toolds mentioned would not be required, and instead go straight to the section on localizing calibre2opds.

The look and feel of the HTML catalogs is also highly customizable. To be able to change these you will need skills in the areas of HTML; CSS stylesheets; and XSL templates. However since you start with working examples already built into Calibre2opds, even novice users should find that they can make changes in this area successfully.

The Developers Guide is split into the following major topic areas:

  • Building Calibre2opds
    This section of the documentation covers what is involved in building calibre2opds from the source. The process has been made as simple as possible so it is believed that even inexperienced users will be able to do this based on the information provided.
  • Localization
    This section of the documentation covers the step involved in helping with the localization of calibre2opds.
  • Customization
    This section fo the documentation covers what facilities are available to allow the user to change the look-and-feel aspects of catalogs generated by calibre2opds.

Any issues relating to bugs in calibre2opds or feature requests for new capabilities are managed and tracked using the Issue tracking system. This is one of the main ways that users and developers interact with each other.

Personal tools

MobileRead Networks