If we split out the References HTML from the rest of the page content, we can actually deliver it as JSON instead.
Doing this would mean that clients could take the structure data and then display references in a way that is best suited on the clients and potentially doing more interesting things.
Current references usage in web/apps:
We show a list of references in specific sections at the bottom of the page for both web and apps. This is inline with the article. Is this the best UI? Would we like to show this list differently? For example, the apps use a full screen native table for displaying the list of revisions. Would we like to do something similar here?
We show a specific reference when a user clicks on a reference. In this case we show a special UI (a native component in apps, but is also a pop up in web). This seems like a case where structured data is a clear win. Currently, the apps are parsing out the references from the DOM (and will be using a JS callback in the future) to get the reference so it can be displayed in the native component. It seems the web is doing something similar.
So some questions:
- Do clients actually want structured data in lieu of HTML so they can construct these interfaces?
- Will clients still need an HTML version in addition to a structured version, OR will they be able to easily construct a UI from the structured data?
- Are there other uses for a references API beyond what is listed above?