« How to configure and use LIRC
Simple-Recent-Comments WordPress Plugin »

Creative-Commons-Configurator WordPress Plugin

January 14th, 2006 by George Notaras

This plugin intends to become the only tool a user will need in order to set a Creative Commons License on a WordPress blog and control the inclusion or display of the license information into the blog pages or the syndication feeds. All configuration is done from a page in the administration panel. Template tags are also available for those who need customization.

Features

These are the plugin’s features in short:

  • Configuration page in the WordPress administration panel. No manual editing of files is needed for basic usage.
  • License selction by using the web-based license selection engine from CreativeCommons.org.
  • The license information can be reset at any time. This action also removes the options that are stored in the WordPress database.
  • Adds license information to:
    • The HTML head area of the every blog page (this is for search engine bots only – Not visible to human visitors).
    • The Atom, RSS 2.0 and RDF (aka RSS 1.0) feeds through the Creative Commons RSS module, which validates properly. This option is compatible only with WordPress 2 or newer due to technical reasons. It will not appear on versions older than 2.0.
    • Displays a block with license information under the published content. Basic customization (license information and formatting) is available through the configuration panel.
  • Some template tags are provided for use in your theme templates.
  • The plugin is ready for localization.

Installation

Copy the cc-configurator.php file in your /wp-content/plugins/ directory and activate the plugin through the administration panel.

The license configuration can be done from within the administration panel. Go to:

Administration Panel -> Options -> License

Compatibility

For full functionality, this plugin requires WordPress 2 or newer. If you use it with older versions of WordPress, the option to include licensing info in the feeds will not appear in the configuration page.

License

Creative-Commons-Configurator is an open-source project, released as Free Software under the terms of the Apache License version 2.

Downloads, Issue Tracking, Support

For the latest releases of Creative-Commons-Configurator please visit the downloads section of the Creative-Commons-Configurator Development Portal.

The development website also hosts an issue tracking facility, where you can submit your feature requests or report bugs, and discussion boards, where you can get first class support from the community of users.

Translations

This plugin is ready for translations. The default language is English.

Translation files are available from the download area as well.

Currently the following language files are available. Just throw the proper one for your language in your plugins directory and you are set.

  • Greek for v1.0 – By George Notaras

Donate

This plugin is released as free software. Nevertheless, its development requires time and effort. A small donation, as a sign of appreciation of the effort, is welcome. Please, use the following button to visit the Donations page. Thanks in advance for your support!

Donations Button

Changelog – Release Notes

* Tue Jan 6 2009 – v1.1
- Use rawurldecode() on the values that are returned by the CC API.
- Removed the border attribute from the image hyperlink in order to comply with
XHTML 1.1.
* Thu Mar 15 2007 – v1.0
- The plugin was almost re-written from scratch. Many new features have been added and others have been modified so to provide the best functionality and ease of use.
- The license selection engine from CreativeCommons.org is now used in order to select a license for your blog. No more copying and pasting of license code.
- A new license info layer is introduced for placing under the published content. Customization of that layer is possible either from the config panel or with CSS.
- WARNING: the bccl_display_full_html_license() template tag has been replaced by bccl_full_html_license(). Make sure you update your theme templates.
- New template tags are available.
- The configuration panel has been reworked.
- The plugin is ready for translations.
* Sat Feb 24 2007 – v0.6
- Supports CC v3
* Wed Nov 01 2006 – v0.5
- When the options where modified in the administration panel, a confirmation was asked. This behaviour has been corrected and the options are saved immediately.
- Wordpress escaped some characters in the extra message that is displayed after the post’s body. This resulted in corrupted HTML code. This has been corrected (thanks John)
* Wed Oct 04 2006 – v0.4
- Plugin information update
* Mon Jan 16 2006
- Update to version 0.2
- Added a WordPress version check, so that the option to include licensing info in the feeds does not appear in older WP version than 2.0.
- Added an informational section in the configuration page about the template tags that can be used in the theme.
- Added success message after successful license reset.
- Added success message after successful license code submission.
- Added error message if license code does not seem valid.
- Added some Creative Commons license code verification. Seems to work with all licenses, but is very primitive. Only the basic HTML code structure is checked.
- The default licensing info message that is displayed after the post’s body was modified.
- Added one more option. Now a user can define some custom code that will be displayed
together with the default message below the post’s body.
- Added some template tags that can be used by a user on a theme.
- More modularization of the code.
- Minor fixes, so it works properly with other CC licenses, eg Developing Nations, Sampling etc.
- Minor form HTML code fixes.
* Sat Jan 14 2006
- Initial v0.1 release

The Creative-Commons-Configurator WordPress Plugin by George Notaras, unless otherwise expressly stated, is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License. Terms and conditions beyond the scope of this license may be available at www.g-loaded.eu.

Related Articles

Tags: , , , , ,

Bookmark and Share

16 Responses to “Creative-Commons-Configurator WordPress Plugin”

  1. Car Seat Cover Says :

    You have really done a good job on this. Keep it up!

  2. Josh Wilkins Says :

    Just wanted to say thanks for the great plugin!

  3. John Holman Says :

    Just a note of caution: I am no expert so this might be due to something I did. But part of my site went down after I installed your plugin — I run WP 2.04 and a modified K2 091. The home page was there and correct but all other pages lost some their formatting and appeared corrupt. I de-installed your plugin but that didn’t change a thing. I then went into the database and deleted the wp-option stuff your plugin inserts. After that all worked well again. Sorry, as I said maybe it was just me and my site (template) but I thought I’d mention it….

    Regards
    John

  4. GNot Says :

    Hello John,
    Reporting such issues is the right thing to do, so you shouldn’t be sorry about that.

    First of all, some info about the options. The following are the options that this plugin adds to the wp_options table whenever a CC license is set:

    bccl_body_extra
    bccl_body
    bccl_html
    bccl_rdf
    bccl_header
    bccl_feed
    

    All these options are removed whenever the license is reset from the admin interface (options->license tab). For example, when you press the “Reset License” button, the above options are removed. If you de-activate the plugin without previously reseting the license, the above options will remain in the wp_options table, but they are not used for anything else and they cannot interfere with any of the blog’s functions. They just take some storage space in the database table.

    Here are some possible reasons that the problems you mentioned might have happened:

    || The home page was there and correct but all other pages lost some their formatting and appeared corrupt.

    There might be some problem between the default message’s (license info) HTML code, that appears under each post, and your theme’s HTML code. Probably not all HTML tags are closed properly and generally a HTML related issue.

    || I de-installed your plugin but that didn’t change a thing.

    This is something I do not understand. This plugin works without requiring any manual theme editing. It uses the available hooks to add the license info in the post body, feed, or page head.
    An issue could rise only in the case that the user has manually used the template tags that this plugin offeres, so to add license information to any place the user likes. In this case, if the plugin’s functions are called from within the theme, but the plugin has been de-activated, the blog would simply not work. This is normal behaviour. It can be avoided by using function_exists when calling a function.

    In your case, I assume that either the wordpress cache or any other caching mechanism you may use was the reason that the page remained the same, even after the de-activation of the plugin.

    || I then went into the database and deleted the wp-option stuff your plugin inserts. After that all worked well again.

    As I explained earlier, the stored options cannot produce any problem by themselves. They are just some options, prefixed with bccl_. It’s also very unlikely that some other plugin has the same options so to conflict.

    Generally, I cannot provide any other explanation about your issue. I believe that the problem is only the default license message’s HTML code or any additional HTML code that is added to it through the admin panel. When I have the time, I’ll re-examine the plugin in a new test blog to determine if there is an issue with it.

    Thanks for your feedback.

  5. John Holman Says :

    Thanks for your fast feedback. I might get brave and try it again today. I only know enough about this stuff to be dangerous but my thoughts about it were also to do with something like and unclosed div or some html stuff. It installed well, and only went ape after I chose putting cc in the header and RSS! BTW just for accuracy, when I said I de-installed, that was not a correct statement. I deleted it via ftp so I suppose it didn’t deactivate and maybe I exacerbated my problem. Told you I was dangerous :-)

  6. GNot Says :

    John: I had some free time today and, after upgrading to WP v2.0.5, I checked this plugin a bit. You were absolutely right about the corruption of the HTML code. It happens when the extra license message field is filled with HTML code. New versions of wordpress escape this code, which produces the results you mentioned in your comment.

    Plus another bug with the administration panel have been corrected in version 0.5 of the plugin.

    Thanks for your feedback.

  7. Ryan Salinger Says :

    Thank you so much for this plugin. It works flawlessly and is so neat!

  8. Albert Keizer Says :

    We’re working with wordpress now for over 3 months. As a company that puts value on a worldwide change of view on ways of licencing we are searching for an option to give each of the writers for our blog a choice between licences for their piece, ranging from strict copyright too the most loose form of public domain. In this CC-licencing can play a big role, cause they have them all.
    What I now miss with this plugin is just that, give the writers their own form of licencing to pick within the ‘write-post’ section throug a drop down or checkbox functionality.

    Is there anyway you guys allready working on this. And if not, is there any way we can encourage you guys to do so :)

    Hope to hear from you soon.
    Sincerely,
    Albert

  9. GNot Says :

    Hello Albert,

    This would be a nice and useful feature, but sincerely I do not know how much time and effort it will require in order to implement it. I have never studied the code that has to do with user management in wordpress.

    On the other hand, I expect that support for CC licenses becomes part of wordpress itself because, as you have mentioned, licences are very important.

    I would like to extend this plugin’s functionality by making it possible to define a CC licence on a per-post basis and, after yor request, on a per-author basis. The problem is that I have no free time at the moment and there is absolutely nothing that can be done for this right now or in the next 2-3 months. Sorry.

    Moreover, I would encourage you to file a request for support for CC licences in the wordpress trac.

    Best Regards,
    George

  10. Daddo Says :

    Hi,
    Plug works without any problems, nifty little thing,
    I’m not so familiar with php but would like to include the license image like you have over here in my footer, how would I go about this ?
    THX

  11. GNot Says :

    Hi, the plugin provides some template_tags which you can use in your theme templates. To display an image hyperlink of your current licence you can use the following:

    <?php bccl_license_image_hyperlink() ?>
    

    For more info, please read the advanced section of the plugin’s configuration panel.

  12. Daddo Says :

    THANK YOU !!! :)

  13. GNot Says :

    TODO LIST

    * Move this page to a new CC Wiki page

  14. GNot Says :

    Support for creative commons v3 licenses has been added.

    A new release will be available later today.

    Stay tuned ;)

  15. GNot Says :

    Version 0.6 of the plugins has been released. This was a quick fix in order to support the new Creative Commons v3.0 licenses, which would not work with the previous version of the plugin. I would like to thank Dave for reporting this issue.

    How to update:
    - Download and extract the new version of the plugin.
    - Overwrite the old file with the new one.
    - Go to Options->License configuration panel and reset the license (this will also clean the database from any old options)
    - Now follow the instructions in order to add the new license code. Actually this involves pasting the code that you have generated from the creative commons website.

    A new version, which will contain cleaner code will be available in the following weeks. If you encounter any issues with the current 0.6 version, please report them ASAP.

    Thank you

  16. GNot Says :

    The latest and greatest version 1.0 is out.

    This is an almost new plugin! Just try it out! :)

    Upgrade instructions:

    - Reset your current license
    - Install the new version of the plugin by overwriting the old file
    - Go to Options -> License and select your license and options.

    Enjoy!
    :-)

Comments are automatically disabled after a certain period of time. Further discussion about the published content is still possible though in the G-Loaded Forums.