Difference between revisions of "PubMan Wordpress Plugin"

Revision as of 06:27, 9 April 2009

The Wordpress Plugin for fetching content from eSciDoc works via the Search&Export REST interface.
Please note that this is a temporary page which will later be moved to an appropriate place.

PubMan Content Plugin[edit]

Contributors: Andreas Gros
Link: http://pubman.mpdl.mpg.de
Tags: rest, publication
Requires at least: 2.5
Tested up to: 2.7.0
Stable tag: trunk

This Wordpress plugin enables you to fetch publication data from PubMan via the Search&Export REST interface.

Description[edit]

This Wordpress plugin enables you to fetch publication data from PubMan via the Search&Export REST interface of eSciDoc PubMan (http://pubman.mpdl.mpg.de). The plugin depends on a web server with expat enabled for parsing XML.

You can get user-friendly access to the REST interface here: http://pubman.mpdl.mpg.de/search/SearchAndExport_rest_sample.jsp

The plugin transforms the "snippet" output of

http://pubman.mpdl.mpg.de/search/SearchAndExport?cqlQuery=MySearchString&exportFormat=APA&outputFormat=snippet&language=all

into a publication list and returns this list back to Wordpress.

Usage[edit]

You can put the following line (an inline plugin call) into your page or post to fetch a list of publication items from PubMan to be displayed in a single post or page, or you can use the "user settings" described below to automatically create one blog post for each publication item fetched from PubMan according to category/subject terms:

[pubman-content searchstring="MySearchString" citationstyle="APA"]

Examples for searchstrings:

escidoc.metadata=sengbusch
escidoc.any-persons=sengbusch%20AND%20escidoc.subject=fische

For a list of possible escidoc-terms, e.g. escidoc.any-persons, etc., please visit: http://coreservice.mpdl.mpg.de:8080/srw/search/escidoc_all?operation=explain

You can limit the output by setting offset ("startRecord") and the number of records to be returned ("maximumRecords") in the search query: http://pubman.mpdl.mpg.de/search/SearchAndExport?cqlQuery=MySearchString&exportFormat=APA&outputFormat=snippet&startRecord=1&maximumRecords=10

The total number of records in PubMan that matches the search query is returned in the HTTP header as x-total-number-of-records, e.g. : x-total-number-of-records: 307

The plugin parses the HTTP header and reads out this number (necessary to for paging search results returned for "inline call" search queries for which search results have to be displayed within a single post/page without creating actual blog posts, but still need to be readable (i.e. paged or attributed with a "read more ..." link).

Download[edit]

PubMan Wordpress Plugin (beta)

Installation[edit]

Unzip pubman.zip to the /wp-content/plugins/ directory
Activate the plugin through the 'Plugins' menu in WordPress
Place [pubman-content searchstring="MySearchString" citationstyle="APA"] in your posts or pages or use the site admin pages of the plugin to configure it for more advanced usage.

Configuration[edit]

Inside Wordpress's site-admin area[edit]

Admin settings[edit]

Go to "Settings" and "PubMan Content Plugin Config" and put in the following parameters:

Researcher's name, e.g. sengbusch
Base-URL, e.g. http://pubman.mpdl.mpg.de
Path to full item view in PubMan, e.g. /pubman/item/
Path to the Search&Export interface in PubMan, e.g. /search/SearchAndExport
Default text for the link to the full item view, e.g. [LINK]
Default search string
Default sort key, e.g. escidoc.issued,,0, which sorts by "date issued" (descending). You can find a list of possible search terms here (search for "sortKeyword").
Default number of items per page
Default citation style

User settings[edit]

Go to "Manage" and "PubMan Content User Options".

On this page you find all subject terms of PubMan items that are found by using the search terms specified in "Admin settings" above. Currently it uses "Researcher's name" as default search term. This will be adapted for future use cases.

The plugin checks which of the subject terms have already been put in the blog as "Categories" and shows those as "checked" items in a list of all subject terms found.

All subject terms that are checked are the categories for which the plugin will fetch the PubMan items and will create the missing post categories and a blog post for each publication item if necessary. Existing blog posts of PubMan items will be updated if necessary (i.e. a publication item was updated in PubMan). You can force an update of all blog posts by ticking the check-box at "Force update" below the list of subject terms. The option "Show a report about the actions taken" will put out some debugging information about the actions taken by the plugin.

Screenshots[edit]

The screenshot (scrnshot1.png) shows the output of the plugin in Wordpress.
The screenshot (scrnshot2.png) shows the current admin interface of the plugin in Wordpress
The screenshot (scrnshot3.png) shows the current user interface of the plugin in Wordpress

To do[edit]

A lot!

@@ Line 42: / Line 42: @@
 http://pubman.mpdl.mpg.de/search/SearchAndExport?cqlQuery=MySearchString&exportFormat=APA&outputFormat=snippet&startRecord=1&maximumRecords=10
-The total number of records in PubMan that matches the search query is returned in the HTTP header as:
+The total number of records in PubMan that matches the search query is returned in the HTTP header as <code>x-total-number-of-records</code>, e.g. :
-x-total-number-of-records: 307
+<code>x-total-number-of-records: 307</code>
 The plugin parses the HTTP header and reads out this number (necessary to for paging search results returned for "inline call" search queries for which search results have to be displayed within a single post/page without creating actual blog posts, but still need to be readable (i.e. paged or attributed with a "read more ..." link).