Git Product home page Git Product logo

craft-webmention-client's Introduction

Craft Webmention Client Plugin

This plugin for the Craft CMS allows you to send webmentions to other websites. From the IndieWebCamp wiki:

Webmention is a modern update to Pingback, using only HTTP and x-www-urlencoded content rather than XMLRPC requests.

This plugin provides a client for sending notifications to others that your entry has mentioned a URL on the receiver's website. More information on the webmention protocol can be found at http://webmention.org/.

Installation

To install the Webmention Client plugin, do the following:

  1. Move the webmentionclient folder to your craft/plugins folder.
  2. In the Craft control panel, go to Settings > Plugins and install the Webmention Client plugin.

That's it!

Usage

Create a new "Webmention (targets)" Field

First, create a new field and select "Webmention (targets)" as the Field Type. In the example screenshot above, we're using "Mentioned URLs" as the field's name.

After creating the new field, add it to the Field Layout for one or more of your site's Entry Types.

Create a new entry

In your newly-created field ("Mentioned URLs" above), add the URLs–one per line—mentioned in the entry's body field (or fields). When you save the entry, the plugin will detect webmention support for each URL and send a notification as necessary.

In the example screenshot above, the URL http://adactio.com/journal/6495/ is referenced in the body and added to the list of mentioned URLs below. When this entry is saved, the plugin will ping that URL, looking for a webmention endpoint. If one is found, the plugin will send a webmention to that endpoint, notifying Jeremy that someone has referenced his work.

Acknowledgements

The core functionality of this plugin is based heavily on Aaron Parecki's mention-client-php.

Additionally, the plugin makes use of the following utility methods:

Finally, many thanks to Trevor Davis for his Craft plugin development expertise.

craft-webmention-client's People

Contributors

jgarber623 avatar

Watchers

James Cloos avatar Webremote avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.