<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<!DOCTYPE bugzilla SYSTEM "https://www.w3.org/Bugs/Public/page.cgi?id=bugzilla.dtd">

<bugzilla version="5.0.4"
          urlbase="https://www.w3.org/Bugs/Public/"
          
          maintainer="sysbot+bugzilla@w3.org"
>

    <bug>
          <bug_id>26335</bug_id>
          
          <creation_ts>2014-07-14 23:18:20 +0000</creation_ts>
          <short_desc>Add &quot;data-noexport&quot; to local dfns that just point to other specs</short_desc>
          <delta_ts>2015-09-16 09:26:23 +0000</delta_ts>
          <reporter_accessible>1</reporter_accessible>
          <cclist_accessible>1</cclist_accessible>
          <classification_id>1</classification_id>
          <classification>Unclassified</classification>
          <product>WHATWG</product>
          <component>HTML</component>
          <version>unspecified</version>
          <rep_platform>Other</rep_platform>
          <op_sys>other</op_sys>
          <bug_status>RESOLVED</bug_status>
          <resolution>MOVED</resolution>
          
          
          <bug_file_loc></bug_file_loc>
          <status_whiteboard>tools</status_whiteboard>
          <keywords></keywords>
          <priority>P3</priority>
          <bug_severity>normal</bug_severity>
          <target_milestone>Unsorted</target_milestone>
          
          
          <everconfirmed>1</everconfirmed>
          <reporter name="Tab Atkins Jr.">jackalmage</reporter>
          <assigned_to name="Ian &apos;Hixie&apos; Hickson">ian</assigned_to>
          <cc>annevk</cc>
    
    <cc>ian</cc>
    
    <cc>mike</cc>
          
          <qa_contact>contributor</qa_contact>

      

      

      

          <comment_sort_order>oldest_to_newest</comment_sort_order>  
          <long_desc isprivate="0" >
    <commentid>108928</commentid>
    <comment_count>0</comment_count>
    <who name="Tab Atkins Jr.">jackalmage</who>
    <bug_when>2014-07-14 23:18:20 +0000</bug_when>
    <thetext>If you have any local &quot;definitions&quot; that are actually just local anchors that point to the real definitions in other specs, they should be marked with a &quot;data-noexport&quot; boolean attribute.  This ensures that Shepherd won&apos;t pick them up when parsing the spec, and they won&apos;t cause accidental dfn conflicts with the spec that actually defines them when a Bikeshedded spec uses the term.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>108955</commentid>
    <comment_count>1</comment_count>
    <who name="Ian &apos;Hixie&apos; Hickson">ian</who>
    <bug_when>2014-07-15 18:31:21 +0000</bug_when>
    <thetext>Isn&apos;t that just redundant with looking at whether the &lt;dfn&gt; has a link inside it that points to another spec?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>108970</commentid>
    <comment_count>2</comment_count>
    <who name="Tab Atkins Jr.">jackalmage</who>
    <bug_when>2014-07-15 20:09:52 +0000</bug_when>
    <thetext>Possibly, but that feels too magical to me.  You definitely can&apos;t test just for the presence of a link (Bikeshed puts permalink anchors inside of &lt;dfn&gt;s, for example), and once you&apos;re actually examining the href of a link to see if it disqualifies a &lt;dfn&gt; from being &quot;export-worthy&quot;, I feel like you&apos;re a few steps past reasonable.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>109019</commentid>
    <comment_count>3</comment_count>
    <who name="Ian &apos;Hixie&apos; Hickson">ian</who>
    <bug_when>2014-07-16 19:50:04 +0000</bug_when>
    <thetext>I don&apos;t understand why that&apos;s magical. An attribute is redundant. The question is &quot;is this a definition of a term in another spec&quot;, and the answer is in the DOM already, since it&apos;s a &lt;dfn&gt; with a &lt;a href=&quot;&quot;&gt; link to another spec. It&apos;s not magical, it&apos;s just looking at the semantics, which is the whole point of having semantics.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>109696</commentid>
    <comment_count>4</comment_count>
    <who name="Ian &apos;Hixie&apos; Hickson">ian</who>
    <bug_when>2014-07-31 19:32:50 +0000</bug_when>
    <thetext>Sounds like Anne&apos;s pipeline uses the fragment-links.js file currently. Would it make sense for me to just export a data file that you can both parse more easily rather than having y&apos;all try to parse the HTML or JS files?

What information are you actually looking for?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>109712</commentid>
    <comment_count>5</comment_count>
    <who name="Tab Atkins Jr.">jackalmage</who>
    <bug_when>2014-07-31 21:27:26 +0000</bug_when>
    <thetext>(In reply to Ian &apos;Hixie&apos; Hickson from comment #4)
&gt; Sounds like Anne&apos;s pipeline uses the fragment-links.js file currently. Would
&gt; it make sense for me to just export a data file that you can both parse more
&gt; easily rather than having y&apos;all try to parse the HTML or JS files?
&gt; 
&gt; What information are you actually looking for?

I don&apos;t parse anything, Shepherd (the tool maintained by Peter Linss) does.  It already does HTML parsing for all this stuff, so it would be more work to do a special data file than to just parse the spec as it is.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>109714</commentid>
    <comment_count>6</comment_count>
    <who name="Tab Atkins Jr.">jackalmage</who>
    <bug_when>2014-07-31 22:24:35 +0000</bug_when>
    <thetext>(In reply to Ian &apos;Hixie&apos; Hickson from comment #4)
&gt; What information are you actually looking for?

Oh, I didn&apos;t answer this part.

What I&apos;m looking for is all the terms that HTML defines, in a machine-extractable format, but none of the terms that HTML doesn&apos;t define (in other words, no collisions with the *real* definitions in other specs; collisions are nowhere near fatal in Bikeshed, but they&apos;re annoying and should be limited).</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>109719</commentid>
    <comment_count>7</comment_count>
    <who name="Ian &apos;Hixie&apos; Hickson">ian</who>
    <bug_when>2014-07-31 22:47:30 +0000</bug_when>
    <thetext>Where a definition is a human-readable string, a cross-reference keyword (&quot;concept-foo-bar&quot;, &quot;attr-quux-book&quot;, or whatever), a spec identifier (the equivalent of &quot;[HTML]&quot;), and a URL with fragment identifier pointing to the &lt;dfn&gt; where that term is defined?</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>109722</commentid>
    <comment_count>8</comment_count>
    <who name="Tab Atkins Jr.">jackalmage</who>
    <bug_when>2014-07-31 23:13:31 +0000</bug_when>
    <thetext>(In reply to Ian &apos;Hixie&apos; Hickson from comment #7)
&gt; Where a definition is a human-readable string, a cross-reference keyword
&gt; (&quot;concept-foo-bar&quot;, &quot;attr-quux-book&quot;, or whatever), a spec identifier (the
&gt; equivalent of &quot;[HTML]&quot;), and a URL with fragment identifier pointing to the
&gt; &lt;dfn&gt; where that term is defined?

No need for cross-ref keyword; that&apos;s what the human-readable string is for.  No need for a spec identifier either; that&apos;s implied by the fact that the definitions appear in the spec.

Shepherd just looks for:

* the term being defined; this defaults to the text content of the &lt;dfn&gt;, but can be overridden by the title=&apos;&apos; attribute.
* the id of the &lt;dfn&gt;
* the type of the definition; Bikeshed&apos;s type hierarchy is at &lt;https://github.com/tabatkins/bikeshed/blob/master/docs/definitions-autolinks.md#definition-types&gt;.  This is specified in markup via the data-dfn-type=&apos;&apos; attribute.
* for the definition types that are namespaced to some other object (like element attributes, or interface methods), the name of the thing they&apos;re namespaced to.  This is specified in markup via the data-dfn-for=&apos;&apos; attribute.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>122964</commentid>
    <comment_count>9</comment_count>
    <who name="Anne">annevk</who>
    <bug_when>2015-09-01 09:37:58 +0000</bug_when>
    <thetext>See https://github.com/whatwg/html/pull/60 for a simple attempt at doing this. PRs for more such changes will be accepted.</thetext>
  </long_desc><long_desc isprivate="0" >
    <commentid>123221</commentid>
    <comment_count>10</comment_count>
    <who name="Anne">annevk</who>
    <bug_when>2015-09-16 09:26:23 +0000</bug_when>
    <thetext>https://github.com/whatwg/html/pull/150</thetext>
  </long_desc>
      
      

    </bug>

</bugzilla>