Changeset 1594991
- Timestamp:
- 02/13/2017 02:35:36 PM (9 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
feed-widget-for-runkeeper-activities/trunk/readme.txt
r1594981 r1594991 9 9 License URI: https://www.gnu.org/licenses/gpl-2.0.html 10 10 11 Displays a widget showing your latest Runkeeper activities. May also be called from a shortcode. 11 May also be called from a shortcode. 12 Displays a widget showing your latest Runkeeper activities. 12 13 13 14 == Description == 14 15 15 This widget shows your latest activities from runkeeper.com. The number of activities can be configured, as can the values that are being displayed (distance, speed, duration, calories burned). The widget may also be called using the [runkeeper] shortcode. 16 This widget shows your latest activities from [Runkeeper](https://runkeeper.com/home). The number of activities can be configured, as can the values that are being displayed (distance, speed, duration, calories burned). 17 The widget may also be called using the **[runkeeper]** shortcode. 16 18 17 A little bit of effort is required to set it up, but it's worth it, because this way, no third partywill ever get access to your data. Everything stays between your WordPress site and Runkeeper.19 A little bit of effort is required to set it up, but it's worth it, because this way, **no third party** will ever get access to your data. Everything stays between your WordPress site and Runkeeper. 18 20 19 21 == Installation == 20 You need to create a Runkeeper Application first.It's worth it, because this way, no third party will ever get access to your data. Everything stays between your WordPress site and Runkeeper.22 **You need to create a Runkeeper Application first.** It's worth it, because this way, no third party will ever get access to your data. Everything stays between your WordPress site and Runkeeper. 21 23 22 1. Go to the [Runkeeper Partner Portal](https://runkeeper.com/partner)24 1. Go to the **[Runkeeper Partner Portal](https://runkeeper.com/partner)**. 23 25 1. If asked, log in with your Runkeeper credentials. 24 1. Click "Connect To Our API", or click "Applications" at the top. 25 1. Click "Register a New Application". 26 1. Fill in "Application Name", "Description", and "Organization". It doesn't really matter what values you enter, but it's best to use sensible values anyway. *(**Example:** Application Name: "Runkeeper Feed Widget", Description: "A WordPress plugin that displays a Runkeeper activity feed.", Organization: [Your blog title])*. Then scroll down and click "Register Application". 27 1. In the "My Applications" overview, click "Keys and URLs" below your WordPress application. 28 1. Leave this window open, you will soon need the "Client ID" and "Client Secret". 26 1. Click **"Connect To Our API"**, or click "Applications" at the top. 27 1. Click **"Register a New Application"**. 28 1. Fill in **"Application Name"**, **"Description"**, and **"Organization"**. It doesn't really matter what values you enter, but it's best to use sensible values anyway. 29 *(**Example:** Application Name: "Runkeeper Feed Widget", Description: "A WordPress plugin that displays a Runkeeper activity feed.", Organization: [Your blog title])*. 30 Then scroll down and click **"Register Application"**. 31 1. In the "My Applications" overview, click **"Keys and URLs"** below your WordPress application. 32 1. Leave this window open, you will soon need the **"Client ID"** and **"Client Secret"**. 29 33 30 Now you are ready to enable and connect the plugin: 34 **Now you are ready to enable and connect the plugin:** 31 35 32 1. Extract the plugin folder to your "wp-content/plugins" directory. 33 1. Activate the plugin through the "Plugins" menu in WordPress. 34 1. Go to "Widgets" in your WordPress backend and add the "Runkeeper Feed Widget" to your page. Alternatively, you may insert the widget in a page or post using the [runkeeper] shortcode. 35 1. Visit the page on your website where the widget is supposed to show up. Follow the instructions there to connect the widget to your Runkeeper account, using the "Client ID" and "Client Secret" from step 8. (You need to be logged into your WordPress as admin in order to do this.) 36 1. **Extract** the plugin folder to your "wp-content/plugins" directory. 37 1. **Activate** the plugin through the "Plugins" menu in WordPress. 38 1. Go to "Widgets" in your WordPress backend and **add the "Runkeeper Feed Widget" to your page**. 39 Alternatively, you may insert the widget in a page or post using the **[runkeeper]** shortcode. 40 1. **Visit the page on your website where the widget is supposed to show up.** Follow the instructions there to connect the widget to your Runkeeper account, using the "Client ID" and "Client Secret" from step 8. 41 *(You need to be logged into your WordPress as admin in order to complete this last step.)* 36 42 37 43 == Frequently Asked Questions == … … 39 45 = How to configure the widget when called from the shortcode? = 40 46 41 The shortcode offers all the same options that are available when adding the widget from the "Widgets" page. You can use them like this (the values given here are the defaults):47 If you only use the **[runkeeper]** shortcode without any options, a widget with default settings will be displayed. However, if you'd like to customize it, the shortcode offers all the same options that are available when adding the widget from the "Widgets" page. You can use them like this *(the values given here are the defaults)*: 42 48 43 [runkeeper title="" numposts=5 unit="km" showlogo=true showdate=true showtime=true showdistance=true showduration=true showspeed=false showcalories=false dateformat="n/j/Y" timeformat="g:i a"] 49 **[runkeeper title="" numposts=5 unit="km" showlogo=true showdate=true showtime=true showdistance=true showduration=true showspeed=false showcalories=false dateformat="n/j/Y" timeformat="g:i a"]** 44 50 45 51 Notes: 46 52 47 53 * **numposts** defines how many recent activities to display. 48 * **unit** can be "km" or "miles".54 * **unit** can be *"km"* or *"miles"*. 49 55 * **showtime=true** will only display the time, if showdate is true as well. 50 * **dateformat** and * timeformat* take a [PHP date format](http://php.net/manual/en/function.date.php).56 * **dateformat** and **timeformat** take a [PHP date format](http://php.net/manual/en/function.date.php). 51 57 52 58 == Screenshots == 53 59 54 60 1. Widget with default settings. 55 2. Di splayed values can be customized, and the plugin is translation-ready.61 2. Different values can be selected for display, and the plugin is translation-ready. 56 62 3. Backend widget options. 57 63
Note: See TracChangeset
for help on using the changeset viewer.