Changes

==Functional Specification == <br>OpenAttribute<br>Functional Specification <br>Authors: Laura F. Hilliger (laura@bigfunarts.com)<br>Creation Date:11/22/2010<br>Last Updated: 11/22/2010<br>Version: 0.1  '''Authors'''<br>  {| width="75%" cellspacing="1" cellpadding="1" border="1" align="left"|-! scope="col" | Date<br> ! scope="col" | Author<br> ! scope="col" | Version<br> ! scope="col" | Revision<br>|-| 11/22/2010<br> | Laura F. Hilliger<br> | 0.1<br> | Initial Draft<br>|<br>|}  '''Reviewers'''<br>  {| width="75%" cellspacing="1" cellpadding="1" border="1" align="left"|-! scope="col" | Date<br> ! scope="col" | Reviewer<br> ! scope="col" | Comments<br>|<br>|} '''Approvers<br>'''  {| width="75%" cellspacing="1" cellpadding="1" border="1" align="left"|-! scope="col" | Date<br> ! scope="col" | Approver<br> ! scope="col" | Comments<br>| <br>|} <br> Table of Contents<br> 1 Project Overview <br>2 Models <br>2.1 Add On<br>2.2 Plugin<br>3 Use Cases<br>3.1 Image to Personal Document<br>3.1.1 Copying Images<br>3.1.2 Downloading Images<br>3.2 Text to Personal Document<br>3.3 Video to Personal Document<br>3.3.1 Copying Video<br>3.3.2 Downloading Video<br>3.4 Manual Entry to Web (Add On)<br>3.5 Image to Web<br>3.6 Text to Web<br>3.7 Video to Web<br>3.8 Manual Entry to Web (Plugin) <br>4 Interfaces <br>4.1 Wikimedia <br>4.2 Flickr <br>4.3 Manual Entry<br>5 Output<br>5.1 Add on<br>5.2 Plugin<br>6 Existing Technologies <br>6.1 Citation Machine: http://citationmachine.net/ <br>6.2 Xpert: http://www.nottingham.ac.uk/xpert/attribution/<br>6.3 CC Metadata Humanizer: http://code.creativecommons.org/~john/ <br>6.4 OCW cite/attribute: http://ocw.korea.edu/ocw<br>6.5 Wikimedia Commons: http://commons.wikimedia.org<br>7 Technical Considerations<br>7.1 Security<br>7.2 Meta Repository<br>8 Recommended Approaches<br>9 Open Issues  <br>  '''Project Overview'''<br>Open Attribute is a project to build attribution generators for Creative Commons licensed content. The project is to build simple tools for a range of platforms so that re-using and attributing open content is as easy as cut and paste. <br> <br>The problem: Creative Commons licensed content is awesome, but attributing it properly can be difficult and confusing.  The first rule for re-using openly licensed content is that you have to properly attribute the creator. There are specific requirements for what needs to go into that attribution, and most people don’t know what they are or how to follow them. How-to guides and user education haven't helped much; too many people are still confused about what to put into an attribution and how to format it.<br> <br>The solution: A simple tool everyone can use to do the right thing with the click of a button.  That's why we're building OpenAttribute, a suite of tools that makes it ridiculously simple for anyone to copy and paste the correct attribution for any CC licensed work. These tools will query the metadata around a CC-licensed object and export it in a properly formatted attribution that users can copy and paste wherever they need to. Citation generators already exist for lots of academic bibliographic formats and many different settings. By building on those tools to produce attributions, we’re creating a clean solution to a messy problem.<br> <br>The tools include a simple add-on for web browsers, and plug-ins for popular publishing platforms like Flickr, Wordpress, MediaWiki and Drupal.  To make automated attribution generation really useful, we need to enable it in a variety of contexts. We need several tools in several places. With an add-on for browsers, users will be able to pull RDFa from any site where it’s available and produce formatted attributions; plugins and widgets for open content publishing platforms like Wordpress and Drupal, will allow creators to facilitate proper attribution of their work. <br> <br>The result: OpenAttribute makes it easy for everyday people to use Creative Commons licensed content. And ensures content creators get credit for their work.  There is an enormously rich pool of open content out there, the easier we can make it to use and reuse that content, the better.  '''Models'''<br>Two models currently exist for this open attribution tool. Both models are limited by their own technical use cases instigating the creation of two separate code solutions. The models define no special functions for any additional user models.  Add On<br>The Add On is defined as a browser extension, which, when installed, allows the user to pull available RDFa data and format it into the proper attribution. When no RDFa data is available, metadata should be generated from other sources NEEDS TO BE INVESTIGATED. When neither RDFa or alternative metadata exist, the add on should pull appropriate data (alt tags, HTML) using class or id names. The method of pulling non metadata must be specific for each interface (see Ch. 3), meaning that an interface detection method will be necessary. The Add On will also allow for manual entry of attribution data when RDFa or metadata does not exist. The manual entry option should also exist when pulling non metadata, as the HTML may not be properly formatted for attribution.  The Add On's use scenario will be specifically click a button in the browser. A sidebar appears with the formatted attribution in plain text and HTML. The Add On's use case will be pulling content from the web to a personal document (see Ch. 4).  Plugin<br>The Plugin is defined as an external code snippet created for use with specific PHP based, open source platforms. These platforms will be: Wordpress, Drupal, Joomla, Zotero, dSpace, ccMixter. The plugin will be created and tested using Wordpress. Iterations of the plugin for the other listed platforms will be forthcoming after successful Wordpress trials. The plugin will also allow for manual entry of attribution data when RDFa or metadata does not exist. The manual entry option should also exist when pulling non metadata, as the HTML may not be properly formatted for attribution.  The Plugin's use scenario will be specifically click a button that appears on the content landing page or the download page. A pop-up (e.g., using ajax or javascript) offers plain text and HTML options for copying and pasting the attribution. The Plugin's use case will be pulling content from the web to the web (see Ch. 4).  <br>'''Use Cases'''<br>Image to Personal Document<br>Copying Images<br>The user finds an image that he/she would like to use in a personal document. The user copies the image to the clipboard. The attribution information is copied with the image. Upon pasting the image, attribution information is printed below the image with the same width as the image and using left alignment.<br>Downloading Images<br>The user finds an image that he/she would like to use in a personal document. The user downloads the image. The attribution information is stored in the image file as metadata. (this works for sure with JPG, investigate GIF, PNG file formats)  Text to Personal Document<br>The user finds a piece of text that he/she would like to use in a personal document. The user copies the text and upon paste the text is formatted into quotation style with attribution information appearing in italics two points smaller and aligned right of the quotation.  Video to Personal Document<br>Copying Video<br>The user finds a video that he/she would like to use in a personal document. The user tries to copy the video to the clipboard. The attribution information is copied with the video location information. Upon pasting, attribution and a link will be printed to the document.<br>Downloading Video<br>The user finds a video that he/she would like to use in a personal document. The user downloads the video. The attribution information is stored in the video file as metadata.  Manual Entry to Web (Add On)<br>The user clicks the button to begin the attribution process, when no RDFa, metadata or suitable HTML is found, the Add On opens a form. The form includes entry for the title of the work being attributed, attribution name (e.g., author, company, username), source URL for the attributed work, CC license name, CC license URL, existing copyright notices. Optional attribution elements are the URL for the author site and contact information for additional permissions.  Image to Web<br>The user finds an image that he/she would like to use on the web. The user copies the image to the clipboard. The attribution information is copied with the image. Upon pasting the image, attribution information is printed below the image with the same width as the image and using left alignment. Additionally, the image itself is linked to the original source.  Text to Web<br>The user finds a piece of text that he/she would like to use on the web. The user copies the text and upon paste the text is formatted into quotation style with attribution information appearing in italics two points smaller and aligned right of the quotation.  Video to Web<br>The user finds a video that he/she would like to use on the web. The user tries to copy the video to the clipboard. The attribution information is copied with the video location information. Upon pasting, attribution and a link will be printed to the webpage.<br>Manual Entry to Web (Plugin)<br>The user clicks the button to begin the attribution process, when no RDFa, metadata or suitable HTML is found, the plugin opens a form in the popup window. The form includes entry for the title of the work being attributed, attribution name (e.g., author, company, username), source URL for the attributed work, CC license name, CC license URL, existing copyright notices. Optional attribution elements are the URL for the author site and contact information for additional permissions.<br>'''Interfaces '''<br>RESEARCH NEEDED: This section needs to contain the information for how these sites store their metadata<br>Wikimedia<br>The Wikimedia Commons offers an API for pulling an XML of the metadata included in a document. This API must be implemented and queried to pull the attribution information. http://toolserver.org/~magnus/commonsapi_test.php<br>Flickr<br>Manual Entry<br>A form that allows the user to create an entry for the title of the work being attributed, attribution name (e.g., author, company, username), source URL for the attributed work, CC license name, CC license URL, existing copyright notices. Optional attribution elements are the URL for the author site and contact information for additional permissions.<br>'''Output'''<br>Add on<br>The attribution will be created based on the type of content is being pulled. If the content is an image, attribution information is printed below the image with the same width as the image and using left alignment. In this instance, the attribution information should also be embedded in the image metadata. Text should be formatted as a quote with 3px spacing on all sides with attribution information on the new line (e.g.&lt;br/&gt;), 2px smaller and in italics. Text output can use a standard web font at 12 pixels, making the attribution information 10px. Videos will be attributed with the attribution information followed by a &lt;br/&gt; tag and subsequently, the link information. When a video is downloaded, attribution information will be embedded in the file.<br>Plugin<br>The attribution will be created based on the type of content is being pulled. If the content is an image, attribution information is printed below the image with the same width as the image and using left alignment. In this instance, the image will also link back to the original source. Text should be formatted as a quote with 3px spacing on all sides with attribution information on the new line (e.g.&lt;br/&gt;), 2px smaller and in italics. Text output can use a standard web font at 12 pixels, making the attribution information 10px. Videos will be linked or embedded with the attribution information on the next line. <br>'''Existing Technologies'''<br>Citation Machine: http://citationmachine.net/<br>Xpert: http://www.nottingham.ac.uk/xpert/attribution/<br>CC Metadata Humanizer: http://code.creativecommons.org/~john/ <br>OCW cite/attribute: http://ocw.korea.edu/ocw<br>Wikimedia Commons: http://commons.wikimedia.org<br>Technical Considerations<br>This functional spec assumes that RDFa and metadata will be accessible. The persons responsible for the implementation of this functional spec will need to determine which interfaces allow the usage of stored RDFa or metadata and how the API must be implemented to pull the data. For purposes of the functional specification, the authors have assumed all interfaces have open metadata.  <br> '''Security'''<br>This section needs to detail whether or not the attribution can be deleted. If the add on or plugin pulls the metadata and prints it with text or HTML, the user has the ability to delete the data. Does it matter?  '''Meta Repository'''<br>Where and how will we store manual entry metadata? <br>Recommended Approaches<br>Open Issues<br>  <br>