Skip to content

Commit b6f7c30

Browse files
committed
chore: keyboard keys
1 parent 2b3cbbd commit b6f7c30

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

source/pinpoint/tutorials/tutorial_api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ they will not run in the web browser.
1212
1. Launch Open Ephys and connect to or simulate one or more probes using the Neuropix-PXI plugin.
1313
2. Make sure at least one [Probe Viewer](https://open-ephys.github.io/gui-docs/User-Manual/Plugins/Probe-Viewer.html#probe-viewer) plugin is in your signal chain. If you don't see the Probe Viewer in your processor list, you can add it via the Plugin Installer (Probe Viewer version ≥0.3.1 is needed to interface with Pinpoint).
1414
3. Make sure the HTTP Server is enabled in Open Ephys ("File > Enable HTTP Server" should have a checkmark next to it).
15-
4. In Pinpoint, press \[ESC\] to open the settings menu and navigate to the "API" tab
15+
4. In Pinpoint, press <kbd>ESC</kbd> to open the settings menu and navigate to the "API" tab
1616
5. In the "OpenEphys API" section, make sure the IP address matches that of the machine running Open Ephys. If Pinpoint is running on the same computer, this will be "localhost". The port number will always be 37497.
1717
6. Toggle the API on
1818
7. In the probe matching list on the right, you should see each of your Pinpoint probes. Use the dropdown menus to link each probe to its corresponding name in Open Ephys.
@@ -29,7 +29,7 @@ Make sure that your SpikeGLX version is updated, you'll need a 202306 or later v
2929
2. Launch SpikeGLX
3030
3. In the Options > Command server Settings menu, make sure that *Enable Remote Command Server* option is checked.
3131
4. Start a **New Acquisition**, using existing data in simulation or a live probe. Note that the *Open File Viewer* option does not work with the API.
32-
5. In Pinpoint, press \[ESC\] to open the settings menu and navigate to the "API" tab
32+
5. In Pinpoint, press <kbd>ESC</kbd> to open the settings menu and navigate to the "API" tab
3333
6. Make sure the location of the HelloSGLX file is accurate. Use the file navigator to locate the file if it's wrong.
3434
7. Toggle the API on. If you see an API Status error, it probably means you didn't turn the command server on, see step 3.
3535
8. In the probe matching list on the right, you should see each of your Pinpoint probes. Using the dropdown menus, select which SpikeGLX probe ID each probe should be linked to

source/pinpoint/tutorials/tutorial_basics.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -101,27 +101,27 @@ The axis keys are [W/S] for AP, [A/D] for ML, [Q/E] for DV, and [Z/X] for depth.
101101
You can also press the keyboard keys to move the probe along that axis in 1/10/100/1000um
102102
increments. Pressing and holding a key moves continuously.
103103

104-
Press \[SHIFT\] to increase the speed of each movement. Press \[CTRL\] to reduce the speed.
104+
Press <kbd>SHIFT</kbd> to increase the speed of each movement. Press <kbd>CTRL</kbd> to reduce the speed.
105105

106106
![probe controls](https://virtualbrainlab.org/_static/images/pinpoint/ProbeControls.png)
107107

108-
Use \[W/A/S/D\] to move the probe along the AP or ML axis. Use \[Q/E\] to move the
109-
probe along the DV axis and \[Z/X\] to move the probe along the depth axis.
108+
Use <kbd>W/A/S/D</kbd> to move the probe along the AP or ML axis. Use <kbd>Q/E</kbd> to move the
109+
probe along the DV axis and <kbd>Z/X</kbd> to move the probe along the depth axis.
110110

111111
You can also rotate the probe with keyboard clicks.
112112

113-
Use \[1/3\] to yaw the probe around the vertical axis. Note that NP2.4
113+
Use <kbd>1/3</kbd> to yaw the probe around the vertical axis. Note that NP2.4
114114
probes spin around shank 0 (the leftmost probe shank when looking from the front).
115115

116-
Use \[R/F\] to change the pitch angle of the probe on the manipulator (restricted to
116+
Use <kbd>R/F</kbd> to change the pitch angle of the probe on the manipulator (restricted to
117117
the vertical to horizontal range).
118118

119-
Use \[,/.\] to roll the probe along its own axis.
119+
Use <kbd>,/.</kbd> to roll the probe along its own axis.
120120

121-
Probes can be deleted with \[Backspace\]. To recover a probe you didn't mean to
122-
delete press \[CTRL + Backspace\].
121+
Probes can be deleted with <kbd>Backspace</kbd>. To recover a probe you didn't mean to
122+
delete press <kbd>CTRL + Backspace</kbd>.
123123

124-
You can also quickly switch between probes in the scene by pressing the \[N\] and \[M\] keys.
124+
You can also quickly switch between probes in the scene by pressing the <kbd>N</kbd> and <kbd>M</kbd> keys.
125125

126126
### Controller
127127

@@ -153,7 +153,7 @@ Note that insertions are defined in a Coordinate **Space** with a particular **T
153153

154154
<image src="../../_static/images/tutorial/help.png" alt="overview image" position="left" style="width:100%">
155155

156-
The Settings menu is accessed by pressing \[ESC\]. Press ESC again to close
156+
The Settings menu is accessed by pressing <kbd>ESC</kbd>. Press ESC again to close
157157
the window. The tabs **(1)** on the left side switch between the different
158158
sub-menus.
159159

source/pinpoint/tutorials/tutorial_ephys_link.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,14 +87,14 @@ configuration window will close and the server will use the console window.
8787

8888
![Connecting to Ephys Link](../../_static/images/tutorial/ephys_link/ephys_link_connection.png)
8989

90-
1. Press \[ESC\] to open the settings menu
90+
1. Press <kbd>ESC</kbd> to open the settings menu
9191
2. Switch to the "Ephys Link" tab
9292
3. Fill in the server's IP address
9393
4. And the port number
9494
5. Click "Connect". Upon success, the connect button will read "Disconnect"
9595
6. Panels for each manipulator will appear here. These panels allow for the
9696
configuration of manipulators and linking them to probes in the scene.
97-
7. Press \[ESC\] again to close the settings menu
97+
7. Press <kbd>ESC</kbd> again to close the settings menu
9898

9999
(ephys-link-mirror-probes)=
100100

@@ -106,7 +106,7 @@ for details](mpm-no-need-config).
106106
![Connect a probe to a manipulator](../../_static/images/tutorial/ephys_link/ephys_link_connect_probe.png)
107107

108108
1. Spawn the corresponding probe in the planner scene.
109-
2. Press \[ESC\] to open the settings menu.
109+
2. Press <kbd>ESC</kbd> to open the settings menu.
110110
3. Switch to the "Ephys Link" tab.
111111
4. Scroll down to the panel that represents the _in vivo_ manipulator.
112112
5. Use the dropdown to configure the manipulator's handedness. As of July
@@ -128,7 +128,7 @@ for details](mpm-no-need-config).
128128
the [same keyboard shortcuts](https://virtualbrainlab.org/pinpoint/tutorial.html#keyboard)
129129
used to move probes in the planner around. Manipulators can also be driven
130130
back to their zero coordinate.
131-
10. Press \[ESC\] again to close the settings menu.
131+
10. Press <kbd>ESC</kbd> again to close the settings menu.
132132

133133
At this point, the _in vivo_ probe positions should be mirrored in Pinpoint in
134134
real time.

0 commit comments

Comments
 (0)