forked from codelion7/BadgeOS-LearnDash-Add-on
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreadme.txt
141 lines (85 loc) · 9.2 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
=== BadgeOS LearnDash Add-on ===
Contributors: badgeos, learningtimes, webdevstudios, sc0ttkclark
Donate link: http://badgeos.org/contribute/donate/
Tags: learndash, badge, badges, openbadges, learningtimes, OBI, mozilla, open badges, achievement, award, reward, engagement, submission, nomination, API, open credit, credit
Requires at least: WordPress 3.5 & BadgeOS 1.2
Tested up to: 3.6
Stable tag: 1.0.0
License: GNU AGPLv3
License URI: http://www.gnu.org/licenses/agpl-3.0.html
BadgeOS achievements and badges earned from a wide array of LearnDash learning management system activity.
== Description ==
The "BadgeOS LearnDash Add-on" allows learners to earn achievements and badges from virtually every course, lesson and quiz activity available in the LearnDash learning management system. When activated, BadgeOS admins will see a new "LearnDash Activity" menu in their "Required Steps" manager when editing or creating any achievement or badge.
**Note:** You will need to install the free [BadgeOS plugin](http://wordpress.org/extend/plugins/badgeos/ "BadgeOS")™ (version 1.2 or higher) to use the BadgeOS LearnDash Add-on. You will also need the [LearnDash plugin](http://www.learndash.com "LearnDash") v1.4 or higher installed, available from LearnDash.com.
[Get the BadgeOS plugin](http://wordpress.org/extend/plugins/badgeos/ "BadgeOS").
[Get the LearnDash plugin](http://www.learndash.com/ "LearnDash").
[BadgeOS](http://badgeos.org "BadgeOS")™ turns your WordPress site into an achievement and badging system. And with LearnDash enabled on your site, badges are not only awarded by activities such as making submissions, earning points, completing required achievements, and making site and community contributions, but also by completing LearnDash courses, lessons, courses and quizzes. Define the achievements, organize the badge requirements any way you like, and choose from and combine a range of BadgeOS and LearnDash activity options to determine whether each task or requirement has been achieved.
Earned badges are Open Badge compatible and sharable via [Credly](https://credly.com/ "Credly.com"), the free web service for displaying, storing and managing lifelong achievement.
**New ways to define achievements and give badges for LearnDash activity**
In addition to all of the out-of-the-box features in BadgeOS core, the BadgeOS LearnDash Add-on allows you to award achievements and badges based on these additional triggers:
* **Courses:**
* Complete a specific Course
* Complete any Course
* Complete a course from a specific Tag
* **Lessons:**
* Complete a specific Lesson
* Complete any Lesson
* **Quizzes:**
* Pass a specific Quiz
* Pass any Quiz
* Achieve a minimum percent grade on a specific Quiz
* Achieve a minimum percent grade on any Quiz
* Fail a Quiz (i.e. useful for rewarding the passing of a previously failed quiz)
**Combine LearnDash Steps with BadgeOS Steps in Defining Achievements**
* Simple interface for defining the "Required Steps" for any badge or achievement seamlessly integrates LearnDash actions
* Easily define achievements that rely on both BadgeOS required steps and LearnDash actions
* Easily link together one or more triggers, steps or actions into the conditions needed to earn any badge or mark an achievement.
**LearnDash Badges are Lifelong Achievements with Credly Integration**
* As badges are earned on WordPress using BadgeOS and LearnDash, they can be automatically sent to Credly for lifelong storage, management, and sharing on Facebook, LinkedIn, Twitter, Mozilla Backpack, the earner's own web site, blog, or Credly profile.
* Badges you create in BadgeOS automatically appear and update on Credly, the home for storing and managing lifelong achievements.
* As with the BadgeOS core plugin, LearnDash badges are Mozilla Open Badge (OBI) compatible through integration of the "Open Credit" API by [Credly](https://credly.com/ "Credly.com"), the free web service for issuing, earning and sharing badges.
* Use the Credly iOS app to issue LearnDash badges you created on your WordPress/BadgeOS/LearnDash site.
**Display Badges on User Profiles with Free Community Add-on **
* Activate the free "[BadgeOS Community Add-On](http://wordpress.org/plugins/badgeos-community-add-on/ "BadgeOS Community Add-on")" and "[BuddyPress](http://wordpress.org/plugins/buddypress/ "BuddyPress")" plugins to add a range of user community functions, including the ability to display earned badges and achievements on user profiles for others to see.
= Extensibility and Additional BadgeOS Add-ons =
* BadgeOS is designed to be a true operating system for turning any WordPress site into an engagement management application.
* Built with expandability in mind to allow virtually anything to trigger and recognize achievement.
* BadgeOS plans to continue to release a range of Add-Ons to the plugin -- like the BadgeOS LearnDash Add-on -- that enhance core functionality with specialized functions.
* Check out some of the [BadgeOS customizations](http://badgeos.org/services/badgeos-customization/ "We'll help you customize your BadgeOS site") we've already implemented to get a sense for what you might expect.
= 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.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.
* [Facebook](https://www.facebook.com/LearningTimes "LearningTimes on Facebook") - LearningTimes on Facebook
* [Twitter](https://twitter.com/LearningTimes "LearningTimes on Facebook") - LearningTimes Tweets
* [E-Mailing List](https://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
== Installation ==
1. Upload, activate and configure the free [BadgeOS v1.2 (or later) plugin](http://wordpress.org/extend/plugins/badgeos/ "BadgeOS") to WordPress.
2. Upload, activate and configure the [LearnDash plugin](http://www.learndash.com/ "LearnDash") to WordPress.
3. Upload 'badgeos-LearnDash' to the '/wp-content/plugins/' directory
4. Activate the plugin through the 'Plugins' menu in WordPress
5. Add LearnDash action requirements to any new or existing achievement item using the "Required Steps" manager, with your “Earn by” menu set to "Completing Steps."
6. Ensure that you have entered the Credly credentials for the badge Issuer in the Credly Integration settings of BadgeOS core to enable badge sharing.
== Frequently Asked Questions ==
= Any ideas for making badge images? =
Yes! You can start at [Credly.com](https://credly.com/ "Badge Builder Tool") and use the badge builder there to create beautiful looking badges.
= Can you help us design custom badge images? =
Yes, our designers are available to create custom badges that represent your brand, the kind of achievements you recognize, and the audience you are reaching. From a single badge to a complete constellation, our team of professional badge designers get to know your needs through a tested Badge Design Process which consistently produces successful and delightful results.
See examples and learn more at: [http://badgeos.org/services/badge-design/](http://badgeos.org/services/badge-design/ "Badge Design")
= Do you offer services to help us design, build or customize our BadgeOS site? =
Yes, we do. We especially enjoy working on innovative projects with forward-thinking teams extending achievement recognition into new environments and surfacing achievement in new ways. See [examples](http://badgeos.org/about/sample-sites/ "Sample pojects") and learn more at: [http://badgeos.org/services/badgeos-customization/](http://badgeos.org/services/badgeos-customization/ "BadgeOS Customization").
= Where should I report issues or bugs? =
The ideal place for bug and issue reporting is on the [GitHub](https://github.com/opencredit/badgeos "BadgeOS on GitHub") site for the BadgeOS project.
= Where should I contribute code back to the project? =
Thanks for asking! Please do share back code modifications or enhancements you make for inclusion in BadgeOS core or as add-ons. (Functions that are specialized for just some users are likely best as add-on plugins to BadgeOS. We can help figure that out with you.) Visit us on [GitHub](https://github.com/opencredit/badgeos "BadgeOS on GitHub") to share your code with the BadgeOS LearnDash.
== Screenshots ==
1. "LearnDash Activity" joins multiple other BadgeOS methods for awarding and defining achievements.
2. Make any LearnDash activity an achievement worthy of a digital badge: completing lessons, courses, quizzes and more.
3. Earned badges on your BadgeOS LearnDash site are "Open Badges" that are sharable via Credly to virtually any social network, site, blog or the Mozilla Backpack.
== Changelog ==
= 1.0 =
* BadgeOS LearnDash Add-on says "hello learndash", earns "Hello LearnDash" badge.
== Upgrade Notice ==
= 1.0 =
* Initial release