Skip to content

Commit c26613a

Browse files
authored
Update guidance for 'go to' (#592)
* Update guidance for 'go to' * Add a clarification
1 parent cf841d4 commit c26613a

File tree

3 files changed

+37
-6
lines changed

3 files changed

+37
-6
lines changed

en-US/Design.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -204,12 +204,12 @@
204204
Refer to the <citetitle>UI elements</citetitle> chapter in the <citetitle>IBM Style Guide</citetitle> for more information.
205205
</para>
206206
<section>
207-
<title>Navigating Through Multiple UI Options</title>
207+
<title>Moving Through Multiple UI Options</title>
208208
<para>
209-
Use "Navigate to" when moving through multiple UI options because it covers all cases where you might have to click, point to, press, select, or otherwise make a series of selections to start an action.
209+
Use "go to" when moving through multiple UI options because it covers all cases where you might have to click, point to, press, select, or otherwise make a series of selections to start an action.
210210
</para>
211211
<para>
212-
For example, "From the OpenShift web console, navigate to Monitoring → Alerting."
212+
For example, "From the OpenShift web console, go to Monitoring → Metrics and enter the following metrics as queries."
213213
</para>
214214

215215
</section>

en-US/G.xml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,36 @@
203203
</listitem>
204204

205205
</varlistentry>
206+
<varlistentry id="go-to">
207+
<term>go to</term>
208+
<listitem>
209+
<para>
210+
Use "go to" for directing readers to a location, including when moving through multiple UI options, because it covers all cases where you might have to click, point to, select, or otherwise make a series of selections to initiate an action.
211+
</para>
212+
<para>
213+
Examples:
214+
</para>
215+
<itemizedlist>
216+
<listitem>
217+
<para>
218+
From the OpenShift web console, go to Monitoring → Metrics and enter the following metrics as queries.
219+
</para>
220+
</listitem>
221+
<listitem>
222+
<para>
223+
Open a browser and go to <ulink url="https://www.redhat.com"></ulink>
224+
</para>
225+
</listitem>
226+
<listitem>
227+
<para>
228+
Go to the student user's home directory.
229+
</para>
230+
</listitem>
231+
</itemizedlist>
232+
233+
</listitem>
234+
235+
</varlistentry>
206236
<!-- <varlistentry id="got">
207237
<term>got</term>
208238
<listitem>

en-US/N.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,12 @@
2929
<term>navigate to</term>
3030
<listitem>
3131
<para>
32-
Use "Navigate to" when moving through multiple UI options, because it covers all cases where you might have to click, point to, select, or otherwise make a series of selections to initiate an action.
33-
For example, "From the OpenShift web console, navigate to Monitoring → Alerting."
32+
Use "go to", in preference to "navigate to", for directing readers to a location, including when moving through multiple UI options, to cover all cases where you might have to click, point to, select, or otherwise make a series of selections to initiate an action.
33+
For example, "Go to the student user's home directory."
34+
It is acceptable to use the noun form, "navigation", for example "navigation through the interface".
3435
</para>
3536
<para>
36-
Do not use "Go to", or "point to", or other variations.
37+
Refer to <xref linkend="go-to" />.
3738
</para>
3839
</listitem>
3940

0 commit comments

Comments
 (0)