Re: [w3c/screen-orientation] Clean-up anchors and definitions (#109)

marcoscaceres requested changes on this pull request.

Nearly there! 

> @@ -131,12 +131,12 @@
           task</a></dfn>
         </li>
         <li>
-          <code><dfn><a href=
-          'https://html.spec.whatwg.org/multipage/browsers.html#window'>Window</a></dfn></code>
+          <dfn><a href=

We need to update these (I mislead you a bit, here is ok to use code, then ReSpec automatically "codes" any `a` that xref this)... we can do these separately tho unless you feel like doing them now. 

```HTML
<code><dfn data-cite="!HTML/multipage/browsers.html#window">Window</dfn></code>
```

See: https://github.com/w3c/respec/wiki/data--cite

> @@ -231,45 +231,44 @@
           };
         </pre>
         <p>
-          When the <code><dfn for='ScreenOrientation'>lock</dfn>()</code>
-          method is invoked, the <a>user agent</a> MUST run the <a>apply an
-          orientation lock</a> steps to the <a>responsible document</a> using
+          When the <dfn>lock</dfn>() method is invoked,

Nit: we now support `<dfn>lock()</dfn>` (i.e., parens inside)

> @@ -212,13 +212,13 @@
           };
         </pre>
         <p>
-          The <code><dfn for='Screen'>orientation</dfn></code> object is an
+          The <dfn for='Screen'>orientation</dfn> object is an

Nit: for attribute is not supported. 

>            <var>orientation</var>.
         </p>
         <p>
-          When the <code><dfn for='ScreenOrientation'>unlock</dfn>()</code>
-          method is invoked, the <a>user agent</a> MUST run the steps to
-          <a>lock the orientation</a> of the <a>responsible document</a> to the
+          When the <dfn>unlock</dfn>() method is

as above. 

>          </p>
         <p>
-          The <code><dfn for='ScreenOrientation'>onchange</dfn></code>
-          attribute is an <a>event handler</a> whose corresponding <a>event
-          handler event type</a> is <code>change</code>.
+          The <dfn>onchange</dfn> attribute is an
+          <a>event handler</a> whose corresponding <a>event handler event type</a>
+          is <code>change</code>.

we should probably write `<code>"change"</code>`... if we defined "change", we should probably link to it... can't remember tho. 

>          </p>
         <p>
-          The <code><dfn for='ScreenOrientation'>onchange</dfn></code>
-          attribute is an <a>event handler</a> whose corresponding <a>event
-          handler event type</a> is <code>change</code>.
+          The <dfn>onchange</dfn> attribute is an
+          <a>event handler</a> whose corresponding <a>event handler event type</a>
+          is <code>change</code>.
         </p>
       </section>
       <section>

Please add `data-link-for="OrientationType" data-dfn-for="OrientationType"` attributes to this section.

> @@ -355,15 +354,13 @@
         <ol>
           <li>If the screen width is greater than the screen height, set the
           <a>document</a>'s <a>current orientation type</a> to
-            <code><dfn for='OrientationType'>landscape-primary</dfn></code>
-            or <code><dfn for=
-            'OrientationType'>landscape-secondary</dfn></code>.
+          <dfn data-dfn-for='OrientationType'>landscape-primary</dfn> or

Let's move the `data-dfn-for='OrientationType'` to the `section` element, then it will just work with `<dfn>` 

> @@ -463,20 +460,20 @@
           <li>Depending on <var>orientation</var> value, do the following:
             <dl>
               <dt>
-                <code><dfn for=
-                'OrientationLockType'>portrait-primary</dfn></code> or
-                <code><dfn for=
-                'OrientationLockType'>portrait-secondary</dfn></code> or
-                <code><dfn for=
-                'OrientationLockType'>landscape-primary</dfn></code> or
-                <code><dfn for=
-                'OrientationLockType'>landscape-secondary</dfn></code>
+                <dfn data-dfn-for=

as above... then you don't need `data-dfn-for` here... ReSpec always looks for the nearest section with "data-dfn-for=". 

> @@ -702,9 +698,9 @@
               </li>
               <li>If the orientation change was triggered by a user gesture
               such as the user turning the device, as opposed to a call to
-              <a data-link-for='ScreenOrientation'>lock</a>, the <a>task</a>
-              MUST be annotated with <code>process user orientation change
-              </code> when running the next step.
+              <a>lock</a>, the <a>task</a> MUST be annotated with
+              <code>process user orientation change</code> when running the

Nit: this `code` should probably have been an `<a>` 

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/w3c/screen-orientation/pull/109#pullrequestreview-73716488

Received on Thursday, 2 November 2017 09:02:21 UTC