From 65a96801677a0d1be33da24dc7bcbf4de2399627 Mon Sep 17 00:00:00 2001 From: Douglas Arellanes Date: Mon, 23 Jan 2017 18:25:17 +0100 Subject: [PATCH 1/2] Update README.md First draft. Added information about how the plugin works with Superdesk, as well as links to relevant information. --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index d361b3a..963d669 100644 --- a/README.md +++ b/README.md @@ -1 +1,16 @@ # superdesk-wordpress-plugin +The Superdesk Wordpress Publisher plugin enables content to be sent from an instance of Sourcefabric's Superdesk newsroom management system (www.superdesk.org) and the Wordpress instance it's installed on. Superdesk itself is open source (https://github.com/superdesk/superdesk). + +When both Superdesk and the Wordpress Superdesk Publisher plugin are correctly configured, a Superdesk user publishes an item and it is automatically published in Wordpress. Users can still log in to Wordpress to administer the site. + +Superdesk supports the IPTC's industry standard ninjs (http://dev.iptc.org/ninjs), which standardizes the representation of news in JSON - a lightweight, easy-to-parse, data interchange format. The Superdesk Wordpress Publisher plugin will also enable multiple instances of Wordpress to receive content from a single instance of Superdesk; output channels are defined in Superdesk, so you could have multiple, or only one, or none at all (which wouldn't be that useful but still possible (wink)). This plugin should also work with other information sources that use ninjs. + +We've created a table to map fields between Superdesk's ninjs implementation and Wordpress: https://wiki.sourcefabric.org/display/NR/Ninjs+to+WP+data+structure+mapping + +On the Superdesk side, there are publishing providers which are the ones in charge of actually delivering the content in the configured format and delivery mechanism; this is done on a publishing channel basis in Superdesk. + +Stories are checked in Superdesk as published, then the publishing providers take over to distribute the content. + +The Superdesk Wordpress Publisher plugin currently uses Superdesk's HTTP PUSH to receive content in ninjs. (This is likely to change in future versions.) + +We do not have a native Wordpress publishing provider in Superdesk, and there is no plan to write one in the current roadmap. We prefer to use ninjs as an standard interchange format. From 96782f64e7e71b55d4ca0819d78e3dd55abc1fa0 Mon Sep 17 00:00:00 2001 From: Douglas Arellanes Date: Mon, 23 Jan 2017 22:31:04 +0100 Subject: [PATCH 2/2] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 963d669..e39351e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ -# superdesk-wordpress-plugin +# What is the Wordpress Superdesk Publisher plugin? The Superdesk Wordpress Publisher plugin enables content to be sent from an instance of Sourcefabric's Superdesk newsroom management system (www.superdesk.org) and the Wordpress instance it's installed on. Superdesk itself is open source (https://github.com/superdesk/superdesk). +# What does the Wordpress Superdesk Publisher plugin do? When both Superdesk and the Wordpress Superdesk Publisher plugin are correctly configured, a Superdesk user publishes an item and it is automatically published in Wordpress. Users can still log in to Wordpress to administer the site. +# How does it work? Superdesk supports the IPTC's industry standard ninjs (http://dev.iptc.org/ninjs), which standardizes the representation of news in JSON - a lightweight, easy-to-parse, data interchange format. The Superdesk Wordpress Publisher plugin will also enable multiple instances of Wordpress to receive content from a single instance of Superdesk; output channels are defined in Superdesk, so you could have multiple, or only one, or none at all (which wouldn't be that useful but still possible (wink)). This plugin should also work with other information sources that use ninjs. We've created a table to map fields between Superdesk's ninjs implementation and Wordpress: https://wiki.sourcefabric.org/display/NR/Ninjs+to+WP+data+structure+mapping @@ -13,4 +15,5 @@ Stories are checked in Superdesk as published, then the publishing providers tak The Superdesk Wordpress Publisher plugin currently uses Superdesk's HTTP PUSH to receive content in ninjs. (This is likely to change in future versions.) +# What's next? We do not have a native Wordpress publishing provider in Superdesk, and there is no plan to write one in the current roadmap. We prefer to use ninjs as an standard interchange format.