Skip to content

Commit a342591

Browse files
anchors
1 parent 02e193d commit a342591

File tree

1 file changed

+47
-49
lines changed

1 file changed

+47
-49
lines changed

docs/design/labelling.rst

Lines changed: 47 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -281,21 +281,21 @@ Add
281281

282282
Takes an existing object and uses it in a new context (for example, adds an item to the cart, adds a User to a group, or adds a document to a folder).
283283

284-
Where appropriate, combine add with the object (for example, Add User or Add role). See also Create, Insert, New, and Upload.
284+
Where appropriate, combine add with the object (for example, Add User or Add role). See also :ref:`Create`, :ref:`Insert`, :ref:`New`, and :ref:`Upload`.
285285

286286
Apply
287287
^^^^^
288288

289289
Saves changes without closing the dialog. These properties often affect subsequent system behavior.
290290

291-
Use instead of Save changes. See also Save and Save as.
291+
Use instead of Save changes. See also :ref:`Save` and :ref:`Save as`.
292292

293293
Approve
294294
^^^^^^^
295295

296-
Indicates the User agrees. In a business process, typically initiates the next step.
296+
Indicates the User agrees. Tipically initiates the next step.
297297

298-
See also Reject.
298+
See also :ref:`Reject`.
299299

300300
B
301301
-
@@ -305,7 +305,7 @@ Back
305305

306306
Returns the User to the previous step in a sequence of steps, such as in a wizard.
307307

308-
Use instead of Previous. See also Next and Finish.
308+
Use instead of Previous. See also :ref:`Next` and :ref:`Finish`.
309309

310310
Browse
311311
^^^^^^
@@ -320,35 +320,35 @@ Cancel
320320

321321
Stops the current action and closes the dialog.
322322

323-
Warn the User of any possible negative consequences of stopping an action from progressing, such as data corruption. See also Reset.
323+
Warn the User of any possible negative consequences of stopping an action from progressing, such as data corruption. See also :ref:`Reset`.
324324

325325
Clear
326326
^^^^^
327327

328328
This action clears all the fields or selections. Also deletes the contents of a document, such as a log. Typically the default selection or value is re-established for controls that always have a selection or value, such as radio buttons.
329329

330-
Where appropriate, combine clear with the object (for example, Clear fields or Clear all). See also Delete and Remove.
330+
Where appropriate, combine clear with the object (for example, Clear fields or Clear all). See also :ref:`Delete` and :ref:`Remove`.
331331

332332
Close
333333
^^^^^
334334

335335
Closes the current page or window (for example, closing a secondary window containing online help).
336336

337-
Do not use Close alongside OK or Cancel actions. See also Cancel and Done.
337+
Do not use Close alongside OK or Cancel actions. See also :ref:`Cancel` and :ref:`Done`.
338338

339339
Copy
340340
^^^^
341341

342342
Creates new instances of the selected objects in a specific destination.
343343

344-
Combine Copy with the object being copied (for example, Copy folder) or the destination (for example, Copy to clipboard) if there are multiple possibilities. See also New.
344+
Combine Copy with the object being copied (for example, Copy folder) or the destination (for example, Copy to clipboard) if there are multiple possibilities. See also :ref:`New`.
345345

346346
Create
347347
^^^^^^
348348

349349
Makes a new object from scratch (for example, creates a calendar event or creates a new document).
350350

351-
In scenarios where the User needs to supply some details or settings as part of the create process, use new to initiate the action and create to apply the user-supplied details or settings to the new object. See also Add, Copy, Insert, and New.
351+
In scenarios where the User needs to supply some details or settings as part of the create process, use new to initiate the action and create to apply the user-supplied details or settings to the new object. See also :ref:`Add`, :ref:`Copy`, :ref:`Insert`, and :ref:`New`.
352352

353353
Customize
354354
^^^^^^^^^
@@ -363,35 +363,35 @@ Delete
363363

364364
Destroys an existing object so that it no longer exists (for example, deletes a file from a directory or deletes a value from a table cell).
365365

366-
Where appropriate, combine Delete with the object (for example, Delete column or Delete row). See also Clear and Remove.
366+
Where appropriate, combine Delete with the object (for example, Delete column or Delete row). See also :ref:`Clear` and :ref:`Remove`.
367367

368368
Docs
369369
^^^^
370370

371371
Opens a separate window containing the landing page for the product documentation.
372372

373-
Use as link text only for the specific link that points to the product documentation from the console menu bar. See also Learn more.
373+
Use as link text only for the specific link that points to the product documentation from the console menu bar. See also :ref:`Learn more`.
374374

375375
Done
376376
^^^^
377377

378378
Indicates that the User has finished working in an environment (for example, editing templates) and wants to return to where he or she came from.
379379

380-
See also Close and Finish.
380+
See also :ref:`Close` and :ref:`Finish`.
381381

382382
Download
383383
^^^^^^^^
384384

385385
Transfers a file from a remote system to a local system.
386386

387-
See also Upload.
387+
See also :ref:`Upload`.
388388

389389
Drop
390390
^^^^
391391

392392
Use only when referring to dropping a database table.
393393

394-
In other scenarios, use Clear, Delete, or Remove.
394+
In other scenarios, use :ref:`Clear`, :ref:`Delete`, or :ref:`Remove`.
395395

396396
E
397397
-
@@ -406,14 +406,14 @@ Empty trash
406406

407407
Permanently deletes all files or objects that have been placed into a trash container.
408408

409-
See also Move to trash.
409+
See also :ref:`Move to trash`.
410410

411411
Export
412412
^^^^^^
413413

414414
Saves data in a different format external to the system. Typically opens a secondary window for the User to specify the file type and destination (for example, storing table data as a set of comma-separated values).
415415

416-
See also Import.
416+
See also :ref:`Import`.
417417

418418
F
419419
-
@@ -423,21 +423,21 @@ Filter
423423

424424
Shortens a list to objects that match the filter criteria.
425425

426-
See also Find and Search.
426+
See also :ref:`Find` and :ref:`Search`.
427427

428428
Find
429429
^^^^
430430

431431
Moves the cursor to the next element matching the specified criteria (for example, view the next occurrence of a specific word within an email message).
432432

433-
See also Filter and Search.
433+
See also :ref:`Filter` and :ref:`Search`.
434434

435435
Finish
436436
^^^^^^
437437

438438
Indicates completion of a series of steps, such as in a wizard.
439439

440-
See also Done.
440+
See also :ref:`Done`.
441441

442442
G
443443
-
@@ -447,7 +447,7 @@ Get help
447447

448448
Opens a search field from which the User can search for help information.
449449

450-
Use only as link text on the console menu bar. See also Docs and Learn more.
450+
Use only as link text on the console menu bar. See also :ref:`Docs` and :ref:`Learn more`.
451451

452452
H
453453
-
@@ -457,7 +457,7 @@ Hide
457457

458458
Removes an element that was previously shown (for example, enables the User to hide details or descriptions).
459459

460-
See also Show.
460+
See also :ref:`Show`.
461461

462462
I
463463
-
@@ -467,22 +467,22 @@ Import
467467

468468
Transforms data or objects from an external source. Typically opens a secondary window for the User to locate the external source.
469469

470-
Context: creating a new table based on comma-separated values contained in a separate file. See also Export.
470+
Context: creating a new table based on comma-separated values contained in a separate file. See also :ref:`Export`.
471471

472472
Insert
473473
^^^^^^
474474

475475
Adds an element at a particular position in an ordered view.
476476

477-
Context: adding a picture to the body of a document or inserting a record into a table. See also Add and New
477+
Context: adding a picture to the body of a document or inserting a record into a table. See also :ref:`Add` and :ref:`New`.
478478

479479
L
480480
-
481481

482482
Launch
483483
^^^^^^
484484

485-
Do not use Launch; use Start.
485+
Do not use Launch; use :ref:`Start`.
486486

487487
Learn more
488488
^^^^^^^^^^
@@ -496,14 +496,14 @@ Log in
496496

497497
Enters a site or app. This choice typically opens a Form for entry of credentials. Also used on the submission button after Users enter their credentials.
498498

499-
Use instead of Sign in. This is to make it visually distinct from Sign up. These options are often side by side and the different words allow for quick recognition. See also Log out.
499+
Use instead of Sign in. This is to make it visually distinct from Sign up. These options are often side by side and the different words allow for quick recognition. See also :ref:`Log out`.
500500

501501
Log out
502502
^^^^^^^
503503

504504
Exits an app or site.
505505

506-
Use instead of Sign out. See also Log in.
506+
Use instead of Sign out. See also :ref:`Log in`.
507507

508508
M
509509
-
@@ -518,7 +518,7 @@ Move to trash
518518

519519
A soft delete. Moves a file or object to an area from where it can later be permanently deleted or recovered.
520520

521-
Use instead of Delete if it is possible for the User to recover the objects. See also Empty trash.
521+
Use instead of Delete if it is possible for the User to recover the objects. See also :ref:`Empty trash`.
522522

523523
N
524524
-
@@ -528,14 +528,14 @@ New
528528

529529
Starts the creation of a new object. New either creates the object immediately or opens a dialog or set of fields where the user can enter properties.
530530

531-
Combine new with the object to create (for example, New User or New column). See also Add, Copy, Create, Insert, and Save as.
531+
Combine new with the object to create (for example, New User or New column). See also :ref:`Add`, :ref:`Copy`, :ref:`Create`, :ref:`Insert`, and :ref:`Save as`.
532532

533533
Next
534534
^^^^
535535

536536
Advances the User to the next step in a sequence of steps, such as in a wizard.
537537

538-
See also Back and Finish.
538+
See also :ref:`Back` and :ref:`Finish`.
539539

540540
O
541541
-
@@ -564,7 +564,7 @@ Post
564564
565565
Adds a new comment to an online community or adds status to a log or record.
566566

567-
If you are editing an existing comment, use Save instead.
567+
If you are editing an existing comment, use :ref:`Save` instead.
568568

569569
Preview
570570
^^^^^^^
@@ -584,7 +584,7 @@ Redo
584584

585585
Redoes an undo action.
586586

587-
Likely used only as a tooltip on an icon button. See also Undo.
587+
Likely used only as a tooltip on an icon button. See also :ref:`Undo`.
588588

589589
Refresh
590590
^^^^^^^
@@ -602,14 +602,14 @@ Reject
602602

603603
Indicates the User doesn't approve. In a business process, typically blocks the process from proceeding to the next step.
604604

605-
See also Approve.
605+
See also :ref:`Approve`.
606606

607607
Remove
608608
^^^^^^
609609

610610
Removes an object from the current context but the object is not destroyed as a result of the action (for example, removes a user from a group or removes an item from the cart).
611611

612-
Where appropriate, combine Remove with the object that will be removed (for example, Remove User or Remove role). See also Clear and Delete.
612+
Where appropriate, combine Remove with the object that will be removed (for example, Remove User or Remove role). See also :ref:`Clear` and :ref:`Delete`.
613613

614614
Reply
615615
^^^^^
@@ -621,28 +621,28 @@ Reset
621621

622622
Reverts values back to their last saved state. The last saved state includes the values stored the last time the User clicked Apply. Doesn't close the dialog or window.
623623

624-
See also Cancel, Restore, Restore defaults, and Undo.
624+
See also :ref:`Cancel`, :ref:`Restore`, :ref:`Restore defaults`, and :ref:`Undo`.
625625

626626
Restore
627627
^^^^^^^
628628

629629
Brings a file back after deletion, corruption, or similar event.
630630

631-
See also Reset.
631+
See also :ref:`Reset`.
632632

633633
Restore all
634634
^^^^^^^^^^^
635635

636636
Completes a restore operation on all files or objects in a given system or container.
637637

638-
See also Restore.
638+
See also :ref:`Restore`.
639639

640640
Restore defaults
641641
^^^^^^^^^^^^^^^^
642642

643643
Sets Form values to the default settings.
644644

645-
See also Reset and Undo.
645+
See also :ref:`Reset` and :ref:`Undo`.
646646

647647
Run
648648
^^^
@@ -659,7 +659,7 @@ Save
659659

660660
Saves pending modifications made to a file or document. Doesn't close the window or panel.
661661

662-
See also Apply.
662+
See also :ref:`Apply`.
663663

664664
Save as
665665
^^^^^^^
@@ -671,7 +671,7 @@ Search
671671

672672
Returns all objects (for example, files, names, or documents) within a defined set (for example, in a folder, directory, database, or the internet) that match some specified criteria.
673673

674-
See also Filter and Find.
674+
See also :ref:`Filter` and :ref:`Find`.
675675

676676
Select
677677
^^^^^^
@@ -683,7 +683,7 @@ Select all
683683

684684
Adds all objects in the view to the selection set or checks all checkboxes.
685685

686-
See also Clear.
686+
See also :ref:`Clear`.
687687

688688
Send
689689
^^^^
@@ -695,14 +695,14 @@ Show
695695

696696
Reveals an object that was previously hidden (for example, shows descriptions or shows further details).
697697

698-
See also Hide.
698+
See also :ref:`Hide`.
699699

700700
Sign up
701701
^^^^^^^
702702

703703
Creates a User account or registers a User in a system.
704704

705-
Use instead of Register.
705+
Use instead of :ref:`Register`.
706706

707707
Sort
708708
^^^^
@@ -721,9 +721,7 @@ Use instead of Launch.
721721
Submit an idea
722722
^^^^^^^^^^^^^^
723723

724-
Opens a separate window containing the IBM Cloud Ideas portal.
725-
726-
Use only as link text on the Support widget from the console menu bar.
724+
Opens a window or modal to submit feedback using external tool or resource.
727725

728726
T
729727
-
@@ -743,21 +741,21 @@ Undo
743741

744742
Reverts to the state before the most recent changes made by the User. Repeated use successively reverts to prior states in reverse chronological order. Applies to changes in data and not to changes made to the view.
745743

746-
Not all actions, such as Save, can be undone. See also Redo, Reset, and Restore.
744+
Not all actions, such as Save, can be undone. See also :ref:`Redo`, :ref:`Reset`, and :ref:`Restore`.
747745

748746
Update
749747
^^^^^^
750748

751749
Label for a button in a dialog or Form for editing an object. The settings in the dialog are applied to the object when it is updated.
752750

753-
See also Edit.
751+
See also :ref:`Edit`.
754752

755753
Upload
756754
^^^^^^
757755

758756
Transfers a file from a local system to a remote system.
759757

760-
See also Download.
758+
See also :ref:`Download`
761759

762760
V
763761
-

0 commit comments

Comments
 (0)