Confirm
9,624
edits
Changes
no edit summary
=OpenAttribute: The world's simplest open attribution tool= ==Get Involved==* Mailing list (Google Group)* Tweet #Drumbeat #OpenAttribute* Group chat (IRC)* Weekly Drumbeat community calls (open to all) ==The project in 5 sentences:== ==One-page overview== ==Project infographic== ==Frequently Asked Questions== ==Market scan: What already exists?== == 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
|}
<br><br>
'''Reviewers'''<br>
| <br>
|}
<br>
'''Approvers<br>'''
<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.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>
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.
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>
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>
'''[[|]]4. 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><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.<br/>), 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 <br/> 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.<br/>), 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>
'''[[|]]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?
7.2 Meta Repository<br>Where and how will we store manual entry metadata? <br>'''<br>'''
'''[[|]]8. Recommended Approaches'''<br>'''[[|]]9. Open Issues'''<br>
<br>
==Project management==
==1 pager==OpenAttribute: building the world's simplest open attribution toolProject Description
OpenAttribute: building the world's simplest open attribution tool Project Description
<br> The project in five sentences:
•Creative Commons content is awesome, but attributing it properly can be difficult and confusing.
•How-to guides and user education haven't helped much. We need 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.
•The tools include a simple add-on for web browsers, and plug-ins for popular publishing platforms like Flickr, Wordpress, MediaWiki and Drupal.
•The result: OpenAttribute makes it easy for everyday people to use open and Creative Commons content. And ensures content creators get credit for their work.
<br>
The project in one page:
•Become an alpha tester
<br>
POTENTIAL PROJECT NAMES:
•Attaboy +3
•(I don't love using a gendered name - Molly) +1
•CAT (Commons Attribution Tool)
•ChalkUp +2
•(Given Molly's note about gender, this is my new favorite as a temporary working title. Cuz it's so short. e.g., "#drumbeat #chalkup")
•Copy Credit
•Creative Credit
•CreditDue
•OpenAttribute +3
<br>
•Join the project mailing list: http://groups.google.com/group/attrib-generator
•Developers who can help advise & amp; build. (Before they start building, they probably need to help spec it and advise on technical strategy.)
•The first step here is to develop a functional spec. A lot of developers will only get onboard if everything is spelled out and formatted specifically for their techie brains. This document is on the way and could be utilized for the FS.
•Basic FS points (these will, of course, be modified for this specific tool)
•Project Overview with User Model
•Concepts
•Public Features (if separate from Admin)
•Admin Features (if separate from Public)
• Technical Considerations (Security & amp; Metatagging)
• Recommended Softwares or Implementations/Examples and Review of preexisting tools
• We need to ensure that what we're proposing to build doesn't exist already. What's the competitive / co-opetive landscape or ecology?
• What other solutions already exist that we might collaborate with or learn from?
• (Please list others here)
==FAQ== FREQUENTLY ASKED QUESTIONS
• What does "attribute" and "attribution" mean? Why should I care about it?
• Simple, one or two-sentence anwswer in a nutshell, anyone? :)
• To define "attribute" let's just break the word into two words, as in "a" "tribute". Basically, attribution is giving "a" "tribute" to the person that created the awesome content you're using. Why should you care? Because content creators using creative commons licenses care about giving you access to their creations...
• http://wiki.creativecommons.org/Frequently_Asked_Questions#How_do_I_properly_attribute_a_Creative_Commons_licensed_work.3F
<br>
• What's the specific problem this project will help solve? How does it make the web more open and awesome?
• Lots of people are using Creative Commons and other open licenses to share their work. We need a tool that can 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.
<br>
• What's the difference between "attribution" and "citation?"
• Attribution = crediting a copyright holder according to the terms of a copyright license. Usually (though not always) crediting artistic works like music, fiction, video, and photography.
<br>
• What's the itch you're trying to scratch?
• However, as far as we have been able to find, there is still no automated tool that pulls the necessary metadata about an openly licensed work and formats it into a cut and pasteable attribution.
• What's the right technological approach for this project?
• When we talked about how to tackle this at Drumbeat, the group agreed that beginning with the bookmarklet / add-on probably made a lot of sense, even though it won't reach all the people we want to reach.
<br>
• What specifically will the project build?
• An attribution generator tool. For closed content platforms (like Flickr) that share lots of openly licensed content. (or just for them to implement RDFa?)
<br>
• Who are the key AUDIENCES or "customers" for this project?
• Is this targeted at the end user? Or at a handful of big partners (Creative Commons, Flickr, Wordpress, etc.) who in turn deliver a large number of end users for the tool?
<br>
• Is the tool intended primarily / exclusively for Creative Commons content? Or other use cases as well?
• http://creativecommons.org/publicdomain/
<br>
• Is this a "suite" of tools (plural)? Or a "tool" (singular)?
• (or a "project," if there's a big emphasis on lobbying sites)
<br>
• What format will the attributions use?
• Answer: Print (plain text) and web (HTML with RDFa)
<br>
• What citation scheme will you use?
• Lots of things that are needed in a "properly formatted" citation won't be included in the creator-provided metadata. Do we need to build a robust citation generator, or how simple will the attribution be?
<br>
• Will this provide a simple attribution based on what's specified in the RDFa?
• What is the "baseline" of data recommended in RDFa? Will it be hard to change that?
<br>
• What's the user experience like?
• A pop-up (e.g., using ajax or javascript) offers plain text and HTML options for copying and pasting the attribution.
• For content creators / authors:
• Platform based tool: The author provides their preferred name for attribution. And has the option to include CC+ information about contact information for additional permissions.
<br>
• What metadata will be included in the attribution?
• 2) Contact information for additional permissions
<br>
• What "closed" platforms will you support?
• (In a fantasty world, they'd do more than that - they would build an "attribute this" button into every page that users could click to get a properly formatted attribution. Nearly all academic databases include a "cite this" button - same principle, only for attributions - Molly)
<br> What "open" platforms will you support? (what do we know about these platforms' plug-in systems? can we write once and port easily?)
--I would think that a plugin for Wordpress, Drupal, Joomla and all the rest of the PHP based content management systems would be a once over in one system and then a quick port. If the PHP is clean, it should be easy to write it for multiple platforms.
just sharing— could be a cool test case:
http://ookaboo.com/o/pictures/http://ookaboo.com/o/pictures/topic/12586624/Auto_rickshaw <br>
• Wikipedia (MediaWiki)
• --I would think that a plugin for Wordpress, Drupal, Joomla and all the rest of the PHP based content management systems would be a once over in one system and then a quick port. If the PHP is clean, it should be easy to write it for multiple platforms.
• What's an example of what the plain text attribution would look like?
• My Drumbeat Experience / Pieter Kleymeer (@bagabot) / Creative Commons Attribution 3.0 Unported License.
<br>
• What's an example of what the HTML attribution looks like?
• Code for the pasteable HTML attribution, w/ RDFa
• <<a rel="license" href="http://creativecommons.org/licenses/by/3.0/"><><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by/3.0/88x31.png" /><></a><br />> <span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/StillImage" property="dct:title" rel="dct:type">My Drumbeat Experience</span> by <<a xmlns:cc="http://creativecommons.org/ns#" href="http://open.umich.edu" property="cc:attributionName" rel="cc:attributionURL">>Pieter Kleymeer (@bagabot)<</a> > is licensed under a <<a rel="license" href="http://creativecommons.org/licenses/by/3.0/">>Creative Commons Attribution 3.0 Unported License<</a>>.<br /> Based on a work at <<a xmlns:dct="http://purl.org/dc/terms/" href="http://flickr.com" rel="dct:source">>flickr.com<</a>>.
