reference items that need examples

[lmccart]

this wiki section contains info on how to add examples. anyone, please feel free to add to this list with reference entries that could use examples added.

• https://p5js.org/reference/#/p5.MediaElement/connect
• https://p5js.org/reference/#/p5.MediaElement/disconnect
• https://p5js.org/reference/#/p5.Graphics/remove
• https://p5js.org/reference/#/p5.PrintWriter/write
• https://p5js.org/reference/#/p5.PrintWriter/print
• https://p5js.org/reference/#/p5.PrintWriter/flush
• https://p5js.org/reference/#/p5.PrintWriter/close
• https://p5js.org/reference/#/p5/setMoveThreshold
• https://p5js.org/reference/#/p5/setShakeThreshold
• https://p5js.org/reference/#/p5/save
• https://p5js.org/reference/#/p5.Table.js:397: method p5.Table.matchRow
• https://p5js.org/reference/#/p5.Table.js:637: method p5.Table.getColumnCount
• https://p5js.org/reference/#/p5.Table.js:647: method p5.Table.getRowCount
• https://p5js.org/reference/#/p5.Table.js:657: method p5.Table.removeTokens
• https://p5js.org/reference/#/p5.Table.js:706: method p5.Table.trim
• https://p5js.org/reference/#/p5.Table.js:907: method p5.Table.setString
• https://p5js.org/reference/#/p5.Table.js/getArray
• https://p5js.org/reference/#/p5.TableRow.js:43: method p5.TableRow.set
• https://p5js.org/reference/#/p5.TableRow.js:74: method p5.TableRow.setNum
• https://p5js.org/reference/#/p5.TableRow.js:89: method p5.TableRow.setString
• https://p5js.org/reference/#/p5.TableRow.js:104: method p5.TableRow.get
• https://p5js.org/reference/#/p5.TableRow/getNum
• https://p5js.org/reference/#/p5.TableRow/getString
• https://p5js.org/reference/#/p5.XML/addChild
• https://p5js.org/reference/#/p5/orbitControl
• https://p5js.org/reference/#/p5/loadShader
• https://p5js.org/reference/#/p5/shader
• https://p5js.org/reference/#/p5.Geometry/computeFaces
• https://p5js.org/reference/#/p5.Geometry/computeNormals
• https://p5js.org/reference/#/p5.Geometry/averageNormals
• https://p5js.org/reference/#/p5.Geometry/averagePoleNormals
• https://p5js.org/reference/#/p5.Geometry/normalize
• https://p5js.org/reference/#/p5.RendererGL/beginShape
• https://p5js.org/reference/#/p5.RendererGL/vertex
• https://p5js.org/reference/#/p5.RendererGL/get
• https://p5js.org/reference/#/p5.RendererGL/loadPixels
• https://p5js.org/reference/#/p5.Shader/setUniform
• https://p5js.org/reference/#/p5.Texture/update
• https://p5js.org/reference/#/p5.Texture/bindTexture
• https://p5js.org/reference/#/p5.Texture/unbindTexture

[theekshanadis]

Hi,

I would like to contribute to p5js by adding examples listed in this issue. I have made an example for httpDo() method as my first contribution.
But I'm new to this Open Source project related documentation. Can you please give me some guidance.

Thank You.

[lmccart]

@Thzn glad you want to contribute, thanks! In addition to the wiki section listed above, you may first want to check out this hello world github introduction and the other github guides and then watch the looking inside p5.js videos to get an overview of the file structure and tools of p5.js.

this section of the wiki explains how to add examples into the source code.

[theekshanadis]

@lmccart
Thank you for the instructions ...!. I will finish it soon...

[outofambit]

hi! what is the proposed workflow for testing and adding examples? should i write them in a separate context and then copy paste into the inline comments?

i'm trying to build and view the documentation locally (by following https://github.com/processing/p5.js/wiki/Inline-documentation#adding-example-code) to verify that my example works, but am having no luck. (getting this:

)

am i going about this wrong? thanks!

[lmccart]

@outofambit sorry that was out of date. running grunt yui should now generate docs that can be viewed at localhost/docs/reference, and are also ready to be copied to p5js.org. the fonts may not link correctly if viewing locally due to cross-origin permissions, but the examples should render.

[outofambit]

@lmccart thanks i'll give that a try!

update: it works great!

[austince]

@Thzn are you still working on the HTTP methods?

In the meantime, I'd like to contribute the Element/elt, Element/class, and Element/removeClass!

[theekshanadis]

@austince
No, I'm not working on them right now. I had a problem with the docker. So I posted about it on the page (toolness/p5.js-docker#13) . I think he is working on it. You can implement them as well.....

[bomoko]

Been meaning to return to this for a while.
I don't see anyone else working on the MediaElement examples - so I'd like to take them on.
Let's say, to begin, I'd like to do src, play, stop, pause, loop, and noLoop

[eJohnstonePhd1991]

This section https://p5js.org/reference/#/p5/createVideo also lacks an example, which may also relate to #1844

[constanceyu]

Hi! I will be working on the p5.Table.js and p5.TableRow.js references. Please let me know if you already started working on any of them so we can work together!

[AdilRabbani]

Hello, I would like to add examples to renderer methods (beginShape, vertex). But as they won't be appearing in the reference docs as suggested by @Spongman in #2793 , should I go for it?

[limzykenneth]

@AdilRabbani those functions will be called when the sketch is in WebGL mode, so maybe you can create WebGL versions of those examples. Get concensus with @Spongman or @kjhollen first maybe as they may still be working on those functionalities.

[kjhollen]

@AdilRabbani documentation for the renderer doesn't appear in the user facing documentation, so I don't think it's necessary to write examples there. However, the vertex method in general only has one example at the moment, and doesn't show any of the configurations for webGL. Maybe you can work on adding some there? in core/vertex.js.

[Spongman]

just be aware that WebGL-mode support for some of the beginShape modes is a little spotty right now. hopefully this should improve a little with #2670.

---

the current list of methods missing examples is:

src\events\acceleration.js:350: method p5.setMoveThreshold missing example
src\events\acceleration.js:363: method p5.setShakeThreshold missing example
src\io\files.js:1329: method p5.save missing example
src\webgl\material.js:14: method p5.loadShader missing example
src\webgl\material.js:123: method p5.shader missing example
src\webgl\p5.Geometry.js:54: method p5.Geometry.computeFaces missing example
src\webgl\p5.Geometry.js:96: method p5.Geometry.computeNormals missing example
src\webgl\p5.Geometry.js:135: method p5.Geometry.averageNormals missing example
src\webgl\p5.Geometry.js:156: method p5.Geometry.averagePoleNormals missing example
src\webgl\p5.Geometry.js:249: method p5.Geometry.normalize missing example
src\webgl\p5.Shader.js:270: method p5.Shader.setUniform missing example

i think it would be nice, once all these are fixed, to turn this message into a build error to ensure that all future additions to the library include an example.

[AdilRabbani]

Added examples for vertex method. #2798

[aatishb]

Hi, I'd like to add some simple visual interactive examples for the p5.Vector methods. Here's a list of examples I'm hoping to add.

[Spongman]

@aatishb nice, could use a little toFixed() here & there.

[lmccart]

thanks for the help everyone! closing this one as #2865 seems to cover this with clearer explanations

[jatin33]

Is this issue still opened? Is anyone else working on it?

[lmccart]

Yes, here's a more up to date issue: #2865
You can get a partial list of missing examples by running grunt. Here's the current list:

src/dom/dom.js:2615: method p5.MediaElement.autoplay missing example
src/dom/dom.js:3032: method p5.MediaElement.connect missing example
src/dom/dom.js:3081: method p5.MediaElement.disconnect missing example
src/io/files.js:1395: method p5.save missing example
src/webgl/material.js:270: method p5.resetShader missing example
src/webgl/p5.Camera.js:298: method p5.createCamera missing example
src/webgl/p5.Camera.js:409: method p5.Camera.perspective missing example
src/webgl/p5.Camera.js:489: method p5.Camera.ortho missing example
src/webgl/p5.Camera.js:548: method p5.Camera.frustum missing example
src/webgl/p5.Camera.js:837: method p5.Camera.camera missing example
src/webgl/p5.Geometry.js:72: method p5.Geometry.computeFaces missing example
src/webgl/p5.Geometry.js:114: method p5.Geometry.computeNormals missing example
src/webgl/p5.Geometry.js:153: method p5.Geometry.averageNormals missing example
src/webgl/p5.Geometry.js:174: method p5.Geometry.averagePoleNormals missing example
src/webgl/p5.Geometry.js:267: method p5.Geometry.normalize missing example