Difference between revisions of "Wordpress publication"

From OpenKM Documentation
Jump to: navigation, search
(Configuration)
m (Configuration)
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
Wordpress publication feature allow to automatically publish contents from OpenKM to wordpress. OpenKM Wordpress publication feature can upload html contents from openkm and images related into these html contents to Wordpress.
+
{{TOCright}} __TOC__
 +
Wordpress publication feature allow to automatically publish contents from OpenKM to wordpress. OpenKM Wordpress publication feature can upload HTML contents from OpenKM and images related into these HTML contents to Wordpress.
  
 
== Configuration ==  
 
== Configuration ==  
There are three configuration parameters that must be set in [[Configuration view]]
+
There are three configuration parameters that must be set in [[Configuration view]]:
* '''wordpress.url''' the wordpress xmlrpc wordpress url for example http://yoursite/blogname/xmlrpc.php  
+
 
* '''wordpress.user''' the wordpress users with write grants for publishing
+
* '''wordpress.url''': the Wordpress XML-RPC URL, for example http://yoursite/blogname/xmlrpc.php.
* '''wordpress.pass''' the password of the user
+
* '''wordpress.user''': the Wordpress users with write grants for publishing.
 +
* '''wordpress.pass''': the password of the user.
 +
 
 +
 
 +
'''Property group configuration'''
 +
 
 +
This property group must be registered in [[Property Groups administration]]:
 +
 
 +
<source lang="xml">
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.3//EN"
 +
                                "http://www.openkm.com/dtd/property-groups-2.3.dtd">
 +
<property-groups>
 +
  <property-group label="WP Publication" name="okg:wordpress_publication">
 +
    <input label="Id" type="text" name="okp:wordpress_publication.id" readonly="true"/>
 +
    <input label="Title" type="text" name="okp:wordpress_publication.title" width="300px">
 +
      <validator type="req"/> 
 +
    </input>     
 +
    <select label="Category" name="okp:wordpress_publication.category" type="multiple">
 +
      <option label="OpenKM Features" value="OpenKM Features"/>
 +
      <option label="OpenKM Blog" value="OpenKM Blog"/>
 +
    </select> 
 +
    <textarea label="Tag" name="okp:wordpress_publication.tag" />
 +
    <input label="Date" type="date" name="okp:wordpress_publication.date" >
 +
      <validator type="req"/>
 +
    </input>     
 +
    <select label="Type" name="okp:wordpress_publication.type" type="simple">
 +
      <option label="Post" value="post"/>
 +
      <option label="Page" value="page"/>         
 +
      <validator type="req"/>
 +
    </select>
 +
    <select label="Status" name="okp:wordpress_publication.status" type="simple">
 +
      <option label="Draft" value="draft"/>
 +
      <option label="Public" value="publish"/>
 +
      <option label="Pending" value="pending"/>
 +
      <option label="Future" value="future"/>
 +
      <option label="Password protected" value="protected" />
 +
      <option label="Private" value="private"/>
 +
      <validator type="req"/>
 +
    </select>     
 +
    <input label="Password" type="text" name="okp:wordpress_publication.password"/>     
 +
    <select label="Synchronized" name="okp:wordpress_publication.synchronized" type="simple">
 +
      <option label="True" value="true"/>
 +
      <option label="False" value="false"/>
 +
      <validator type="req"/>
 +
    </select> 
 +
    <input label="Related media" type="text" name="okp:wordpress_publication.related.media" readonly="true"/>   
 +
  </property-group>
 +
  <property-group label="WP Media" name="okg:wordpress_media" readonly="true">
 +
    <input label="Id" type="text" name="okp:wordpress_media.id"/>
 +
    <input label="Name" type="text" name="okp:wordpress_media.filename"/> 
 +
    <input label="URL" type="link" name="okp:wordpress_media.url"/>
 +
    <input label="Related docs" type="text" name="okp:wordpress_media.related.docs"/>   
 +
  </property-group>
 +
</property-groups>
 +
</source>
  
 
== Publish content ==
 
== Publish content ==
With any html file - uploaded or created into openkm - add the property group ( metadata ) called '''WP Publication'''
+
With any HTML file - uploaded or created into OpenKM - add the property group ( metadata ) called '''WP Publication'''
  
[[File:Okm_user_guide_543.png]]
 
  
After the property group ( metadata ) fields will be saved, these are automatically processed by OpenKM metadata events. The OpenKM automation task called '''Worpress metadata''' will process the contents and upload the media - images - realated into the HTML content to wordpress.  
+
[[File:Okm_user_guide_543.png|800px|center]]
  
[[File:Okm_user_guide_544.png]]
 
  
Also the wordpress response is processed by OpenKM and values are saved in property group ( metadata ) '''WP Publication''' information about wordpress content, like post_id  
+
After the property group ( metadata ) fields will be saved, these are automatically processed by OpenKM metadata events. The OpenKM automation task called '''Wordpress metadata''' will process the contents and upload the media - images - related into the HTML content to Wordpress.
 +
 
 +
 
 +
[[File:Okm_user_guide_544.png|900px|center]]
 +
 
 +
 
 +
Also the Wordpress response is processed by OpenKM and values are saved in property group ( metadata ) '''WP Publication''' information about wordpress content, like post_id  
 +
 
 +
[[File:Okm_user_guide_545.png|800px|center]]
  
[[File:Okm_user_guide_545.png]]
 
  
 
or into property group ( metadata ) '''WP Media''' information about media contents, like media_id, media_url  
 
or into property group ( metadata ) '''WP Media''' information about media contents, like media_id, media_url  
  
[[File:Okm_user_guide_546.png]]
+
 
 +
[[File:Okm_user_guide_546.png|center]]
 +
 
 +
== Update content ==
 +
Each time some content yet published into Wordpress is updated, automatically is processed by OpenKM metadata events. The OpenKM automation task called '''Wordpress content and media''' will update the content.
 +
 
 +
== Update metadata ==
 +
Each time some '''WP publication''' property group - metadata - values are changed automatically are processed by OpenKM metadata events. The OpenKM automation task called '''Worpress metadata''' will update the content.
  
 
== Update media ==
 
== Update media ==
Each time some media yet uploaded into wordpress is updated, automatically is processed by OpenKM metadata events. The OpenKM automation task called '''Wordpress content and media''' will process the contents, update media at Wordpress and also update all related contents with that media.
+
Each time some media yet uploaded into Wordpress is updated, automatically is processed by OpenKM metadata events. The OpenKM automation task called '''Wordpress content and media''' will update media at Wordpress and also update all related contents with that media.
 +
 
 +
 
 +
[[File:Okm_user_guide_544.png|900px|center]]
  
[[File:Okm_user_guide_544.png]]
 
  
 
Also the wordpress response is processed by OpenKM and values are updated in property group ( metadata ) '''WP Publication'''.
 
Also the wordpress response is processed by OpenKM and values are updated in property group ( metadata ) '''WP Publication'''.
 +
 +
== Property group description ==
 +
'''WP Publication'''
 +
* '''Id''': is the Wordpress post id.
 +
* '''Title''': is the Wordpress tittle.
 +
* '''Category''': are the Wordpress categories.
 +
* '''Tag''': are the Wordpress tags.
 +
* '''Type''': indicate if the publication is a post or a page.
 +
* '''Status''': indicate the Wordpress publication status (Draft, Public, Pending, Future, Password protected, Private ).
 +
* '''Password''': when the publication is protected.
 +
* '''Related media''': is the list of OpenKM document UUID related into the HTML contents.
 +
 +
'''WP Media'''
 +
* '''Id''': is the Wordpress media id.
 +
* '''Name''': is the unique Wordpress filename.
 +
* '''URL''': is the Wordpress media url.
 +
* '''Related doc''': is the list of OpenKM document UUID related what contains media UUID into their contents.
  
 
[[Category: User Guide]]
 
[[Category: User Guide]]

Latest revision as of 23:44, 10 May 2014

Wordpress publication feature allow to automatically publish contents from OpenKM to wordpress. OpenKM Wordpress publication feature can upload HTML contents from OpenKM and images related into these HTML contents to Wordpress.

Configuration

There are three configuration parameters that must be set in Configuration view:

  • wordpress.url: the Wordpress XML-RPC URL, for example http://yoursite/blogname/xmlrpc.php.
  • wordpress.user: the Wordpress users with write grants for publishing.
  • wordpress.pass: the password of the user.


Property group configuration

This property group must be registered in Property Groups administration:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE property-groups PUBLIC "-//OpenKM//DTD Property Groups 2.3//EN"
                                 "http://www.openkm.com/dtd/property-groups-2.3.dtd">
<property-groups>
  <property-group label="WP Publication" name="okg:wordpress_publication">
    <input label="Id" type="text" name="okp:wordpress_publication.id" readonly="true"/>
    <input label="Title" type="text" name="okp:wordpress_publication.title" width="300px">
      <validator type="req"/>   
    </input>       
    <select label="Category" name="okp:wordpress_publication.category" type="multiple">
      <option label="OpenKM Features" value="OpenKM Features"/>
      <option label="OpenKM Blog" value="OpenKM Blog"/>
    </select>  
    <textarea label="Tag" name="okp:wordpress_publication.tag" />
    <input label="Date" type="date" name="okp:wordpress_publication.date" >
      <validator type="req"/>
    </input>      
    <select label="Type" name="okp:wordpress_publication.type" type="simple">
      <option label="Post" value="post"/>
      <option label="Page" value="page"/>          
      <validator type="req"/>
    </select>
    <select label="Status" name="okp:wordpress_publication.status" type="simple">
      <option label="Draft" value="draft"/>
      <option label="Public" value="publish"/>
      <option label="Pending" value="pending"/>
      <option label="Future" value="future"/>
      <option label="Password protected" value="protected" /> 
      <option label="Private" value="private"/> 
      <validator type="req"/>
    </select>      
    <input label="Password" type="text" name="okp:wordpress_publication.password"/>      
    <select label="Synchronized" name="okp:wordpress_publication.synchronized" type="simple">
      <option label="True" value="true"/>
      <option label="False" value="false"/>
      <validator type="req"/>
    </select>  
    <input label="Related media" type="text" name="okp:wordpress_publication.related.media" readonly="true"/>    
  </property-group>
  <property-group label="WP Media" name="okg:wordpress_media" readonly="true">
    <input label="Id" type="text" name="okp:wordpress_media.id"/>
    <input label="Name" type="text" name="okp:wordpress_media.filename"/>  
    <input label="URL" type="link" name="okp:wordpress_media.url"/>
    <input label="Related docs" type="text" name="okp:wordpress_media.related.docs"/>     
  </property-group>
</property-groups>

Publish content

With any HTML file - uploaded or created into OpenKM - add the property group ( metadata ) called WP Publication


Okm user guide 543.png


After the property group ( metadata ) fields will be saved, these are automatically processed by OpenKM metadata events. The OpenKM automation task called Wordpress metadata will process the contents and upload the media - images - related into the HTML content to Wordpress.


Okm user guide 544.png


Also the Wordpress response is processed by OpenKM and values are saved in property group ( metadata ) WP Publication information about wordpress content, like post_id

Okm user guide 545.png


or into property group ( metadata ) WP Media information about media contents, like media_id, media_url


Okm user guide 546.png

Update content

Each time some content yet published into Wordpress is updated, automatically is processed by OpenKM metadata events. The OpenKM automation task called Wordpress content and media will update the content.

Update metadata

Each time some WP publication property group - metadata - values are changed automatically are processed by OpenKM metadata events. The OpenKM automation task called Worpress metadata will update the content.

Update media

Each time some media yet uploaded into Wordpress is updated, automatically is processed by OpenKM metadata events. The OpenKM automation task called Wordpress content and media will update media at Wordpress and also update all related contents with that media.


Okm user guide 544.png


Also the wordpress response is processed by OpenKM and values are updated in property group ( metadata ) WP Publication.

Property group description

WP Publication

  • Id: is the Wordpress post id.
  • Title: is the Wordpress tittle.
  • Category: are the Wordpress categories.
  • Tag: are the Wordpress tags.
  • Type: indicate if the publication is a post or a page.
  • Status: indicate the Wordpress publication status (Draft, Public, Pending, Future, Password protected, Private ).
  • Password: when the publication is protected.
  • Related media: is the list of OpenKM document UUID related into the HTML contents.

WP Media

  • Id: is the Wordpress media id.
  • Name: is the unique Wordpress filename.
  • URL: is the Wordpress media url.
  • Related doc: is the list of OpenKM document UUID related what contains media UUID into their contents.