Confirmed users
233
edits
MDN/Archives/Development/CompatibilityTables/Importer: Difference between revisions
MDN/Archives/Development/CompatibilityTables/Importer (view source)
Revision as of 11:01, 3 August 2015
, 3 August 2015Improved formatting of 'section_skipped' section
(Add notes for footnote_multiple and footnote_unused) |
Sebastianz (talk | contribs) (Improved formatting of 'section_skipped' section) |
||
| Line 323: | Line 323: | ||
''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 <code>SpecName</code> and <code>Spec2</code> 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()]): | * 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] | ** 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. | ** Paste this into the "Specifications" section of the problem page. | ||
** Replace the specification identifying name in the SpecName(' ... ') and Spec2(' ... ') templates 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 | ** Replace the specification identifying name in the <code>SpecName(' ... ')</code> and <code>Spec2(' ... ')</code> templates 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, <code>Timeranges.start()</code> is specified in the [https://html.spec.whatwg.org/multipage/ WHATWG HTML Living Standard]. In the <code>SpecName</code> 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! | ** 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 <code>SpecName(' ... ')</code> 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 <code>Timeranges.start()</code> 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 <code>'embedded-content.html#dom-timeranges-start'</code>. | ||
** The third argument needs to contain a human-readable name for the feature, in this case 'start()'. | ** The third argument needs to contain a human-readable name for the feature, in this case <code>'start()'</code>. | ||
** the full template call is SpecName('HTML WHATWG','embedded-content.html#dom-timeranges-start','start()') | ** the full template call is <code>SpecName('HTML WHATWG','embedded-content.html#dom-timeranges-start','start()')</code> | ||
* The "Browser compatibility table" should be structured just like the one on the [https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API Fetch API landing page]. If some diffrent kind of table is being used, replace it with a table of this structure. | * The "Browser compatibility table" should be structured just like the one on the [https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API Fetch API landing page]. If some diffrent kind of table is being used, replace it with a table of this structure. | ||