~aleteoryx/scrobble.observer#5: 
Watermarking

Support for a limited form of (optional) watermaking. It would be up to the themes to include it.

#Query Parameters

  • ?watermark - specifies opting-in/out to the watermark.

#Config Entries

  • LFME_WATERMARK_DEFAULT: 0|1 - enables the watermark if 1. If 1, ?watermark disables the watermark.
  • LFME_WATERMARK_TEXT: string - should contain the name of the specific instance, or a tagline.
  • LFME_WATERMARK_IMG: string - should contain a link to an image. The rendered size of this image is at the discretion of a given theme, but it should be around 32x32-64x64, and have an aspect ratio no greater than 1:2.
  • LFME_WATERMARK_URL: string - should contain a link to the host, or whoever else the admin wishes.

#Context Members

  • watermark: object - null, unless (LFME_WATERMARK_TEXT || LFME_WATERMARK_IMG || LFME_WATERMARK_URL) && (?watermark XOR LFME_WATERMARK). Should be interpreted as whether to render a watermark.
  • watermark.text = LFME_WATERMARK_TEXT - defaults to lfm_embed.
  • watermark.img = LFME_WATERMARK_IMG - defaults to null.
  • watermark.url = LFME_WATERMARK_URL - defaults to null.

All that is guaranteed if watermark != null is the presence of watermark.text, so all themes should be able to fallback to text. Image support should be considered optional for themes. Linking support is mandatory for themes.

It is not an error to specify a default-enabled watermark with no possible contents, as the watermark object will simply not be present. A warning should be output on startup.

Status
REPORTED
Submitter
~aleteoryx
Assigned to
No-one
Submitted
4 months ago
Updated
4 months ago
Labels
feature - user