Changes

Jump to: navigation, search

Drumbeat/Attribution generator Functional Specification

1,113 bytes removed, 20:14, 23 November 2010
no edit summary
<br>
 
<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>
 
*7.1 Security
*7.2 Meta Repository
 
[[#8|8 Recommended Approaches]]<br>[[#9|9 Open Issues]]
<br>
== '''1. Project Overview'''<br> ==
<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> &nbsp; For more, see the [http://etherpad.mozilla.com:9000/OpenAttribute-one-page-overview one-page project description here].<br>
== '''2. Models'''<br> ==
<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.
<br>
 === 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.
<br>
 === 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.
<br>
 === 3.7 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>
<br>
 === 3.8 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>
== <br> 4. Interfaces ==
4<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. Interfaces ==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><br>
== <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><br> <br> 5. 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.
'''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>
 == <br> 6. 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>7. 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. 7.1 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?
<br>
 
== 7.2 Meta Repository ==
 
<br>Where and how will we store manual entry metadata?
 
== '''<br>''' 8. Recommended Approaches ==
== 7.2 Meta Repository ==
<br>Where and how will we store manual entry metadata? <br>'''<br>''' 8== 9. Recommended Approaches Open Issues ==
9. Open Issues== <br> ==
<br>
Confirm
9,624
edits

Navigation menu