You are here

README.txt in Flickr 7

The content of this file is based on the online documentation that can be found
at https://drupal.org/node/2171299
It is recommended to read it there, as it is more detailed and illustrated.

NAME
====
Flickr Field
Part of the Flickr module. Project page at https://drupal.org/project/flickr

OVERVIEW
========
Add Flickr images or sets to content as fields:
- can be added to entities, usually nodes
- have several formatting options to use various sizes, including slideshows
- can be queried with the Views module.

There are two kind of module provided Flickr fields. Only the first type is used
for single Flickr photos. Both type of fields can be used for Flickr Photo Sets
but each in a different way.

Flickr Photo
------------
Store Flickr Photo or Photoset IDs and display the photos in nodes and Views.
Despite the name this field is used both for individual photos (using
'Item Type': 'Photo') as for complete sets of photos (using 'Item Type':
'Photoset'). The submodule Flickr Sets should be enabled to use sets in this
field.

Flickr Photo Set
----------------
Field for storing a reference to a Flickr photo set. It displays only the
primary representing image of a set or a slideshow of multiple images. To
display multiple photos from a photoset, use the Flickr Photo field type or use
the slideshow format.

Most interesting feature of this field is the slideshow. Both a full featured and
basic version exist. Both are responsive and adapt to the available space.

Full screen mode is supported, showing the largest available image that fits the
screen on a black background (the way that most professional photographers
prefer to showcase their work).

FIELD CONFIGURATION
===================
- Go to '/admin/structure/types'
- Click 'manage fields'
- Add new field > Flickr Photo or Flickr Photo Set (submodule Flickr Sets
  should be enabled to use sets in this field)
- Save field settings
- Configure as desired
- Save settings
Then:
- Go to '/admin/structure/types'
- Click 'manage display'
- Select the formatter for a Flickr field (a size)
- Save

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.

FEEDS INTEGRATION
=================
If you have the feeds module enabled, you can export Flickr field data.
- Go to 'Mapping' (under 'Processor') for your particular feed.
- See and use the 3 new 'Target' options (named as your chosen field name with
  the targeted column (id, nsid and type) in brackets.

The options are as follows:
- id: This is the Flickr photo or set ID.
- nsid: This is the Flickr user ID.
- type: This is the type of Flickr field. Current options are 'photo_id' (for an
  individual photo) and 'id' (for a set).

Find an example csv file and feeds importer at:
https://www.drupal.org/node/2339189#comment-9160963

File

field/README.txt
View source
  1. The content of this file is based on the online documentation that can be found
  2. at https://drupal.org/node/2171299
  3. It is recommended to read it there, as it is more detailed and illustrated.
  4. NAME
  5. ====
  6. Flickr Field
  7. Part of the Flickr module. Project page at https://drupal.org/project/flickr
  8. OVERVIEW
  9. ========
  10. Add Flickr images or sets to content as fields:
  11. - can be added to entities, usually nodes
  12. - have several formatting options to use various sizes, including slideshows
  13. - can be queried with the Views module.
  14. There are two kind of module provided Flickr fields. Only the first type is used
  15. for single Flickr photos. Both type of fields can be used for Flickr Photo Sets
  16. but each in a different way.
  17. Flickr Photo
  18. ------------
  19. Store Flickr Photo or Photoset IDs and display the photos in nodes and Views.
  20. Despite the name this field is used both for individual photos (using
  21. 'Item Type': 'Photo') as for complete sets of photos (using 'Item Type':
  22. 'Photoset'). The submodule Flickr Sets should be enabled to use sets in this
  23. field.
  24. Flickr Photo Set
  25. ----------------
  26. Field for storing a reference to a Flickr photo set. It displays only the
  27. primary representing image of a set or a slideshow of multiple images. To
  28. display multiple photos from a photoset, use the Flickr Photo field type or use
  29. the slideshow format.
  30. Most interesting feature of this field is the slideshow. Both a full featured and
  31. basic version exist. Both are responsive and adapt to the available space.
  32. Full screen mode is supported, showing the largest available image that fits the
  33. screen on a black background (the way that most professional photographers
  34. prefer to showcase their work).
  35. FIELD CONFIGURATION
  36. ===================
  37. - Go to '/admin/structure/types'
  38. - Click 'manage fields'
  39. - Add new field > Flickr Photo or Flickr Photo Set (submodule Flickr Sets
  40. should be enabled to use sets in this field)
  41. - Save field settings
  42. - Configure as desired
  43. - Save settings
  44. Then:
  45. - Go to '/admin/structure/types'
  46. - Click 'manage display'
  47. - Select the formatter for a Flickr field (a size)
  48. - Save
  49. NOTE:
  50. For square images ('s': 75px and 'q': 150px) no real width needs to be fetched,
  51. giving it a performance advantage over other sizes. Recommended if you include
  52. many images.
  53. FEEDS INTEGRATION
  54. =================
  55. If you have the feeds module enabled, you can export Flickr field data.
  56. - Go to 'Mapping' (under 'Processor') for your particular feed.
  57. - See and use the 3 new 'Target' options (named as your chosen field name with
  58. the targeted column (id, nsid and type) in brackets.
  59. The options are as follows:
  60. - id: This is the Flickr photo or set ID.
  61. - nsid: This is the Flickr user ID.
  62. - type: This is the type of Flickr field. Current options are 'photo_id' (for an
  63. individual photo) and 'id' (for a set).
  64. Find an example csv file and feeds importer at:
  65. https://www.drupal.org/node/2339189#comment-9160963