Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation #102

Open
6 of 34 tasks
eric79 opened this issue Jan 20, 2014 · 2 comments
Open
6 of 34 tasks

Fix documentation #102

eric79 opened this issue Jan 20, 2014 · 2 comments
Assignees
Labels

Comments

@eric79
Copy link
Member

eric79 commented Jan 20, 2014

  • Fix h1 and h2 headers that block clicking on links above them
  • Replace “Installation Instructions” with Mike’s new version - waiting for @MichaelVacirca
  • Tutorials - waiting for @jessmartin 's Getting Started page [Remove tutorials and link to Getting Started. vwf-web#17]
    • Have Tutorials section point to Jess’ Pong application
    • Remove Hello World and Sandtable tutorials
  • Component Structure
    • Switch “components” and “prototypes” links to point to sections, not other pages
  • Apply browser checks to all pages with embedded content, and also the browser requirements page
  • The Drivers
    • Instead of “the next section…” say, “Now we’ll talk about how the system works and how to reconfigure the system to accomplish more complex tasks”
    • Fix links to point to other parts of the page instead of other pages
    • Move this section right before the Drivers section or revamp whole architecture section to just talk about the structure, not too deep
    • Switch “GLGE” to “three.js”
  • Components
    • Component Contents
      • “needs to be included” instead of “include”
      • Children are not inherited by the component (mentioned both in extends and implments)
      • Fix prototypes, behaviors links
      • Shouldn’t the set and get have semicolons?
      • Change “definined” to “defined”
      • Are all the dispatched event names still valid?
  • Cameras
    • Say “every application that extends ‘scene.vwf’” automatically….
    • Fix components link
    • Transform properties
      • Figure out what axis/angle part should say (is it true what it says about multiplication?)
      • Give a better example than that convoluted one
    • Using multiple cameras
      • Test to see if activeCamera part is true
  • Lights
    • Fix links
    • Remove reference to glge properties
  • Prototypes
    • Fix links
    • Remove reference to navscene.vwf
  • Behaviors
    • Second paragraph: behaviors and children are not inherited
  • Animations
    • Links
    • Switch “collada animations” to “model animations” or something
    • Does it work to do future w/o parentheses?
  • Remove HTML Overlays section\
  • Editor
    • Upper “right”, not upper “ride”
    • “entered”, not “intered”
    • “To exit the script editor” not “To exit to script editor”
    • Does Time pausing/fastforwarding work?
    • About – version numbers still fit the pattern?
  • Querying
    • Links
    • See if there are any outstanding tasks for the Querying section
  • Cookbook: Remove all but the first sentence
  • Create a Multi-User Application
    • Links
  • Create a simulation
    • Remove reference to navscene
    • Have the user put the new component in the folder with their app, not in support/client/blahblahblah
    • Remove reference to “Advanced Event Handling” recipe
  • Create a 2D interface
    • Links
    • Create Components should be titled “Create Nodes”
  • Change “componentName” to “nodeName”
    • Monitor the Model from HTML should not be a link
  • Switch Materials recipe
    • Remove reference to navscene
    • Links
    • Fix spacing in code
  • Add Chat recipe
    • Fix text at beginning of recipe
    • May not be relevant to reference the multi-user recipe anymore
    • sceneNode is a confusing name since there is no 3D scene
    • Use “===”
    • “setup” is two words when used as a verb
    • Fix spacing in code
  • Complex transforms recipe
    • Fix spacing in code
    • Links
    • Transform By examples use transformTo
    • “There are several vector and matrix operations that can be used to calculate a vector and/or matrix to assign to the transform properties or passed to the transform methods.” Should say “which can be assigned to the transform properties or passed…”
    • “finally here are a few more examples”
  • Add Training Instructions
    • Fix underlining
    • Links
    • Remove reference to GLGE
  • Persistence
    • Figure out what to do with this – is this really up to date? I don’t like the call to vwf
  • Testing
    • Fix Note
  • Pitfalls
    • Links
  • Application API
    • Remove
      • Atmosphere.vwf
      • Canvas.vwf
      • Car.vwf
      • centralObject.vwf
      • cesium.vwf
      • control.position.vwf
      • control.vwf
      • dynamicObject.vwf
      • editable3.vwf
      • fly.vwf
      • googleEarth.vwf
      • info-on-click.vwf
      • instruction.vwf
      • lesson.vwf
      • mesh.vwf
      • navscene
      • node3edit.vwf
      • polygon.vwf
      • polylineCollection.vwf
      • polyline.vwf
      • scale-on-click
      • skybox.vwf
      • spin-on-click
      • sun
      • sway-on-click
      • translate-on-down
      • video
    • Rename
      • Client to webRTC-client
    • Fix
      • Control.position.vwf
        • Text under sequence needs work
      • followPath.vwf
        • documentation not showing up correctly
        • Switch reference to fly.vwf to followPath.vwf
      • Material.vwf
        • Make sure it doesn’t get mixed w/ cesium material component
      • Navigable.vwf
        • Change description to make sense
      • Node.vwf
        • Flesh out methods and events
  • System API – Remove it for now
  • Links all take you below title
  • Want a link for every section
  • Frequently when I click a link on the left, the other links and some of the top disappear. How come? (links show up when I mouse over them; everything shows up if I mouse wheel up)
  • Rethink documentation
    • Example apps have no comments in them
    • Some example apps don't work
    • Create an example app using pointerInfo and pickInfo
    • Show how to create objects in yaml, json, and dynamically in js
  • Document pitfall of doing any operations on the nodeID (don’t expect that you know what form it’s in)
@ghost ghost assigned eric79 Jan 20, 2014
@MichaelVacirca
Copy link
Contributor

The anchor tags themselves are formatted for HTML4, but in HTML5 there has been an update such as follows:

current tag:

<a name="install"/><div>....</div>

HTML5:

<div id="install" class="well" markdown="1">

HTML5 anchors go to id of the element itself now, and should be the way to make anchors.

@MichaelVacirca
Copy link
Contributor

As far as the anchors dropping under the header when they are referenced, a potential solution may be to give each div a class type ie:

<div id="install" class="well" markdown="1" class="topClass">

and then set a CSS property for it as follows

div.topClass {
top:-100px;
}

@eric79 eric79 mentioned this issue Feb 11, 2014
65 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants