Skip to content

Commit

Permalink
DOC: add components section
Browse files Browse the repository at this point in the history
  • Loading branch information
jethornton committed Feb 23, 2019
1 parent 9cc1f8c commit 1d478e7
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 18 deletions.
File renamed without changes.
File renamed without changes.
19 changes: 12 additions & 7 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,15 @@ building complex VCPs.

showcase/index

.. toctree::
:maxdepth: 1
:caption: Tutorials

tutorials/basic_vcp
tutorials/getting_started
tutorials/widget_rules
tutorials/components

.. toctree::
:maxdepth: 1
:caption: Configuration
Expand All @@ -32,14 +41,10 @@ building complex VCPs.

.. toctree::
:maxdepth: 1
:caption: Tutorials
:caption: Components

tutorials/basic_vcp
tutorials/getting_started
tutorials/widget_rules
tutorials/components
tutorials/action_buttons
tutorials/status_labels
components/action_buttons
components/status_labels

.. toctree::
:maxdepth: 1
Expand Down
14 changes: 3 additions & 11 deletions docs/source/tutorials/basic_vcp_04.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,6 @@ Now we can see the slider in action.

**DRO**

.. Note::
At this time the `DROWidget` is being reworked so it does not work.


Add a `DROWidget` between the jog buttons and the axis labels and set the axis
and the reference_type to `Relative` and select the correct axis for each one.

Expand All @@ -145,14 +141,10 @@ Now when we run the VCP we can see the DRO's change when we jog an axis.
:align: center
:scale: 60 %

For now we can use a `StatusLabel` to display the positions. Drag three status
labels between the jog buttons and the labels and create a rule for each one.

The channels for each one are from the positions status so type in `p` and pick
position:rel and add the rest like this. The expression is ``ch[0]``.
You can also use a `StatusLabel` to display position. Create a rule for the
`StatusLabel` and add a channel from the position plugin and the expression is
``ch[0]``. The following example is for relative position and the X axis.
::

position:rel?string&axis=x
position:rel?string&axis=y
position:rel?string&axis=z

0 comments on commit 1d478e7

Please # to comment.