Skip to content

Update guidance for 'go to' #592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 9, 2024
Merged

Update guidance for 'go to' #592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6e05898
Update guidance for 'go to'
julian-cable Jul 5, 2024
83307e8
Merge branch 'dev' into jcable/569-go-to
julian-cable Jul 8, 2024
c716716
Apply recent updates from 'dev' to this branch. Merge branch 'dev' in…
julian-cable Jul 8, 2024
e160deb
Add a clarification
julian-cable Jul 8, 2024
952c666
Merge branch 'jcable/569-go-to' of github.com:StyleGuides/WritingStyl…
julian-cable Jul 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions en-US/Design.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,12 +204,12 @@
Refer to the <citetitle>UI elements</citetitle> chapter in the <citetitle>IBM Style Guide</citetitle> for more information.
</para>
<section>
<title>Navigating Through Multiple UI Options</title>
<title>Moving Through Multiple UI Options</title>
<para>
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.
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.
</para>
<para>
For example, "From the OpenShift web console, navigate to Monitoring → Alerting."
For example, "From the OpenShift web console, go to Monitoring → Metrics and enter the following metrics as queries."
</para>

</section>
Expand Down
30 changes: 30 additions & 0 deletions en-US/G.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,36 @@
</listitem>

</varlistentry>
<varlistentry id="go-to">
<term>go to</term>
<listitem>
<para>
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.
</para>
<para>
Examples:
</para>
<itemizedlist>
<listitem>
<para>
From the OpenShift web console, go to Monitoring → Metrics and enter the following metrics as queries.
</para>
</listitem>
<listitem>
<para>
Open a browser and go to <ulink url="https://www.redhat.com"></ulink>
</para>
</listitem>
<listitem>
<para>
Go to the student user's home directory.
</para>
</listitem>
</itemizedlist>

</listitem>

</varlistentry>
<!-- <varlistentry id="got">
<term>got</term>
<listitem>
Expand Down
7 changes: 4 additions & 3 deletions en-US/N.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,12 @@
<term>navigate to</term>
<listitem>
<para>
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.
For example, "From the OpenShift web console, navigate to Monitoring → Alerting."
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.
For example, "Go to the student user's home directory."
It is acceptable to use the noun form, "navigation", for example "navigation through the interface".
</para>
<para>
Do not use "Go to", or "point to", or other variations.
Refer to <xref linkend="go-to" />.
</para>
</listitem>

Expand Down