Labs/Bespin/Bespin Gallery

From MozillaWiki
< Labs‎ | Bespin
Jump to: navigation, search

The Bespin Gallery is a website where plugins for the Bespin project are stored and displayed.

The following page will contain documentation and business rules for the Bespin Gallery.

The url for the site will be http://bespinplugins.mozillalabs.com


Home Page

  • Editors Picks
  • Top Lists
    • Top Plugins - The 10 most downloaded plugins.
    • Top Contributors - The 10 people who have committed the most plugins.
    • Top Reviews - The 10 reviews that have been declared the most helpful. Must have at least a 50% helpful percentage and must have been voted on at least twice.


Admin

  • The admin section is available at http://bespinplugins.mozilla.com/admin
  • A user must be logged-in and must have been granted admin access in order to see any of the pages found within this section.

Contributors

  • A member of the Bespin Gallery will be identified throughout the site as a Contributor.
  • Username supports characters a-z A-Z 0-9 and "_".
  • All uppercase characters found within the username will be converted to lowercase characters upon account creation.
  • Username must be between 4-32 characters in length.
  • Username must be unique; another user on the site cannot have that same Username.
  • Passwords must be between 6-42 characters in length.
  • Email address must be unique - another user on the site cannot have that email address.
  • Verified will be set to 0 if the user has not verified their email address.
  • All users who have not verified their email address within 24 hours will be deleted. Garbage collection happens randomly through the Auth Verification model.
  • User Status will be set to 1 if the user has any associated login roles. User Status will be set to 0 if the user does not have any associated login roles.
  • In order to login, user must have a Verified = 1, Status = 1, and must have an associated login role.
  • Users may be designated as site admins through the User admin screen.
  • A user cannot voluntary delete their account.
  • Users can be edited at http://jetpack.stage.mozilla.com/admin/users
  • Users may update their profiles and allow logged-in site users to view their email address, so that the users may contact the developer directly.

Licenses

  • Each Plugin must have a license associated with it.
  • The user may select a custom license, by filling in the License Other field when submitting their Plugin. When this happens, this Plugin will receive a license_id of 999, which signifies that Plugin Gallery should look at the "license_other" field.
  • Licenses can be added and edited at http://bespinplugins.mozillalabs.com/admin/licenses

Plugins

Plugin Comments

  • A user must be logged in to review a Plugin.
  • A Plugin may only be rated once by the logged-in user; the logged-in user may, however, add comments to each plugin more than once.
  • Once a logged-in user reviews a Plugin, it will send an email to the Plugin owner notifying them of the added review.
    • If a logged-in user adds comments to their own Plugin, a notification email will not be sent out.
  • The logged-in user may change their vote for a particular plugin at any time by re-rating that plugin.
  • Upon review submission, all of the review votes will be calculated to determine the percentage of Thumbs-up / Thumbs-down votes.
  • A logged-in user may rate a review as helpful or unhelpful.
    • The logged-in can vote as many times as they want towards the helpfulness of a review. But each vote will only override your previous vote.
    • All of the helpful votes will be calculated upon voting to determine helpful percentage that is displayed with that review.
  • If the license associated with a Plugin is not available on the site, the user may input their own license by selecting "Other" in the add/edit screen, and then fill in the text box to the right of that radio button.

Plugin Files

  • The Plugin file requires a unique filename; no other plugins may have a plugin file with the same name.
  • Plugin filenames must contain only the characters "a-z", "A-Z", "0-9", "_", "-", ".".
  • Plugin files are currently being stored outside of subversion.
  • When uploaded, plugin files are being saved in ~/files/js/plugins
  • Files will be available for download via POST request to http://bespinplugins.mozillalabs.com/plugins/{shortname}/download
  • $plugin->downloads contains the number of times this plugin was downloaded. This number will be incremented upon each download.
  • If a user edits a plugin at http://bespinplugins.mozillalabs.com/plugins/{id}/edit, and the user chooses to upload a new plugin file, the new file will replace the old file associated with this plugin.
    • The new filename may be the same as the old filename associated with this plugin.
  • The shortname is derived from the filename by splitting the filename at the period in the filename and using the first part of the filename before the period.
    • The shortname for "super_plugin.js" will be "super_plugin".

Plugin Icons

  • Plugin icons are currently being stored outside of subversion.
  • When uploaded, image files are being saved in ~/files/images/plugins/{x}/{plugin_id}/{plugin_id}-image-{screenshot_id}-{image_size}.jpg
    • Round the plugin_id down to the nearest multiple of 1000 to find x. For plugin_id of 49, x = 0. For plugin_id of 1049, x = 1000. For plugin_id of 2049, x = 2000.
    • Image sizes are:
      • tiny (25x25)
      • small (95x95)
      • large (250x250)
  • Current upload limit is 1MB.
  • Accepted image types are .jpg, .gif and .png

Plugin Screenshots

  • Plugin icons are currently being stored outside of subversion.
  • When uploaded, icon files are being saved in ~/files/images/plugins/{x}/{plugin_id}/{plugin_id}_{image_size}.jpg
    • Round the plugin_id down to the nearest multiple of 1000 to find x. For plugin_id of 49, x = 0. For plugin_id of 1049, x = 1000. For plugin_id of 2049, x = 2000.
    • Image sizes are width x height, where height = width x .76, except for the large image, which maintains aspect ratio:
      • tiny (115x87)
      • small (220x167)
      • medium (430x327)
      • large (640x?) - Scale to width of 640px if width >= 640px; else maintain original image size
  • Current upload limit is 3MB.
  • Accepted image types are .jpg, .gif and .png

Plugin Videos

Tags

  • Tags may be added to any Plugin.
  • Only the Plugin owner may add, edit and delete tags for a Plugin.
  • Tags support characters a-z A-Z and 0-9.
  • Spaces, punctuation and all other unsupported characters will be removed when a user adds tags.
  • Tags may be from 1 character to 24 characters in length.
  • Double quotation marks must be used to add a single tag containing multiple words.
  • Adding the tags `red blue "primary colors"` will result in 3 tags being added: `red`, `blue` and `primarycolors`.
  • Admins may remove tags from individual plugins via the Plugin Admin page.
  • Admins may edit and/or remove specific tags from the site in the Tags Admin page at http://bespinplugins.mozillalabs.com/admin/tags

Popular Tags Graph

  • The popular tags graph displays the 10 tags that have been used the most for Plugins across the site.
  • The graph displays the most popular of the 10 tags at the top of the graph and the least popular of the 10 tags at the bottom of the graph.
Retrieved from "https://wiki.mozilla.org/index.php?title=Labs/Bespin/Bespin_Gallery&oldid=233347"