Skip to content

Commit dba65f8

Browse files
stalgiagstalgiag
authored
Inline links reference and URL concatenation fixes (#64)
* Updated reference * First attempt at correcting JSON comment links * Generate paths using removeLocaleAndExtensionFromId * Rename removeLocaleAndExtensionFromId symbol
1 parent 7977352 commit dba65f8

File tree

174 files changed

+1301
-783
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

174 files changed

+1301
-783
lines changed

Diff for: ‎src/content/reference/en/JSON/stringify.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ submodule: Foundation
55
file: src/core/reference.js
66
description: >
77
<p>From <a
8-
href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">the
8+
href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects./JSON/stringify">the
99
MDN entry</a>:
1010
1111
The JSON.stringify() method converts a JavaScript object or value to a JSON <a
12-
href="#/p5/string">string</a>.</p>
12+
href="./p5/string">string</a>.</p>
1313
line: 490
1414
isConstructor: false
1515
itemtype: method

Diff for: ‎src/content/reference/en/console/log.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ submodule: Foundation
55
file: src/core/reference.js
66
description: >
77
<p>Prints a message to your browser's web console. When using p5, you can use
8-
<a href="#/p5/print">print</a>
8+
<a href="./p5/print">print</a>
99
10-
and <a href="#/p5/console/log">console.log</a> interchangeably.</p>
10+
and <a href="#/p5./console/log">console.log</a> interchangeably.</p>
1111
1212
<p>The console is opened differently depending on which browser you are using.
1313
@@ -17,7 +17,7 @@ description: >
1717
, <a
1818
href="https://developers.google.com/web/tools/chrome-devtools/open">Chrome</a>,
1919
<a
20-
href="https://docs.microsoft.com/en-us/microsoft-edge/devtools-guide/console">Edge</a>,
20+
href="https://docs.microsoft.com/en-us/microsoft-edge/devtools-guide./console">Edge</a>,
2121
2222
and <a
2323
href="https://support.apple.com/en-ca/guide/safari/sfri20948/mac">Safari</a>.
@@ -32,10 +32,10 @@ description: >
3232
3333
The Console method log() outputs a message to the web console. The message may
3434
35-
be a single <a href="#/p5/string">string</a> (with optional substitution
35+
be a single <a href="./p5/string">string</a> (with optional substitution
3636
values),
3737
38-
or it may be any one or more JavaScript <a href="#/p5/object">objects</a>.</p>
38+
or it may be any one or more JavaScript <a href="./p5/object">objects</a>.</p>
3939
line: 512
4040
isConstructor: false
4141
itemtype: method

Diff for: ‎src/content/reference/en/p5.Camera/camera.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ file: src/webgl/p5.Camera.js
66
description: |
77
<p>Sets the camera's position and orientation.
88
Accepts the same parameters as the global
9-
<a href="#/p5/camera">camera()</a>.
9+
<a href="./p5/camera">camera()</a>.
1010
More information on this function can be found there.</p>
1111
line: 1360
1212
isConstructor: false

Diff for: ‎src/content/reference/en/p5.Camera/frustum.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ file: src/webgl/p5.Camera.js
66
description: |
77
<p>Sets the camera's frustum.
88
Accepts the same parameters as the global
9-
<a href="#/p5/frustum">frustum()</a>.
9+
<a href="./p5/frustum">frustum()</a>.
1010
More information on this function can be found there.</p>
1111
line: 1040
1212
isConstructor: false

Diff for: ‎src/content/reference/en/p5.Camera/ortho.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ file: src/webgl/p5.Camera.js
66
description: |
77
<p>Sets an orthographic projection.
88
Accepts the same parameters as the global
9-
<a href="#/p5/ortho">ortho()</a>.
9+
<a href="./p5/ortho">ortho()</a>.
1010
More information on this function can be found there.</p>
1111
line: 956
1212
isConstructor: false

Diff for: ‎src/content/reference/en/p5.Camera/perspective.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ file: src/webgl/p5.Camera.js
66
description: |
77
<p>Sets a perspective projection.
88
Accepts the same parameters as the global
9-
<a href="#/p5/perspective">perspective()</a>.
9+
<a href="./p5/perspective">perspective()</a>.
1010
More information on this function can be found there.</p>
1111
line: 853
1212
isConstructor: false

Diff for: ‎src/content/reference/en/p5.EQ/bands.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ file: lib/addons/p5.sound.js
66
description: |
77
<p>The p5.EQ is built with abstracted p5.Filter objects.
88
To modify any bands, use methods of the <a
9-
href="/reference/#/p5.Filter" title="p5.Filter reference">
9+
href="/./p5.Filter" title="p5.Filter reference">
1010
p5.Filter</a> API, especially <code>gain</code> and <code>freq</code>.
1111
Bands are stored in an array, with indices 0 - 3, or 0 - 7</p>
1212
line: 7198

Diff for: ‎src/content/reference/en/p5.Element/child.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >
88
99
<p><code>myElement.child()</code> accepts either a string ID, DOM node, or
1010
11-
<a href="#/p5.Element">p5.Element</a>. For example,
11+
<a href="#./p5.Element">p5.Element</a>. For example,
1212
1313
<code>myElement.child(otherElement)</code>. If no argument is provided, an
1414
array of

Diff for: ‎src/content/reference/en/p5.Element/draggable.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >
88
99
<p>The parameter, <code>elmnt</code>, is optional. If another
1010
11-
<a href="#/p5.Element">p5.Element</a> object is passed, as in
11+
<a href="#./p5.Element">p5.Element</a> object is passed, as in
1212
1313
<code>myElement.draggable(otherElement)</code>, the other element will become
1414
draggable.</p>

Diff for: ‎src/content/reference/en/p5.Element/parent.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ description: >
2323
2424
<code>myElement.parent('container')</code>. It can also be another
2525
26-
<a href="#/p5.Element">p5.Element</a> object, as in
26+
<a href="#./p5.Element">p5.Element</a> object, as in
2727
2828
<code>myElement.parent(myDiv)</code>. Finally, <code>parent</code> can be an
2929
<code>HTMLElement</code>

Diff for: ‎src/content/reference/en/p5.Envelope/ramp.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ file: lib/addons/p5.sound.js
66
description: >
77
<p>Exponentially ramp to a value using the first two
88
9-
values from <code><a href="#/p5.Envelope/setADSR">setADSR(attackTime,
9+
values from <code><a href="./setADSR">setADSR(attackTime,
1010
decayTime)</a></code>
1111
1212
as <a href="https://en.wikipedia.org/wiki/RC_time_constant">

Diff for: ‎src/content/reference/en/p5.Font/textBounds.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,15 +28,15 @@ description: >
2828
2929
coordinates of the bounding box's bottom-left corner. See
3030
31-
<a href="#/p5/textAlign">textAlign()</a> for more ways to align text.</p>
31+
<a href="./p5/textAlign">textAlign()</a> for more ways to align text.</p>
3232
3333
<p>The fourth parameter, <code>fontSize</code>, is optional. It sets the font
3434
size used to
3535
3636
determine the bounding box. By default, <code>font.textBounds()</code> will
3737
use the
3838
39-
current <a href="#/p5/textSize">textSize()</a>.</p>
39+
current <a href="./p5/textSize">textSize()</a>.</p>
4040
line: 62
4141
isConstructor: false
4242
itemtype: method

Diff for: ‎src/content/reference/en/p5.Font/textToPoints.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ description: >
2222
2323
coordinates of the bounding box's bottom-left corner. See
2424
25-
<a href="#/p5/textAlign">textAlign()</a> for more ways to align text.</p>
25+
<a href="./p5/textAlign">textAlign()</a> for more ways to align text.</p>
2626
2727
<p>The fourth parameter, <code>fontSize</code>, is optional. It sets the
2828
text's font
2929
3030
size. By default, <code>font.textToPoints()</code> will use the current
3131
32-
<a href="#/p5/textSize">textSize()</a>.</p>
32+
<a href="./p5/textSize">textSize()</a>.</p>
3333
3434
<p>The fifth parameter, <code>options</code>, is also optional.
3535
<code>font.textToPoints()</code>

Diff for: ‎src/content/reference/en/p5.Framebuffer/autoSized.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: |
88
along with the canvas it's attached to in order to match its size.</p>
99
<p>Call this method with no arguments to see if it is currently auto-sized,
1010
or pass in a boolean to set this property.</p>
11-
line: 257
11+
line: 261
1212
isConstructor: false
1313
itemtype: method
1414
class: p5.Framebuffer

Diff for: ‎src/content/reference/en/p5.Framebuffer/begin.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ description: |
77
<p>Begin drawing to this framebuffer. Subsequent drawing functions to the
88
canvas the framebuffer is attached to will not be immediately visible, and
99
will instead be drawn to the framebuffer's texture. Call
10-
<a href="#/p5.Framebuffer/end">end()</a> when finished to make draw
10+
<a href="./end">end()</a> when finished to make draw
1111
functions go right to the canvas again and to be able to read the
1212
contents of the framebuffer's texture.</p>
13-
line: 790
13+
line: 794
1414
isConstructor: false
1515
itemtype: method
1616
alt: |-

Diff for: ‎src/content/reference/en/p5.Framebuffer/color.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ submodule: ''
55
file: src/webgl/p5.Framebuffer.js
66
description: |
77
<p>A texture with the color information of the framebuffer. Pass this (or the
8-
framebuffer itself) to <a href="#/p5/texture">texture()</a> to draw it to
8+
framebuffer itself) to <a href="./p5/texture">texture()</a> to draw it to
99
the canvas, or pass it to a shader with
1010
<a href="#/p5.Shader/setUniform">setUniform()</a> to read its data.</p>
1111
<p>Since Framebuffers are controlled by WebGL, their y coordinates are stored
1212
flipped compared to images and videos. When texturing with a framebuffer
1313
texture, you may want to flip vertically, e.g. with
1414
<code>plane(framebuffer.width, -framebuffer.height)</code>.</p>
15-
line: 1279
15+
line: 1283
1616
isConstructor: false
1717
itemtype: property
1818
alt: 'A red, green, and blue sphere in the middle of the canvas'

Diff for: ‎src/content/reference/en/p5.Framebuffer/createCamera.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ submodule: ''
55
file: src/webgl/p5.Framebuffer.js
66
description: |
77
<p>Creates and returns a new
8-
<a href="#/p5.FramebufferCamera">p5.FramebufferCamera</a> to be used
8+
<a href="#./p5.FramebufferCamera">p5.FramebufferCamera</a> to be used
99
while drawing to this framebuffer. The camera will be set as the
1010
currently active camera.</p>
11-
line: 698
11+
line: 702
1212
isConstructor: false
1313
itemtype: method
1414
class: p5.Framebuffer

Diff for: ‎src/content/reference/en/p5.Framebuffer/depth.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: >
99
was created with <code>{ depth: false }</code> in its settings, then this
1010
property will
1111
12-
be undefined. Pass this to <a href="#/p5/texture">texture()</a> to draw it to
12+
be undefined. Pass this to <a href="./p5/texture">texture()</a> to draw it to
1313
1414
the canvas, or pass it to a shader with
1515
@@ -22,7 +22,7 @@ description: >
2222
texture, you may want to flip vertically, e.g. with
2323
2424
<code>plane(framebuffer.width, -framebuffer.height)</code>.</p>
25-
line: 1321
25+
line: 1325
2626
isConstructor: false
2727
itemtype: property
2828
alt: |-

Diff for: ‎src/content/reference/en/p5.Framebuffer/draw.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ description: >
1212
and then calling <code>framebuffer.end()</code>, but ensures that one never
1313
1414
accidentally forgets <code>begin</code> or <code>end</code>.</p>
15-
line: 947
15+
line: 951
1616
isConstructor: false
1717
itemtype: method
1818
alt: |-

Diff for: ‎src/content/reference/en/p5.Framebuffer/end.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ submodule: ''
55
file: src/webgl/p5.Framebuffer.js
66
description: |
77
<p>After having previously called
8-
<a href="#/p5.Framebuffer/begin">begin()</a>, this method stops drawing
8+
<a href="./begin">begin()</a>, this method stops drawing
99
functions from going to the framebuffer's texture, allowing them to go
1010
right to the canvas again. After this, one can read from the framebuffer's
1111
texture.</p>
12-
line: 918
12+
line: 922
1313
isConstructor: false
1414
itemtype: method
1515
class: p5.Framebuffer

Diff for: ‎src/content/reference/en/p5.Framebuffer/get.mdx

+5-5
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ description: >
2525
getting an image, the x and y parameters define the coordinates for the
2626
2727
upper-left corner of the image, regardless of the current <a
28-
href="#/p5/imageMode">imageMode()</a>.</p>
29-
line: 1026
28+
href="./p5/imageMode">imageMode()</a>.</p>
29+
line: 1030
3030
isConstructor: false
3131
itemtype: method
3232
class: p5.Framebuffer
3333
return:
3434
description: the rectangle <a href="#/p5.Image">p5.Image</a>
3535
type: p5.Image
3636
overloads:
37-
- line: 1026
37+
- line: 1030
3838
params:
3939
- name: x
4040
description: |
@@ -55,12 +55,12 @@ overloads:
5555
return:
5656
description: the rectangle <a href="#/p5.Image">p5.Image</a>
5757
type: p5.Image
58-
- line: 1047
58+
- line: 1051
5959
params: []
6060
return:
6161
description: the whole <a href="#/p5.Image">p5.Image</a>
6262
type: p5.Image
63-
- line: 1051
63+
- line: 1055
6464
params:
6565
- name: x
6666
description: ''

Diff for: ‎src/content/reference/en/p5.Framebuffer/pixelDensity.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: |
99
created on, which will match the display density.</p>
1010
<p>Call this method with no arguments to get the current density, or pass
1111
in a number to set the density.</p>
12-
line: 235
12+
line: 239
1313
isConstructor: false
1414
itemtype: method
1515
class: p5.Framebuffer

Diff for: ‎src/content/reference/en/p5.Framebuffer/pixels.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ description: >
1111
1212
containing the values for all the pixels in the Framebuffer.</p>
1313
14-
<p>Like the <a href="#/p5/pixels">main canvas pixels property</a>, call
14+
<p>Like the <a href="./p5/pixels">main canvas pixels property</a>, call
1515
16-
<a href="#/p5.Framebuffer/loadPixels">loadPixels()</a> before reading
16+
<a href="./loadPixels">loadPixels()</a> before reading
1717
18-
it, and call <a href="#/p5.Framebuffer.updatePixels">updatePixels()</a>
18+
it, and call <a href="#./p5.Framebuffer.updatePixels">updatePixels()</a>
1919
2020
afterwards to update its data.</p>
2121
2222
<p>Note that updating pixels via this property will be slower than
2323
24-
<a href="#/p5.Framebuffer/begin">drawing to the framebuffer directly.</a>
24+
<a href="./begin">drawing to the framebuffer directly.</a>
2525
2626
Consider using a shader instead of looping over pixels.</p>
2727
line: 93

Diff for: ‎src/content/reference/en/p5.Framebuffer/remove.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ submodule: ''
55
file: src/webgl/p5.Framebuffer.js
66
description: |
77
<p>Removes the framebuffer and frees its resources.</p>
8-
line: 729
8+
line: 733
99
isConstructor: false
1010
itemtype: method
1111
alt: A rotating red cube blinks on and off every second.

Diff for: ‎src/content/reference/en/p5.Graphics/createFramebuffer.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ description: >
99
inside a p5.Graphics WebGL context.</p>
1010
1111
<p>This takes the same parameters as the <a
12-
href="#/p5/createFramebuffer">global
12+
href="./p5/createFramebuffer">global
1313
1414
createFramebuffer function.</a></p>
15-
line: 199
15+
line: 203
1616
isConstructor: false
1717
itemtype: method
1818
class: p5.Graphics

Diff for: ‎src/content/reference/en/p5.Graphics/remove.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ file: src/core/p5.Graphics.js
66
description: |
77
<p>Removes a Graphics object from the page and frees any resources
88
associated with it.</p>
9-
line: 131
9+
line: 135
1010
isConstructor: false
1111
itemtype: method
1212
alt: |-

Diff for: ‎src/content/reference/en/p5.Graphics/reset.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ description: >
99
1010
and in the Lights category that are not automatically reset
1111
12-
with graphics buffer objects. Calling this in <a href='#/p5/draw'>draw()</a>
12+
with graphics buffer objects. Calling this in <a href='./p5/draw'>draw()</a>
1313
will copy the behavior
1414
1515
of the standard canvas.</p>
16-
line: 79
16+
line: 83
1717
isConstructor: false
1818
itemtype: method
1919
alt: >-

0 commit comments

Comments
 (0)