LibccLicense - Revision history

Scott Shawcroft at 23:59, 22 June 2007

2007-06-22T23:59:34Z

Scott Shawcroft: /* Interface */

2007-06-19T23:44:03Z

‎Interface

Scott Shawcroft: /* Interface */

2007-06-19T23:28:36Z

‎Interface

Scott Shawcroft: /* Interface */

2007-06-19T23:26:48Z

‎Interface

Scott Shawcroft: /* Interface */

2007-06-19T23:22:09Z

‎Interface

Scott Shawcroft: /* Interface */

2007-06-19T19:56:25Z

‎Interface

Scott Shawcroft: /* Data Structure */

2007-06-19T00:07:05Z

‎Data Structure

Scott Shawcroft: /* Interface */

2007-06-19T00:02:01Z

‎Interface

Scott Shawcroft: /* Uses */

2007-06-18T23:38:48Z

‎Uses

Scott Shawcroft: Initial ideas.

2007-06-18T23:32:31Z

Initial ideas.

New page

== Purpose ==
To provide a generic interface to the CC license data, license choice data and license choice logic.

== Audience ==
Application developers who wish to choose and/or verify CC licenses.

== Implementation ==
This library will be implemented in C to provide maximum portability.

=== Interface ===

* Data accessors.
** get_locale(uri)
** get_jurisdiction(uri)
** get_name(uri)
** get_version(uri)
** is_sa(uri)
** is_by(uri)
** is_nc(uri)
** is_nd(uri)
** is_sampling(uri)
** get_notification(uri[,url])

* Data verification.
** verify_uri(uri)
** verify_url(uri,url)

* License chooser (return uris)
** get_license(sa,nc,nd) (Raise error upon simultaneous choice of sa and nd.)
** get_license_options(locale)
** get_sampling(nc)
** get_sampling_options(locale)

=== Data Structure ===
* Data Types (informal)
** uri
** name
** notification
** deed
** sampling

=== Bindings ===
* Python

== Uses ==
[[LibccLicense system implementation guidelines.]]
* Gnome
* KDE
* OpenMoko
* Sugar (OLPC)

← Older revision		Revision as of 23:59, 22 June 2007
Line 1:		Line 1:
−	~~== Purpose ==~~	+	#REDIRECT [[Liblicense]]
−	~~To provide a generic interface to the CC license data, license choice data and license choice logic.~~
−
−	~~== Audience ==~~
−	~~Application developers who wish to choose and/or verify CC licenses.~~
−
−	~~== Implementation ==~~
−	~~This library will be implemented in C to provide maximum portability.~~
−
−	~~=== Interface ===~~
−	* get_jurisdiction(uri) - ''returns the jurisdiction for the given license.''
−	* get_jurisdictions(short or bitcode) - ''returns the available jurisdiction for the given short name or bitcode.''
−	* get_locale(uri) – ''returns the locale for the given license.''
−	* get_locales(jurisdiction, short or bitcode) – ''returns the available locales for the given jurisdiction and short name or bitcode.''
−	* get_name(uri) – ''returns the name of the license.''
−	* get_version(uri) – ''returns the version of the license.''
−	* get_versions(short, jurisdiction) - ''returns the available versions for the given short name or bitcode and jurisdiction.''
−	* get_short(uri) - ''returns the short name for the given uri.''
−	* has_flag(attribute,uri) – ''returns if the flag is set for the given uri.''
−	* family_flags(family) - ''returns the flags available for a given family.''
−	* family(uri) – ''returns the family the given uri belongs to.''
−	* get_notification(uri[,url]) - ''returns the notification string for the given url with an option to provide a verification url.''
−	* verify_uri(uri) - ''returns whether or not the given uri is recognized by the system.''
−	* get_license(family,flags, jurisdiction,locale) – ''returns the uri which satisfies the given attributes.''
−	* get_all_licenses() - ''returns a null-terminated list of all general licenses available.''
−	* get_general_licenses(family) - ''returns a null-terminated list of all general licenses in a family.''
−	* get_families() – ''returns a null-terminated list of available families.''
−
−	~~=== Data Structure ===~~
−	* Data Types (informal)
−	** uri
−	** name
−	** notification
−	** deed
−	** sampling
−
−	~~==== Diskwise ====~~
−	* licenses
−	** creative_commons_sampling
−	** creative_commons
−	*** licenses
−	*** flags
−	*** name
−	*** general
−
−	~~=== Bindings ===~~
−	* Python
−
−	~~== Uses ==~~
−	[[~~libccLicense system implementation guidelines~~]]
−	* Gnome
−	* KDE
−	* OpenMoko
−	* Sugar (OLPC)

@@ Line 23: / Line 23: @@
 * verify_uri(uri) - ''returns whether or not the given uri is recognized by the system.''
 * get_license(family,flags, jurisdiction,locale) – ''returns the uri which satisfies the given attributes.''
-* get_all_licenses() - ''returns all general licenses available.''
+* get_all_licenses() - ''returns a null-terminated list of all general licenses available.''
-* get_general_licenses(family) - ''returns all general licenses in a family.''
+* get_general_licenses(family) - ''returns a null-terminated list of all general licenses in a family.''
-* get_families() – ''returns a list of available families.''
+* get_families() – ''returns a null-terminated list of available families.''
 === Data Structure ===

@@ Line 9: / Line 9: @@
 === Interface ===
-* get_jurisdiction(uri) ''- returns the jurisdiction for the given license.''
+* get_jurisdiction(uri) - ''returns the jurisdiction for the given license.''
 * get_jurisdictions(short or bitcode) - ''returns the available jurisdiction for the given short name or bitcode.''
 * get_locale(uri) – ''returns the locale for the given license.''
-* get_locales(jurisdiction, short or bitcode) – returns the available locales for the given jurisdiction and short name or bitcode.
+* get_locales(jurisdiction, short or bitcode) – ''returns the available locales for the given jurisdiction and short name or bitcode.''
-* get_name(uri) – returns the name of the license.
+* get_name(uri) – ''returns the name of the license.''
-* get_version(uri) – returns the version of the license.
+* get_version(uri) – ''returns the version of the license.''
-* get_versions(short, jurisdiction) - returns the available versions for the given short name or bitcode and jurisdiction.
+* get_versions(short, jurisdiction) - ''returns the available versions for the given short name or bitcode and jurisdiction.''
-* get_short(uri) - returns the short name for the given uri.
+* get_short(uri) - ''returns the short name for the given uri.''
-* has_flag(attribute,uri) – returns if the flag is set for the given uri.
+* has_flag(attribute,uri) – ''returns if the flag is set for the given uri.''
-* family_flags(family) - returns the flags available for a given family.
+* family_flags(family) - ''returns the flags available for a given family.''
-* family(uri) – returns the family the given uri belongs to.
+* family(uri) – ''returns the family the given uri belongs to.''
-* get_notification(uri[,url]) - returns the notification string for the given url with an option to provide a verification url.
+* get_notification(uri[,url]) - ''returns the notification string for the given url with an option to provide a verification url.''
-* verify_uri(uri) - returns whether or not the given uri is recognized by the system.
+* verify_uri(uri) - ''returns whether or not the given uri is recognized by the system.''
-* get_license(family,flags, jurisdiction,locale) – returns the uri which satisfies the given attributes.
+* get_license(family,flags, jurisdiction,locale) – ''returns the uri which satisfies the given attributes.''
-* get_all_licenses() - returns all general licenses available.
+* get_all_licenses() - ''returns all general licenses available.''
-* get_general_licenses(family) - returns all general licenses in a family.
+* get_general_licenses(family) - ''returns all general licenses in a family.''
-* get_families() – returns a list of available families.
+* get_families() – ''returns a list of available families.''
 === Data Structure ===

@@ Line 9: / Line 9: @@
 === Interface ===
-* '''get_jurisdiction'''(uri) - returns the jurisdiction for the given license.
+* get_jurisdiction(uri) ''- returns the jurisdiction for the given license.''
-* '''get_jurisdictions'''(short or bitcode) - returns the available jurisdiction for the given short name or bitcode.
+* get_jurisdictions(short or bitcode) - ''returns the available jurisdiction for the given short name or bitcode.''
-* '''get_locale'''(uri) – returns the locale for the given license.
+* get_locale(uri) – ''returns the locale for the given license.''
-* '''get_locales'''(jurisdiction, short or bitcode) – returns the available locales for the given jurisdiction and short name or bitcode.
+* get_locales(jurisdiction, short or bitcode) – returns the available locales for the given jurisdiction and short name or bitcode.
-* '''get_name'''(uri) – returns the name of the license.
+* get_name(uri) – returns the name of the license.
-* '''get_version'''(uri) – returns the version of the license.
+* get_version(uri) – returns the version of the license.
-* '''get_versions'''(short, jurisdiction) - returns the available versions for the given short name or bitcode and jurisdiction.
+* get_versions(short, jurisdiction) - returns the available versions for the given short name or bitcode and jurisdiction.
-* '''get_short'''(uri) - returns the short name for the given uri.
+* get_short(uri) - returns the short name for the given uri.
-* '''has_flag'''(attribute,uri) – returns if the flag is set for the given uri.
+* has_flag(attribute,uri) – returns if the flag is set for the given uri.
-* '''family_flags'''(family) - returns the flags available for a given family.
+* family_flags(family) - returns the flags available for a given family.
-* '''family'''(uri) – returns the family the given uri belongs to.
+* family(uri) – returns the family the given uri belongs to.
-* '''get_notification'''(uri[,url]) - returns the notification string for the given url with an option to provide a verification url.
+* get_notification(uri[,url]) - returns the notification string for the given url with an option to provide a verification url.
-* '''verify_uri'''(uri) - returns whether or not the given uri is recognized by the system.
+* verify_uri(uri) - returns whether or not the given uri is recognized by the system.
-* '''get_license'''(family,flags, jurisdiction,locale) – returns the uri which satisfies the given attributes.
+* get_license(family,flags, jurisdiction,locale) – returns the uri which satisfies the given attributes.
-* '''get_all_licenses'''() - returns all general licenses available.
+* get_all_licenses() - returns all general licenses available.
-* '''get_general_licenses'''(family) - returns all general licenses in a family.
+* get_general_licenses(family) - returns all general licenses in a family.
-* '''get_families'''() – returns a list of available families.
+* get_families() – returns a list of available families.
 === Data Structure ===

@@ Line 9: / Line 9: @@
 === Interface ===
-* License Attributes
+* '''get_jurisdiction'''(uri) - returns the jurisdiction for the given license.
-** Standard
+* '''get_jurisdictions'''(short or bitcode) - returns the available jurisdiction for the given short name or bitcode.
-*** CC_NC
+* '''get_locale'''(uri) – returns the locale for the given license.
-*** CC_SA
+* '''get_locales'''(jurisdiction, short or bitcode) – returns the available locales for the given jurisdiction and short name or bitcode.
-*** CC_ND
+* '''get_name'''(uri) – returns the name of the license.
-*** CC_BY
+* '''get_version'''(uri) – returns the version of the license.
-** Sampling
+* '''get_versions'''(short, jurisdiction) - returns the available versions for the given short name or bitcode and jurisdiction.
-*** SAMPLING_NC
+* '''get_short'''(uri) - returns the short name for the given uri.
+* '''has_flag'''(attribute,uri) – returns if the flag is set for the given uri.
-* Data accessors.
+* '''family_flags'''(family) - returns the flags available for a given family.
-** get_jurisdiction(uri)
+* '''family'''(uri) – returns the family the given uri belongs to.
-** get_jurisdictions(short)
+* '''get_notification'''(uri[,url]) - returns the notification string for the given url with an option to provide a verification url.
-** get_locale(uri)
+* '''verify_uri'''(uri) - returns whether or not the given uri is recognized by the system.
-** get_locales(short)
+* '''get_license'''(family,flags, jurisdiction,locale) – returns the uri which satisfies the given attributes.
-** get_name(uri)
+* '''get_all_licenses'''() - returns all general licenses available.
-** get_version(uri)
+* '''get_general_licenses'''(family) - returns all general licenses in a family.
-** get_versions(short, jurisdiction)
+* '''get_families'''() – returns a list of available families.
 === Data Structure ===

@@ Line 33: / Line 33: @@
 ** deed
 ** sampling
 === Bindings ===

@@ Line 15: / Line 15: @@
 ** get_name(uri)
 ** get_version(uri)
-** is_sa(uri)
+** is(attribute,uri)
-** is_by(uri)
+** category(uri)
 ** get_notification(uri[,url])
 * Data verification.
 ** verify_uri(uri)
 * License chooser (return uris)
-** get_license(sa,nc,nd) (Raise error upon simultaneous choice of sa and nd.)
+** get_license(category,flags)
-** get_license_options(locale)
+** get_license_options(category,locale)
 === Data Structure ===

@@ Line 44: / Line 44: @@
 == Uses ==
-[[LibccLicense system implementation guidelines.]]
+[[libccLicense system implementation guidelines]]
 * Gnome
 * KDE
 * OpenMoko
 * Sugar (OLPC)