[Compat-data] Note and Footnote

[Stephanie Hobson]

Hi All,

Another compatibility tables UI design question, but I'm separating them to
help keep track of the discussions :)

Looking at the use cases for compatibility data display [1] the only table
that displays abbreviated support in-line with the version support
information is the one which replicates how MDN is currently displaying
data.

*Can we move the content of the inline-notes into the footnotes?*

For: Compat tables will be easier and faster to read. Tables will fit
better on the page. They will match formatting of every other support
resource on the web. Devs will get all implementation information in one
place. There's one less field to localize.

Against: This feature makes MDN unique, devs quickly get an idea if they
need to review the footnotes.

Recommendation: Move the content of the inline-notes into footnotes, remove
the "notes" field from the API entirely, and improve the compatibility
table UI to make viewing the complete footnotes faster and easier
(something like caniuse's hover effect, or in the row below the compat info
like quirksmode).

Thanks,
Stephanie.

[1]
https://wiki.mozilla.org/MDN/Development/CompatibilityTables/Data_Requirements#Compatibility_Tables

[Jeremie Patonnier]

Hi!

2015-01-22 1:07 GMT+01:00 Stephanie Hobson <sho...@mozilla.com>:
>
> *Can we move the content of the inline-notes into the footnotes?*
>

Yes :)

Recommendation: Move the content of the inline-notes into footnotes,
> remove the "notes" field from the API entirely,

I'm not sure about that. How do we plan to store aside information and how
to retrieve them if they are removed from the API?

Best,
--
Jeremie
.............................
Web : http://jeremie.patonnier.net
Twitter : @JeremiePat <http://twitter.com/JeremiePat>

[Stephanie Hobson]

On Thu, Jan 22, 2015 at 1:43 AM, Jeremie Patonnier <
jeremie....@gmail.com> wrote:

> Hi!
>
> 2015-01-22 1:07 GMT+01:00 Stephanie Hobson <sho...@mozilla.com>:
>>
>> *Can we move the content of the inline-notes into the footnotes?*
>>
>
> Yes :)
>
> Recommendation: Move the content of the inline-notes into footnotes,
>> remove the "notes" field from the API entirely,
>
>
> I'm not sure about that. How do we plan to store aside information and how
> to retrieve them if they are removed from the API?
>

If you agree that we can move the content of the inline-notes into the
footnotes what information would we be left to be stored in the
inline-notes field?

[Janet Swisher]

On 1/22/15 12:54 PM, Stephanie Hobson wrote:
> On Thu, Jan 22, 2015 at 1:43 AM, Jeremie Patonnier <
> jeremie....@gmail.com> wrote:
>
>> Hi!
>>
>> 2015-01-22 1:07 GMT+01:00 Stephanie Hobson <sho...@mozilla.com>:
>>> *Can we move the content of the inline-notes into the footnotes?*
>>>
>> Yes :)
>>
>> Recommendation: Move the content of the inline-notes into footnotes,
>>> remove the "notes" field from the API entirely,
>>
>> I'm not sure about that. How do we plan to store aside information and how
>> to retrieve them if they are removed from the API?
>>
> If you agree that we can move the content of the inline-notes into the
> footnotes what information would we be left to be stored in the
> inline-notes field?

Not everybody in this discussion is familiar with the details of the
API. If there is still a way to retrieve footnotes, then all is good.

--
Janet Swisher <mailto:jREMOVE...@mozilla.com>
Mozilla Developer Network <https://developer.mozilla.org>
MDN Community Manager

[Jeremie Patonnier]

Hi!

2015-01-22 19:54 GMT+01:00 Stephanie Hobson <sho...@mozilla.com>:
>
> On Thu, Jan 22, 2015 at 1:43 AM, Jeremie Patonnier <
> jeremie....@gmail.com> wrote:
>>
>> 2015-01-22 1:07 GMT+01:00 Stephanie Hobson <sho...@mozilla.com>:
>>>
>>> Recommendation: Move the content of the inline-notes into footnotes,
>>> remove the "notes" field from the API entirely,
>>
>>
>> I'm not sure about that. How do we plan to store aside information and
>> how to retrieve them if they are removed from the API?
>>
>
> If you agree that we can move the content of the inline-notes into the
> footnotes what information would we be left to be stored in the
> inline-notes field?
>

Oh! Okay, there is a difference between inline-note end footnote in the
API. I wasn't aware of such difference. I was thinking we only had
(foot/inline-)notes (wherever they are displayed). As long as we have a
relation between a feature and some notes, making the API simpler is okay :)