cross
Foswiki General Assembly will be held on 12th December 2019, 1200 UTC on Freenode IRC channel #foswiki-association. See AgendaTenthGeneralAssembly
TIP PixabayPlugin is not installed on Foswiki.org.

PixabayPlugin

Pixabay stock images and videos

logo.png

Description

This plugin let's you access over 1 mililion stock images, videos and illuatrations of pixabay. Pixabay is a vibrant community of creatives, sharing copyright free images and videos. All contents are released under the Pixabay License, which makes them safe to use without asking for permission or giving credit to the artist - even for commercial purposes.

If you se this plugin and this the Pixabay API, a link to Pixabay is required and you may use their logo for this purpose. By default, you can make up to 5,000 requests per hour towards pixabay.com. Requests are associated with an API key, and not with your IP address. In addition this plugin caches query results to pixabay.com for a certain period of time, a day by default.

Returned images are cached on this server and not hotlinked their source location on pixabay.com. This is not only required due to the API usage guidelines but also comes with a certain performance advantage compared to other image services such as unsplash.com.

Usage

Images and videos are made available to Foswiki using the %PIXABAY{...}% macro. The macro may return a list of images or videos, not only one. You may page through this list using the skip and limit parameters.

Parameter Description Default
"..." or q search term. if omitted, all images are returned. This value may not exceed 100 characters. example: "yellow flower"  
id retrieve individual images by iD. the id normally is a numeric value which may also be specified as a search term.  
lang language code of the language to be searched in. accepted values: cs, da, de, en, es, fr, id, it, hu, nl, no, pl, pt, ro, sk, fi, sv, tr, vi, th, bg, ru, el, ja, ko, zh en
type kind of resource to query. possible values: photo, illuatrations, vector, video, film, animation, allimages, allvideos photo
category filter results by category. accepted values: fashion, nature, backgrounds, science, education, people, feelings, religion, health, places, animals, industry, food, computer, sports, transportation, travel, buildings, business, music  
safesearch a flag indicating that only images/videos suitable for all ages should be returned. off
min_width minimum image width 0
min_height minimum image height 0
size accepted values for images: web, preview, large, orig, fullHD; accepted values for videos: tiny, small, medium, large  
editors_choice select images that have received an Editor's Choice award off
order how the results should be ordered. accepted values: popular, latest popular
header string to be prefixed to results  
format format string to render the fetched resource. for images: <img src='$url' width='$width' height='$height' alt='$id' $class />
for videos: <video width='$width' height='$height' $controls $autoplay $muted $loop $class alt='$id'>Your browser does not support the video tag.</video>
separator format string between each fetched resource  
footer string to be appended to results  
width explicit width of the image/video width of the resource as returned by pixabay
height explicit height of the image/video height of the resource as returned by pixabay
class css class to add to the result  
random integer specifying a range within which a skip value is piced randomly; the higher the parameter the more random results will be returned 0
skip page through the list of images/videos found by the search term 0
limit number if images/videos to return 1
orientation (only images) whether an image is wider than it is tall, or taller than it is wide. accepted values: all, horizontal, vertical all
controls (only videos) flag to display video controls (pause, play, forward, backward) off
autoplay (only videos) flag to start playing the video as soon as it has been loaded on
mute (only videos) flag to mute or unmute audio of a video on
loop (only videos) flag to loop a video or only play it once on

Examples

Default settings

%PIXABAY{"neon"}%

Specific image

%PIXABAY{id="2014616"%

Random film with people

%PIXABAY{"people" type="film" random="10"}%

Photos by Masashi Wakui

%PIXABAY{"user:MasashiWakui" random="10" limit="5"}%

Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. "Extensions Operation and Maintenance" Tab -> "Install, Update or Remove extensions" Tab. Click the "Search for Extensions" button. Enter part of the extension name or description and press search. Select the desired extension(s) and click install. If an extension is already installed, it will not show up in the search results.

You can also install from the shell by running the extension installer as the web server user: (Be sure to run as the webserver user, not as root!)
cd /path/to/foswiki
perl tools/extension_installer <NameOfExtension> install

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See https://foswiki.org/Support/ManuallyInstallingExtensions for more help.

Before you may use this plugin you'll need to register an account at https://pixabay.com and fetch your API key from here https://pixabay.com/api/docs.

Dependencies

NameVersionDescription
WebService::Pixabay>=2Required
Cache::FileCache>=1Required
LWP::UserAgent>=6Required

Change History

19 Nov 2019 initial release

PackageForm edit

Author Michael Daum
Version 1.01
Release 19 Nov 2019
Description Pixabay stock images and videos
Copyright 2019, Michael Daum, All Rights Reserved
License GPL (GNU General Public License)
Home http://foswiki.org/Extensions/PixabayPlugin
Support http://foswiki.org/Support/PixabayPlugin
Repository https://github.com/foswiki/PixabayPlugin
ExtensionClassification Interface and Visualisation
ExtensionType PluginPackage
Compatibility
IncompatibleWith
ImageUrl
DemoUrl
SupportUrl PixabayPlugin
ModificationPolicy CoordinateWithAuthor
Topic attachments
I Attachment Action Size Date Who Comment
PixabayPlugin.md5md5 PixabayPlugin.md5 manage 162 bytes 19 Nov 2019 - 12:53 MichaelDaum  
PixabayPlugin.sha1sha1 PixabayPlugin.sha1 manage 186 bytes 19 Nov 2019 - 12:53 MichaelDaum  
PixabayPlugin.tgztgz PixabayPlugin.tgz manage 16 K 19 Nov 2019 - 12:53 MichaelDaum  
PixabayPlugin.zipzip PixabayPlugin.zip manage 22 K 19 Nov 2019 - 12:53 MichaelDaum  
PixabayPlugin_installerEXT PixabayPlugin_installer manage 4 K 19 Nov 2019 - 12:53 MichaelDaum  
logo.pngpng logo.png manage 7 K 19 Nov 2019 - 12:53 MichaelDaum  
Topic revision: r1 - 19 Nov 2019, MichaelDaum - This page was cached on 02 Dec 2019 - 09:23.

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. See Copyright Statement. Creative Commons License    Legal Imprint    Privacy Policy