Skip to content

Commit

Permalink
Remove Page macro in example sections - AudioListener (#4401)
Browse files Browse the repository at this point in the history
* Fix up page macro in example section - audiolistener

* Remove syntax as an example
  • Loading branch information
hamishwillee authored Apr 27, 2021
1 parent d92c1a9 commit d932bcf
Show file tree
Hide file tree
Showing 15 changed files with 28 additions and 24 deletions.
2 changes: 1 addition & 1 deletion files/en-us/web/api/audiolistener/dopplerfactor/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h3 id="Value">Value</h3>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioContext.createPanner","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a> for example code.</p>

<h2 id="Browser_compatibility">Browser compatibility</h2>

Expand Down
9 changes: 5 additions & 4 deletions files/en-us/web/api/audiolistener/forwardx/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,25 @@

<p>The <code>forwardX</code> read-only property of the {{ domxref("AudioListener") }} interface is an {{domxref("AudioParam")}} representing the x value of the direction vector defining the forward direction the listener is pointing in.</p>

<div class="note">
<p><strong>Note</strong>: The parameter is <em>a-rate</em> when used with a {{domxref("PannerNode")}} whose {{domxref("PannerNode.panningModel", "panningModel")}} is set to equalpower, or <em>k-rate</em> otherwise.</p>
<div class="notecard note">
<h4>Note</h4>
<p>The parameter is <em>a-rate</em> when used with a {{domxref("PannerNode")}} whose {{domxref("PannerNode.panningModel", "panningModel")}} is set to equalpower, or <em>k-rate</em> otherwise.</p>
</div>

<h2 id="Syntax">Syntax</h2>

<pre class="brush: js">var audioCtx = new AudioContext();
var myListener = audioCtx.listener;
myListener.forwardX.value = 0;
</pre>
</pre>

<h3 id="Value">Value</h3>

<p>An {{domxref("AudioParam")}}. Its default value is 0, and it can range between positive and negative infinity.</p>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioListener","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a> for example code.</p>

<h2 id="Specifications">Specifications</h2>

Expand Down
7 changes: 4 additions & 3 deletions files/en-us/web/api/audiolistener/forwardy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@

<p>The <code>forwardY</code> read-only property of the {{ domxref("AudioListener") }} interface is an {{domxref("AudioParam")}} representing the y value of the direction vector defining the forward direction the listener is pointing in.</p>

<div class="note">
<p><strong>Note</strong>: The parameter is <em>a-rate</em> when used with a {{domxref("PannerNode")}} whose {{domxref("PannerNode.panningModel", "panningModel")}} is set to equalpower, or <em>k-rate</em> otherwise.</p>
<div class="notecard note">
<h4>Note</h4>
<p>The parameter is <em>a-rate</em> when used with a {{domxref("PannerNode")}} whose {{domxref("PannerNode.panningModel", "panningModel")}} is set to equalpower, or <em>k-rate</em> otherwise.</p>
</div>

<h2 id="Syntax">Syntax</h2>
Expand All @@ -31,7 +32,7 @@ <h3 id="Value">Value</h3>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioListener","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example">BaseAudioContext.createPanner()</a> for example code.</p>

<h2 id="Specifications">Specifications</h2>

Expand Down
7 changes: 4 additions & 3 deletions files/en-us/web/api/audiolistener/forwardz/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@

<p>The <code>forwardZ</code> read-only property of the {{ domxref("AudioListener") }} interface is an {{domxref("AudioParam")}} representing the z value of the direction vector defining the forward direction the listener is pointing in.</p>

<div class="note">
<p><strong>Note</strong>: The parameter is <em>a-rate</em> when used with a {{domxref("PannerNode")}} whose {{domxref("PannerNode.panningModel", "panningModel")}} is set to equalpower, or <em>k-rate</em> otherwise.</p>
<div class="notecard note">
<h4>Note</h4>
<p>The parameter is <em>a-rate</em> when used with a {{domxref("PannerNode")}} whose {{domxref("PannerNode.panningModel", "panningModel")}} is set to equalpower, or <em>k-rate</em> otherwise.</p>
</div>

<h2 id="Syntax">Syntax</h2>
Expand All @@ -31,7 +32,7 @@ <h3 id="Value">Value</h3>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioListener","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a> for example code.</p>

<h2 id="Specifications">Specifications</h2>

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/audiolistener/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ <h2 id="Deprecated_features">Deprecated features</h2>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioContext.createPanner","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a> for example code.</p>

<h2 id="Specifications">Specifications</h2>

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/audiolistener/positionx/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h3 id="Value">Value</h3>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioListener","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a> for example code.</p>

<h2 id="Specifications">Specifications</h2>

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/audiolistener/positiony/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h3 id="Value">Value</h3>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioListener","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a> for example code.</p>

<h2 id="Specifications">Specifications</h2>

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/audiolistener/positionz/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h3 id="Value">Value</h3>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioListener","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a> for example code.</p>

<h2 id="Specifications">Specifications</h2>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ <h3 id="Returns">Returns</h3>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioContext.createPanner","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a> for example code.</p>

<h2 id="Parameters">Parameters</h2>

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/audiolistener/setposition/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h3 id="Returns">Returns</h3>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioContext.createPanner","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a> for example code.</p>

<h2 id="Parameters">Parameters</h2>

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/audiolistener/speedofsound/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ <h3 id="Value">Value</h3>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioContext.createPanner","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a> for example code.</p>

<h2 id="Browser_compatibility">Browser compatibility</h2>

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/audiolistener/upx/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h3 id="Value">Value</h3>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioListener","Example")}}</p>
<p>For more detailed example code see <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a>.</p>

<h2 id="Specifications">Specifications</h2>

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/audiolistener/upy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ <h3 id="Value">Value</h3>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioListener","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a> for example code.</p>

<h2 id="Specifications">Specifications</h2>

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/audiolistener/upz/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h3 id="Value">Value</h3>

<h2 id="Example">Example</h2>

<p>{{page("/en-US/docs/Web/API/AudioListener","Example")}}</p>
<p>See <a href="/en-US/docs/Web/API/BaseAudioContext/createPanner#example"><code>BaseAudioContext.createPanner()</code></a> for example code.</p>

<h2 id="Specifications">Specifications</h2>

Expand Down
7 changes: 4 additions & 3 deletions files/en-us/web/api/baseaudiocontext/createpanner/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

<h2 id="Syntax">Syntax</h2>

<pre class="brush: js">baseAudioCtx.createPanner();</pre>
<pre class="brush: js">createPanner();</pre>

<h3 id="Returns">Returns</h3>

Expand Down Expand Up @@ -138,8 +138,9 @@ <h2 id="Example">Example</h2>
pannerData.textContent = `Panner data: X ${xPos} Y ${yPos} Z ${zPos}`;
}</pre>

<div class="note">
<p><strong>Note</strong>: In terms of working out what position values to apply to the
<div class="notecard note">
<h4>Note</h4>
<p>In terms of working out what position values to apply to the
listener and panner, to make the sound appropriate to what the visuals are doing on
screen, there is quite a bit of math involved, but you will soon get used to it with a
bit of experimentation.</p>
Expand Down

0 comments on commit d932bcf

Please sign in to comment.