Rewrite all "engineer"-written Patches popups

esaruoho commented 7 years ago

Concept: take all the atom descriptions and rewrite them, in case they are not descriptive. Detail: There's 256 of them at vizor/documentation/browser/plugins

I'll let @mattatgit speak: As i recall, most of the tooltips were pretty much dense technical jargon, and mostly gave users no real clue as to (a) what the patch does or (b) how to use it. Along with writing proper docs, this is another one of those large efforts that would require at least 2 people + substantial time. Someone needs to go through and rewrite them all, consulting with Antti when a patch's function or purpose is unclear.

so, anyway, onwards & upwards!

~~Here's a good example:~~

fullscreen_06_07_2017__10_20

Note: this has already been fixed, and replaced with the following written by @mattatgit:

Anything connected here will appear in your Vizor scene. Click the port and drag to disconnect or select the patch and hit delete.

Continuing onwards: ~~The end user (TM) will not be interested in finding out that the Scene is the informative "THREE.js Scene".~~ They want more verbose descriptions.

This issue will need to be an ongoing process since there is simply no way we can address ALL of the atoms in a single fell swoop.

What we could do, is single out the worst offenders (TM) and attack those, then think about the whole rewrite to make them all stick to one form.

Concept originally mentioned by wd-vizor at #256 (issue now closed) wd-vizor also posted this URL: https://etherpad.mozilla.org/ZrIm7QNBny

which is basically a this.desc dump of descriptions. note: this.desc in the plugin.js file itself is not the same as what is on /vizor/documentation/browser/plugins/pluginname.md (what the user sees)

Here's a slightly more up-to-date one: https://pastebin.com/raw/s6EmxcPM

esaruoho commented 7 years ago

Description missing altogether

[ ] array_remove.md
[ ] cubemap_assembler.md
[ ] photosphere_orientation_reader.md
[ ] radial_point_geometry.md
[ ] runtime_event_read.md
[ ] three_material_modifier.md

added to branch https://github.com/vizorvr/vizor/tree/Patchesbranch

[x] add_on_trigger_float.md
[x] add_on_trigger_vector3.md
[x] array_length.md
[x] array_set.md
[x] array_get.md

esaruoho commented 7 years ago

here's the list from 2017-07-06 (6th of July 2017) https://pastebin.com/raw/s6EmxcPM

esaruoho commented 7 years ago

Three.JS mess

[ ] three_ambient_light.md -- THREE.js Ambient Light
[ ] three_cube_material.md -- Cube Shader Material.
[ ] three_directional_light.md -- THREE.js Directional Light
[ ] three_environment_settings.md -- Environment Settings Description
[ ] three_gaze_clicker.md -- Gaze Clicker
[ ] three_geometry_box.md -- THREE.js Box Geometry
[ ] three_geometry_circle.md -- THREE.js Circle Geometry
[ ] three_geometry_cylinder.md -- THREE.js Cylinder Geometry
[ ] three_geometry_dodecahedron.md -- THREE.js Dodecahedron Geometry
[ ] three_geometry_plane.md -- THREE.js Plane Geometry
[ ] three_geometry_ring.md -- THREE.js Ring Geometry
[ ] three_geometry_sphere.md -- THREE.js Sphere Geometry
[ ] three_geometry_torus.md -- THREE.js Torus Geometry
[ ] three_group.md -- Group several object3ds together so that they can be manipulated as one
[ ] three_hemisphere_light.md -- THREE.js Hemisphere Light
[ ] three_line_material.md -- THREE.js Line Material
[ ] three_line_segments.md -- THREE.js Line Segments
[ ] three_loader_model.md -- THREE.js OBJ loader
[ ] three_loader_scene.md -- 3D Object/Scene loader. Loads .obj and THREE.js .json object hierarchies.
[ ] three_material.md -- THREE.js Mesh Basic Material
[ ] three_material_depth.md -- THREE.js Mesh Depth Material
[ ] three_material_extractor.md -- THREE.js Material Extractor
[ ] three_material_lambert.md -- THREE.js Lambert Material
[ ] three_material_modifier.md -- no description
[ ] three_material_phong.md -- THREE.js Phong Material
[ ] three_material_shader.md -- Shader Material
[ ] three_material_standard.md -- THREE.js Standard Material
[ ] three_mesh.md -- THREE.js Mesh
[ ] three_meshline_material.md -- Vector Line Material
[ ] three_meshline_mesh.md -- Vector Line Object3d
[ ] three_object3d_attribute_extractor.md -- Extract position, rotation and scale from a Mesh
[ ] three_object3d_bbox_extractor.md -- Extract bounding box from Mesh
[ ] three_orbit_camera.md -- THREE.js Orbit Camera
[ ] three_particle_emitter.md -- no description
[ ] three_perspective_camera.md -- THREE.js Perspective Camera
[ ] three_point_cloud_material.md -- THREE.js Point Cloud Material
[ ] three_point_cloud_mesh.md -- THREE.js Point Cloud Mesh
[ ] three_point_light.md -- THREE.js Point Light
[ ] three_procedural_ground.md -- THREE.js Procedural Ground
[ ] three_spot_light.md -- THREE.js Spot Light
[ ] three_text_geometry.md -- Generate text
[ ] three_vr_camera.md -- THREE.js VR Camera
[ ] three_webgl_renderer.md -- THREE.js WebGL renderer
[ ] three_webgl_texture_renderer.md -- THREE.js WebGL Texture renderer

esaruoho commented 7 years ago

detail: how to export the textfile - go into the folder with the .md files and run this script: (btw, script was written by Jari Jaanto, thanks Jari!)

    A="##Description"
    B="##Inputs"
    for i in *.md
    do
            echo $i
            foo=`cat $i`
            foo=${foo##*$A}
            foo=${foo%%$B*}
            echo "$foo" | awk 'n>=2 { print a[n%2] } { a[n%2]=$0; n=n+1 }'|tail -n +2
    done

esaruoho commented 7 years ago

added to branch https://github.com/vizorvr/vizor/tree/Patchesbranch

[x] add_on_trigger_float.md
[x] add_on_trigger_vector3.md
[x] array_length.md
[x] array_set.md
[x] array_get.md

vizorvr / patches

Rewrite all "engineer"-written Patches popups #2022