Plugin Directory

Changeset 2263563


Ignore:
Timestamp:
03/19/2020 02:25:08 AM (6 years ago)
Author:
vincentastolfi
Message:

Update readme.txt with Vimeo and WooCommerce affiliation disclaimer

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wc-vimeo/trunk/readme.txt

    r2263475 r2263563  
    1313
    1414== Description ==
     15
     16This plugin & its author are in no way affiliated with Vimeo or WooCommerce; this is an open source project to link the two.
    1517
    1618With Video Sales for Woocommerce with Vimeo, selling access to your Vimeo videos via WooCommerce has never been easier. Vimeo allows you to password protect your videos, and we can utilize this feature to allow us to sell premium access to those password protected videos!
     
    3234= How do I get Vimeo API credentials for the plugin configuration page? =
    3335
    34 * Go to https://developer.vimeo.com/apps/new (Log in or create in account if you don't have one already)
     36* Go to [https://developer.vimeo.com/apps/new](https://developer.vimeo.com/apps/new) (Log in or create in account if you don't have one already)
    3537* Select a name and description for your app; these are arbitrary, but you can set something like "Vimeo Woocommerce" if you'd like
    3638* For the "Will people besides you be able to access your app?" option, select "No"
     
    4345* Click the gray "Generate" button just below the checkboxes
    4446* Immediately copy that token you generated into your configuration options; it will not be accessible once you reload this page
    45 * Also copy your Client Secret and Client Identifier into the Video Sales for Woocommerce with Vimeo plugin options at https://your-site.com/wp-admin/admin.php?page=wc-settings&tab=vimeo (see screenshot 1)
     47* Also copy your Client Secret and Client Identifier into the Video Sales for Woocommerce with Vimeo plugin options at [https://your-site.com/wp-admin/admin.php?page=wc-settings&tab=vimeo](https://your-site.com/wp-admin/admin.php?page=wc-settings&tab=vimeo) (see screenshot 1)
    4648* Save -- you're good to go!
    4749
     
    5052Products with Vimeo videos selected have a lot of extra meta data associated with the Vimeo video stored on them. You can access this data in your email templates, as it is stored as custom fields on the Product. The names of the custom fields are:
    5153
    52 * `wc_vimeo_id`: The ID of the Vimeo video; the ID in the Vimeo URL http://vimeo.com/**18293829**
     54* `wc_vimeo_id`: The ID of the Vimeo video; the ID in the Vimeo URL https://vimeo.com/**18293829**
    5355* `wc_vimeo_password`: The password needed to access the video (will only be set if video is password protected at Vimeo)
    54 * `wc_vimeo_link`: The link to the Vimeo video (this is a full link http://vimeo.com/18293829)
     56* `wc_vimeo_link`: The link to the Vimeo video (this is a full link [https://vimeo.com/18293829](https://vimeo.com/18293829))
    5557* `wc_vimeo_name`: The name, or title of the Vimeo video
    5658* `wc_vimeo_uri`: The uri of the Vimeo video (this is the link without the leading domain, e.g. /18293829)
     
    6264This plugin works by setting meta data from the Vimeo video on the Product when you select a video. There are many ways to deliver this meta data to your users on purchase of a product.
    6365
    64 One way is to create an email template in your theme. See the sample gist here: https://gist.github.com/astolfivincent/42cc9359d6b616675d70659e6de6f7a4
     66One way is to create an email template in your theme. See the sample gist here: [https://gist.github.com/astolfivincent/42cc9359d6b616675d70659e6de6f7a4](https://gist.github.com/astolfivincent/42cc9359d6b616675d70659e6de6f7a4)
    6567
    66 Copy the content of the gist. In your theme (or child theme's) folder create a file at /woocommerce/emails/customer-completed-order.php and copy the contents of the gist into that file. So the full directory would be /wp-content/themes/{your theme or child theme}/woocommerce/emails/customer-completed-order.php
     68Copy the content of the gist. In your theme (or child theme's) folder create a file at `/woocommerce/emails/customer-completed-order.php` and copy the contents of the gist into that file. So the full directory would be `/wp-content/themes/{your theme or child theme}/woocommerce/emails/customer-completed-order.php`
    6769
    6870This gist gives some examples of how to access the Video data in your confirmation email, but you could do something similar in the processing email or other confirmation emails. You can edit this file and reformat it to suit your styling tastes.
    6971
    70 For more information about custom WooCommerce emails,  see the section called "Creating Custom Templates with Code" at https://woocommerce.com/posts/how-to-customize-emails-in-woocommerce/
     72For more information about custom WooCommerce emails,  see the section called "Creating Custom Templates with Code" at [https://woocommerce.com/posts/how-to-customize-emails-in-woocommerce/](https://woocommerce.com/posts/how-to-customize-emails-in-woocommerce/)
    7173
    7274= I just uploaded a video to Vimeo, but it's not showing up in the list of Vimeo videos when I create a product =
     
    7880Note that depending on how many videos you have at Vimeo, making requests to get video data can be resource intensive. If you have many videos, you might consider increasing the cache clearing interval.
    7981
    80 You can change the cache clear interval or clear the cache manually at https://your-site.com/wp-admin/admin.php?page=wc-settings&tab=vimeo (see screenshot 2)
     82You can change the cache clear interval or clear the cache manually at [https://your-site.com/wp-admin/admin.php?page=wc-settings&tab=vimeo](https://your-site.com/wp-admin/admin.php?page=wc-settings&tab=vimeo) (see screenshot 2)
    8183
    8284== Screenshots ==
Note: See TracChangeset for help on using the changeset viewer.