Changes

| Initial Draft<br>|<br>

! scope="col" | Comments<br>|<br>

! scope="col" | Comments<br>

'''Table of Contents'''<br>  [[#1|1 Project Overview ]]<br>[[#2|2 Models ]]<br> *[[#2.1|2.1 Add On]]*[[#2.2|2.2 Plugin]] [[#3|3 Use Cases]]<br> *[[#3.1|3.1 Image to Personal Document]]*[[#3.1.1|3.1.1 Copying Images]]*[[#3.1.2|3.1.2 Downloading Images]]*[[#3.2|3.2 Text to Personal Document]]*[[#3.3|3.3 Video to Personal Document]]*[[#3.3.1|3.3.1 Copying Video]]*[[#3.3.2|3.3.2 Downloading Video]]*[[#3.4|3.4 Manual Entry to Web (Add On)]]*[[#3.5|3.5 Image to Web]]*[[#3.6|3.6 Text to Web]]*[[#3.7|3.7 Video to Web]]*[[#3.8|3.8 Manual Entry to Web (Plugin)]] [[#4|4 Interfaces ]]<br> *4.1 Wikimedia *4.2 Flickr *4.3 Manual Entry [[#5|5 Output]]<br> *5.1 Add on*5.2 Plugin [[#6|6 Existing Technologies ]]<br> *6.1 Citation Machine: http://citationmachine.net/ *6.2 Xpert: http://www.nottingham.ac.uk/xpert/attribution/*6.3 CC Metadata Humanizer: http://code.creativecommons.org/~john/ *6.4 OCW cite/attribute: http://ocw.korea.edu/ocw*6.5 Wikimedia Commons: http://commons.wikimedia.org [[#7|7 Technical Considerations]]<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|8 Recommended Approaches]]<br>[[#9|9 Open Issues ]]

'''[[|]]1. 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.

'''[[|]] 2. 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.

[[|]]2.1 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.

[[|]]2.2 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.

<br>'''[[|]]3. Use Cases'''<br>[[|]]3.1 Image to Personal Document<br>[[|]]3.1.1 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>[[|]]3.1.2 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)  3.2 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.  3.3 Video to Personal Document<br>3.3.1 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>3.3.2 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.  3.4 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.  3.5 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.  3.6 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.

Text 3.7 Video to Personal DocumentWeb<br>The user finds a piece of text video that he/she would like to use in a personal documenton the web. The user copies tries to copy the text and upon paste video to the text clipboard. The attribution information is formatted into quotation style copied with the video location information. Upon pasting, attribution information appearing in italics two points smaller and aligned right of a link will be printed to the quotationwebpage. <br>

Video 3.8 Manual Entry to Personal Document<br>Copying VideoWeb (Plugin)<br>The user finds clicks the button to begin the attribution process, when no RDFa, metadata or suitable HTML is found, the plugin opens a video that he/she would like to use form in a personal documentthe popup window. The user tries to copy form includes entry for the title of the video to work being attributed, attribution name (e.g., author, company, username), source URL for the clipboardattributed work, CC license name, CC license URL, existing copyright notices. The Optional attribution information is copied with elements are the URL for the video location author site and contact informationfor additional permissions. Upon pasting, attribution and a link will be printed <br> '''[[|]]4. Interfaces '''<br>RESEARCH NEEDED: This section needs to contain the document.information for how these sites store their metadata<br>Downloading VideoWikimedia<br>The user finds a video that he/she would like to use Wikimedia Commons offers an API for pulling an XML of the metadata included in a personal document. The user downloads This API must be implemented and queried to pull the video. The attribution information is stored in the video file as metadata. http://toolserver.org/~magnus/commonsapi_test.php<br>Flickr<br>Manual Entry<br><br><br>

Manual Entry to Web ('''[[|]]5. Output'''<br>Add On)on<br>The user clicks 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 button to begin 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 processinformation on the new line (e.g.&lt;br/&gt;), when no RDFa2px 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, metadata or suitable HTML the link information. When a video is founddownloaded, attribution information will be embedded in the Add On opens a formfile. <br>Plugin<br>The form includes entry for attribution will be created based on the title type of content is being pulled. If the work being attributedcontent is an image, attribution name 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;), author, company2px smaller and in italics. Text output can use a standard web font at 12 pixels, username), source URL for making the attributed work, CC license name, CC license URL, existing copyright noticesattribution information 10px. Optional Videos will be linked or embedded with the attribution elements are the URL for information on the author site and contact information for additional permissionsnext line. <br>

Image to Web'''[[|]]6. Existing Technologies'''<br>Citation Machine: http://citationmachine.net/<br>The user finds an image that heXpert: http://she would like to use on the webwww.nottingham. The user copies the image to the clipboardac. The uk/xpert/attribution information is copied with the image/<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. Upon pasting The persons responsible for the image, attribution information is printed below implementation of this functional spec will need to determine which interfaces allow the image with usage of stored RDFa or metadata and how the same width as API must be implemented to pull the image and using left alignmentdata. AdditionallyFor purposes of the functional specification, the image itself is linked to the original sourceauthors have assumed all interfaces have open metadata.

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'''[[|]]7. Technical Considerations'''<br>

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 permissions7.1 Security<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 detail whether or not 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 can be created based on the type of content is being pulleddeleted. If the content is an image, attribution information is printed below the image with the same width as add on or plugin pulls 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 prints it with the attribution information followed by a &lt;br/&gt; tag and subsequentlytext or HTML, 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 user has the same width as the image and using left alignment. In this instance, the image will also link back ability 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 delete the data. For purposes of the functional specification, the authors have assumed all interfaces have open metadata. Does it matter?

7.2 Meta Repository<br>Where and how will we store manual entry metadata? <br> '''Security<br>'''<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[[|]]8. Recommended Approaches'''<br>Where and how will we store manual entry metadata? <br>Recommended Approaches<br>'''[[|]]9. Open Issues'''<br>