Development

User Guide Overview Building Localization Customization Issues

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.

This section of the documentation is intended to give a brief overview of the development processes used by calibre2opds. Users are encouraged to providew feedback on how the documentation could be improved in light of their own experiences.

If you want to work on changing the 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 Developers Guide is split into the following major topic areas:

  • Building Calibre2opds
    This section of the documentation covers whtat is involved inbuilding calibre2opds from the source.
  • 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.

  1. Cyana
    25/12/2011 at 07:53

    Couldn’t you just provide a link where I could get the localization files, please ? The description above leaves no clue where to get it. I’d be happy to provide a German localization.
    Many thanks and Merry X-mas ;)
    Cyana

    • 25/12/2011 at 09:09

      Here’s a direct link to the relevant paragraph in the documentation. Thanks for your help !

      • Cyana
        25/12/2011 at 12:33

        Thank you for the swift reply. Unfortunately, the documentation does not give a link to the needed files. It just says ‘Download the latest calibre2opds source using the process specified above’. There however is no process specified. All you learn is that you can skip the following section when you just want to alter the localization files and go straight to the ‘Localization’ Section.

        In ‘Obtaining Source Code’ the only clue provided is ‘To get the source code from Google Code you use the Subversion source control system’. I do not have such a system, nor do I have an idea how to use it. All I wanted was the mentioned spreadsheet for localization.

        greetings and thanks
        Cyana

  2. 25/12/2011 at 22:06

    Ok I understand your concern. Google Code is a well-designed source host, and allows browsing for files in the source control system.
    You can find the spreadsheet in this folder along with the associated .properties files.
    Hope this helps !
    Cheers, and merry Xmas,
    David.

    • Cyana
      27/12/2011 at 00:58

      Thanks David. I’ve finished the translation of localization.xls . Some open questions remain, however:

      Line 477 config.GoodreadTitleUrl.description
      All external links using book titel use titel {0} AND author {1} besides Goodread. Is this correct or just has been overseen ?

      Line 508 config.CustomCatalogSavedSearchName.description
      The valid preceding statements for links are described as ‘opds://, htps:// or htpps://’ – should it maybe read ‘opds://, http:// or https://‘ ?

      Line 615 gui.stopGeneration.confirm and following
      ‘stop generating the catalog’ in the sense of ‘interrupt’ (so there is an option to continue later) or in the sense of ‘cancel’ (you have to restart from the beginning). ? This has influence on the translation into German

      and last but not least – how do I send you the spreadsheet ;) ?

      And a feature request ;) – a custom external link opportunity. Foreign language speakers might prefer a link to reviews in their own language, as the book might be published only in their language and will not even show up in Goodread or IFSDB

      best greetings and thanks
      Cyana

  3. 02/01/2012 at 14:53

    Line 477 config.GoodreadTitleUrl.description
    All external links using book titel use titel {0} AND author {1} besides Goodread. Is this correct or just has been overseen ?

    No, it’s by design. Goodreads only needs the title to point to a designated book, other services need the author.

    Line 508 config.CustomCatalogSavedSearchName.description
    The valid preceding statements for links are described as ‘opds://, htps:// or htpps://’ – should it maybe read ‘opds://, http:// or https://’ ?

    Apparently it’s already been corrected; thanks for telling us !

    Line 615 gui.stopGeneration.confirm and following
    ‘stop generating the catalog’ in the sense of ‘interrupt’ (so there is an option to continue later) or in the sense of ‘cancel’ (you have to restart from the beginning). ? This has influence on the translation into German

    We mean “cancel”.

    and last but not least – how do I send you the spreadsheet ;) ?

    You can send it to calibre2opds@gmail.com.
    Thanks for your work !

  1. No trackbacks yet.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Follow

Get every new post delivered to your Inbox.

Join 27 other followers

%d bloggers like this: