MozillaWiki

MDN/Archives/Development/CompatibilityTables/Importer: Difference between revisions

Page Discussion

MDN/Archives/Development/CompatibilityTables/Importer (view source)

Revision as of 22:03, 14 May 2015

8,353 bytes added ,  14 May 2015
Skeleton for testing linkage
(Created page with "This page reserved for content as specified in https://bugzilla.mozilla.org/show_bug.cgi?id=1154349.")
 
(Skeleton for testing linkage)
Line 1: Line 1:
This page reserved for content as specified in https://bugzilla.mozilla.org/show_bug.cgi?id=1154349.
'''Note''': ''If you came to this page from a link on https://browsercompat.herokuapp.com/importer, then it may be that additional documentation has not been written for the importer issue.  Feel free to add a Level 3 heading for your issue.''
 
== General Information ==
It is not enough to create a
[https://bugzilla.mozilla.org/showdependencytree.cgi?id=996570&hide_resolved=1 data store] for compatibility data. It also needs to be populated with structured data. We've decided to start with MDN data, rather than start from scratch or [https://github.com/Fyrd/caniuse an existing data source]. An MDN data importer is now part of the [https://github.com/jwhitlock/web-platform-compat web-platform-compat] project, and is live at https://browsercompat.herokuapp.com/importer/.
 
== The Issues ==
The importer identifies classes of issues with a ''slug'', a short span of text.  The sections below use those slugs as the title, so that we can link directly from the importer to advice for handling that class of issue.
 
=== bad_json ===
''Error template'':<br />
Response from {url} is not JSON<br />
Actual content:
{content}
 
''No one has contributed hints for handling this issue yet.''
 
 
=== compatgeckodesktop_unknown ===
''Error template'':<br />
Unknown Gecko version &quot;{version}&quot;<br />
The importer does not recognize this version for CompatGeckoDesktop. Change the MDN page or update the importer.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== compatgeckofxos_override ===
''Error template'':<br />
Override &quot;{override}&quot; is invalid for Gecko version &quot;{version}&quot;.<br />
The importer does not recognize this override for CompatGeckoFxOS. Change the MDN page or update the importer.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== compatgeckofxos_unknown ===
''Error template'':<br />
Unknown Gecko version &quot;{version}&quot;<br />
The importer does not recognize this version for CompatGeckoFxOS. Change the MDN page or update the importer.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== exception ===
''Error template'':<br />
Unhandled exception<br />
{traceback}
 
''No one has contributed hints for handling this issue yet.''
 
 
=== extra_cell ===
''Error template'':<br />
Extra cell in compatibility table row.<br />
A row in the compatibility table has more cells than the header row. It may be the cell identified in the context, a different cell in the row, or a missing header cell.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== failed_download ===
''Error template'':<br />
Failed to download {url}.<br />
Status {status}, Content:
{text}
 
''No one has contributed hints for handling this issue yet.''
 
 
=== false_start ===
''Error template'':<br />
No &lt;h2&gt; found in page.<br />
A compatibility table must be after a proper &lt;h2&gt; to be imported.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== footnote_feature ===
''Error template'':<br />
Footnotes are not allowed on features<br />
The Feature model does not include a notes field. Remove the footnote from the feature.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== footnote_missing ===
''Error template'':<br />
Footnote [{footnote_id}] not found.<br />
The compatibility table has a reference to footnote &quot;{footnote_id}&quot;, but no matching footnote was found. This may be due to parse issues in the footnotes section, a typo in the MDN page, or a footnote that was removed without removing the footnote reference from the table.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== footnote_multiple ===
''Error template'':<br />
Only one footnote allowed per compatibility cell.<br />
The API supports only one footnote per support assertion. Combine footnotes [{prev_footnote_id}] and [{footnote_id}], or remove one of them.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== footnote_no_id ===
''Error template'':<br />
Footnote has no ID.<br />
Footnote references, such as [1], are used to link the footnote to the support assertion in the compatibility table. Reformat the MDN page to use footnote references.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== footnote_unused ===
''Error template'':<br />
Footnote [{footnote_id}] is unused.<br />
No cells in the compatibility table included the footnote reference [{footnote_id}]. This could be due to a issue importing the compatibility cell, a typo on the MDN page, or an extra footnote that should be removed from the MDN page.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== halt_import ===
''Error template'':<br />
Unable to finish importing MDN page.<br />
The importer was unable to finish parsing the MDN page. This may be due to a duplicated section, or other unexpected content.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== inline_text ===
''Error template'':<br />
Unknown inline support text &quot;{text}&quot;.<br />
The API schema does not include inline notes. This text needs to be converted to a footnote, converted to a support attribute (which may require an importer update), or removed.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== nested_p ===
''Error template'':<br />
Nested &lt;p&gt; tags are not supported.<br />
Edit the MDN page to remove the nested &lt;p&gt; tag
 
''No one has contributed hints for handling this issue yet.''
 
 
=== section_missed ===
''Error template'':<br />
Section &lt;h2&gt;{title}&lt;/h2&gt; was not imported.<br />
The import of section {title} failed, but no parse error was detected. This is usually because of a previous critical error, which must be cleared before any parsing can be attempted.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== section_skipped ===
''Error template'':<br />
Section &lt;h2&gt;{title}&lt;/h2&gt; has unexpected content.<br />
The parser was trying to match rule &quot;{rule_name}&quot;, but was unable to understand some unexpected content. This may be markup or text, or a side-effect of previous issues. Look closely at the context (as well as any previous issues) to find the problem content.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== spec_h2_id ===
''Error template'':<br />
Expected &lt;h2 id=&quot;Specifications&quot;&gt;, actual id={{h2_id}}<br />
Fix the id so that the table of contents, other feature work.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== spec_h2_name ===
''Error template'':<br />
Expected &lt;h2 name=&quot;Specifications&quot;&gt;, actual name={{h2_name}}<br />
Fix or remove the name attribute.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== spec_mismatch ===
''Error template'':<br />
SpecName({specname_key}, ...) does not match Spec2({spec2_key}).<br />
SpecName and Spec2 must refer to the same mdn_key. Update the MDN page.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== unknown_browser ===
''Error template'':<br />
Unknown Browser &quot;{name}&quot;.<br />
The API does not have a browser with the name &quot;{name}&quot;. This could be a typo on the MDN page, or the browser needs to be added to the API.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== unknown_kumascript ===
''Error template'':<br />
Unknown KumaScript {display} in {scope}.<br />
The importer has to run custom code to import KumaScript, and it hasn&#39;t been taught how to import {name} when it appears in a {scope}. File a bug, or convert the MDN page to not use this KumaScript macro.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== unknown_spec ===
''Error template'':<br />
Unknown Specification &quot;{key}&quot;.<br />
The API does not have a specification with mdn_key &quot;{key}&quot;. This could be a typo on the MDN page, or the specfication needs to be added to the API.
 
''No one has contributed hints for handling this issue yet.''
 
 
=== unknown_version ===
''Error template'':<br />
Unknown version &quot;{version}&quot; for browser &quot;{browser_name}&quot;<br />
The API does not have a version &quot;{version}&quot; for browser &quot;{browser_name} (id {browser_id}, slug &quot;{browser_slug}&quot;). This could be a typo on the MDN page, or the version needs to be added to the API.
 
''No one has contributed hints for handling this issue yet.''
Jwhitlock
67

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/1074750"