WebEpg development (3 Viewers)

[Holzi]

@doskabouter
We have a documentation subtask for this issue. Do you know what needs to be documented?

 

[doskabouter]

Well, if you want it to be documented as thorough as the listing-type="xml", it's there already
I think in general, there needs to be some explanation of type="Data", type="Xml" and type="JSON"
Xml and JSON I'm able to provide some text/examples for, but Data: I haven't investigated that part.

 

[Holzi]

Xml and JSON I'm able to provide some text/examples for

Are you able to do that?
Would help our Docs Team.

 

[doskabouter]

I can add it myself if you give me edit rights, or do you want to review it before posting?
It's about this page, isn't it? http://wiki.team-mediaportal.com/1_...bers_and_Tuning_details/WebEPG/WebEPG_Grabber

 

[Holzi]

I can add it myself if you give me edit rights

Thanks!
I guess you need no special rights. Just log in with your Forum details?!
Could you add your changes under this page? -> http://wiki.team-mediaportal.com/in...'s_New/1.6.x/Using_MediaPortal/WebEPG_Grabber

 

[doskabouter]

Hm, I can't login at that page. No errors, just returns me to the same page (with login option at the top). Using FF 24

Is that the only place you want to document it?
Or perhaps that should be done if 1.6.0 is released...

 

[Holzi]

So log in in general works?


We document new stuff in the 'Whats new' section at first. When MP 1.6 is officially released our Docs Team move this stuff to the right Wiki subpages.

If you can't log in just write down your changes in a forum post here.
Thanks!

 

[doskabouter]

Login works at trontpage and forum, but not for wiki, but I'll get to that when it becomes annoying...

Explanation is clear, I'll post the lot here when I have it complete

 

[doskabouter]

First draft of the JSON stuff:

Spoiler

Overview

Parse WebEPG data from json sources

Description of Change

Besides Html, Xml, and generic data, JSON is now supported as well

For that I have created a JSON parser, and a JSON Xpath evaluator

Changed to be made in the http://wiki.team-mediaportal.com/1_...bers_and_Tuning_details/WebEPG/WebEPG_Grabber page:

Add a 2.3.7. <JSON>
At #.3CListing_type.3D.22.22.3E add JSON

The "JSON" element may containg the following content:

Attributes:
"xpath": Xpath expression which returns the EPG-elements. Note that this is a custom implementation of Xpath, and not all possibilities are supported (yet)
"channel": Filter to apply to the list of EPG-elements

ChildNodes:
"Fields": Mapping from JSON-attributes to EPG-fields
This contains a number of "Field" nodes, with these attributes:
"name": EPG-Field
"jsonname": JSON-attribute

Example:
<JSON channel="channel/id=28" xpath="airing">
<Fields>
<Field name="#START" jsonname="air_time" />
<Field name="#TITLE" jsonname="title" />
<Field name="#DESCRIPTION" jsonname="episode/original_title" />
</Fields>
</JSON>

Additional Information and References
Issue #: 4215
Issue Component: WebEPG
Type of Change: Feature
Related Wiki page(s): http://wiki.team-mediaportal.com/1_...bers_and_Tuning_details/WebEPG/WebEPG_Grabber
Author: doskabouter
Date added: Fri, 01 Nov 2013

Is this along the lines you want it, or should I try to make it more user-friendly?

And an explanation which can already be added to the Xml section:

Spoiler

The "Xml" element may containg the following content:

Attributes:
"xpath": Xpath expression which returns the EPG-elements
"channel": Filter to apply to the list of EPG-elements

ChildNodes:
"Fields": Mapping from xml-attributes to EPG-fields
This contains a number of "Field" nodes, with these attributes:
"name": EPG-Field
"xmlname": xml-attribute

Example:
<Xml channel="id=28" xpath="airing">
<Fields>
<Field name="#START" xmlname="air_time" />
<Field name="#TITLE" xmlname="title" />
<Field name="#DESCRIPTION" xmlname="description" />
</Fields>
</Xml>

 

[Dadeo]

Login works at trontpage and forum, but not for wiki, but I'll get to that when it becomes annoying...

I see you managed to login to wiki doskabouter so I gave you access to the What's new > 1.6.x > WebEPG Grabber wiki page. Normally the developer responsible for merging the branch to master is responsible for the initial docs, so only Team Members can create/edit pages in What's New section. But we all try to help out as much as we can, and try to encourage community contribution as much as possible.

We only need to document the changes, but at a certain point if the changes are significant we may need a new wiki page.
The most important things to document imho are:

1. Do users need to do anything different when configuring the WebEPG plugin in TV-Server plugins - or does everything on that wiki page still apply to grabbers using JSON? It doesn't look like there are any changes so far, but just checking
2. What is different in creating or customizing a WebEPG Grabber using JSON? i.e. what will we need to add/change on the current WebEPG Grabber I think that's what you have covered already?

As Holzi said:

We document new stuff in the 'Whats new' section at first. When MP 1.6 is officially released our Docs Team move this stuff to the right Wiki subpages.

That gives us time to 'develop' the docs, and hopefully even get some testers to verify their completeness, accuracy and comprehensiveness before we integrate them into the main wiki pages. It's part of our Docs policy now to try and ensure the wiki docs are updated as soon a a new version of MP is released, which is not easy unless we start documenting during development/testing.

@Holzi - now that doskabouter's initial question about WebEPG support has been addressed, maybe this thread should be moved to a 'development' thread? Or should we start a separate Area51 thread once doskabouter feels it is ready for testing? It might be useful if we can interest a few more users who provide WebEPG grabbers to test creating grabbers using JSON (and review the docs ) Once 'ready' and doskabouter adds some new WebEPG grabbers to Submit: EPG-Grabbers and tuningdetails sub forum - a sticky announcing JSON support for 1.6.0 might be useful in that sub-forum as well? I'm not sure what's the best way to 'inspire' some users to test.