Gallery3:User guide:Obsolete modules - Gallery Codex
Personal tools

Gallery3:User guide:Obsolete modules

From Gallery Codex

Overview

Occasionally, updates to Gallery will render some previous modules obsolete. This could be because of:

  • Enhancement: the Gallery core now includes the functionality previously given by the module
  • Incompatibility: the Gallery core is now incompatible with the module
  • External changes: the module interfaced with external services that are no longer available (e.g. Digibug)

How do I find out if this affects me?

Starting with v3.0.5, Gallery provides warning messages if it detects obsolete modules that are active. Login as an admin, then navigate to one of these three places:

  • Admin | Dashboard screen
  • Admin | Modules screen
  • Upgrader screen

If there's no message, then you're good to go!

What should I do to fix this?

We recommend that you deactivate the obsolete modules. Login as an admin, then navigate to the Admin | Modules screen and deactivate it. The warning message on the Admin | Modules screen should disappear. Although not required, you may also consider uninstalling the module once you've deactivated it.

For more information on the now-obsolete module, take a look at the module-specific notes below.

What will Gallery do with the obsolete modules?

Nothing. Gallery only provides warning messages, and will not forcibly prohibit or deactivate the modules.

Obsolete modules

Digibug

  • Obsolete as of: Gallery v3.0.5 (released 2/2013)
  • Obsolete versions: up to v2 (current as of 2/2013)
  • Alternatives: none
  • Documentation: Gallery3:Modules:digibug

The module itself is fine, but unfortunately Digibug went out of business in 2/2013. For more information, see http://sourceforge.net/apps/trac/gallery/ticket/2002.

NoFFmpeg

  • Obsolete as of: Gallery v3.0.5 (released 2/2013)
  • Obsolete versions: up to v1 (current as of 2/2013)
  • Alternatives: Gallery's own Admin | Settings | Movies screen
  • Documentation: Gallery3:Modules:noffmpeg

The movie-handling capabilities of Gallery's core received significant upgrades with v3.0.5, and this module is no longer needed. Instead, go to the Admin | Settings | Movies screen and change the allow uploads option to "always."

Additionally, you may want to consider trying to install FFmpeg, as we tried to make it easier with Gallery v3.0.5. Instructions can be found on the same Admin | Settings | Movies screen.

VideoDimensions

  • Obsolete as of: Gallery v3.0.5 (released 2/2013)
  • Obsolete versions: up to v1 (current as of 2/2013)
  • Alternatives: Gallery's built-in movie player auto-resizing
  • Documentation: Gallery3:Modules:videodimensions

The movie-handling capabilities of Gallery's core received significant upgrades with v3.0.5, and this module is no longer needed. This is because Gallery automatically resizes the movie player window once the movie is loaded.

In previous versions, if these dimensions were set to zero because FFmpeg was not installed, the movie player would also be sized (and not auto-resized) at 0x0 pixels. This made it effectively unviewable unless VideoDimensions was used.

Videos

The movie-handling capabilities of Gallery's core received significant upgrades with v3.0.5, and this module is no longer needed. Instead, we recommend a newer module such as Movie Tools (Gallery3:Modules:movie_tools), which takes advantage of the new API changes and provides tighter integration of additional movie formats with Gallery's core.

In previous versions, the API of Gallery was not entirely amenable to adding additional movie formats. As a result, the videos module had to replace several key functions of Gallery to allow them. While this did provide the desired functionality, it didn't provide tight integration or stability with Gallery updates (e.g. Videos v4 still uses modified versions of Gallery v3.0.1 code).

Facebook admins

Seems development of the module has stopped and the authors download link no longer works. There is no Gallery auto detection of this module. If devlopment gets corrected please notify the forums and the team will make corrections to the docs as needed.

Technical details

How does Gallery detect module obsolescence?

The Gallery core has a list of modules and version numbers (see module::get_obsolete_modules_message). A warning message is generated if:

  • an active module is on the list
  • its installed version is at or below the version given

A warning message is not generated if:

  • the module is installed but not active
  • the module is active but has a newer version

I don't want to deactivate this module. How can I remove the warnings in Gallery?

Increase the module's version number in its module.info file, then run the upgrader. Before performing this workaround, we strongly recommend reading and understanding the notes above!

I'm the developer of a now-obsolete module. How can I revamp my module and keep Gallery from calling it obsolete?

After revamping the module, update its version number in the module.info file.

advertisements