syeda-mal / wp-plugin-creativecommons Goto Github PK

CC WordPress Plugin

Official Creative Commons plugin for licensing your content on your WordPress website. With Creative Commons licenses, keep your copyright and share your creativity.

The plugin is an attribution tool. It has multiple features that allow users to attribute their content by including Creative Commons license (Choose a License) on their WordPress website. This includes default, post, page and media attribution.

CODE_OF_CONDUCT.md:

The Creative Commons team is committed to fostering a welcoming community. This project and all other Creative Commons open source projects are governed by our Code of Conduct. Please report unacceptable behavior to [email protected] per our reporting guidelines.

See CONTRIBUTING.md.

Download the latest version from this project's releases. You can install the plugin to your WP website using any of these methods:

1. In your plugin Dashboard on WordPress, Click Add New and upload the plugin .zip file. When installed, activate the plugin.
2. Extract the .zip file and paste the extracted folder to the "/wp-content/plugins/" directory. Go to your plugin Dashboard and activate the plugin.

After activating the plugin, head to Settings > Creative Commons to set up the default license.

Selecting a license is simple. Select one from the given CC licenses, by default CC BY-SA license is used.

There are multiple options available for the license. You can add:

• Additional attribution text for a custom note.
• Title and Title URL. If not mentioned it defaults to "the content".
• Author and Author URL. If not mentioned it defaults to "on this site".
• Display options.

There are two options to display the default license, as a widget or in the footer. We recommend using the widget for better theme compatibility.

After selecting the widget go to Appearance > Widgets and drag the CC License Widget to the required area. The widget will then display the default license on all pages of the site.

The plugin adds specific Gutenberg blocks for each Creative Commons license. If you are using the default Gutenberg editor, you will find these blocks under a separate category.

These blocks can be used to license any page/post/image or other media.

Following is an image attributed using CC gutenberg block.

At a glance, with WP CC Plugin you can:

• License your site with a default license.
• You can display the default license in the footer or as a widget in widget areas.
• Display license for the site, posts and pages license)
• License your WordPress Network (WordPress Multisite install)
• License some of your sites differently in your WordPress Network
• License some posts, pages, or images differently from your default license (per content license)
• License posts and pages by simply including CC Gutenberg blocks for each license required (Gutenberg License Blocks)

Contributions will be very appreciated. See CONTRIBUTING.md.

A local docker-compose.yml file is included in the ./dev/ directory. It includes an Apache webserver, the latest WordPress installation files, and a mySQL db server utilizing MariaDB.

It is modelled after the official example, given here by WordPress: https://hub.docker.com/_/wordpress/

To run a local development environment for building and testing contributions you can run the following pattern from the root directory of this repository after cloning it.

docker compose -f ./dev/docker-compose.yml [command]

Be sure to substitute [command] for a valid docker compose command, such as:

docker compose -f ./dev/docker-compose.yml up to build and start containers

OR

docker compose -f ./dev/docker-compose.yml down to stop containers

The first time the build process is run via docker compose -f ./dev/docker-compose.yml up, docker will create two directories within your local repository clone:

• ./dev/db where the database and relevant config will be stored
• ./dev/wordpress where the WordPress files will be stored

It will then mount this plugin's root directory into the /wp-content/plugins/ directory of the WordPress installation. Edits made to your local plugin clone will reflect within the build.

You can then navigate to http://localhost:8080/ and proceed with a manual WordPress installation. After the initial installation the WordPress install will persisist between docker sessions.

If you need to reset the WordPress install to a "clean slate" you can simply delete the db and wordpress directories respectively, and then run docker compose -f ./dev/docker-compose.yml up again to initialize a clean install build.

We will release a new version every month that there are substantial changes. See milestones for how GitHub issues are assigned for release.

This plugin is loosely based on an existing, but seemingly abandoned WordPress plugin named 'License' (a component of the MIT Educational Collaboration Space project) by mitcho (Michael Yoshitaka Erlewine) and Brett Mellor. We're also inspired by Creative Commons' original wordpress-cc-plugin written by former Creative Commons CTO Nathan Yergler.

• Michael Yoshitaka Erlewine (License v0.5)
• Brett Mellor (License v0.5)
• Bjorn Wijers
• Matt Lee
• Rob Myers
• Tarmo Toikkanen

• license.txt (GPLv2 or later License)

Thanks goes to these wonderful people (emoji key):

Alan Levine 💻	Brylie Christopher Oxley 💻	Dibyajiban Sahoo 📖	Hugo Solar 💻 👀	Juane Puig 💻	Kriti Godey 📆	Ned Zimmerman 💻
Nishant Mittal 📖	Priscillia Umeakuekwe 📖	Radek Czajka 💻	Rajesh Royal 🌍 💻	Rhea Myers 💻	Stefano Ottolenghi 💻	Timid Robot Zehta 👀 📆
赵丰 (Zhao Feng) 📖 🌍

This project follows the all-contributors specification. Contributions of any kind welcome!