Skip to content

Commit

Permalink
doc(website): Add basic documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jourdain committed Jun 25, 2018
1 parent 215b6de commit f0fef94
Show file tree
Hide file tree
Showing 6 changed files with 139 additions and 2 deletions.
19 changes: 19 additions & 0 deletions documentation/content/doc/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
title: What is ParaView Glance?
----

ParaView Glance is a light-weight, open-source, web application developed at Kitware for visualizing volumetric images, molecular structures, geometric objects, and point clouds.

![Welcome](../gallery/01-glance-welcome.jpg)

As part of the ParaView platform, it is intended to allow users to quickly __glance__ at their small to medium size data. Ultimately, ParaView Glance is intended to help you:

1. quickly view your data on your computer. It launches quickly and supports a wide variety of data formats so that you can quickly look at the most recent results from a new algorithm you are developing or visually confirm the contents of a data file on your drive.

2. review items-of-interest on [Girder]. Imagine that you have reviewed a large collection of data on Girder, and you have narrowed your search to two interesting items that you want to explore more closely. Via an optional Girder module, ParaViewGlance can be associated with appropriate types of data items and launched to download and view items of interest with minimal interaction (a single click per item), minimal delay (requiring only the time to transfer the data to your machine), and no need to explicitly install an application or run a dedicated server (ParaViewGlance is a stand-alone, JavaScript+WebAssembly application).

3. develop new applications involving VTK.js and ITK.js. ParaView Glance has been architected to be a highly customizable platform. It can be used as a basis for creating stand-alone web-based applications, desktop applications via Electron, and web-based systems that involve services from [ParaViewWeb] and/or [Resonant].


[Girder]: http://resonant.kitware.com
[ParaViewWeb]: https://www.paraview.org/web
[Resonant]: http://resonant.kitware.com/
62 changes: 62 additions & 0 deletions documentation/content/doc/keyboard_shortcuts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
title: Keyboard shortcuts
----

<style>
table {
width: 100%;
}
</style>

## Data management

| Shortcut | Action |
| -------------- | -------------------- |
| Ctrl + O | Open File Dialog |
| Ctrl + Delete | Delete active data |


## View

| Shortcut | Action |
| ----------| ----------------- |
| Ctrl + G | Grab a screenshot |
| Ctrl + 0 | 3D View |
| Ctrl + X | 2D View along X |
| Ctrl + Y | 2D View along Y |
| Ctrl + Z | 2D View along Z |


## Slice / Window / Level

| Shortcut | Action |
| ------------------------- | ------------------- |
| Shift + Up arrow | Increase Window |
| Shift + Down arrow | Decrease Window |
| Shift + Left arrow | Decrease Level |
| Shift + Right arrow | Increase Level |
| Shift + Alt + Up arrow | Next Slice |
| Shift + Alt + Down arrow | Previous Slice |
| Shift + Alt + Right arrow | Next Slice |
| Shift + Alt + Left arrow | Previous Slice |

## Layout

| Shortcut | Action |
| ------------ | -------------------- |
| Ctrl + Space | Toggle left pane |
| Ctrl + 1 | One view |
| Ctrl + 2 | Split view (top) |
| Ctrl + 3 | Split view (bottom) |
| Ctrl + 4 | Quad view |


## Camera

| Shortcut | Action |
| ------------------ | -------------------- |
| R | Reset Camera |
| Alt + Left arrow | Roll Left |
| Alt + Right arrow | Roll right |
| Alt + X/L | Reset camera X |
| Alt + Y/P | Reset camera Y |
| Alt + Z/S | Reset camera Z |
49 changes: 49 additions & 0 deletions documentation/content/doc/readers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
title: Supported file formats
----

ParaView Glance comes loaded with ITK.js image data readers as well as VTK.js image and geometry readers. When used online, depending on the file that gets loaded, if it is a format provided by ITK, the appropriate reader module will be downloaded and cached locally for any subsequent usage. But because of that dynamic mechanism, the readers provided by ITK are not yet available with the standalone single file HTML version that you can run from your desktop.

The following set of tables list the supported format and which library is defining the reader.

<style>
table {
width: 100%;
}
</style>

## VTK.js

| Extension | Description | Format specificity |
| --------- | -------------------- | ------------------------------------------------------------------- |
| *.vtp | VTK Polydata | ASCII or binary or appended with or without compression (ZLib only) |
| *.vti | VTK ImageData | ASCII or binary or appended with or without compression (ZLib only) |
| *.stl | Stereol lithography | ASCII or binary |
| *.obj | Wavefront | Geometry without the material file. |
| *.pdb | Protein Data Bank | Molecule representation |
| *.glyph | **Custom/Internal** | Custom format to define vtk.js source setting and Glyph positioning |
| *.skybox | **Custom/Internal** | Zip bundle of a set of textures for an infinit cube box |

## ITK.js

The only structure that can be loaded by ITK.js are vtkImageData.
This means that the `Legacy VTK (*.vtk)` format won't work for vtkPolyData, vtkUnstructuredGrid...

| Extension | Module |
| ------------------- | -------------- |
| *.bmp | itkBMPImage |
| *.dcm | itkDCMTKImage |
| *.gipl, gipl.gz | itkGiplImage |
| *.hdf5 | itkHDF5Image |
| *.jpg, *.jpeg | itkJPEGImage |
| *.json | itkJSONImage |
| *.lsm | itkLSMImage |
| *.mnc, *.mnc2 | itkMINCImage |
| *.mgh, *.mgz | itkMGHImage |
| *.mha, *.mhd | itkMetaImage |
| *.mrc | itkMRCImage |
| *.nia, *.nii, *.hdr | itkNiftiImage |
| *.nrrd, *.nhdr | itkNrrdImage |
| *.png | itkPNGImage |
| *.pic | itkBioRadImage |
| *.tif, *.tiff | itkTIFFImage |
| *.vtk | itkVTKImage |
1 change: 1 addition & 0 deletions documentation/data/menu.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
documentation: /doc/
gallery: /gallery/
app: /app/
nightly: /nightly/
5 changes: 4 additions & 1 deletion documentation/tpl/__en__
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
menu:
documentation: Documentation
gallery: Gallery
app: Stable
nightly: Nightly
Expand All @@ -17,7 +18,9 @@ page:
last_updated: "Last updated: %s"

sidebar:
docs:
doc:
getting_started: Getting Started
overview: Overview
readers: Supported formats
keyboard: Keyboard shortcuts

5 changes: 4 additions & 1 deletion documentation/tpl/__sidebar__
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
docs:
doc:
getting_started:
overview: index.html
readers: readers.html
keyboard: keyboard_shortcuts.html


0 comments on commit f0fef94

Please sign in to comment.