Skip to content

Commit

Permalink
Merge pull request #715 from FarooqAbdullah/version-3.4
Browse files Browse the repository at this point in the history
Version 3.4
  • Loading branch information
the-wooninjas authored Jan 17, 2020
2 parents bd4cca8 + 8fe9066 commit 0e5b22d
Show file tree
Hide file tree
Showing 5 changed files with 110 additions and 154 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
## Changelog

#### 3.4
- New: Added option to update achievement post type and steps slugs
- New: Added option to approve/deny nominations/submissions in bulk
- New: Added new shortcode to display earned achievements for logged in user
- New: Added new shortcode to display earned points for logged in user
- New: Added new shortcode to display earned ranks for logged in user
- New: Added new filters
- Fix: Fixed site loading issue
- Fix: Displayed approved/denied submissions/nominations on front-end
- Fix: Fixed duplicate submission/nomination awarding issue
- Fix: Fixed email notification issue

#### 3.3
- New: Set default point type as point type id parameter in badgeos_get_points_by_type()
- New: Added post attributes for BadgeOS Rank Type posts
Expand Down
135 changes: 54 additions & 81 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,14 @@
About BadgeOS [![Build Status](https://travis-ci.org/opencredit/badgeos.png?branch=master)](https://travis-ci.org/opencredit/badgeos)
============
Easily create badges and set up the steps and achievements users complete to earn them. Badges are Mozilla OBI compatible and sharable via Credly. Official website: [BadgeOS.org](http://badgeos.org).
BadgeOS turns your site into an achievement and badging system. Easily create badges and set up the steps and achievements users complete to earn them.


Description
------------

**Major Release (3.0):**
This is a major release of BadgeOS in which we have added separate point type options so that you can create multiple point types to award/deduct points. We have also added ranks in this version so you can awards ranks to your users on completing the events. We strongly recommend you to update below add-ons too as older versions of these add-ons won't work with this major release.
Note: You may have to update all the existing badges too in order to sync the point types data.
* [BadgeOS Interactive Progress Map](https://badgeos.org/downloads/interactive-progress-map/ "BadgeOS Interactive Progress Map")
* [BadgeOS Leaderboards](https://badgeos.org/downloads/leaderboards/ "BadgeOS Leaderboards")
* [BadgeOS Congratulation](https://badgeos.org/downloads/congratulations/ "BadgeOS Congratulation")
* [BadgeOS Reports add-on](https://badgeos.org/downloads/reports/ "BadgeOS Reports add-on")
* [BadgeOS Community add-on](https://wordpress.org/plugins/badgeos-community-add-on/ "BadgeOS Community add-on")
* [BadgeOS LearnDash](https://wordpress.org/plugins/badgeos-learndash-add-on/ "BadgeOS Auto LearnDash")
[BadgeOS](http://badgeos.org "BadgeOS")™ turns your WordPress site into an achievement, badging and engagement management system. Your users complete steps, demonstrate skills and knowledge, and earn digital badges/points/ranks. Easily define the achievements, organize the badge requirements any way you like, and choose from and combine a range of assessment options to determine whether each task or requirement has been achieved.

After updating the plugin to 3.0, You will need to update the users' earning and achievements. Follow the steps below to update them.

**Note: please clear the cache of the site before updating the user's earning and existing achievements.**

**Update users' earned achievements and points:**
- Update the BadgeOS to 3.1 or greater
- Go to Dashboard -> BadgeOS -> Point Type
- Create a new point type (if not created already)
- Go to Dashboard -> BadgeOS -> Settings
- Select the default point type and click on save settings button
- Click on the "Upgrade 3.0 DB" button

**Update existing achievements:**
- Update the BadgeOS to 3.2 or greater
- Go to Dashboard -> BadgeOS -> Point Type
- Create a new point type (if not created already)
- Go to Dashboard -> BadgeOS -> Settings
- Select the default point type and click on save settings button
- Click on the "Upgrade Achievements" button

[BadgeOS](http://badgeos.org "BadgeOS")™ turns your WordPress site into an achievement and badging system. Your site's users complete steps, demonstrate skills and knowledge, and earn digital badges. Easily define the achievements, organize the badge requirements any way you like, and choose from and combine a range of assessment options to determine whether each task or requirement has been achieved.

Create badges and set up the achievements to earn them. Badges are Mozilla OBI compatible and sharable via [Credly](https://credly.com/ "Credly.com"), the free web service for managing and displaying lifelong credentials.
Create badges and set up the achievements/points/ranks to earn them. Badges are Mozilla OBI compatible and shareable via BadgeOS Social Share add-on

BadgeOS is extremely powerful and infinitely extensible. Check out some of the out-of-the-box features:

Expand All @@ -48,95 +18,101 @@ BadgeOS is extremely powerful and infinitely extensible. Check out some of the o
* Reviewed submissions
* Auto-approving submissions
* Nominations and review
* Site activity (triggers based on commenting and logging in to your site)
* Site activity (triggers based on publising posts and pages, commenting and logging in to your site)
* Completing specific other achievements one or a specific number of times
* Completing one, select or all achievements of a specific type
* Point thresholds
* Admin Given Badges
* Option to Award/Revoke Badges/Points/Ranks in bulk
* Point/Rank award on completing the required steps/triggers
* Admin Given Badges/Points/Ranks
* Option to transfer points to other users via BadgeOS Transfer Points add-on
* Community Activity (with the powerful [BadgeOS Community Add-on](http://wordpress.org/extend/plugins/badgeos-community-add-on/ "BadgeOS Community Add-on"))
* Activity from other popular WordPress plugins (see growing catalog of [BadgeOS Add-ons](http://badgeos.org/add-ons/ "BadgeOS Add-ons"))
* Integration with [LearnDash](https://badgeos.org/downloads/badgeos-learndash-pro/ "BadgeOS LearnDash Pro") and [LifterLMS](https://badgeos.org/downloads/lifterlms-badgeos-integration/ "BadgeOS LifterLMS Integration")
* Integration with [EDD](https://badgeos.org/downloads/badgeos-edd-integration-addon/ "BadgeOS EDD Integration") and [WooCommerce](https://badgeos.org/downloads/badgeos-woocommerce-integration/ "BadgeOS WooCommerce Integration")
* See growing catalog of [BadgeOS Add-ons](http://badgeos.org/add-ons/ "BadgeOS Add-ons").

**Define an Unlimited Number of Achievement Types**

* Create as many types of achievement as you like
* Name achievement types whatever you wish
* Easily define how they relate to one another using the 'Required Steps' tool
* Set default images for each achievement type or select unique images for every achievement item.
* Set default images for each achievement type or select unique images for every achievement item

**Define an Unlimited Number of Rank Types**

* Create as many types of rank as you like
* Name rank types whatever you wish
* Easily define how they relate to one another using the 'Required Steps' tool
* Set default images for each rank type or select unique images for every achievement item

**Define an Unlimited Number of Point Types**

* Create as many types of points as you like
* Name point types whatever you wish
* Easily define how they relate to one another using the 'Required Steps' tool
* Set default images for each rank type or select unique images for every achievement item

**Design Beautiful Badge and Achievement Images from within WordPress**

* Use the integrated Credly "[Badge Builder](https://credly.com/badge-builder-home "Credly tool for designing badge images")" to create professional looking badge images right from within WordPress
* Launch the Badge Builder from any achievement or achievement type editing screen in WordPress admin
* Use "[BadgeOS Badge Builder]( https://badgeos.org/downloads/badgeos-badge-builder/ "BadgeOS Badge Builder" )" to create professional looking badge/point/rank images right from within WordPress
* Launch the Badge Builder from any achievement/point/rank types editing screen in WordPress admin
* Choose from a variety of badge shapes and border styles
* Select from a library of thousands of Noun Project icons, or upload your own to the center of any badge
* Add or remove a banner with text to your badge
* Full color palette selection for border, fill, icon and banner
* Saves automatically to your WordPress Media Library for easy re-use for other achievements or anywhere else on your site
* Edit previously created badge and achievement images and save new versions to your Media Library
* Simply enter your Credly credentials in the "Credly Integration" settings menu in BadgeOS to enable the Badge Builder. If you don't have a [Credly](https://credly.com/ "Credly lets you create and manage lifelong achievements") account, [create](https://credly.com/#!/create-account "Create a free Credly account") one for free.


**Sharable Badges with Credly Integration**

* Badges are Mozilla Open Badge (OBI) compatible through [integration](http://badgeos.org/about/credly-integration/ "Credly Integration") of the "Open Credit" API by [Credly](https://credly.com/ "Credly.com"), the free web service for issuing, earning and sharing badges.
* Connect your Credly account to your BadgeOS site and voila! You're using WordPress to issue "Open Badges" that can be displayed virtually anywhere.
* Badges you create in BadgeOS automatically appear and update on Credly
* Use Credly iOS app to issue badges you created on your WordPress site.
* As badges are earned on WordPress, they can be automatically sent to Credly for easy sharing on Facebook, LinkedIn, Twitter, Mozilla Backpack, the earner's own web site, blog, or Credly profile.
**Sharable Badges**

* Badges are Mozilla Open Badge (OBI) compatible through integration of the "[BadgeOS Social Sharing](https://badgeos.org/downloads/badgeos-social-sharing/ "BadgeOS Social Sharing" )" add-on
* Share earned OB standard badges to Facebook, Twitter, Linked Inn, and any other platform using embed code
* Allowed Badges can be automatically baked into OB standard badges

**'Required Steps' Manager**

* Simple yet powerful admin interface for defining the "Required Steps" for any badge or achievement.
* Easily link together one or more triggers, steps or actions into the conditions needed to earn a badge or mark an achievement.
* Extend the Required Steps options using the free [BadgeOS Community Add-on](http://wordpress.org/extend/plugins/badgeos-community-add-on/ "BadgeOS Community Add-on")
* Also extend Required Steps with other [BadgeOS Add-ons](http://badgeos.org/add-ons "BadgeOS Add-ons")

* Simple yet powerful admin interface for defining the "Required Steps" for any badge or achievement/Points/Ranks.
* Easily link together one or more triggers, steps or actions into the conditions needed to earn a badge/Points/Ranks or mark an achievement.
* Extend the Required Steps options using the free [BadgeOS Community Add-on](http://wordpress.org/extend/plugins/badgeos-community-add-on/ "BadgeOS Community Add-on").
* Also extend Required Steps with other [BadgeOS Add-ons](http://badgeos.org/add-ons "BadgeOS Add-ons").

**Reward User Progress**

* Issue badges for any combination of achievements
* Award points for commenting, logging in, making submissions, completing tasks
* Award points for commenting, logging in, making submissions, completing any combination of tasks
* Display a congratulatory message, customizable per Achievement, on each achievement page.


**View and Issue your BadgeOS badges via iOS Mobile App**

* Badges created in BadgeOS are immediately available on the Credly iOS mobile app (with free Credly integration enabled).
* Create badges in WordPress, and then issue them from your iPhone!
* BadgeOS badge earners can receive, accept, view and share their badges from the iOS app (with their profile set to receive badges via Credly).
* Credly app's "ID Card" view essentially turns a BadgeOS badge into an "access pass" for face-to-face activities.


**Earned Achievements Widget**

* Shows logged in users what badges they have earned.
* Option to choose which specific achievement types to display in the widget.
* Set the parameters for the widget to decide how many recent badges to display.
* Shows logged in users what badges/points/ranks they have earned.
* Option to choose which specific achievement/points/ranks types to display in the widget.
* Set the parameters for the widget to decide how many recent badges/ranks to display.
* Option to show logged in users total points they have earned (if you are using BadgeOS points mechanism).
* Members can share their badges right from the widget to their Credly profile and off to their linked social networks or Mozilla Backpack.


**Theme Agnostic & Shortcodes**

* BadgeOS works with just about any standard WordPress theme.
* No special hooks or theme updates are needed.
* Turn any page or post into a way to display available achievements and for users to track their progress.
* Multiple options and parameters for each for great flexibility.
* Turn any page or post into a way to display available achievements/points/ranks and for users to track their progress.
* Multiple options and parameters for each shortcode for great flexibility.
* Shortcode WYSIWYG embedder - appears in the toolbar of all WordPress content editor areas, allowing you to transform any page or post into part of your achievement system -- without referencing any of the shortcodes.
* Shortcodes to bring submission and nomination review to the front-end of your site.
* Shortcode to integrate specific available achievements into any post or page of your site.
* Shortcode for Credly "[Custom Assertion Location](http://blog.credly.com/custom-assertion-location/ "Credly Custom Redirection")" for displaying badges issued by Credly Pro users on your site
* [Shortcode documentation](http://badgeos.org/support/shortcodes/ "BadgeOS Shortcodes") in the plugin menu and on BadgeOS.org.
* Just activate BadgeOS and place simple shortcodes on any page or post, and you've got an engagement management system running on your WordPress site!


**Submission and Nomination Review**

* Easily review submissions and nominations from members.
* Approve or deny submissions with one click
* Approve or deny submissions with one click.
* Shortcodes with multiple options for review of submissions on any page or post on your site.
* Powerful shortcodes to add an achievement submission or nomination form to any post or page.
* Add comments to engage the member and elaborate on your decisions.
* Optional notification emails inform you when people on your site have made submissions or nominated peers.
* Shortcodes for easily creating front-end pages for displaying submissions and nominations.
* Submission Notification Settings: Specify an unlimited number of email addresses for submission admin notifications.
* Notifications for: new submissions, new comments, and submission status changes
* Filter Submissions to only show those from members of specific BuddyPress Groups (requires plugins: [BuddyPress](http://wordpress.org/extend/plugins/buddypress/ "BuddyPress") and [BadgeOS Community Add-on](http://wordpress.org/extend/plugins/badgeos-community-add-on/ "BadgeOS Community Add-on"))


Extensibility and BadgeOS Add-ons
Expand All @@ -149,19 +125,16 @@ Extensibility and BadgeOS Add-ons

Stay Connected / Helpful Links
------------
BadgeOS is made available by [LearningTimes, LLC](http://www.LearningTimes.com/ "LearningTimes web site"). Here are some ways to stay connected and to see what else we are up to:
BadgeOS is made available by [LearningTimes, LLC](http://www.learningtimes.com/ "LearningTimes web site"). Here are some ways to stay connected and to see what else we are up to:

* [BadgeOS.org](http://badgeos.org/ "BadgeOS web site") - Contact Us, Video Tutorials, Examples, News
* [LearningTimes](http://www.learningtimes.com/ "LearningTimes web site") - Bringing people together through engaging online conferences, events and activities.
* [Credly.com](https://credly.com/ "Credly web site") - Manage lifelong credentials that matter
* [LearningTimes](http://www.learningtimes.com "LearningTimes web site") - Online learning programs, development and expertise
* [BadgeOS Developer Resources](http://badgeos.org/developers "BadgeOS Developer Docs and APIs") - Open documentation, APIs and resources for BadgeOS developers.
* [Credly Knowledgebase](http://support.credly.com/ "Credly FAQ and Support") - Credly FAQ
* [Facebook](https://www.facebook.com/LearningTimes "LearningTimes on Facebook") - LearningTimes on Facebook
* [Twitter](https://twitter.com/LearningTimes "LearningTimes on Facebook") - LearningTimes Tweets
* [Facebook](https://web.facebook.com/groups/1899542540365937/ "BadgeOS on Facebook") - BadgeOS on Facebook
* [Twitter](https://twitter.com/BadgeOs "BadgeOS on Twitter") - BadgeOS Tweets
* [E-Mailing List](http://badgeos.org/join-list/ "BadgeOS Occasional Mailing List - No spam!") - Occasional updates via e-mail
* [GitHub](https://github.com/opencredit/badgeos "BadgeOS on GitHub") - Report issues, contribute code


License Info
------------

Expand All @@ -174,7 +147,7 @@ Installation
------------
1. Upload 'badgeos' to the '/wp-content/plugins/' directory of your WordPress installation
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Visit the BadgeOS menu to add Badges and set up new Achievement Types.
3. Visit the BadgeOS menu to add Badges and set up new Achievement/Point/Rank Types.
4. Enter Credly credentials for the badge Issuer in the Credly Integration settings to enable badge sharing. (First get free account at Credly.com if you do not have one.)
5. Visit the Help/Support section of the BadgeOS menu for shortcodes to turn any page or post on your site into a BadgeOS list of available achievements and badges.

Expand Down
4 changes: 2 additions & 2 deletions badgeos.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Plugin URI: http://www.badgeos.org/
* Description: BadgeOS lets your site’s users complete tasks and earn badges that recognize their achievement. Define achievements and choose from a range of options that determine when they're complete. Badges are Mozilla Open Badges (OBI) compatible through integration with the “Open Credit” API by Credly, the free web service for issuing, earning and sharing badges for lifelong achievement.
* Author: LearningTimes
* Version: 3.3
* Version: 3.4
* Author URI: https://credly.com/
* License: GNU AGPL
* Text Domain: badgeos
Expand Down Expand Up @@ -33,7 +33,7 @@ class BadgeOS {
*
* @var string
*/
public static $version = '3.3';
public static $version = '3.4';

function __construct() {
// Define plugin constants
Expand Down
4 changes: 4 additions & 0 deletions includes/admin-settings.php
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,10 @@ function badgeos_settings_page() {
<th scope="row"><label for="log_entries"></th>
<td>&nbsp;</td>
</tr>
<tr valign="top">
<th scope="row"><label for="notice"><?php echo __( 'Note' . ': ', 'badgeos' ); ?></th>
<td><?php echo __( 'We strongly recommend you to take back up of database first when updating the post_types slugs. Also make sure that slugs should not exceeded than 18 characters.', 'badgeos' ); ?></td>
</tr>
<tr valign="top">
<th scope="row"><label for="achievement_main_post_type"><?php _e( 'Achievement Post Type:', 'badgeos' ); ?></label></th>
<td>
Expand Down
Loading

0 comments on commit 0e5b22d

Please sign in to comment.