Skip to main content

Comments

8 comments

Date Votes
  • Permanently deleted user
    It appears that you don't have the full extract or package downloaded. Mine looks a lot different...The doco is actually in the samples folder somewhere which makes life _painful_. Don't know why latitude makes this convoluted for developers -_-

     

    _img_ alt="User-added image" src="https://latitudegeo--c.na53.content.force.com/servlet/rtaImage?eid=90760000000Xb9b&feoid=Body&refid=0EM60000000Xr0Z"_/_img_
    0
  • Permanently deleted user
    That's weird. I just downloaded it again. When I view the contents of the zip file I see what you're showing but when I extract the zip file, I only see what my original post shows. Why is this so complicated??
    0
  • Permanently deleted user
    Sorry folks. It was never intended to be confusing or convoluted. The SDK samples are essentially a framework application -- the same framework used for the HTML5 viewer itself. It's really just an instance of the HTML5 viewer hosting other instances of itself. Because the samples viewer is a web application just like the full viewer, it was always our expectation that a developer would deploy both the viewer itself and its SDK samples to a web server in order to use them.

     

    The API reference itself grew out of SDK samples as something a developer would use -- initially, at least -- as they explored the samples and learned about our framework and how it worked. And, as with the samples themselves, they were intended to be hosted in a web server -- like a self-hosted instance of javadocs.

     

    That said, the API reference documentation is a collection of HTML documents that reference one another locally, so you should be able to browse directly to C:\<wherever you've unzipped the HTML5 viewer zip>\Samples\SamplesViewer\Resources\Reference, open Index.html in your browser, and be able to use the documentation exactly as if it were hosted on a server.

     

    In version 2.5, we added a shortcut to help folks find that page without having to dig around in the Samples (because, if all you want is to read the documentation, its location is, well, confusing and convoluted). The link runs a command to open that Reference\Index.html in whatever default application your computer uses to open HTML pages (usually your favourite browser).

     

    If the link file isn't working for you, I'd be very curious to know if you get any kind of error message when you try to run it. The command window (and any potential error message within it) tends to disappear before you can read it, so could you please try this for me:

     

        * Open a command window in the folder containing the "Geocortex SDK for HTML5 API Reference" link file by right-clicking the folder while pressing the Shift key and selecting "Open command window here".

     

        * Copy the following command: %COMSPEC% /c start "" "Samples\SamplesViewer\Resources\Reference\index.html"

     

        *  Right-click in the command window, paste that command, and hit enter.

     

    Does the API Reference page open in your browser? If not, do you see any sort of error in the command window?
    0
  • John Nerge
    Couldn't Latitude just host the API reference so we don't have to save the install files and read it locally?
    0
  • Permanently deleted user
    I was finally able to get to the files extracted. I had to extract them on a different network drive so it was an issue on our end.

     

    I agree with making the reference more easily accessible. Seems like the support site would be a logical place where it's easy to find and access. Right now it's sort of buried and I didn't even know where to look till I found a reference to it in a forum post.
    0
  • Permanently deleted user
    Jordan, your explanation explains the thought process and given that makes a lot of sense. The problem is that it's not intuitive and actually storing the documentation in a "samples" folder is wrong. It's not a sample but documentation.

     

    If a developer can see that it's a locally hosted html help document in a documentation folder then I'm sure they can figure out how to host it on the web server themselves.
    0
  • Permanently deleted user
    I am looking for the API Reference for version 2.8.2. It was not included in the download as in previous versions. Does this exist somewhere? I need it very much.

     

    "Geocortex SDK for HTML5 API Reference" Shortcut.

     

    Points to:

     

    %COMSPEC% /c start "" "Samples\SamplesViewer\Resources\Reference\index.html" in version 2.5.2 download

     

    %COMSPEC% /c start "" "Samples\SamplesViewer\Docs\index.html" in version 2.7.1 download
    0
  • Permanently deleted user
    Hi David,

     

    The API reference can be found here: https://docs.geocortex.com/essentials/gvh/latest/api-help/index.html

     

    Documentation for Commands and Events can be found here: https://docs.geocortex.com/essentials/gvh/latest/commands-help/index.html#/

     

    The samples are here: https://docs.geocortex.com/essentials/gvh/latest/SamplesViewer/

     

    Also potentially handy: https://docs.geocortex.com/developers/
    0

Please sign in to leave a comment.

Didn't find what you were looking for?

New post