1170206 - [Compat Data][Importer] Ignore sections marked for parser to skip

Status: RESOLVED FIXED

(developer.mozilla.org Graveyard :: General, enhancement)

Description

[John Whitlock [:jwhitlock]]

What problem would this feature solve?
======================================
On some pages, the Specifications section lists a prose explanation of why a feature is unspecified, rather than a compatibility table.  This confuses the parser, preventing the importing of the valid Browser Compatibility section

Who has this problem?
=====================
Core contributors to MDN

How do you know that the users identified above have this problem?
==================================================================
DevEngage meeting June 1st, 2015 

How are the users identified above solving this problem now?
============================================================
Rename the Specifications table so the parser will skip it.

Do you have any suggestions for solving the problem? Please explain in detail.
==============================================================================
Ideas in the meeting include:

- Adding a css class to the <h2> or the first paragraph
- Adding a KumaScript macro
- Adding KumaScript start and end macros

Is there anything else we should know?
======================================
Once a method is decided and implemented, the parser can learn to ignore those sections.

Comment 1

[John Whitlock [:jwhitlock]]

Writing team needs to decide the best solution for communicating to the parser that the section should be skipped, and implement it, for example on AnimationEvent.initAnimationEvent

https://developer.mozilla.org/en-US/docs/Web/API/AnimationEvent.initAnimationEvent
https://browsercompat.herokuapp.com/importer/9

Comment 2

[Eric Shepherd [:sheppy]]

The macros have been created: we can now wrap a text-only explanation like "There is no specification for this feature." thusly:

{{WhyNoSpecStart}}There is no specification for this feature.{{WhyNoSpecEnd}}

Using a pair of macros to bookend the content this way allows any kind of content (styles, macros, etc) within the explanatory text.

I have also updated https://developer.mozilla.org/en-US/docs/Web/API/AnimationEvent/initAnimationEvent#Specifications to use this, but have not done so anywhere else yet.

Comment 3

[John Whitlock [:jwhitlock]]

PR #36 submitted:

https://github.com/mozilla/web-platform-compat/pull/36

Code is live:

https://browsercompat.herokuapp.com/importer/1373

Comment 4

[John Whitlock [:jwhitlock]]

In bug 1180573, :fscholz asks that {{WhyNoSpecStart}} also sets the standardized flag on the page features to false.  Is this desired behaviour?

Comment 5

[Eric Shepherd [:sheppy]]

(In reply to John Whitlock [:jwhitlock] from comment #4)
> In bug 1180573, :fscholz asks that {{WhyNoSpecStart}} also sets the
> standardized flag on the page features to false.  Is this desired behaviour?

{{WhyNoSpecStart}} does, literally, nothing. It's just a no-op (the only content is a comment). It exists solely for the parser to detect it.

Comment 6

[MDN Team (:mdn-dev)]

Commits pushed to master at https://github.com/mozilla/web-platform-compat

https://github.com/mozilla/web-platform-compat/commit/4ba76143205b95be5c04c97a32c71b106d22a54c
fix bug 1170206 - Ignore {{WhyNoSpec*}} block

Used on:

https://developer.mozilla.org/en-US/docs/Web/API/AnimationEvent/initAnimationEvent#Specifications

https://github.com/mozilla/web-platform-compat/commit/4dd9b4400dae68e6c86f79eaa2b49c7928ace2aa
Merge pull request #36 from jwhitlock/1170206_ignore_whynospec

Fix bug 1170206 - Ignore {{WhyNoSpecStart}}...{{WhyNoSpecEnd}} block