Confirmed users
228
edits
MDN/Archives/Development/CompatibilityTables/Importer: Difference between revisions
Jump to navigation
Jump to search
MDN/Archives/Development/CompatibilityTables/Importer (view source)
Revision as of 08:58, 1 June 2015
, 1 June 2015→section_skipped: adding explanation of a specific fix to this error.
(Added a section to explain how to fix errors.) |
(→section_skipped: adding explanation of a specific fix to this error.) |
||
| Line 270: | Line 270: | ||
''Possible solutions'':<br /> | ''Possible solutions'':<br /> | ||
* Often, this is caused by the use of plain text or HTML instead of an expected KumaScript macro. For instance, [https://developer.mozilla.org/en-US/docs/MDN/Contribute/Content/Specification_tables specification tables] should be using the SpecName and Spec2 macros instead of specifying text directly. | * Often, this is caused by the use of plain text or HTML instead of an expected KumaScript macro. For instance, [https://developer.mozilla.org/en-US/docs/MDN/Contribute/Content/Specification_tables specification tables] should be using the SpecName and Spec2 macros instead of specifying text directly. | ||
* When the proper [https://developer.mozilla.org/en-US/docs/MDN/Contribute/Content/Specification_tables specification tables] and macros are not used, and instead a simple link to the spec is provided, follow these steps to resolve (the example I fixed when writing these steps was [https://developer.mozilla.org/en-US/docs/Web/API/TimeRanges/start Timeranges.start()]): | |||
** Copy a proper spec table from a reliable source, for example the [https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API#Specifications Fetch API spec table] | |||
** Paste this into the "Specifications" section of the problem page. | |||
** Replace the specification identifying name in the {{SpecName(' ... ')}} and {{Spec2(' ... ')}} macros with the name of the spec where the feature is specified. You can look up what name to use for that particular spec in the [https://developer.mozilla.org/en-US/docs/Template:SpecName SpecName template page]. For example, Timeranges.start() is specified in the [https://html.spec.whatwg.org/multipage/ WHATWG HTML Living Standard]. In the SpecName template its name is listed as HTML WHATWG, so that's what you'll need to use. | |||
** If the page you are fixing is for a specific API landing page, the above steps should be enough. If the page is for a specific feature like a property or method, keep reading! | |||
** The {{SpecName(' ... ')}} template can take two other arguments. The first one is the URL slug that when combined with the spec's base URL will point to the exact feature in the spec. For example, the HTML WHATWG spec's URL is [https://html.spec.whatwg.org/multipage/ https://html.spec.whatwg.org/multipage/], and the URL to the Timeranges.start() method is [https://html.spec.whatwg.org/multipage/embedded-content.html#dom-timeranges-start https://html.spec.whatwg.org/multipage/embedded-content.html#dom-timeranges-start], so the second argument needs to contain 'embedded-content.html#dom-timeranges-start'. | |||
** The third argument needs to contain a human-readable name for the feature, in this case 'start()'. | |||
** the full template call is {{SpecName('HTML WHATWG','embedded-content.html#dom-timeranges-start','start()')}} | |||
=== spec_h2_id === | === spec_h2_id === | ||