See feeds_xpathparser's docs for example structure and relevant content.

Comments

chrowe’s picture

A README.txt with the module would be a good start.

It took me a while just to figure out how to get to the parser settings. Something like:

Look at http://drupal.org/node/919448 for a general idea. FYI: You have to create Node processor mappings before Parser settings will show up

mgifford’s picture

Agreed that something like that would be good @chrowe. Can you give us quick stab at producing a draft?

chrowe’s picture

Here is a stab at a README.txt file

CONTENTS OF THIS FILE
---------------------

* Introduction
* Installation
* Usage
* JSONPath

INTRODUCTION
------------

Current Maintainer: twistor http://drupal.org/user/473738

This is a parser for the Feeds module[1] that allows parsing JSON using
JSONPath[2]. It is very similar to the Feeds XPath Parser module[3].

[1] http://drupal.org/project/feeds
[2] http://goessner.net/articles/JsonPath/
[3] http://drupal.org/project/feeds_jsonpath_parser

INSTALLATION
------------

The file jsonpath-0.8.1.php[4] must be downloaded and put in the module folder.
After installing the module, clear your cache so that the parser will be
available in Feeds.

[4] http://jsonpath.googlecode.com/files/jsonpath-0.8.1.php

USAGE
-----
You should be framiliar with how to configure the feeds module with the parsers
it comes with. The documentation for Feeds XPath Parser[5] will give you the
basic idea and is very similar to how this module works.

FYI: You have to create Node processor mappings before Parser settings will show
up.

[5] http://drupal.org/node/919448

JSONPath
--------

Documentation can be found at http://goessner.net/articles/JsonPath/, and
http://code.google.com/p/jsonpath/wiki/PHP.
** The syntax is different for the @ operator. In the documentation, examples
look like @.name. That syntax changes to @['name'] since this is PHP and not
Javascript. See http://drupal.org/project/feeds_jsonpath_parser for an example
of this.

alibama’s picture

perhaps worth noting that
http://goessner.net/articles/JsonPath/ no longer works however the web archive folks have a few copies

http://web.archive.org/web/20110723135951/http://goessner.net/articles/J...

twistor’s picture

Issue summary: View changes
Status: Active » Closed (fixed)

We have a documentation page.

Not doing further work on this, so providing a README at this point would be counter productive.