You are here

README.txt in Flickr 6

Same filename in this branch
  1. 6 README.txt
  2. 6 filter/README.txt
  3. 6 block/README.txt
  4. 6 field/README.txt
Same filename and directory in other branches
  1. 7 block/README.txt
NAME
====
Flickr Block
Part of the Flickr module. Project page at https://drupal.org/project/flickr

OVERVIEW
========
Flickr images in blocks to show for example recent or random images from a
specific user, set or group.

- Configure the size, media type (photo/video) and number of images to show.
- With visibility by role or path.
- Blocks can be placed in any theme region.

There are three blocks that appear only on user profile pages and show the
Flickr photos of the corresponding user.
- User profile page recent Flickr photos
- User profile page recent Flickr photosets
- User profile page random Flickr photos

The block visibility setting for 'user' blocks are not only restricted by the
user in the block configuration but also by the module. The block gets displayed
when the first argument of the path is 'user' and a specific uid is available.
This is however not visible for the web admin and confusing.
See issue #1122564: Sync the module defined visibility setting with the block
configuration. In the future these blocks will probably move to a dedicated
Flickr Profile sub-module.

Furthermore nine site wide blocks are available. A user, photoset or group needs
to be specified in the block configuration.
- Recent photos from a Flickr user
- Recent photosets from a Flickr user
- Random photos from a Flickr user
- Recent photosfrom a Flickr group
- Random photos from a Flickr photoset
- Recent photos from a Flickr photoset
- Favorite public photos from a Flickr user
- Random photos from a Flickr group
- Random photos with a specific tag from a Flickr user

BLOCK CONFIGURATION
===================

Fields in the block settings that apply on all blocks.

Show n photos
-------------
The block will display this many photos.

Size of photos
--------------
Select the size of photos you'd like to display in the block.
NOTE:
For square images ('s': 75px and 'q': 150px) no real width needs to be fetched,
giving it a performance advantage over other sizes. Recommended if you include
many images.


All blocks except 'User profile recent photosets' and 'Recent photosets from
user'.

Media type
----------
- photos
- videos
Note that for videos only an image representing the video is showed.


All '..from user' blocks.

Flickr User ID
--------------
A valid Flickr User ID, username or email address. If this is left blank, the
sites's default user will be used if set.
Emails or usernames (that might change at any given time) are internally (in the
variable) replaced with a stable NSID (Flickr ID number). These are rendered in
this field as Flickr usernames. 'Maria Emanuela' is human readable,
'43937662@N05' is not. Internal the module still uses the Flickr ID number as it
is more reliable.


Other fields are self-explaining.

File

block/README.txt
View source
  1. NAME
  2. ====
  3. Flickr Block
  4. Part of the Flickr module. Project page at https://drupal.org/project/flickr
  5. OVERVIEW
  6. ========
  7. Flickr images in blocks to show for example recent or random images from a
  8. specific user, set or group.
  9. - Configure the size, media type (photo/video) and number of images to show.
  10. - With visibility by role or path.
  11. - Blocks can be placed in any theme region.
  12. There are three blocks that appear only on user profile pages and show the
  13. Flickr photos of the corresponding user.
  14. - User profile page recent Flickr photos
  15. - User profile page recent Flickr photosets
  16. - User profile page random Flickr photos
  17. The block visibility setting for 'user' blocks are not only restricted by the
  18. user in the block configuration but also by the module. The block gets displayed
  19. when the first argument of the path is 'user' and a specific uid is available.
  20. This is however not visible for the web admin and confusing.
  21. See issue #1122564: Sync the module defined visibility setting with the block
  22. configuration. In the future these blocks will probably move to a dedicated
  23. Flickr Profile sub-module.
  24. Furthermore nine site wide blocks are available. A user, photoset or group needs
  25. to be specified in the block configuration.
  26. - Recent photos from a Flickr user
  27. - Recent photosets from a Flickr user
  28. - Random photos from a Flickr user
  29. - Recent photosfrom a Flickr group
  30. - Random photos from a Flickr photoset
  31. - Recent photos from a Flickr photoset
  32. - Favorite public photos from a Flickr user
  33. - Random photos from a Flickr group
  34. - Random photos with a specific tag from a Flickr user
  35. BLOCK CONFIGURATION
  36. ===================
  37. Fields in the block settings that apply on all blocks.
  38. Show n photos
  39. -------------
  40. The block will display this many photos.
  41. Size of photos
  42. --------------
  43. Select the size of photos you'd like to display in the block.
  44. NOTE:
  45. For square images ('s': 75px and 'q': 150px) no real width needs to be fetched,
  46. giving it a performance advantage over other sizes. Recommended if you include
  47. many images.
  48. All blocks except 'User profile recent photosets' and 'Recent photosets from
  49. user'.
  50. Media type
  51. ----------
  52. - photos
  53. - videos
  54. Note that for videos only an image representing the video is showed.
  55. All '..from user' blocks.
  56. Flickr User ID
  57. --------------
  58. A valid Flickr User ID, username or email address. If this is left blank, the
  59. sites's default user will be used if set.
  60. Emails or usernames (that might change at any given time) are internally (in the
  61. variable) replaced with a stable NSID (Flickr ID number). These are rendered in
  62. this field as Flickr usernames. 'Maria Emanuela' is human readable,
  63. '43937662@N05' is not. Internal the module still uses the Flickr ID number as it
  64. is more reliable.
  65. Other fields are self-explaining.