Module Documentation  Friday, February 17, 2006 10:00 PM


  1. What It Does and How It Works
  2. Installation & Quick Start
  3. User Preferences
  4. Navigation
  5. Bummers
  6. License & Warranty
  7. Send Feedback
google_flickr_viewer_screenshot_02

What It Does and How It Works

This Google ig module lets you choose groups of Flickr images to have randomly displayed on your homepage. You can select images using any combination of the three main features Search, Favorites and Interesting.

As soon as it loads on the page this module collects info about pictures from Flickr based on picture criteria you provide in the user preferences. Then it randomly displays 1 or 2 images randomly selected from the image info it got from Flickr. The number of images displayed depends on the size of the images. The module will fit as many pictures as possible without running out of vertical space...

Installation & Quick Start

  1. Goto http://www.google.com/ig and sign in (top right)
  2. Click on "Add Content" on the top left of the page.
  3. Click on "Create a Section" on the resulting left menu.
  4. Enter the url to the google_flickr_viewer_v1.0.xml module into the "Create a Section" text box and click "Go". You can get the url by clicking on this text box and copying the text
  5. You'll get a mild warning message about the fact that Google didn't write this module... Click "OK" unless you think I'm evil... I'm not, but if I were I probably wouldn't admit it here.
  6. Once installed just follow the onscreen instructions to start viewing your pictures.

Quick Start

To get started fast:
  1. Click edit at the top of the module
  2. Check the search box
  3. Enter "russelldad" for the "Search: screen name"
  4. Enter "googleigold" for the "Search: tags"
  5. Click save
You should see a bunch of my Flickr pictures. You can change the user preferences to see almost any picture on Flickr. Keep reading if you want to know how all the user preferences work.

Search Feature & User Preferences

The Search feature lets you get the latest images uploaded to Flickr filtered by the Screen Name of the user that posted them and/or Tags that are applied to the pictures. There are 5 user preferences (available via the edit link at the top of the module) that control the behavior of the Search feature. Each contains "Search" as the first word in the preference name.

  • Search (checkbox): This is the on/off switch for the Search feature. To collect images by Search, check this box. If this box is not checked, regardless of the settings for the following Search user preferences, no images will be displayed using Search.
  • Search: screen name: This user pref takes a single Flickr screen name. When a screen name is provided the search results will only provide pictures that were posted by that user. If no screen name is provided search will choose from all of the public pictures posted to Flickr.
    • Search: screen name and Search: tags can be used together to select pictures posted by a specific person tagged with specific tags.
    • If you're not sure what someone's screen name is look at one of their pictures. You'll see their screen name next to the words "posted by".
  • Search tags:(, separated): This user preference take a comma separated list of Flickr tags. When a tag or tags (comma separated) are provided, only pictures tagged with one or more of the provided tags will be displayed. If no tags are provided, search will choose from pictures with any tag.
    • Search: screen name and Search: tags can be used together to select pictures posted by a specific person tagged with specific tags.
    • If you're not sure what someone's Search: screen name is look at one of their pictures. You'll see their screen name next to the words "posted by".
    • If you're not familiar with tags definitely read Flickr's tag FAQ.
  • Search: uid: (power users only) Proper use of this user preference can shorten the time it takes for images to display. Improper use may drive you mad. In order to do a Flickr search by screen name, Flickr requires the super secret Flickr userID that relates to that screen name... That means before the search can happen this module needs to ask Flickr what the super secret Flickr userID for that screen name is. Once the module knows, only then can it do the search. Unfortunately the userIDs are not easy for people to remember (example: 22987453@N00 ). If you like your pictures to load faster, you can provide the userID instead of the screen name. It should cut the lookup time in half. There are two ways to find the screen name:
    • Check the Search feature, enter screen name, and click save. After the pictures display. click help (bottom right). The userID for the screen name you provided will appear at the bottom of the help.
    • View a Flickr picture and look in the url for something that looks like 22987453@N00
      IMPORTANT: If you ever want to change users. you should delete any value you have in the userID field as it overrides anything you type in the screen name field.
  • Search: # of pics: This user preference determines how many unique pictures will be collected from flickd during the search. It has a maximum of 500, minimum of 1, and it defaults to 100. Collecting images from Flickr is time consuming. The higher the number you provide, the longer it will take Flickr to display pictures. On the other hand, the smaller the number, the more likely you’ll see the same pictures over and over... Life is all about balance...

Favorites Feature & User Preferences

Favorites lets you get the latest Flickr favorites for a given screen name. There are 4 user preferences (available via the edit link at the top of the module) that control the behavior of the Favorites feature. Each contains "Favorites" as the first word in the preference name.

  • Favorites (checkbox): This is the on/off switch for the Favorites feature. To collect images by Favorites, check this box. If this box is not checked, regardless of the settings for the following Favorites user preferences, no images will be displayed using Favorites
  • Favorites: screen name: This user preference takes a single Flickr screen name. That screen name's favorite photos will be displayed. This is most commonly used to view the pictures you've marked as favorites.
  • Favorites: uid: (power users only) Proper use of this user preference can shorten the time it takes for images to display. Improper use may drive you mad. In order to do a Flickr search by screen name, Flickr requires the super secret Flickr userID that maps to that screen name... That means before the search can happen this module needs to ask Flickr what the super secret Flickr userID for that screen name is. Once the module knows, only then can it look up that user's favorites. Unfortunately the userIDs are not easy for people to remember (example: 22987453@N00 ). If you like your pictures to load faster, you can provide the userID instead of the screen name. It should cut the lookup time in half. There are two ways to find the screen name:
    • Check the Favorites feature, enter screen name, and click save. After the pictures display, click help (bottom right). The userID for the screen name you provided will appear at the bottom of the help.
    • View a Flickr picture and look in the url for something that looks like 22987453@N00.
  • Favorites: # of pics: This user preference determines how many unique favorites pictures will be collected from Flickr. It has a maximum of 500, minimum of 1, and it defaults to 100. Collecting images from Flickr is time consuming. The higher the number you provide, the longer it will take Flickr to display pictures. On the other hand the smaller the number, the more likely you’ll see the same pictures over and over... Life is all about balance...

Interesting Feature & User Preferences

Interesting lets you get the latest Interesting pictures from Flickr. There are 2 user preferences (available via the edit link at the top of the module) that control the behavior of the Interesting feature. Each contains "Interesting" as the first word in the preference name.

WARNING: Interesting pictures may offend some audiences... Flickr pictures are identified as interesting based on a complex Flickr algorithm which keys off the viewing behavior of other people that use Flickr. What some people find interesting, others may find offensive... Some of the pictures you will see via the interesting feature include, but are not limited to:

bubbles, sunsets, naked people, clothed animals (not really offensive, but definitely strange), close up shots of all sorts us stuff (eyeballs, crayons, flowers, shoes), cute kids, old people, snow drifts, antique furniture and much more... It's the naked people that most people get hung up on...

If you are offended by any or all of these things, or are planning to show your Google IG web page to a group of neo-conservatives I strongly recommend you do not use the Interesting feature.

  • Interesting (checkbox): This is the on/off switch for the Interesting feature. To display Flickr's recent pictures, check this box. If this box is not checked, regardless of the settings for the following Interesting user preferences, no images will be displayed using Interesting.
  • Interesting: # of pics: This user preference determines how many unique Interesting pictures will be collected from Flickr. It has a maximum of 500, minimum of 1, and it defaults to 100. Collecting images from Flickr is time consuming. The higher the number you provide, the longer it will take Flickr to display pictures. On the other hand, the smaller the number, the more likely you’ll see the same pictures over and over... Life is all about balance...

Module Title

This user preference lets you change the title that appears at the top of the module. I tried really hard to come up with a good name, but all of the descriptive ones can be a little dull to look at day after day, so I leave it to you the user to come up with the module name you want to see at the top of your chosen pictures. Change it as often as you like...

Navigation

Once the module loads and displays pictures, you may want to see some other random pictures from your selection. To do so click on the word "random" at the bottom of the module. Back << and forward >> navigation is also available to pictures you have already viewed.

Bummers

With all the user preferences available to be used in different combinations, it's likely that this module will run into a problem either with the user preferences people provide, or with Flickr. Sometimes when Flickr gets really busy it acts weird. Not to worry, if something goes wrong, the module will display any images it can. You'll be alerted to any problems by the appearance of the word bummer at the bottom of the module. Just click on the word bummer to see an explanation of what went wrong and what you can do to fix it.

Want to see bummers in action? Check the Search feature and type in "ksjdakjsdhksjdlkajsdlk" for a screen name. Then click save. One bummer coming right up.

License & Warranty

This module is provided without any guarantee. I hope it will make you happy. If not, please stop using it immediately. You are free to take the source code and use it in any way you like as long as you do something nice for someone else in return. Pay it forward...

Sending Feedback or Reporting Bugs

Feedback can be sent to me at parussel+googleig (at) gmail.com. Thanks, praise, undying adoration and even bug reports are welcome.

Unless you're a close friend or relative of mine, feature requests are unlikely to be implemented. I need to get on to all my other projects...

Share and Enjoy,
Paul
 
This is the home page for the Google Flickr Picture Viewer. Its a google homepage module I threw together in my spare time that lets you choose flickr pictures to view and navigate on your google homepage.


Previous Posts




Archives



Get Firefox