Creative Commons - User contributions [en]

Mozilla Service Week

2009-09-02T19:28:49Z

Gameguy43: /* Volunteers */

<div style="padding:1.25em 1em; -moz-border-radius:5px; -webkit-border-radius:5px; background-color: #eaeaea; overflow: auto; margin-bottom:2em;">
Mozilla Service Week is an opportunity for people to help others learn more about their area of expertise.

<table width="100%">
<tr align="center">
<td><strong>[[#I Want To Help!|I Want To Help!]]</strong></td>
<td><strong>[[#I Need Help!|I Need Help!]]</strong></td>
</tr></table>

</div>

Mozilla Service Week is September 14-21, 2009. From [http://mozillaservice.org/learn_more/index/en_US their website]:

<blockquote>
<strong>What Is Mozilla Service Week?</strong>

<p>During the week of September 14-21, 2009, we're asking individuals to step up and make a difference by using the Web to better their community. We're looking for people who want to share, give, engage, create, and collaborate by offering their time and talent to local organizations and people who need their help.</p>

<p>Mozilla believes everyone should know how to use the Internet, have easy access to it, and have a good experience when they're online. By utilizing our community's talents for writing, designing, programming, developing, and all-around technical know-how, we believe we can make the Web a better place for everyone.</p>
</blockquote>

As an organization that shares those values and ideals, Creative Commons is answering Mozilla's call for participation by hosting an online help desk via our [[IRC]] channel.

The CC help desk is a place for experienced CC-ers (staff, Jurisdiction partners, and community members), to come together to share their collective expertise with those that are new to CC and need a little, or a lot, of guidance.

The CC community will be providing help with the following topics:

* General CC help
* CC technology (ccREL and software projects)
* Where and how to publish CC works
* Where and how to find CC works
* CC in education and science

= I Need Help! =

If you're new to CC or just have questions about one of the topics above you can get help by joining the [[IRC]] channel during Service Week. Refer to the list of [[#Volunteers|volunteers]] below if you're not sure who in the channel to ask.

== But I don't know what IRC is! ==

From the [http://en.wikipedia.org/wiki/IRC IRC] page in Wikipedia:

<blockquote>[IRC] is a form of real-time Internet text messaging (chat)... mainly designed for group communication in discussion forums, called channels.</blockquote>

Creative Commons has a dedicated room, [[IRC|#cc]], on the [http://freenode.net Freenode Network].

== IRC Software ==

If you don't currently use IRC, Wikipedia has a helpful [http://en.wikipedia.org/wiki/List_of_IRC_clients list of applications].

==== Linux Users ====

You have lots of options; [http://xchat-gnome.navi.cx/ X-Chat Gnome] is one of them. If you have a favorite, add a link here!

==== Mac OS X Users ====

* [http://colloquy.info/ Colloquy] is an IRC client for Mac OS X

==== Windows Users ====

* X-Chat is available at http://www.silverex.org/download/
* [http://www.mirc.com/ mIRC] was awesome in 1995. Maybe it still is.

= I Want To Help! =

If you have time to help out, you can participate by spending time in the channel answering questions.

Add your name to the schedule below and join the channel during your scheduled day. You don't need to block out time, you can just leave it running in the background and look periodically to answer questions.

Please add your name and IRC nick below to the days you can help out.

== Volunteers ==

The people below (with their IRC nick names in parenthesis) have volunteered to help out.

=== Monday, September 14, 2009 ===

* Nathan Yergler (nathany) [CC Staff]
* Alex Kozak (akozak) [CC Staff]
* Nathan Kinkade (nkinkade) [CC Staff]
* Greg Grossmeier (greg-g) [CC Staff]
* Aurelia J. Schultz [CC Staff]
* Fred Benenson (mecredis) [CC Staff]
* Parker Phinney (pyrak) [Former CC Intern]

=== Tuesday, September 15, 2009 ===

* Nathan Yergler (nathany) [CC Staff]
* Alex Kozak (akozak) [CC Staff]
* Nathan Kinkade (nkinkade) [CC Staff]
* Greg Grossmeier (greg-g) [CC Staff]
* Aurelia J. Schultz [CC Staff]
* Parker Phinney (pyrak) [Former CC Intern]

=== Wednesday, September 16, 2009 ===

* Nathan Yergler (nathany) [CC Staff]
* Alex Kozak (akozak) [CC Staff]
* Nathan Kinkade (nkinkade) [CC Staff]
* Greg Grossmeier (greg-g) [CC Staff]
* Aurelia J. Schultz [CC Staff]
* Parker Phinney (pyrak) [Former CC Intern]

=== Thursday, September 17, 2009 ===

* Nathan Yergler (nathany) [CC Staff]
* Alex Kozak (akozak) [CC Staff]
* Nathan Kinkade (nkinkade) [CC Staff]
* Greg Grossmeier (greg-g) [CC Staff]
* Michelle Thorne [CC Staff]
* Parker Phinney (pyrak) [Former CC Intern]

=== Friday, September 18, 2009 ===

* Nathan Yergler (nathany) [CC Staff]
* Alex Kozak (akozak) [CC Staff]
* Nathan Kinkade (nkinkade) [CC Staff]
* Greg Grossmeier (greg-g) [CC Staff]
* Aurelia J. Schultz [CC Staff]
* Parker Phinney (pyrak) [Former CC Intern]

Jswidget new

2009-08-07T21:26:12Z

Gameguy43: /* Sample Usage */

{{Software Project
|Description=LicenseChooser.js provides a lightweight method for integrating license selection into web applications.
|Bug tracker=http://code.creativecommons.org/issues/
|Code repository=http://code.creativecommons.org/viewsvn/jswidget/
|Mailing list=http://lists.ibiblio.org/mailman/listinfo/cc-devel
}}
{{Project}}
__NOTOC__

Creative Commons currently provides two methods for integrating license selection into applications: the [[Partner Interface]] and the [[Creative Commons Web Services|web service API]]. The CC Javascript Widget (LicenseChooser.js) provides an additional, lightweight method for integrating license selection into web applications. The widget is used by TypePad, as well as [[WpLicense]].

'''LicenseChooser.js is nearly ready! Please try the [http://code.creativecommons.org/viewsvn/jswidget/tags/0.97/ 0.97 preview].'''

== Users ==
* [[WpLicense]] uses LicenseChooser.js to provide a license selector for WordPress
* TypePad provides [http://everything.typepad.com/cc/ a widget] for adding a license to hosted blogs.

== Sample Usage ==

You can read the source of these examples; they demonstrate some (but not all) of the combinations for advanced usage described below.

* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-license.html CC License selector only]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-openness.html Selector without the choice of "No license"]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/ Basic usage (all options visible)]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/inside_form.html Basic usage from inside another form tag]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/default-is-no-license.html Selector where "no license" is the starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/without-jurisdiction.html Selector without a jurisdiction choice]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed.html Selector with a specific license used as a starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-without-jurisdiction.html Selector with a specific license as a starting point with no jurisdiction selector, always using the "seeded" jurisdiction]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-old-version.html Selector where an old license version was given as the seed]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/language-detect.html Selector that relies on Apache Content Negotiation for translations]

== Availability ==

You can play with a 0.97 pre-release right now!
* 2009-04-29: [http://mirrors.creativecommons.org/software/licensechooser-js/licensechooser-js-0.97.tar.gz Released 0.97]. '''This is the latest preview that is very close to 1.0.''' This release allows you to embed LicenseChooser.js inside a form tag. Thanks to John Horigan for reporting this issue and providing a patch (which we merged with some changes).
* 2009-03-16: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.96]. The help text for "Share alike" was wrong, mistakenly giving you the non-commercial help text. Fixed! This is an important update.
* 2008-09-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.95]. An anonymous bug reporter indicated that we overwrite the first JavaScript file found, even if it is not LicenseChooser.js. Fixed! This is an important update.
* 2008-08-27: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.94]. Stylistic issue found: image not always properly aligned with text in pop-up describing e.g. Share-Alike. We no longer user document.write() (yuck) to insert the HTML of the widget into the document; we now modify the innerHTML of a div we create ourselves. We may further harden the JS against namespace collisions with [http://kentbrewster.com/badges Kent Brewster's badges] strategy.
* 2007-10-10: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.92]. Stylistic updates: Alex has gone to town on the chooser and styled it. It only shows jurisdictions that have launched. There are no known pending technical or visual issues.
* 2007-08-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.91]. The license selector allows one to remove the jurisdiction selector. There is a "No license" choice. Translation is done using JavaScript and not hidden DOM elements. Application developers have more control over the defaults, including "no license" being choosable as the default.
* 2007-08-09: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.9]. We've changed the plan to add some features before 1.0 based on talking with potential users. All DOM elements are '''really''' prefixed with cc_js_ this time, and all strings '''really''' are available for translation this time. Documentation is updated for the 0.9 release, including a way to have the application developer specify only a single jurisdiction for the license. JSON output is validated before being sent to a web browser. Removed dependency on prototype.js. Server code changes to improve performance. Massive reduction of unused JS and CSS (this process began with 0.4).
* 2007-08-06: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.4]. All DOM elements are prefixed with cc_js_. The widget works in Opera and Safari and works with degraded functionality in Konqueror.
* 2007-08-01: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.3]. This release introduces Internet Explorer compatibility, Apache Content Negotiation to handle user language selection even if the server doesn't provide it for us, a hopefully-stable API for selecting a license, and license seeding.
* 2007-07-25: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.2]. The UI now doesn't ask or contain spurious questions, plus translation is halfway there.
* 2007-07-19: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.1]. Don't try to use this in production, but DO let us know how it fits into your systems and what you would want us to change.

== Extra features ==
=== "Seeding" ===
* If the user has already selected a license through some other means, and you want to "seed" the JavaScript widget with the choices the user has already made, just create a hidden form field whose ID is cc_js_seed_uri with the URI of the license you want to start with.
** NOTE that whatever license version you provide, we always upgrade it to the most recent version the jurisdiction offers. We do display a '''Message''' underneath the license icon saying we did this.

=== Forcing a particular jurisdiction ===
To force the user to choose a license in a particular jurisdiction:
* First, use the "seeding" feature to seed the Attribution ("by") license in your jurisdiction
* Then, disable jurisdiction selection

=== Disabling jurisdiction selection ===
If you want to not offer the user a choice of jurisdictions:
* just append ?show_jurisdiction_chooser=n to the complete.js call.

=== Setting the license chooser to no license by default ===
If you want to set the license chooser to no license by default:
* just append ?default_option=no-license

=== Removing the "No license" option ===
If you want to not offer the user the option of selecting "no license:
* just append ?show_no-license_option=n to the query string
=== Language selection ===
* You can append ?locale=XX to your call to complete.js to choose a language. The example distributed as index.html in the distribution package sets the language to US English this way.
* If omitted, Apache Content Negotiation will select the most appropriate language based on the user's preferences, defaulting to US English.
=== Extracting results ===
All of these result extraction systems are demonstrated in the examples.
* There are two hidden form fields called '''cc_js_result_uri''' and '''cc_js_result_name''' that respectively store the URI and name of the license selected by the user. Just do <code>document.getElementById("cc_js_result_uri").value</code> (or "cc_js_result_name" instead) and you'll have the license information.
* There is an extra hidden form field containing the link to the image used. Simply get the element whose ID is '''cc_js_result_img''' and you will have a URL that is a permanent image. [http://en.wikipedia.org/wiki/Inline_linking Hotlink]ing these images is allowed and encouraged.

=== Styling ===
* Jswidget uses javascript magic to pull in a stylesheet, whether you want it to or not. Luckily, it puts the stylesheet at the very top of the header, so that you can easily override styles by including your own style sheet. We encourage you to write your own style sheet that builds on the one we've provided and personalized the look and feel of the widget to match your web app.

=== Namespacing ===
* All LicenseChooser.js HTML elements that have IDs or classes start with "cc_js_" to avoid namespace collisions.
* Similarly, all LicenseChooser.js JavaScript functions start with cc_js_. This is '''not''' true for the bundled Prototype.js library.

=== Full List of Query String Variables ===

* show_jurisdiction_chooser=(y/n)
**show/hide jurisdiction chooser
* show_cc0_option=(y/n);
**show/hide "CC0" option
* show_cc-license_option=(y/n);
**show/hide "CC license" option
* show_no-license_option=(y/n);
**show/hide "No license" option
*default_option=(cc0/cc-license/no-license);
**choose which option is present to the user first
*locale=(locale, ie 'en_US')
**choose language

You can specify as many of these options as you like by simply putting an '&' between them.

==== Examples: ====

*complete.js?locale=en_US&show_jurisdiction_chooser=n&default_option=cc-license&show_no-license_option=n
**Selector defaults to CC license chooser, is in US English, does not include a jurisdiction chooser, and does not include a "No license" option
*?locale=en_US&default_option=no-license&show_cc0_option=n
**Selector in US English which defaults to the "No license" option and doesn't include the cc0 option

==== Defaults ====

Currently, by default everything is displayed, and the CC license chooser is the default option. Thus, this query will return the exact same widget as the empty "complete.js"

complete.js?show_jurisdiction_chooser=y&show_cc0_option=y&show_cc-license_option=y&show_no-license_option=y&default_option=cc-license

(note that in this case, Apache content negotiation will be used to determine which language to use)

You might consider passing query string variables that assert settings that would be true due to default behavior anyway--this ensures that on the off chance that default behavior changes, your widget's behavior does not.

== Goals ==

The following list of general goals to remind us what we want out of LicenseChooser.js. You can expect most of it for 1.0.

See [[JsWidget/Plan]] to see what features are planned for what versions.

* Generate HTML suitable for use in a form which presents the basic license selector
* Provide compatibility with all [http://developer.yahoo.com/yui/articles/gbs/ A-grade browsers]
* Provide up to date license information by
** Utilizing licenses.xml to generate the appropriate Javascript on the server side. This may be done using a dynamic language such as PHP or through pre-processing to a static file when licenses are updated.
* Support new, expanded metadata including attributionName, attributionUrl and morePermissions.
* Provide a robust, scalable serving solution (if any server-side processing is needed) in order to support CC-hosted Javascript resources for the general public

== Version expectations ==
=== Zero point something (like 0.4) ===
There are no guarantees, but we'd like to keep to the same promises as a 1.0 release
=== Something point zero (like 1.0) ===
We guarantee (outside of really urgent situation where we exercise a judgement call) that these will '''not''' change:
* The programmatic interface for the widget will not change
* The user interface for selecting licenses will not change

The following are the only things that '''may'' change:
* As new translations become available, the text may become increasingly internationalized
* As jurisdictions offer new licenses, the engine will update the choices available to a user

== Resources ==

* [http://code.creativecommons.org/viewsvn/jswidget/ LicenseChooser.js development in Subversion]
* [http://cctools.svn.sourceforge.net/viewvc/cctools/cclib/trunk/js/ cclib/trunk/js] in Subversion contains the Javascript used for the [http://labs.creativecommons.org/dhtmllicense/ DHTML License Selector]
* [[JsWidget/Security|Security considerations]]

[[Category:Developer]]
[[Category:Opensource]]
[[Category:Integration]]

Jswidget new

2009-08-07T21:13:48Z

Gameguy43:

{{Software Project
|Description=LicenseChooser.js provides a lightweight method for integrating license selection into web applications.
|Bug tracker=http://code.creativecommons.org/issues/
|Code repository=http://code.creativecommons.org/viewsvn/jswidget/
|Mailing list=http://lists.ibiblio.org/mailman/listinfo/cc-devel
}}
{{Project}}
__NOTOC__

Creative Commons currently provides two methods for integrating license selection into applications: the [[Partner Interface]] and the [[Creative Commons Web Services|web service API]]. The CC Javascript Widget (LicenseChooser.js) provides an additional, lightweight method for integrating license selection into web applications. The widget is used by TypePad, as well as [[WpLicense]].

'''LicenseChooser.js is nearly ready! Please try the [http://code.creativecommons.org/viewsvn/jswidget/tags/0.97/ 0.97 preview].'''

== Users ==
* [[WpLicense]] uses LicenseChooser.js to provide a license selector for WordPress
* TypePad provides [http://everything.typepad.com/cc/ a widget] for adding a license to hosted blogs.

== Sample Usage ==

<div style="text-align:center">
[[Image:Jswidget-0.2-screenshot.png]]
</div>

You can read the source of these examples; they demonstrate some (but not all) of the combinations for advanced usage described below.

* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-license.html CC License selector only]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-openness.html Selector without the choice of "No license"]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/ Basic usage (all options visible)]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/inside_form.html Basic usage from inside another form tag]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/default-is-no-license.html Selector where "no license" is the starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/without-jurisdiction.html Selector without a jurisdiction choice]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed.html Selector with a specific license used as a starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-without-jurisdiction.html Selector with a specific license as a starting point with no jurisdiction selector, always using the "seeded" jurisdiction]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-old-version.html Selector where an old license version was given as the seed]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/language-detect.html Selector that relies on Apache Content Negotiation for translations]

== Availability ==

You can play with a 0.97 pre-release right now!
* 2009-04-29: [http://mirrors.creativecommons.org/software/licensechooser-js/licensechooser-js-0.97.tar.gz Released 0.97]. '''This is the latest preview that is very close to 1.0.''' This release allows you to embed LicenseChooser.js inside a form tag. Thanks to John Horigan for reporting this issue and providing a patch (which we merged with some changes).
* 2009-03-16: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.96]. The help text for "Share alike" was wrong, mistakenly giving you the non-commercial help text. Fixed! This is an important update.
* 2008-09-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.95]. An anonymous bug reporter indicated that we overwrite the first JavaScript file found, even if it is not LicenseChooser.js. Fixed! This is an important update.
* 2008-08-27: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.94]. Stylistic issue found: image not always properly aligned with text in pop-up describing e.g. Share-Alike. We no longer user document.write() (yuck) to insert the HTML of the widget into the document; we now modify the innerHTML of a div we create ourselves. We may further harden the JS against namespace collisions with [http://kentbrewster.com/badges Kent Brewster's badges] strategy.
* 2007-10-10: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.92]. Stylistic updates: Alex has gone to town on the chooser and styled it. It only shows jurisdictions that have launched. There are no known pending technical or visual issues.
* 2007-08-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.91]. The license selector allows one to remove the jurisdiction selector. There is a "No license" choice. Translation is done using JavaScript and not hidden DOM elements. Application developers have more control over the defaults, including "no license" being choosable as the default.
* 2007-08-09: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.9]. We've changed the plan to add some features before 1.0 based on talking with potential users. All DOM elements are '''really''' prefixed with cc_js_ this time, and all strings '''really''' are available for translation this time. Documentation is updated for the 0.9 release, including a way to have the application developer specify only a single jurisdiction for the license. JSON output is validated before being sent to a web browser. Removed dependency on prototype.js. Server code changes to improve performance. Massive reduction of unused JS and CSS (this process began with 0.4).
* 2007-08-06: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.4]. All DOM elements are prefixed with cc_js_. The widget works in Opera and Safari and works with degraded functionality in Konqueror.
* 2007-08-01: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.3]. This release introduces Internet Explorer compatibility, Apache Content Negotiation to handle user language selection even if the server doesn't provide it for us, a hopefully-stable API for selecting a license, and license seeding.
* 2007-07-25: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.2]. The UI now doesn't ask or contain spurious questions, plus translation is halfway there.
* 2007-07-19: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.1]. Don't try to use this in production, but DO let us know how it fits into your systems and what you would want us to change.

== Extra features ==
=== "Seeding" ===
* If the user has already selected a license through some other means, and you want to "seed" the JavaScript widget with the choices the user has already made, just create a hidden form field whose ID is cc_js_seed_uri with the URI of the license you want to start with.
** NOTE that whatever license version you provide, we always upgrade it to the most recent version the jurisdiction offers. We do display a '''Message''' underneath the license icon saying we did this.

=== Forcing a particular jurisdiction ===
To force the user to choose a license in a particular jurisdiction:
* First, use the "seeding" feature to seed the Attribution ("by") license in your jurisdiction
* Then, disable jurisdiction selection

=== Disabling jurisdiction selection ===
If you want to not offer the user a choice of jurisdictions:
* just append ?show_jurisdiction_chooser=n to the complete.js call.

=== Setting the license chooser to no license by default ===
If you want to set the license chooser to no license by default:
* just append ?default_option=no-license

=== Removing the "No license" option ===
If you want to not offer the user the option of selecting "no license:
* just append ?show_no-license_option=n to the query string
=== Language selection ===
* You can append ?locale=XX to your call to complete.js to choose a language. The example distributed as index.html in the distribution package sets the language to US English this way.
* If omitted, Apache Content Negotiation will select the most appropriate language based on the user's preferences, defaulting to US English.
=== Extracting results ===
All of these result extraction systems are demonstrated in the examples.
* There are two hidden form fields called '''cc_js_result_uri''' and '''cc_js_result_name''' that respectively store the URI and name of the license selected by the user. Just do <code>document.getElementById("cc_js_result_uri").value</code> (or "cc_js_result_name" instead) and you'll have the license information.
* There is an extra hidden form field containing the link to the image used. Simply get the element whose ID is '''cc_js_result_img''' and you will have a URL that is a permanent image. [http://en.wikipedia.org/wiki/Inline_linking Hotlink]ing these images is allowed and encouraged.

=== Styling ===
* Jswidget uses javascript magic to pull in a stylesheet, whether you want it to or not. Luckily, it puts the stylesheet at the very top of the header, so that you can easily override styles by including your own style sheet. We encourage you to write your own style sheet that builds on the one we've provided and personalized the look and feel of the widget to match your web app.

=== Namespacing ===
* All LicenseChooser.js HTML elements that have IDs or classes start with "cc_js_" to avoid namespace collisions.
* Similarly, all LicenseChooser.js JavaScript functions start with cc_js_. This is '''not''' true for the bundled Prototype.js library.

=== Full List of Query String Variables ===

* show_jurisdiction_chooser=(y/n)
**show/hide jurisdiction chooser
* show_cc0_option=(y/n);
**show/hide "CC0" option
* show_cc-license_option=(y/n);
**show/hide "CC license" option
* show_no-license_option=(y/n);
**show/hide "No license" option
*default_option=(cc0/cc-license/no-license);
**choose which option is present to the user first
*locale=(locale, ie 'en_US')
**choose language

You can specify as many of these options as you like by simply putting an '&' between them.

==== Examples: ====

*complete.js?locale=en_US&show_jurisdiction_chooser=n&default_option=cc-license&show_no-license_option=n
**Selector defaults to CC license chooser, is in US English, does not include a jurisdiction chooser, and does not include a "No license" option
*?locale=en_US&default_option=no-license&show_cc0_option=n
**Selector in US English which defaults to the "No license" option and doesn't include the cc0 option

==== Defaults ====

Currently, by default everything is displayed, and the CC license chooser is the default option. Thus, this query will return the exact same widget as the empty "complete.js"

complete.js?show_jurisdiction_chooser=y&show_cc0_option=y&show_cc-license_option=y&show_no-license_option=y&default_option=cc-license

(note that in this case, Apache content negotiation will be used to determine which language to use)

You might consider passing query string variables that assert settings that would be true due to default behavior anyway--this ensures that on the off chance that default behavior changes, your widget's behavior does not.

== Goals ==

The following list of general goals to remind us what we want out of LicenseChooser.js. You can expect most of it for 1.0.

See [[JsWidget/Plan]] to see what features are planned for what versions.

* Generate HTML suitable for use in a form which presents the basic license selector
* Provide compatibility with all [http://developer.yahoo.com/yui/articles/gbs/ A-grade browsers]
* Provide up to date license information by
** Utilizing licenses.xml to generate the appropriate Javascript on the server side. This may be done using a dynamic language such as PHP or through pre-processing to a static file when licenses are updated.
* Support new, expanded metadata including attributionName, attributionUrl and morePermissions.
* Provide a robust, scalable serving solution (if any server-side processing is needed) in order to support CC-hosted Javascript resources for the general public

== Version expectations ==
=== Zero point something (like 0.4) ===
There are no guarantees, but we'd like to keep to the same promises as a 1.0 release
=== Something point zero (like 1.0) ===
We guarantee (outside of really urgent situation where we exercise a judgement call) that these will '''not''' change:
* The programmatic interface for the widget will not change
* The user interface for selecting licenses will not change

The following are the only things that '''may'' change:
* As new translations become available, the text may become increasingly internationalized
* As jurisdictions offer new licenses, the engine will update the choices available to a user

== Resources ==

* [http://code.creativecommons.org/viewsvn/jswidget/ LicenseChooser.js development in Subversion]
* [http://cctools.svn.sourceforge.net/viewvc/cctools/cclib/trunk/js/ cclib/trunk/js] in Subversion contains the Javascript used for the [http://labs.creativecommons.org/dhtmllicense/ DHTML License Selector]
* [[JsWidget/Security|Security considerations]]

[[Category:Developer]]
[[Category:Opensource]]
[[Category:Integration]]

Jswidget new

2009-08-07T21:11:35Z

Gameguy43: /* Full List of Query String Variables */

{{Software Project
|Description=LicenseChooser.js provides a lightweight method for integrating license selection into web applications.
|Bug tracker=http://code.creativecommons.org/issues/
|Code repository=http://code.creativecommons.org/viewsvn/jswidget/
|Mailing list=http://lists.ibiblio.org/mailman/listinfo/cc-devel
}}
{{Project}}
__NOTOC__

Creative Commons currently provides two methods for integrating license selection into applications: the [[Partner Interface]] and the [[Creative Commons Web Services|web service API]]. The CC Javascript Widget (LicenseChooser.js) provides an additional, lightweight method for integrating license selection into web applications. The widget is used by TypePad, as well as [[WpLicense]].

'''LicenseChooser.js is nearly ready! Please try the [http://code.creativecommons.org/viewsvn/jswidget/tags/0.97/ 0.97 preview].'''

== Users ==
* [[WpLicense]] uses LicenseChooser.js to provide a license selector for WordPress
* TypePad provides [http://everything.typepad.com/cc/ a widget] for adding a license to hosted blogs.

== Sample Usage ==

<div style="text-align:center">
[[Image:Jswidget-0.2-screenshot.png]]
</div>

You can read the source of these examples; they demonstrate some (but not all) of the combinations for advanced usage described below.

* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-license.html CC License selector only]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-openness.html Selector without the choice of "No license"]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/ Basic usage (all options visible)]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/inside_form.html Basic usage from inside another form tag]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/default-is-no-license.html Selector where "no license" is the starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/without-jurisdiction.html Selector without a jurisdiction choice]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed.html Selector with a specific license used as a starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-without-jurisdiction.html Selector with a specific license as a starting point with no jurisdiction selector, always using the "seeded" jurisdiction]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-old-version.html Selector where an old license version was given as the seed]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/language-detect.html Selector that relies on Apache Content Negotiation for translations]

== Availability ==

You can play with a 0.97 pre-release right now!
* 2009-04-29: [http://mirrors.creativecommons.org/software/licensechooser-js/licensechooser-js-0.97.tar.gz Released 0.97]. '''This is the latest preview that is very close to 1.0.''' This release allows you to embed LicenseChooser.js inside a form tag. Thanks to John Horigan for reporting this issue and providing a patch (which we merged with some changes).
* 2009-03-16: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.96]. The help text for "Share alike" was wrong, mistakenly giving you the non-commercial help text. Fixed! This is an important update.
* 2008-09-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.95]. An anonymous bug reporter indicated that we overwrite the first JavaScript file found, even if it is not LicenseChooser.js. Fixed! This is an important update.
* 2008-08-27: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.94]. Stylistic issue found: image not always properly aligned with text in pop-up describing e.g. Share-Alike. We no longer user document.write() (yuck) to insert the HTML of the widget into the document; we now modify the innerHTML of a div we create ourselves. We may further harden the JS against namespace collisions with [http://kentbrewster.com/badges Kent Brewster's badges] strategy.
* 2007-10-10: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.92]. Stylistic updates: Alex has gone to town on the chooser and styled it. It only shows jurisdictions that have launched. There are no known pending technical or visual issues.
* 2007-08-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.91]. The license selector allows one to remove the jurisdiction selector. There is a "No license" choice. Translation is done using JavaScript and not hidden DOM elements. Application developers have more control over the defaults, including "no license" being choosable as the default.
* 2007-08-09: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.9]. We've changed the plan to add some features before 1.0 based on talking with potential users. All DOM elements are '''really''' prefixed with cc_js_ this time, and all strings '''really''' are available for translation this time. Documentation is updated for the 0.9 release, including a way to have the application developer specify only a single jurisdiction for the license. JSON output is validated before being sent to a web browser. Removed dependency on prototype.js. Server code changes to improve performance. Massive reduction of unused JS and CSS (this process began with 0.4).
* 2007-08-06: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.4]. All DOM elements are prefixed with cc_js_. The widget works in Opera and Safari and works with degraded functionality in Konqueror.
* 2007-08-01: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.3]. This release introduces Internet Explorer compatibility, Apache Content Negotiation to handle user language selection even if the server doesn't provide it for us, a hopefully-stable API for selecting a license, and license seeding.
* 2007-07-25: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.2]. The UI now doesn't ask or contain spurious questions, plus translation is halfway there.
* 2007-07-19: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.1]. Don't try to use this in production, but DO let us know how it fits into your systems and what you would want us to change.

== Extra features ==
=== "Seeding" ===
* If the user has already selected a license through some other means, and you want to "seed" the JavaScript widget with the choices the user has already made, just create a hidden form field whose ID is cc_js_seed_uri with the URI of the license you want to start with.
** NOTE that whatever license version you provide, we always upgrade it to the most recent version the jurisdiction offers. We do display a '''Message''' underneath the license icon saying we did this.

=== Forcing a particular jurisdiction ===
To force the user to choose a license in a particular jurisdiction:
* First, use the "seeding" feature to seed the Attribution ("by") license in your jurisdiction
* Then, disable jurisdiction selection

=== Disabling jurisdiction selection ===
If you want to not offer the user a choice of jurisdictions:
* just append ?show_jurisdiction_chooser=n to the complete.js call.

=== Setting the license chooser to no license by default ===
If you want to set the license chooser to no license by default:
* just append ?default_option=no-license

=== Removing the "No license" option ===
If you want to not offer the user the option of selecting "no license:
* just append ?show_no-license_option=n to the query string
=== Language selection ===
* You can append ?locale=XX to your call to complete.js to choose a language. The example distributed as index.html in the distribution package sets the language to US English this way.
* If omitted, Apache Content Negotiation will select the most appropriate language based on the user's preferences, defaulting to US English.
=== Extracting results ===
All of these result extraction systems are demonstrated in the examples.
* There are two hidden form fields called '''cc_js_result_uri''' and '''cc_js_result_name''' that respectively store the URI and name of the license selected by the user. Just do <code>document.getElementById("cc_js_result_uri").value</code> (or "cc_js_result_name" instead) and you'll have the license information.
* There is an extra hidden form field containing the link to the image used. Simply get the element whose ID is '''cc_js_result_img''' and you will have a URL that is a permanent image. [http://en.wikipedia.org/wiki/Inline_linking Hotlink]ing these images is allowed and encouraged.

=== Styling ===
* Jswidget uses javascript magic to pull in a stylesheet, whether you want it to or not. Luckily, it puts the stylesheet at the very top of the header, so that you can easily override styles by including your own style sheet. We encourage you to write your own style sheet that builds on the one we've provided and personalized the look and feel of the widget to match your web app.

=== Namespacing ===
* All LicenseChooser.js HTML elements that have IDs or classes start with "cc_js_" to avoid namespace collisions.
* Similarly, all LicenseChooser.js JavaScript functions start with cc_js_. This is '''not''' true for the bundled Prototype.js library.

=== Full List of Query String Variables ===

* show_jurisdiction_chooser=(y/n)
**show/hide jurisdiction chooser
* show_cc0_option=(y/n);
**show/hide "CC0" option
* show_cc-license_option=(y/n);
**show/hide "CC license" option
* show_no-license_option=(y/n);
**show/hide "No license" option
*default_option=(cc0/cc-license/no-license);
**choose which option is present to the user first
*locale=(locale, ie 'en_US')
**choose language

You can specify as many of these options as you like by simply putting an '&' between them.

== Examples: ==

*complete.js?locale=en_US&show_jurisdiction_chooser=n&default_option=cc-license&show_no-license_option=n
**Selector defaults to CC license chooser, is in US English, does not include a jurisdiction chooser, and does not include a "No license" option
*?locale=en_US&default_option=no-license&show_cc0_option=n
**Selector in US English which defaults to the "No license" option and doesn't include the cc0 option

== Defaults ==

Currently, by default everything is displayed, and the CC license chooser is the default option. Thus, this query will return the exact same widget as the empty "complete.js"

complete.js?show_jurisdiction_chooser=y&show_cc0_option=y&show_cc-license_option=y&show_no-license_option=y&default_option=cc-license

(note that in this case, Apache content negotiation will be used to determine which language to use)

== Goals ==

The following list of general goals to remind us what we want out of LicenseChooser.js. You can expect most of it for 1.0.

See [[JsWidget/Plan]] to see what features are planned for what versions.

* Generate HTML suitable for use in a form which presents the basic license selector
* Provide compatibility with all [http://developer.yahoo.com/yui/articles/gbs/ A-grade browsers]
* Provide up to date license information by
** Utilizing licenses.xml to generate the appropriate Javascript on the server side. This may be done using a dynamic language such as PHP or through pre-processing to a static file when licenses are updated.
* Support new, expanded metadata including attributionName, attributionUrl and morePermissions.
* Provide a robust, scalable serving solution (if any server-side processing is needed) in order to support CC-hosted Javascript resources for the general public

== Version expectations ==
=== Zero point something (like 0.4) ===
There are no guarantees, but we'd like to keep to the same promises as a 1.0 release
=== Something point zero (like 1.0) ===
We guarantee (outside of really urgent situation where we exercise a judgement call) that these will '''not''' change:
* The programmatic interface for the widget will not change
* The user interface for selecting licenses will not change

The following are the only things that '''may'' change:
* As new translations become available, the text may become increasingly internationalized
* As jurisdictions offer new licenses, the engine will update the choices available to a user

== Resources ==

* [http://code.creativecommons.org/viewsvn/jswidget/ LicenseChooser.js development in Subversion]
* [http://cctools.svn.sourceforge.net/viewvc/cctools/cclib/trunk/js/ cclib/trunk/js] in Subversion contains the Javascript used for the [http://labs.creativecommons.org/dhtmllicense/ DHTML License Selector]
* [[JsWidget/Security|Security considerations]]

[[Category:Developer]]
[[Category:Opensource]]
[[Category:Integration]]

Jswidget new

2009-08-07T20:53:21Z

Gameguy43: /* Namespacing */

{{Software Project
|Description=LicenseChooser.js provides a lightweight method for integrating license selection into web applications.
|Bug tracker=http://code.creativecommons.org/issues/
|Code repository=http://code.creativecommons.org/viewsvn/jswidget/
|Mailing list=http://lists.ibiblio.org/mailman/listinfo/cc-devel
}}
{{Project}}
__NOTOC__

Creative Commons currently provides two methods for integrating license selection into applications: the [[Partner Interface]] and the [[Creative Commons Web Services|web service API]]. The CC Javascript Widget (LicenseChooser.js) provides an additional, lightweight method for integrating license selection into web applications. The widget is used by TypePad, as well as [[WpLicense]].

'''LicenseChooser.js is nearly ready! Please try the [http://code.creativecommons.org/viewsvn/jswidget/tags/0.97/ 0.97 preview].'''

== Users ==
* [[WpLicense]] uses LicenseChooser.js to provide a license selector for WordPress
* TypePad provides [http://everything.typepad.com/cc/ a widget] for adding a license to hosted blogs.

== Sample Usage ==

<div style="text-align:center">
[[Image:Jswidget-0.2-screenshot.png]]
</div>

You can read the source of these examples; they demonstrate some (but not all) of the combinations for advanced usage described below.

* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-license.html CC License selector only]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-openness.html Selector without the choice of "No license"]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/ Basic usage (all options visible)]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/inside_form.html Basic usage from inside another form tag]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/default-is-no-license.html Selector where "no license" is the starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/without-jurisdiction.html Selector without a jurisdiction choice]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed.html Selector with a specific license used as a starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-without-jurisdiction.html Selector with a specific license as a starting point with no jurisdiction selector, always using the "seeded" jurisdiction]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-old-version.html Selector where an old license version was given as the seed]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/language-detect.html Selector that relies on Apache Content Negotiation for translations]

== Availability ==

You can play with a 0.97 pre-release right now!
* 2009-04-29: [http://mirrors.creativecommons.org/software/licensechooser-js/licensechooser-js-0.97.tar.gz Released 0.97]. '''This is the latest preview that is very close to 1.0.''' This release allows you to embed LicenseChooser.js inside a form tag. Thanks to John Horigan for reporting this issue and providing a patch (which we merged with some changes).
* 2009-03-16: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.96]. The help text for "Share alike" was wrong, mistakenly giving you the non-commercial help text. Fixed! This is an important update.
* 2008-09-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.95]. An anonymous bug reporter indicated that we overwrite the first JavaScript file found, even if it is not LicenseChooser.js. Fixed! This is an important update.
* 2008-08-27: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.94]. Stylistic issue found: image not always properly aligned with text in pop-up describing e.g. Share-Alike. We no longer user document.write() (yuck) to insert the HTML of the widget into the document; we now modify the innerHTML of a div we create ourselves. We may further harden the JS against namespace collisions with [http://kentbrewster.com/badges Kent Brewster's badges] strategy.
* 2007-10-10: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.92]. Stylistic updates: Alex has gone to town on the chooser and styled it. It only shows jurisdictions that have launched. There are no known pending technical or visual issues.
* 2007-08-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.91]. The license selector allows one to remove the jurisdiction selector. There is a "No license" choice. Translation is done using JavaScript and not hidden DOM elements. Application developers have more control over the defaults, including "no license" being choosable as the default.
* 2007-08-09: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.9]. We've changed the plan to add some features before 1.0 based on talking with potential users. All DOM elements are '''really''' prefixed with cc_js_ this time, and all strings '''really''' are available for translation this time. Documentation is updated for the 0.9 release, including a way to have the application developer specify only a single jurisdiction for the license. JSON output is validated before being sent to a web browser. Removed dependency on prototype.js. Server code changes to improve performance. Massive reduction of unused JS and CSS (this process began with 0.4).
* 2007-08-06: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.4]. All DOM elements are prefixed with cc_js_. The widget works in Opera and Safari and works with degraded functionality in Konqueror.
* 2007-08-01: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.3]. This release introduces Internet Explorer compatibility, Apache Content Negotiation to handle user language selection even if the server doesn't provide it for us, a hopefully-stable API for selecting a license, and license seeding.
* 2007-07-25: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.2]. The UI now doesn't ask or contain spurious questions, plus translation is halfway there.
* 2007-07-19: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.1]. Don't try to use this in production, but DO let us know how it fits into your systems and what you would want us to change.

== Extra features ==
=== "Seeding" ===
* If the user has already selected a license through some other means, and you want to "seed" the JavaScript widget with the choices the user has already made, just create a hidden form field whose ID is cc_js_seed_uri with the URI of the license you want to start with.
** NOTE that whatever license version you provide, we always upgrade it to the most recent version the jurisdiction offers. We do display a '''Message''' underneath the license icon saying we did this.

=== Forcing a particular jurisdiction ===
To force the user to choose a license in a particular jurisdiction:
* First, use the "seeding" feature to seed the Attribution ("by") license in your jurisdiction
* Then, disable jurisdiction selection

=== Disabling jurisdiction selection ===
If you want to not offer the user a choice of jurisdictions:
* just append ?show_jurisdiction_chooser=n to the complete.js call.

=== Setting the license chooser to no license by default ===
If you want to set the license chooser to no license by default:
* just append ?default_option=no-license

=== Removing the "No license" option ===
If you want to not offer the user the option of selecting "no license:
* just append ?show_no-license_option=n to the query string
=== Language selection ===
* You can append ?locale=XX to your call to complete.js to choose a language. The example distributed as index.html in the distribution package sets the language to US English this way.
* If omitted, Apache Content Negotiation will select the most appropriate language based on the user's preferences, defaulting to US English.
=== Extracting results ===
All of these result extraction systems are demonstrated in the examples.
* There are two hidden form fields called '''cc_js_result_uri''' and '''cc_js_result_name''' that respectively store the URI and name of the license selected by the user. Just do <code>document.getElementById("cc_js_result_uri").value</code> (or "cc_js_result_name" instead) and you'll have the license information.
* There is an extra hidden form field containing the link to the image used. Simply get the element whose ID is '''cc_js_result_img''' and you will have a URL that is a permanent image. [http://en.wikipedia.org/wiki/Inline_linking Hotlink]ing these images is allowed and encouraged.

=== Styling ===
* Jswidget uses javascript magic to pull in a stylesheet, whether you want it to or not. Luckily, it puts the stylesheet at the very top of the header, so that you can easily override styles by including your own style sheet. We encourage you to write your own style sheet that builds on the one we've provided and personalized the look and feel of the widget to match your web app.

=== Namespacing ===
* All LicenseChooser.js HTML elements that have IDs or classes start with "cc_js_" to avoid namespace collisions.
* Similarly, all LicenseChooser.js JavaScript functions start with cc_js_. This is '''not''' true for the bundled Prototype.js library.

=== Full List of Query String Variables ===

* show_jurisdiction_chooser = (y/n)
**show/hide jurisdiction chooser
* show_cc0_option = (y/n);
**show/hide "CC0" option
* show_cc-license_option = (y/n);
**show/hide "CC license" option
* show_no-license_option = (y/n);
**show/hide "No license" option
*default_option = (cc0/cc-license/no-license);
**choose which option is present to the user first

== Goals ==

The following list of general goals to remind us what we want out of LicenseChooser.js. You can expect most of it for 1.0.

See [[JsWidget/Plan]] to see what features are planned for what versions.

* Generate HTML suitable for use in a form which presents the basic license selector
* Provide compatibility with all [http://developer.yahoo.com/yui/articles/gbs/ A-grade browsers]
* Provide up to date license information by
** Utilizing licenses.xml to generate the appropriate Javascript on the server side. This may be done using a dynamic language such as PHP or through pre-processing to a static file when licenses are updated.
* Support new, expanded metadata including attributionName, attributionUrl and morePermissions.
* Provide a robust, scalable serving solution (if any server-side processing is needed) in order to support CC-hosted Javascript resources for the general public

== Version expectations ==
=== Zero point something (like 0.4) ===
There are no guarantees, but we'd like to keep to the same promises as a 1.0 release
=== Something point zero (like 1.0) ===
We guarantee (outside of really urgent situation where we exercise a judgement call) that these will '''not''' change:
* The programmatic interface for the widget will not change
* The user interface for selecting licenses will not change

The following are the only things that '''may'' change:
* As new translations become available, the text may become increasingly internationalized
* As jurisdictions offer new licenses, the engine will update the choices available to a user

== Resources ==

* [http://code.creativecommons.org/viewsvn/jswidget/ LicenseChooser.js development in Subversion]
* [http://cctools.svn.sourceforge.net/viewvc/cctools/cclib/trunk/js/ cclib/trunk/js] in Subversion contains the Javascript used for the [http://labs.creativecommons.org/dhtmllicense/ DHTML License Selector]
* [[JsWidget/Security|Security considerations]]

[[Category:Developer]]
[[Category:Opensource]]
[[Category:Integration]]

Jswidget new

2009-08-07T20:35:42Z

Gameguy43: /* Extra features */

{{Software Project
|Description=LicenseChooser.js provides a lightweight method for integrating license selection into web applications.
|Bug tracker=http://code.creativecommons.org/issues/
|Code repository=http://code.creativecommons.org/viewsvn/jswidget/
|Mailing list=http://lists.ibiblio.org/mailman/listinfo/cc-devel
}}
{{Project}}
__NOTOC__

Creative Commons currently provides two methods for integrating license selection into applications: the [[Partner Interface]] and the [[Creative Commons Web Services|web service API]]. The CC Javascript Widget (LicenseChooser.js) provides an additional, lightweight method for integrating license selection into web applications. The widget is used by TypePad, as well as [[WpLicense]].

'''LicenseChooser.js is nearly ready! Please try the [http://code.creativecommons.org/viewsvn/jswidget/tags/0.97/ 0.97 preview].'''

== Users ==
* [[WpLicense]] uses LicenseChooser.js to provide a license selector for WordPress
* TypePad provides [http://everything.typepad.com/cc/ a widget] for adding a license to hosted blogs.

== Sample Usage ==

<div style="text-align:center">
[[Image:Jswidget-0.2-screenshot.png]]
</div>

You can read the source of these examples; they demonstrate some (but not all) of the combinations for advanced usage described below.

* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-license.html CC License selector only]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-openness.html Selector without the choice of "No license"]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/ Basic usage (all options visible)]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/inside_form.html Basic usage from inside another form tag]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/default-is-no-license.html Selector where "no license" is the starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/without-jurisdiction.html Selector without a jurisdiction choice]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed.html Selector with a specific license used as a starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-without-jurisdiction.html Selector with a specific license as a starting point with no jurisdiction selector, always using the "seeded" jurisdiction]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-old-version.html Selector where an old license version was given as the seed]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/language-detect.html Selector that relies on Apache Content Negotiation for translations]

== Availability ==

You can play with a 0.97 pre-release right now!
* 2009-04-29: [http://mirrors.creativecommons.org/software/licensechooser-js/licensechooser-js-0.97.tar.gz Released 0.97]. '''This is the latest preview that is very close to 1.0.''' This release allows you to embed LicenseChooser.js inside a form tag. Thanks to John Horigan for reporting this issue and providing a patch (which we merged with some changes).
* 2009-03-16: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.96]. The help text for "Share alike" was wrong, mistakenly giving you the non-commercial help text. Fixed! This is an important update.
* 2008-09-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.95]. An anonymous bug reporter indicated that we overwrite the first JavaScript file found, even if it is not LicenseChooser.js. Fixed! This is an important update.
* 2008-08-27: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.94]. Stylistic issue found: image not always properly aligned with text in pop-up describing e.g. Share-Alike. We no longer user document.write() (yuck) to insert the HTML of the widget into the document; we now modify the innerHTML of a div we create ourselves. We may further harden the JS against namespace collisions with [http://kentbrewster.com/badges Kent Brewster's badges] strategy.
* 2007-10-10: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.92]. Stylistic updates: Alex has gone to town on the chooser and styled it. It only shows jurisdictions that have launched. There are no known pending technical or visual issues.
* 2007-08-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.91]. The license selector allows one to remove the jurisdiction selector. There is a "No license" choice. Translation is done using JavaScript and not hidden DOM elements. Application developers have more control over the defaults, including "no license" being choosable as the default.
* 2007-08-09: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.9]. We've changed the plan to add some features before 1.0 based on talking with potential users. All DOM elements are '''really''' prefixed with cc_js_ this time, and all strings '''really''' are available for translation this time. Documentation is updated for the 0.9 release, including a way to have the application developer specify only a single jurisdiction for the license. JSON output is validated before being sent to a web browser. Removed dependency on prototype.js. Server code changes to improve performance. Massive reduction of unused JS and CSS (this process began with 0.4).
* 2007-08-06: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.4]. All DOM elements are prefixed with cc_js_. The widget works in Opera and Safari and works with degraded functionality in Konqueror.
* 2007-08-01: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.3]. This release introduces Internet Explorer compatibility, Apache Content Negotiation to handle user language selection even if the server doesn't provide it for us, a hopefully-stable API for selecting a license, and license seeding.
* 2007-07-25: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.2]. The UI now doesn't ask or contain spurious questions, plus translation is halfway there.
* 2007-07-19: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.1]. Don't try to use this in production, but DO let us know how it fits into your systems and what you would want us to change.

== Extra features ==
=== "Seeding" ===
* If the user has already selected a license through some other means, and you want to "seed" the JavaScript widget with the choices the user has already made, just create a hidden form field whose ID is cc_js_seed_uri with the URI of the license you want to start with.
** NOTE that whatever license version you provide, we always upgrade it to the most recent version the jurisdiction offers. We do display a '''Message''' underneath the license icon saying we did this.

=== Forcing a particular jurisdiction ===
To force the user to choose a license in a particular jurisdiction:
* First, use the "seeding" feature to seed the Attribution ("by") license in your jurisdiction
* Then, disable jurisdiction selection

=== Disabling jurisdiction selection ===
If you want to not offer the user a choice of jurisdictions:
* just append ?show_jurisdiction_chooser=n to the complete.js call.

=== Setting the license chooser to no license by default ===
If you want to set the license chooser to no license by default:
* just append ?default_option=no-license

=== Removing the "No license" option ===
If you want to not offer the user the option of selecting "no license:
* just append ?show_no-license_option=n to the query string
=== Language selection ===
* You can append ?locale=XX to your call to complete.js to choose a language. The example distributed as index.html in the distribution package sets the language to US English this way.
* If omitted, Apache Content Negotiation will select the most appropriate language based on the user's preferences, defaulting to US English.
=== Extracting results ===
All of these result extraction systems are demonstrated in the examples.
* There are two hidden form fields called '''cc_js_result_uri''' and '''cc_js_result_name''' that respectively store the URI and name of the license selected by the user. Just do <code>document.getElementById("cc_js_result_uri").value</code> (or "cc_js_result_name" instead) and you'll have the license information.
* There is an extra hidden form field containing the link to the image used. Simply get the element whose ID is '''cc_js_result_img''' and you will have a URL that is a permanent image. [http://en.wikipedia.org/wiki/Inline_linking Hotlink]ing these images is allowed and encouraged.

=== Styling ===
* Jswidget uses javascript magic to pull in a stylesheet, whether you want it to or not. Luckily, it puts the stylesheet at the very top of the header, so that you can easily override styles by including your own style sheet. We encourage you to write your own style sheet that builds on the one we've provided and personalized the look and feel of the widget to match your web app.

=== Namespacing ===
* All LicenseChooser.js HTML elements that have IDs or classes start with "cc_js_" to avoid namespace collisions.
* Similarly, all LicenseChooser.js JavaScript functions start with cc_js_. This is '''not''' true for the bundled Prototype.js library.

== Goals ==

The following list of general goals to remind us what we want out of LicenseChooser.js. You can expect most of it for 1.0.

See [[JsWidget/Plan]] to see what features are planned for what versions.

* Generate HTML suitable for use in a form which presents the basic license selector
* Provide compatibility with all [http://developer.yahoo.com/yui/articles/gbs/ A-grade browsers]
* Provide up to date license information by
** Utilizing licenses.xml to generate the appropriate Javascript on the server side. This may be done using a dynamic language such as PHP or through pre-processing to a static file when licenses are updated.
* Support new, expanded metadata including attributionName, attributionUrl and morePermissions.
* Provide a robust, scalable serving solution (if any server-side processing is needed) in order to support CC-hosted Javascript resources for the general public

== Version expectations ==
=== Zero point something (like 0.4) ===
There are no guarantees, but we'd like to keep to the same promises as a 1.0 release
=== Something point zero (like 1.0) ===
We guarantee (outside of really urgent situation where we exercise a judgement call) that these will '''not''' change:
* The programmatic interface for the widget will not change
* The user interface for selecting licenses will not change

The following are the only things that '''may'' change:
* As new translations become available, the text may become increasingly internationalized
* As jurisdictions offer new licenses, the engine will update the choices available to a user

== Resources ==

* [http://code.creativecommons.org/viewsvn/jswidget/ LicenseChooser.js development in Subversion]
* [http://cctools.svn.sourceforge.net/viewvc/cctools/cclib/trunk/js/ cclib/trunk/js] in Subversion contains the Javascript used for the [http://labs.creativecommons.org/dhtmllicense/ DHTML License Selector]
* [[JsWidget/Security|Security considerations]]

[[Category:Developer]]
[[Category:Opensource]]
[[Category:Integration]]

Jswidget new

2009-08-07T20:19:43Z

Gameguy43: /* Disabling jurisdiction selection */

{{Software Project
|Description=LicenseChooser.js provides a lightweight method for integrating license selection into web applications.
|Bug tracker=http://code.creativecommons.org/issues/
|Code repository=http://code.creativecommons.org/viewsvn/jswidget/
|Mailing list=http://lists.ibiblio.org/mailman/listinfo/cc-devel
}}
{{Project}}
__NOTOC__

Creative Commons currently provides two methods for integrating license selection into applications: the [[Partner Interface]] and the [[Creative Commons Web Services|web service API]]. The CC Javascript Widget (LicenseChooser.js) provides an additional, lightweight method for integrating license selection into web applications. The widget is used by TypePad, as well as [[WpLicense]].

'''LicenseChooser.js is nearly ready! Please try the [http://code.creativecommons.org/viewsvn/jswidget/tags/0.97/ 0.97 preview].'''

== Users ==
* [[WpLicense]] uses LicenseChooser.js to provide a license selector for WordPress
* TypePad provides [http://everything.typepad.com/cc/ a widget] for adding a license to hosted blogs.

== Sample Usage ==

<div style="text-align:center">
[[Image:Jswidget-0.2-screenshot.png]]
</div>

You can read the source of these examples; they demonstrate some (but not all) of the combinations for advanced usage described below.

* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-license.html CC License selector only]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-openness.html Selector without the choice of "No license"]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/ Basic usage (all options visible)]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/inside_form.html Basic usage from inside another form tag]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/default-is-no-license.html Selector where "no license" is the starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/without-jurisdiction.html Selector without a jurisdiction choice]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed.html Selector with a specific license used as a starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-without-jurisdiction.html Selector with a specific license as a starting point with no jurisdiction selector, always using the "seeded" jurisdiction]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-old-version.html Selector where an old license version was given as the seed]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/language-detect.html Selector that relies on Apache Content Negotiation for translations]

== Availability ==

You can play with a 0.97 pre-release right now!
* 2009-04-29: [http://mirrors.creativecommons.org/software/licensechooser-js/licensechooser-js-0.97.tar.gz Released 0.97]. '''This is the latest preview that is very close to 1.0.''' This release allows you to embed LicenseChooser.js inside a form tag. Thanks to John Horigan for reporting this issue and providing a patch (which we merged with some changes).
* 2009-03-16: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.96]. The help text for "Share alike" was wrong, mistakenly giving you the non-commercial help text. Fixed! This is an important update.
* 2008-09-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.95]. An anonymous bug reporter indicated that we overwrite the first JavaScript file found, even if it is not LicenseChooser.js. Fixed! This is an important update.
* 2008-08-27: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.94]. Stylistic issue found: image not always properly aligned with text in pop-up describing e.g. Share-Alike. We no longer user document.write() (yuck) to insert the HTML of the widget into the document; we now modify the innerHTML of a div we create ourselves. We may further harden the JS against namespace collisions with [http://kentbrewster.com/badges Kent Brewster's badges] strategy.
* 2007-10-10: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.92]. Stylistic updates: Alex has gone to town on the chooser and styled it. It only shows jurisdictions that have launched. There are no known pending technical or visual issues.
* 2007-08-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.91]. The license selector allows one to remove the jurisdiction selector. There is a "No license" choice. Translation is done using JavaScript and not hidden DOM elements. Application developers have more control over the defaults, including "no license" being choosable as the default.
* 2007-08-09: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.9]. We've changed the plan to add some features before 1.0 based on talking with potential users. All DOM elements are '''really''' prefixed with cc_js_ this time, and all strings '''really''' are available for translation this time. Documentation is updated for the 0.9 release, including a way to have the application developer specify only a single jurisdiction for the license. JSON output is validated before being sent to a web browser. Removed dependency on prototype.js. Server code changes to improve performance. Massive reduction of unused JS and CSS (this process began with 0.4).
* 2007-08-06: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.4]. All DOM elements are prefixed with cc_js_. The widget works in Opera and Safari and works with degraded functionality in Konqueror.
* 2007-08-01: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.3]. This release introduces Internet Explorer compatibility, Apache Content Negotiation to handle user language selection even if the server doesn't provide it for us, a hopefully-stable API for selecting a license, and license seeding.
* 2007-07-25: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.2]. The UI now doesn't ask or contain spurious questions, plus translation is halfway there.
* 2007-07-19: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.1]. Don't try to use this in production, but DO let us know how it fits into your systems and what you would want us to change.

== Extra features ==
=== "Seeding" ===
* If the user has already selected a license through some other means, and you want to "seed" the JavaScript widget with the choices the user has already made, just create a hidden form field whose ID is cc_js_seed_uri with the URI of the license you want to start with.
** NOTE that whatever license version you provide, we always upgrade it to the most recent version the jurisdiction offers. We do display a '''Message''' underneath the license icon saying we did this.
=== Forcing a particular jurisdiction ===
To force the user to choose a license in a particular jurisdiction:
* First, use the "seeding" feature to seed the Attribution ("by") license in your jurisdiction
* Then, disable jurisdiction selection
=== Disabling jurisdiction selection ===
If you want to not offer the user a choice of jurisdictions:
* just append ?show_jurisdiction_chooser=n to the complete.js call.

=== Setting the license chooser to no license by default ===
If you want to set the license chooser to no license by default:
* just append ?want_a_license= no_license_by_default

=== Removing the "No license" option ===
If you want to not offer the user the option of selecting "no license:
* just append ?want_a_license=definitely to the query string
=== Language selection ===
* You can append ?locale=XX to your call to complete.js to choose a language. The example distributed as index.html in the distribution package sets the language to US English this way.
* If omitted, Apache Content Negotiation will select the most appropriate language based on the user's preferences, defaulting to US English.
=== Extracting results ===
All of these result extraction systems are demonstrated in the examples.
* There are two hidden form fields called '''cc_js_result_uri''' and '''cc_js_result_name''' that respectively store the URI and name of the license selected by the user. Just do <code>document.getElementById("cc_js_result_uri").value</code> (or "cc_js_result_name" instead) and you'll have the license information.
* There is an extra hidden form field containing the link to the image used. Simply get the element whose ID is '''cc_js_result_img''' and you will have a URL that is a permanent image. [http://en.wikipedia.org/wiki/Inline_linking Hotlink]ing these images is allowed and encouraged.

=== Styling ===
* You can use the example style provided in the example application to get you going. We '''urge''' you to put this file on your own web server and not rely on the copy hosted on labs.creativecommons.org.
* What we really want you to do is to change the style of our divs and spans and so-forth to make them fit in to your application. To do that, you should copy the example style file into one of your own CSS files and modify it until you really like it.
=== Namespacing ===
* All LicenseChooser.js HTML elements that have IDs or classes start with "cc_js_" to avoid namespace collisions.
* Similarly, all LicenseChooser.js JavaScript functions start with cc_js_. This is '''not''' true for the bundled Prototype.js library.

== Goals ==

The following list of general goals to remind us what we want out of LicenseChooser.js. You can expect most of it for 1.0.

See [[JsWidget/Plan]] to see what features are planned for what versions.

* Generate HTML suitable for use in a form which presents the basic license selector
* Provide compatibility with all [http://developer.yahoo.com/yui/articles/gbs/ A-grade browsers]
* Provide up to date license information by
** Utilizing licenses.xml to generate the appropriate Javascript on the server side. This may be done using a dynamic language such as PHP or through pre-processing to a static file when licenses are updated.
* Support new, expanded metadata including attributionName, attributionUrl and morePermissions.
* Provide a robust, scalable serving solution (if any server-side processing is needed) in order to support CC-hosted Javascript resources for the general public

== Version expectations ==
=== Zero point something (like 0.4) ===
There are no guarantees, but we'd like to keep to the same promises as a 1.0 release
=== Something point zero (like 1.0) ===
We guarantee (outside of really urgent situation where we exercise a judgement call) that these will '''not''' change:
* The programmatic interface for the widget will not change
* The user interface for selecting licenses will not change

The following are the only things that '''may'' change:
* As new translations become available, the text may become increasingly internationalized
* As jurisdictions offer new licenses, the engine will update the choices available to a user

== Resources ==

* [http://code.creativecommons.org/viewsvn/jswidget/ LicenseChooser.js development in Subversion]
* [http://cctools.svn.sourceforge.net/viewvc/cctools/cclib/trunk/js/ cclib/trunk/js] in Subversion contains the Javascript used for the [http://labs.creativecommons.org/dhtmllicense/ DHTML License Selector]
* [[JsWidget/Security|Security considerations]]

[[Category:Developer]]
[[Category:Opensource]]
[[Category:Integration]]

Jswidget new

2009-08-07T18:44:33Z

Gameguy43: /* Sample Usage */

{{Software Project
|Description=LicenseChooser.js provides a lightweight method for integrating license selection into web applications.
|Bug tracker=http://code.creativecommons.org/issues/
|Code repository=http://code.creativecommons.org/viewsvn/jswidget/
|Mailing list=http://lists.ibiblio.org/mailman/listinfo/cc-devel
}}
{{Project}}
__NOTOC__

Creative Commons currently provides two methods for integrating license selection into applications: the [[Partner Interface]] and the [[Creative Commons Web Services|web service API]]. The CC Javascript Widget (LicenseChooser.js) provides an additional, lightweight method for integrating license selection into web applications. The widget is used by TypePad, as well as [[WpLicense]].

'''LicenseChooser.js is nearly ready! Please try the [http://code.creativecommons.org/viewsvn/jswidget/tags/0.97/ 0.97 preview].'''

== Users ==
* [[WpLicense]] uses LicenseChooser.js to provide a license selector for WordPress
* TypePad provides [http://everything.typepad.com/cc/ a widget] for adding a license to hosted blogs.

== Sample Usage ==

<div style="text-align:center">
[[Image:Jswidget-0.2-screenshot.png]]
</div>

You can read the source of these examples; they demonstrate some (but not all) of the combinations for advanced usage described below.

* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-license.html CC License selector only]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-openness.html Selector without the choice of "No license"]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/ Basic usage (all options visible)]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/inside_form.html Basic usage from inside another form tag]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/default-is-no-license.html Selector where "no license" is the starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/without-jurisdiction.html Selector without a jurisdiction choice]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed.html Selector with a specific license used as a starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-without-jurisdiction.html Selector with a specific license as a starting point with no jurisdiction selector, always using the "seeded" jurisdiction]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-old-version.html Selector where an old license version was given as the seed]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/language-detect.html Selector that relies on Apache Content Negotiation for translations]

== Availability ==

You can play with a 0.97 pre-release right now!
* 2009-04-29: [http://mirrors.creativecommons.org/software/licensechooser-js/licensechooser-js-0.97.tar.gz Released 0.97]. '''This is the latest preview that is very close to 1.0.''' This release allows you to embed LicenseChooser.js inside a form tag. Thanks to John Horigan for reporting this issue and providing a patch (which we merged with some changes).
* 2009-03-16: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.96]. The help text for "Share alike" was wrong, mistakenly giving you the non-commercial help text. Fixed! This is an important update.
* 2008-09-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.95]. An anonymous bug reporter indicated that we overwrite the first JavaScript file found, even if it is not LicenseChooser.js. Fixed! This is an important update.
* 2008-08-27: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.94]. Stylistic issue found: image not always properly aligned with text in pop-up describing e.g. Share-Alike. We no longer user document.write() (yuck) to insert the HTML of the widget into the document; we now modify the innerHTML of a div we create ourselves. We may further harden the JS against namespace collisions with [http://kentbrewster.com/badges Kent Brewster's badges] strategy.
* 2007-10-10: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.92]. Stylistic updates: Alex has gone to town on the chooser and styled it. It only shows jurisdictions that have launched. There are no known pending technical or visual issues.
* 2007-08-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.91]. The license selector allows one to remove the jurisdiction selector. There is a "No license" choice. Translation is done using JavaScript and not hidden DOM elements. Application developers have more control over the defaults, including "no license" being choosable as the default.
* 2007-08-09: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.9]. We've changed the plan to add some features before 1.0 based on talking with potential users. All DOM elements are '''really''' prefixed with cc_js_ this time, and all strings '''really''' are available for translation this time. Documentation is updated for the 0.9 release, including a way to have the application developer specify only a single jurisdiction for the license. JSON output is validated before being sent to a web browser. Removed dependency on prototype.js. Server code changes to improve performance. Massive reduction of unused JS and CSS (this process began with 0.4).
* 2007-08-06: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.4]. All DOM elements are prefixed with cc_js_. The widget works in Opera and Safari and works with degraded functionality in Konqueror.
* 2007-08-01: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.3]. This release introduces Internet Explorer compatibility, Apache Content Negotiation to handle user language selection even if the server doesn't provide it for us, a hopefully-stable API for selecting a license, and license seeding.
* 2007-07-25: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.2]. The UI now doesn't ask or contain spurious questions, plus translation is halfway there.
* 2007-07-19: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.1]. Don't try to use this in production, but DO let us know how it fits into your systems and what you would want us to change.

== Extra features ==
=== "Seeding" ===
* If the user has already selected a license through some other means, and you want to "seed" the JavaScript widget with the choices the user has already made, just create a hidden form field whose ID is cc_js_seed_uri with the URI of the license you want to start with.
** NOTE that whatever license version you provide, we always upgrade it to the most recent version the jurisdiction offers. We do display a '''Message''' underneath the license icon saying we did this.
=== Forcing a particular jurisdiction ===
To force the user to choose a license in a particular jurisdiction:
* First, use the "seeding" feature to seed the Attribution ("by") license in your jurisdiction
* Then, disable jurisdiction selection
=== Disabling jurisdiction selection ===
If you want to not offer the user a choice of jurisdictions:
* just append ?jurisdictions=disabled to the complete.js call.

=== Setting the license chooser to no license by default ===
If you want to set the license chooser to no license by default:
* just append ?want_a_license= no_license_by_default

=== Removing the "No license" option ===
If you want to not offer the user the option of selecting "no license:
* just append ?want_a_license=definitely to the query string
=== Language selection ===
* You can append ?locale=XX to your call to complete.js to choose a language. The example distributed as index.html in the distribution package sets the language to US English this way.
* If omitted, Apache Content Negotiation will select the most appropriate language based on the user's preferences, defaulting to US English.
=== Extracting results ===
All of these result extraction systems are demonstrated in the examples.
* There are two hidden form fields called '''cc_js_result_uri''' and '''cc_js_result_name''' that respectively store the URI and name of the license selected by the user. Just do <code>document.getElementById("cc_js_result_uri").value</code> (or "cc_js_result_name" instead) and you'll have the license information.
* There is an extra hidden form field containing the link to the image used. Simply get the element whose ID is '''cc_js_result_img''' and you will have a URL that is a permanent image. [http://en.wikipedia.org/wiki/Inline_linking Hotlink]ing these images is allowed and encouraged.

=== Styling ===
* You can use the example style provided in the example application to get you going. We '''urge''' you to put this file on your own web server and not rely on the copy hosted on labs.creativecommons.org.
* What we really want you to do is to change the style of our divs and spans and so-forth to make them fit in to your application. To do that, you should copy the example style file into one of your own CSS files and modify it until you really like it.
=== Namespacing ===
* All LicenseChooser.js HTML elements that have IDs or classes start with "cc_js_" to avoid namespace collisions.
* Similarly, all LicenseChooser.js JavaScript functions start with cc_js_. This is '''not''' true for the bundled Prototype.js library.

== Goals ==

The following list of general goals to remind us what we want out of LicenseChooser.js. You can expect most of it for 1.0.

See [[JsWidget/Plan]] to see what features are planned for what versions.

* Generate HTML suitable for use in a form which presents the basic license selector
* Provide compatibility with all [http://developer.yahoo.com/yui/articles/gbs/ A-grade browsers]
* Provide up to date license information by
** Utilizing licenses.xml to generate the appropriate Javascript on the server side. This may be done using a dynamic language such as PHP or through pre-processing to a static file when licenses are updated.
* Support new, expanded metadata including attributionName, attributionUrl and morePermissions.
* Provide a robust, scalable serving solution (if any server-side processing is needed) in order to support CC-hosted Javascript resources for the general public

== Version expectations ==
=== Zero point something (like 0.4) ===
There are no guarantees, but we'd like to keep to the same promises as a 1.0 release
=== Something point zero (like 1.0) ===
We guarantee (outside of really urgent situation where we exercise a judgement call) that these will '''not''' change:
* The programmatic interface for the widget will not change
* The user interface for selecting licenses will not change

The following are the only things that '''may'' change:
* As new translations become available, the text may become increasingly internationalized
* As jurisdictions offer new licenses, the engine will update the choices available to a user

== Resources ==

* [http://code.creativecommons.org/viewsvn/jswidget/ LicenseChooser.js development in Subversion]
* [http://cctools.svn.sourceforge.net/viewvc/cctools/cclib/trunk/js/ cclib/trunk/js] in Subversion contains the Javascript used for the [http://labs.creativecommons.org/dhtmllicense/ DHTML License Selector]
* [[JsWidget/Security|Security considerations]]

[[Category:Developer]]
[[Category:Opensource]]
[[Category:Integration]]

Jswidget new

2009-08-07T18:41:08Z

Gameguy43:

{{Software Project
|Description=LicenseChooser.js provides a lightweight method for integrating license selection into web applications.
|Bug tracker=http://code.creativecommons.org/issues/
|Code repository=http://code.creativecommons.org/viewsvn/jswidget/
|Mailing list=http://lists.ibiblio.org/mailman/listinfo/cc-devel
}}
{{Project}}
__NOTOC__

Creative Commons currently provides two methods for integrating license selection into applications: the [[Partner Interface]] and the [[Creative Commons Web Services|web service API]]. The CC Javascript Widget (LicenseChooser.js) provides an additional, lightweight method for integrating license selection into web applications. The widget is used by TypePad, as well as [[WpLicense]].

'''LicenseChooser.js is nearly ready! Please try the [http://code.creativecommons.org/viewsvn/jswidget/tags/0.97/ 0.97 preview].'''

== Users ==
* [[WpLicense]] uses LicenseChooser.js to provide a license selector for WordPress
* TypePad provides [http://everything.typepad.com/cc/ a widget] for adding a license to hosted blogs.

== Sample Usage ==

<div style="text-align:center">
[[Image:Jswidget-0.2-screenshot.png]]
</div>

You can read the source of these examples; they demonstrate some (but not all) of the combinations for advanced usage described below.

* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-license.html CC License selector only]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-openness.html Selector without the choice of "No license"]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/ Basic usage]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/inside_form.html Basic usage from inside another form tag]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/default-is-no-license.html Selector where "no license" is the starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/without-jurisdiction.html Selector without a jurisdiction choice]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed.html Selector with a specific license used as a starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-without-jurisdiction.html Selector with a specific license as a starting point with no jurisdiction selector, always using the "seeded" jurisdiction]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-old-version.html Selector where an old license version was given as the seed]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/language-detect.html Selector that relies on Apache Content Negotiation for translations]

== Availability ==

You can play with a 0.97 pre-release right now!
* 2009-04-29: [http://mirrors.creativecommons.org/software/licensechooser-js/licensechooser-js-0.97.tar.gz Released 0.97]. '''This is the latest preview that is very close to 1.0.''' This release allows you to embed LicenseChooser.js inside a form tag. Thanks to John Horigan for reporting this issue and providing a patch (which we merged with some changes).
* 2009-03-16: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.96]. The help text for "Share alike" was wrong, mistakenly giving you the non-commercial help text. Fixed! This is an important update.
* 2008-09-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.95]. An anonymous bug reporter indicated that we overwrite the first JavaScript file found, even if it is not LicenseChooser.js. Fixed! This is an important update.
* 2008-08-27: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.94]. Stylistic issue found: image not always properly aligned with text in pop-up describing e.g. Share-Alike. We no longer user document.write() (yuck) to insert the HTML of the widget into the document; we now modify the innerHTML of a div we create ourselves. We may further harden the JS against namespace collisions with [http://kentbrewster.com/badges Kent Brewster's badges] strategy.
* 2007-10-10: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.92]. Stylistic updates: Alex has gone to town on the chooser and styled it. It only shows jurisdictions that have launched. There are no known pending technical or visual issues.
* 2007-08-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.91]. The license selector allows one to remove the jurisdiction selector. There is a "No license" choice. Translation is done using JavaScript and not hidden DOM elements. Application developers have more control over the defaults, including "no license" being choosable as the default.
* 2007-08-09: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.9]. We've changed the plan to add some features before 1.0 based on talking with potential users. All DOM elements are '''really''' prefixed with cc_js_ this time, and all strings '''really''' are available for translation this time. Documentation is updated for the 0.9 release, including a way to have the application developer specify only a single jurisdiction for the license. JSON output is validated before being sent to a web browser. Removed dependency on prototype.js. Server code changes to improve performance. Massive reduction of unused JS and CSS (this process began with 0.4).
* 2007-08-06: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.4]. All DOM elements are prefixed with cc_js_. The widget works in Opera and Safari and works with degraded functionality in Konqueror.
* 2007-08-01: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.3]. This release introduces Internet Explorer compatibility, Apache Content Negotiation to handle user language selection even if the server doesn't provide it for us, a hopefully-stable API for selecting a license, and license seeding.
* 2007-07-25: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.2]. The UI now doesn't ask or contain spurious questions, plus translation is halfway there.
* 2007-07-19: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.1]. Don't try to use this in production, but DO let us know how it fits into your systems and what you would want us to change.

== Extra features ==
=== "Seeding" ===
* If the user has already selected a license through some other means, and you want to "seed" the JavaScript widget with the choices the user has already made, just create a hidden form field whose ID is cc_js_seed_uri with the URI of the license you want to start with.
** NOTE that whatever license version you provide, we always upgrade it to the most recent version the jurisdiction offers. We do display a '''Message''' underneath the license icon saying we did this.
=== Forcing a particular jurisdiction ===
To force the user to choose a license in a particular jurisdiction:
* First, use the "seeding" feature to seed the Attribution ("by") license in your jurisdiction
* Then, disable jurisdiction selection
=== Disabling jurisdiction selection ===
If you want to not offer the user a choice of jurisdictions:
* just append ?jurisdictions=disabled to the complete.js call.

=== Setting the license chooser to no license by default ===
If you want to set the license chooser to no license by default:
* just append ?want_a_license= no_license_by_default

=== Removing the "No license" option ===
If you want to not offer the user the option of selecting "no license:
* just append ?want_a_license=definitely to the query string
=== Language selection ===
* You can append ?locale=XX to your call to complete.js to choose a language. The example distributed as index.html in the distribution package sets the language to US English this way.
* If omitted, Apache Content Negotiation will select the most appropriate language based on the user's preferences, defaulting to US English.
=== Extracting results ===
All of these result extraction systems are demonstrated in the examples.
* There are two hidden form fields called '''cc_js_result_uri''' and '''cc_js_result_name''' that respectively store the URI and name of the license selected by the user. Just do <code>document.getElementById("cc_js_result_uri").value</code> (or "cc_js_result_name" instead) and you'll have the license information.
* There is an extra hidden form field containing the link to the image used. Simply get the element whose ID is '''cc_js_result_img''' and you will have a URL that is a permanent image. [http://en.wikipedia.org/wiki/Inline_linking Hotlink]ing these images is allowed and encouraged.

=== Styling ===
* You can use the example style provided in the example application to get you going. We '''urge''' you to put this file on your own web server and not rely on the copy hosted on labs.creativecommons.org.
* What we really want you to do is to change the style of our divs and spans and so-forth to make them fit in to your application. To do that, you should copy the example style file into one of your own CSS files and modify it until you really like it.
=== Namespacing ===
* All LicenseChooser.js HTML elements that have IDs or classes start with "cc_js_" to avoid namespace collisions.
* Similarly, all LicenseChooser.js JavaScript functions start with cc_js_. This is '''not''' true for the bundled Prototype.js library.

== Goals ==

The following list of general goals to remind us what we want out of LicenseChooser.js. You can expect most of it for 1.0.

See [[JsWidget/Plan]] to see what features are planned for what versions.

* Generate HTML suitable for use in a form which presents the basic license selector
* Provide compatibility with all [http://developer.yahoo.com/yui/articles/gbs/ A-grade browsers]
* Provide up to date license information by
** Utilizing licenses.xml to generate the appropriate Javascript on the server side. This may be done using a dynamic language such as PHP or through pre-processing to a static file when licenses are updated.
* Support new, expanded metadata including attributionName, attributionUrl and morePermissions.
* Provide a robust, scalable serving solution (if any server-side processing is needed) in order to support CC-hosted Javascript resources for the general public

== Version expectations ==
=== Zero point something (like 0.4) ===
There are no guarantees, but we'd like to keep to the same promises as a 1.0 release
=== Something point zero (like 1.0) ===
We guarantee (outside of really urgent situation where we exercise a judgement call) that these will '''not''' change:
* The programmatic interface for the widget will not change
* The user interface for selecting licenses will not change

The following are the only things that '''may'' change:
* As new translations become available, the text may become increasingly internationalized
* As jurisdictions offer new licenses, the engine will update the choices available to a user

== Resources ==

* [http://code.creativecommons.org/viewsvn/jswidget/ LicenseChooser.js development in Subversion]
* [http://cctools.svn.sourceforge.net/viewvc/cctools/cclib/trunk/js/ cclib/trunk/js] in Subversion contains the Javascript used for the [http://labs.creativecommons.org/dhtmllicense/ DHTML License Selector]
* [[JsWidget/Security|Security considerations]]

[[Category:Developer]]
[[Category:Opensource]]
[[Category:Integration]]

Jswidget new

2009-08-07T18:34:56Z

Gameguy43:

{{Software Project
|Description=LicenseChooser.js provides a lightweight method for integrating license selection into web applications.
|Bug tracker=http://code.creativecommons.org/issues/
|Code repository=http://code.creativecommons.org/viewsvn/jswidget/
|Mailing list=http://lists.ibiblio.org/mailman/listinfo/cc-devel
}}
{{Project}}
__NOTOC__

Creative Commons currently provides two methods for integrating license selection into applications: the [[Partner Interface]] and the [[Creative Commons Web Services|web service API]]. The CC Javascript Widget (LicenseChooser.js) provides an additional, lightweight method for integrating license selection into web applications. The widget is used by TypePad, as well as [[WpLicense]].

'''LicenseChooser.js is nearly ready! Please try the [http://code.creativecommons.org/viewsvn/jswidget/tags/0.97/ 0.97 preview].'''

== Users ==
* [[WpLicense]] uses LicenseChooser.js to provide a license selector for WordPress
* TypePad provides [http://everything.typepad.com/cc/ a widget] for adding a license to hosted blogs.

== Sample Usage ==

<div style="text-align:center">
[[Image:Jswidget-0.2-screenshot.png]]
</div>

You can read the source of these examples; they demonstrate some (but not all) of the combinations for advanced usage described below.

* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/ Basic usage]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/inside_form.html Basic usage from inside another form tag]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/default-is-no-license.html Selector where "no license" is the starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/without-jurisdiction.html Selector without a jurisdiction choice]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed.html Selector with a specific license used as a starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-without-jurisdiction.html Selector with a specific license as a starting point with no jurisdiction selector, always using the "seeded" jurisdiction]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-old-version.html Selector where an old license version was given as the seed]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/language-detect.html Selector that relies on Apache Content Negotiation for translations]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-license.html Selector without the choice of "No license"]

== Availability ==

You can play with a 0.97 pre-release right now!
* 2009-04-29: [http://mirrors.creativecommons.org/software/licensechooser-js/licensechooser-js-0.97.tar.gz Released 0.97]. '''This is the latest preview that is very close to 1.0.''' This release allows you to embed LicenseChooser.js inside a form tag. Thanks to John Horigan for reporting this issue and providing a patch (which we merged with some changes).
* 2009-03-16: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.96]. The help text for "Share alike" was wrong, mistakenly giving you the non-commercial help text. Fixed! This is an important update.
* 2008-09-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.95]. An anonymous bug reporter indicated that we overwrite the first JavaScript file found, even if it is not LicenseChooser.js. Fixed! This is an important update.
* 2008-08-27: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.94]. Stylistic issue found: image not always properly aligned with text in pop-up describing e.g. Share-Alike. We no longer user document.write() (yuck) to insert the HTML of the widget into the document; we now modify the innerHTML of a div we create ourselves. We may further harden the JS against namespace collisions with [http://kentbrewster.com/badges Kent Brewster's badges] strategy.
* 2007-10-10: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.92]. Stylistic updates: Alex has gone to town on the chooser and styled it. It only shows jurisdictions that have launched. There are no known pending technical or visual issues.
* 2007-08-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.91]. The license selector allows one to remove the jurisdiction selector. There is a "No license" choice. Translation is done using JavaScript and not hidden DOM elements. Application developers have more control over the defaults, including "no license" being choosable as the default.
* 2007-08-09: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.9]. We've changed the plan to add some features before 1.0 based on talking with potential users. All DOM elements are '''really''' prefixed with cc_js_ this time, and all strings '''really''' are available for translation this time. Documentation is updated for the 0.9 release, including a way to have the application developer specify only a single jurisdiction for the license. JSON output is validated before being sent to a web browser. Removed dependency on prototype.js. Server code changes to improve performance. Massive reduction of unused JS and CSS (this process began with 0.4).
* 2007-08-06: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.4]. All DOM elements are prefixed with cc_js_. The widget works in Opera and Safari and works with degraded functionality in Konqueror.
* 2007-08-01: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.3]. This release introduces Internet Explorer compatibility, Apache Content Negotiation to handle user language selection even if the server doesn't provide it for us, a hopefully-stable API for selecting a license, and license seeding.
* 2007-07-25: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.2]. The UI now doesn't ask or contain spurious questions, plus translation is halfway there.
* 2007-07-19: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.1]. Don't try to use this in production, but DO let us know how it fits into your systems and what you would want us to change.

== Extra features ==
=== "Seeding" ===
* If the user has already selected a license through some other means, and you want to "seed" the JavaScript widget with the choices the user has already made, just create a hidden form field whose ID is cc_js_seed_uri with the URI of the license you want to start with.
** NOTE that whatever license version you provide, we always upgrade it to the most recent version the jurisdiction offers. We do display a '''Message''' underneath the license icon saying we did this.
=== Forcing a particular jurisdiction ===
To force the user to choose a license in a particular jurisdiction:
* First, use the "seeding" feature to seed the Attribution ("by") license in your jurisdiction
* Then, disable jurisdiction selection
=== Disabling jurisdiction selection ===
If you want to not offer the user a choice of jurisdictions:
* just append ?jurisdictions=disabled to the complete.js call.

=== Setting the license chooser to no license by default ===
If you want to set the license chooser to no license by default:
* just append ?want_a_license= no_license_by_default

=== Removing the "No license" option ===
If you want to not offer the user the option of selecting "no license:
* just append ?want_a_license=definitely to the query string
=== Language selection ===
* You can append ?locale=XX to your call to complete.js to choose a language. The example distributed as index.html in the distribution package sets the language to US English this way.
* If omitted, Apache Content Negotiation will select the most appropriate language based on the user's preferences, defaulting to US English.
=== Extracting results ===
All of these result extraction systems are demonstrated in the examples.
* There are two hidden form fields called '''cc_js_result_uri''' and '''cc_js_result_name''' that respectively store the URI and name of the license selected by the user. Just do <code>document.getElementById("cc_js_result_uri").value</code> (or "cc_js_result_name" instead) and you'll have the license information.
* There is an extra hidden form field containing the link to the image used. Simply get the element whose ID is '''cc_js_result_img''' and you will have a URL that is a permanent image. [http://en.wikipedia.org/wiki/Inline_linking Hotlink]ing these images is allowed and encouraged.

=== Styling ===
* You can use the example style provided in the example application to get you going. We '''urge''' you to put this file on your own web server and not rely on the copy hosted on labs.creativecommons.org.
* What we really want you to do is to change the style of our divs and spans and so-forth to make them fit in to your application. To do that, you should copy the example style file into one of your own CSS files and modify it until you really like it.
=== Namespacing ===
* All LicenseChooser.js HTML elements that have IDs or classes start with "cc_js_" to avoid namespace collisions.
* Similarly, all LicenseChooser.js JavaScript functions start with cc_js_. This is '''not''' true for the bundled Prototype.js library.

== Goals ==

The following list of general goals to remind us what we want out of LicenseChooser.js. You can expect most of it for 1.0.

See [[JsWidget/Plan]] to see what features are planned for what versions.

* Generate HTML suitable for use in a form which presents the basic license selector
* Provide compatibility with all [http://developer.yahoo.com/yui/articles/gbs/ A-grade browsers]
* Provide up to date license information by
** Utilizing licenses.xml to generate the appropriate Javascript on the server side. This may be done using a dynamic language such as PHP or through pre-processing to a static file when licenses are updated.
* Support new, expanded metadata including attributionName, attributionUrl and morePermissions.
* Provide a robust, scalable serving solution (if any server-side processing is needed) in order to support CC-hosted Javascript resources for the general public

== Version expectations ==
=== Zero point something (like 0.4) ===
There are no guarantees, but we'd like to keep to the same promises as a 1.0 release
=== Something point zero (like 1.0) ===
We guarantee (outside of really urgent situation where we exercise a judgement call) that these will '''not''' change:
* The programmatic interface for the widget will not change
* The user interface for selecting licenses will not change

The following are the only things that '''may'' change:
* As new translations become available, the text may become increasingly internationalized
* As jurisdictions offer new licenses, the engine will update the choices available to a user

== Resources ==

* [http://code.creativecommons.org/viewsvn/jswidget/ LicenseChooser.js development in Subversion]
* [http://cctools.svn.sourceforge.net/viewvc/cctools/cclib/trunk/js/ cclib/trunk/js] in Subversion contains the Javascript used for the [http://labs.creativecommons.org/dhtmllicense/ DHTML License Selector]
* [[JsWidget/Security|Security considerations]]

[[Category:Developer]]
[[Category:Opensource]]
[[Category:Integration]]

Jswidget new

2009-07-30T21:30:14Z

Gameguy43:

[content starts here]
TODO:
*new screenshot

== Sample Usage ==

<div style="text-align:center">
[[Image:Jswidget-0.2-screenshot.png]]
</div>

You can read the source of these examples; they demonstrate some (but not all) of the combinations for advanced usage described below.

* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/ Basic usage]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/inside_form.html Basic usage from inside another form tag]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/default-is-no-license.html Selector where "no license" is the starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/without-jurisdiction.html Selector without a jurisdiction choice]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed.html Selector with a specific license used as a starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-without-jurisdiction.html Selector with a specific license as a starting point with no jurisdiction selector, always using the "seeded" jurisdiction]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-old-version.html Selector where an old license version was given as the seed]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/language-detect.html Selector that relies on Apache Content Negotiation for translations]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-license.html Selector without the choice of "No license"]

== Availability ==

You can play with a 0.97 pre-release right now!
* 2009-04-29: [http://mirrors.creativecommons.org/software/licensechooser-js/licensechooser-js-0.97.tar.gz Released 0.97]. '''This is the latest preview that is very close to 1.0.''' This release allows you to embed LicenseChooser.js inside a form tag. Thanks to John Horigan for reporting this issue and providing a patch (which we merged with some changes).
* 2009-03-16: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.96]. The help text for "Share alike" was wrong, mistakenly giving you the non-commercial help text. Fixed! This is an important update.
* 2008-09-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.95]. An anonymous bug reporter indicated that we overwrite the first JavaScript file found, even if it is not LicenseChooser.js. Fixed! This is an important update.
* 2008-08-27: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.94]. Stylistic issue found: image not always properly aligned with text in pop-up describing e.g. Share-Alike. We no longer user document.write() (yuck) to insert the HTML of the widget into the document; we now modify the innerHTML of a div we create ourselves. We may further harden the JS against namespace collisions with [http://kentbrewster.com/badges Kent Brewster's badges] strategy.
* 2007-10-10: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.92]. Stylistic updates: Alex has gone to town on the chooser and styled it. It only shows jurisdictions that have launched. There are no known pending technical or visual issues.
* 2007-08-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.91]. The license selector allows one to remove the jurisdiction selector. There is a "No license" choice. Translation is done using JavaScript and not hidden DOM elements. Application developers have more control over the defaults, including "no license" being choosable as the default.
* 2007-08-09: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.9]. We've changed the plan to add some features before 1.0 based on talking with potential users. All DOM elements are '''really''' prefixed with cc_js_ this time, and all strings '''really''' are available for translation this time. Documentation is updated for the 0.9 release, including a way to have the application developer specify only a single jurisdiction for the license. JSON output is validated before being sent to a web browser. Removed dependency on prototype.js. Server code changes to improve performance. Massive reduction of unused JS and CSS (this process began with 0.4).
* 2007-08-06: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.4]. All DOM elements are prefixed with cc_js_. The widget works in Opera and Safari and works with degraded functionality in Konqueror.
* 2007-08-01: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.3]. This release introduces Internet Explorer compatibility, Apache Content Negotiation to handle user language selection even if the server doesn't provide it for us, a hopefully-stable API for selecting a license, and license seeding.
* 2007-07-25: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.2]. The UI now doesn't ask or contain spurious questions, plus translation is halfway there.
* 2007-07-19: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.1]. Don't try to use this in production, but DO let us know how it fits into your systems and what you would want us to change.

== Extra features ==
=== "Seeding" ===
* If the user has already selected a license through some other means, and you want to "seed" the JavaScript widget with the choices the user has already made, just create a hidden form field whose ID is cc_js_seed_uri with the URI of the license you want to start with.
** NOTE that whatever license version you provide, we always upgrade it to the most recent version the jurisdiction offers. We do display a '''Message''' underneath the license icon saying we did this.
=== Forcing a particular jurisdiction ===
To force the user to choose a license in a particular jurisdiction:
* First, use the "seeding" feature to seed the Attribution ("by") license in your jurisdiction
* Then, disable jurisdiction selection
=== Disabling jurisdiction selection ===
If you want to not offer the user a choice of jurisdictions:
* just append ?jurisdictions=disabled to the complete.js call.

=== Setting the license chooser to no license by default ===
If you want to set the license chooser to no license by default:
* just append ?want_a_license= no_license_by_default

=== Removing the "No license" option ===
If you want to not offer the user the option of selecting "no license:
* just append ?want_a_license=definitely to the query string
=== Language selection ===
* You can append ?locale=XX to your call to complete.js to choose a language. The example distributed as index.html in the distribution package sets the language to US English this way.
* If omitted, Apache Content Negotiation will select the most appropriate language based on the user's preferences, defaulting to US English.
=== Extracting results ===
All of these result extraction systems are demonstrated in the examples.
* There are two hidden form fields called '''cc_js_result_uri''' and '''cc_js_result_name''' that respectively store the URI and name of the license selected by the user. Just do <code>document.getElementById("cc_js_result_uri").value</code> (or "cc_js_result_name" instead) and you'll have the license information.
* There is an extra hidden form field containing the link to the image used. Simply get the element whose ID is '''cc_js_result_img''' and you will have a URL that is a permanent image. [http://en.wikipedia.org/wiki/Inline_linking Hotlink]ing these images is allowed and encouraged.

=== Styling ===
* You can use the example style provided in the example application to get you going. We '''urge''' you to put this file on your own web server and not rely on the copy hosted on labs.creativecommons.org.
* What we really want you to do is to change the style of our divs and spans and so-forth to make them fit in to your application. To do that, you should copy the example style file into one of your own CSS files and modify it until you really like it.
=== Namespacing ===
* All LicenseChooser.js HTML elements that have IDs or classes start with "cc_js_" to avoid namespace collisions.
* Similarly, all LicenseChooser.js JavaScript functions start with cc_js_. This is '''not''' true for the bundled Prototype.js library.

== Goals ==

The following list of general goals to remind us what we want out of LicenseChooser.js. You can expect most of it for 1.0.

See [[JsWidget/Plan]] to see what features are planned for what versions.

* Generate HTML suitable for use in a form which presents the basic license selector
* Provide compatibility with all [http://developer.yahoo.com/yui/articles/gbs/ A-grade browsers]
* Provide up to date license information by
** Utilizing licenses.xml to generate the appropriate Javascript on the server side. This may be done using a dynamic language such as PHP or through pre-processing to a static file when licenses are updated.
* Support new, expanded metadata including attributionName, attributionUrl and morePermissions.
* Provide a robust, scalable serving solution (if any server-side processing is needed) in order to support CC-hosted Javascript resources for the general public

== Version expectations ==
=== Zero point something (like 0.4) ===
There are no guarantees, but we'd like to keep to the same promises as a 1.0 release
=== Something point zero (like 1.0) ===
We guarantee (outside of really urgent situation where we exercise a judgement call) that these will '''not''' change:
* The programmatic interface for the widget will not change
* The user interface for selecting licenses will not change

The following are the only things that '''may'' change:
* As new translations become available, the text may become increasingly internationalized
* As jurisdictions offer new licenses, the engine will update the choices available to a user

== Resources ==

* [http://code.creativecommons.org/viewsvn/jswidget/ LicenseChooser.js development in Subversion]
* [http://cctools.svn.sourceforge.net/viewvc/cctools/cclib/trunk/js/ cclib/trunk/js] in Subversion contains the Javascript used for the [http://labs.creativecommons.org/dhtmllicense/ DHTML License Selector]
* [[JsWidget/Security|Security considerations]]

[[Category:Developer]]
[[Category:Opensource]]
[[Category:Integration]]

Jswidget new

2009-07-30T21:27:53Z

Gameguy43: Created page with ' [content starts here] == Sample Usage == <div style="text-align:center"> Image:Jswidget-0.2-screenshot.png </div> You can read the source of these examples; they demonstr…'

[content starts here]

== Sample Usage ==

<div style="text-align:center">
[[Image:Jswidget-0.2-screenshot.png]]
</div>

You can read the source of these examples; they demonstrate some (but not all) of the combinations for advanced usage described below.

* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/ Basic usage]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/inside_form.html Basic usage from inside another form tag]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/default-is-no-license.html Selector where "no license" is the starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/without-jurisdiction.html Selector without a jurisdiction choice]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed.html Selector with a specific license used as a starting point]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-without-jurisdiction.html Selector with a specific license as a starting point with no jurisdiction selector, always using the "seeded" jurisdiction]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/with-seed-old-version.html Selector where an old license version was given as the seed]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/language-detect.html Selector that relies on Apache Content Negotiation for translations]
* [http://labs.creativecommons.org/jswidget/tags/0.97/example_web_app/definitely-want-license.html Selector without the choice of "No license"]

== Availability ==

You can play with a 0.97 pre-release right now!
* 2009-04-29: [http://mirrors.creativecommons.org/software/licensechooser-js/licensechooser-js-0.97.tar.gz Released 0.97]. '''This is the latest preview that is very close to 1.0.''' This release allows you to embed LicenseChooser.js inside a form tag. Thanks to John Horigan for reporting this issue and providing a patch (which we merged with some changes).
* 2009-03-16: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.96]. The help text for "Share alike" was wrong, mistakenly giving you the non-commercial help text. Fixed! This is an important update.
* 2008-09-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.95]. An anonymous bug reporter indicated that we overwrite the first JavaScript file found, even if it is not LicenseChooser.js. Fixed! This is an important update.
* 2008-08-27: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.94]. Stylistic issue found: image not always properly aligned with text in pop-up describing e.g. Share-Alike. We no longer user document.write() (yuck) to insert the HTML of the widget into the document; we now modify the innerHTML of a div we create ourselves. We may further harden the JS against namespace collisions with [http://kentbrewster.com/badges Kent Brewster's badges] strategy.
* 2007-10-10: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.92]. Stylistic updates: Alex has gone to town on the chooser and styled it. It only shows jurisdictions that have launched. There are no known pending technical or visual issues.
* 2007-08-23: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.91]. The license selector allows one to remove the jurisdiction selector. There is a "No license" choice. Translation is done using JavaScript and not hidden DOM elements. Application developers have more control over the defaults, including "no license" being choosable as the default.
* 2007-08-09: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.9]. We've changed the plan to add some features before 1.0 based on talking with potential users. All DOM elements are '''really''' prefixed with cc_js_ this time, and all strings '''really''' are available for translation this time. Documentation is updated for the 0.9 release, including a way to have the application developer specify only a single jurisdiction for the license. JSON output is validated before being sent to a web browser. Removed dependency on prototype.js. Server code changes to improve performance. Massive reduction of unused JS and CSS (this process began with 0.4).
* 2007-08-06: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.4]. All DOM elements are prefixed with cc_js_. The widget works in Opera and Safari and works with degraded functionality in Konqueror.
* 2007-08-01: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.3]. This release introduces Internet Explorer compatibility, Apache Content Negotiation to handle user language selection even if the server doesn't provide it for us, a hopefully-stable API for selecting a license, and license seeding.
* 2007-07-25: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.2]. The UI now doesn't ask or contain spurious questions, plus translation is halfway there.
* 2007-07-19: [http://sourceforge.net/project/showfiles.php?group_id=80503&package_id=239510 Released 0.1]. Don't try to use this in production, but DO let us know how it fits into your systems and what you would want us to change.

== Extra features ==
=== "Seeding" ===
* If the user has already selected a license through some other means, and you want to "seed" the JavaScript widget with the choices the user has already made, just create a hidden form field whose ID is cc_js_seed_uri with the URI of the license you want to start with.
** NOTE that whatever license version you provide, we always upgrade it to the most recent version the jurisdiction offers. We do display a '''Message''' underneath the license icon saying we did this.
=== Forcing a particular jurisdiction ===
To force the user to choose a license in a particular jurisdiction:
* First, use the "seeding" feature to seed the Attribution ("by") license in your jurisdiction
* Then, disable jurisdiction selection
=== Disabling jurisdiction selection ===
If you want to not offer the user a choice of jurisdictions:
* just append ?jurisdictions=disabled to the complete.js call.

=== Setting the license chooser to no license by default ===
If you want to set the license chooser to no license by default:
* just append ?want_a_license= no_license_by_default

=== Removing the "No license" option ===
If you want to not offer the user the option of selecting "no license:
* just append ?want_a_license=definitely to the query string
=== Language selection ===
* You can append ?locale=XX to your call to complete.js to choose a language. The example distributed as index.html in the distribution package sets the language to US English this way.
* If omitted, Apache Content Negotiation will select the most appropriate language based on the user's preferences, defaulting to US English.
=== Extracting results ===
All of these result extraction systems are demonstrated in the examples.
* There are two hidden form fields called '''cc_js_result_uri''' and '''cc_js_result_name''' that respectively store the URI and name of the license selected by the user. Just do <code>document.getElementById("cc_js_result_uri").value</code> (or "cc_js_result_name" instead) and you'll have the license information.
* There is an extra hidden form field containing the link to the image used. Simply get the element whose ID is '''cc_js_result_img''' and you will have a URL that is a permanent image. [http://en.wikipedia.org/wiki/Inline_linking Hotlink]ing these images is allowed and encouraged.

=== Styling ===
* You can use the example style provided in the example application to get you going. We '''urge''' you to put this file on your own web server and not rely on the copy hosted on labs.creativecommons.org.
* What we really want you to do is to change the style of our divs and spans and so-forth to make them fit in to your application. To do that, you should copy the example style file into one of your own CSS files and modify it until you really like it.
=== Namespacing ===
* All LicenseChooser.js HTML elements that have IDs or classes start with "cc_js_" to avoid namespace collisions.
* Similarly, all LicenseChooser.js JavaScript functions start with cc_js_. This is '''not''' true for the bundled Prototype.js library.

== Goals ==

The following list of general goals to remind us what we want out of LicenseChooser.js. You can expect most of it for 1.0.

See [[JsWidget/Plan]] to see what features are planned for what versions.

* Generate HTML suitable for use in a form which presents the basic license selector
* Provide compatibility with all [http://developer.yahoo.com/yui/articles/gbs/ A-grade browsers]
* Provide up to date license information by
** Utilizing licenses.xml to generate the appropriate Javascript on the server side. This may be done using a dynamic language such as PHP or through pre-processing to a static file when licenses are updated.
* Support new, expanded metadata including attributionName, attributionUrl and morePermissions.
* Provide a robust, scalable serving solution (if any server-side processing is needed) in order to support CC-hosted Javascript resources for the general public

== Version expectations ==
=== Zero point something (like 0.4) ===
There are no guarantees, but we'd like to keep to the same promises as a 1.0 release
=== Something point zero (like 1.0) ===
We guarantee (outside of really urgent situation where we exercise a judgement call) that these will '''not''' change:
* The programmatic interface for the widget will not change
* The user interface for selecting licenses will not change

The following are the only things that '''may'' change:
* As new translations become available, the text may become increasingly internationalized
* As jurisdictions offer new licenses, the engine will update the choices available to a user

== Resources ==

* [http://code.creativecommons.org/viewsvn/jswidget/ LicenseChooser.js development in Subversion]
* [http://cctools.svn.sourceforge.net/viewvc/cctools/cclib/trunk/js/ cclib/trunk/js] in Subversion contains the Javascript used for the [http://labs.creativecommons.org/dhtmllicense/ DHTML License Selector]
* [[JsWidget/Security|Security considerations]]

[[Category:Developer]]
[[Category:Opensource]]
[[Category:Integration]]

CcValidator

2009-06-29T21:07:49Z

Gameguy43:

[[Category:Developer]]
[[Category:Opensource]]
[[Category:Tools]]

ccValidator is an on-line service which parses Creative Commons licenses, validates the RDF and displays their contents in human readable form. It is useful for ensuring that your license accurately reflects the rights you wish to reserve (or not). The service is available from the Creative Commons website, at http://validator.creativecommons.org.

This service was first created in response to a list of [[Developer Challenges|developer challenges]] published by the Creative Commons and totally revamped during Google Summer of Code 2008. Suggestions and bug reports are always welcome. You can e-mail them to software@creativecommons.org.

== Architecture ==

The validator consists of a Pylons web app called "validator" and a Python support module called "libvalidator." libvalidator handles RDF in many formats; RDF in a comment, RDFa, or inline RDF/XML. HTML is processed by html5lib, and the RDF is passed on to RDFlib. The CC RDF information is accessed via the cc.license Python module that wraps the Creative Commons RDF data.

== Source Code ==

The current implementation is available in git. Setting up the validator requires three modules:

* cc.license
* libvalidator
* validator

(If you are not familiar with our git repository, read our [[Source Repository Information#git|documentation on our source repositories]].)

If you don't mind cluttering up your PYTHONPATH, the easiest way to get going to is to clone each of these and run "python setup.py install". After that, read the README in the validator repository; you can easily launch the validator web application, by default listening on localhost port 5000.

== Demonstration ==

The validator can validate both our old RDF-in-a-comment and the recommendation from here on out, RDFa. The validator's [http://validator.creativecommons.org/ front page] links to these sample documents.

== Additional Resources ==

'''Bug reports''' should be submitted via the [http://code.creativecommons.org/issues CC issue tracker].

* Historical development notes are in [[User:NathanYergler|Nathan Yergler's]] blog; the ccValidate-specific archive is located [http://yergler.net/blog/category/projects/ccvalidator/ here]. The historical ccValidator code is currently unavailable, but that codebase is unrelated to the current codebase (whose history is preserved in git).
* Hugo's posts about Google Summer of Code development process:
** [http://labs.creativecommons.org/2008/05/26/license%E2%80%91oriented-metadata-validator-and-viewer-the-development-has-just-started/ Start of summer post announcing Hugo's plans]
** [http://labs.creativecommons.org/2008/07/08/license-oriented-metadata-validator-and-viewer-libvalidator/ Middle of summer post explaining the separation of libvalidator]
** [http://labs.creativecommons.org/2008/08/16/license-oriented-metadata-validator-and-viewer-summertime-is-winding-up/ Beta release at the end of GSoC]