You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/design/labelling.rst
+47-49Lines changed: 47 additions & 49 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -281,21 +281,21 @@ Add
281
281
282
282
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).
283
283
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`.
285
285
286
286
Apply
287
287
^^^^^
288
288
289
289
Saves changes without closing the dialog. These properties often affect subsequent system behavior.
290
290
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`.
292
292
293
293
Approve
294
294
^^^^^^^
295
295
296
-
Indicates the User agrees. In a business process, typically initiates the next step.
296
+
Indicates the User agrees. Tipically initiates the next step.
297
297
298
-
See also Reject.
298
+
See also :ref:`Reject`.
299
299
300
300
B
301
301
-
@@ -305,7 +305,7 @@ Back
305
305
306
306
Returns the User to the previous step in a sequence of steps, such as in a wizard.
307
307
308
-
Use instead of Previous. See also Next and Finish.
308
+
Use instead of Previous. See also :ref:`Next` and :ref:`Finish`.
309
309
310
310
Browse
311
311
^^^^^^
@@ -320,35 +320,35 @@ Cancel
320
320
321
321
Stops the current action and closes the dialog.
322
322
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`.
324
324
325
325
Clear
326
326
^^^^^
327
327
328
328
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.
329
329
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`.
331
331
332
332
Close
333
333
^^^^^
334
334
335
335
Closes the current page or window (for example, closing a secondary window containing online help).
336
336
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`.
338
338
339
339
Copy
340
340
^^^^
341
341
342
342
Creates new instances of the selected objects in a specific destination.
343
343
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`.
345
345
346
346
Create
347
347
^^^^^^
348
348
349
349
Makes a new object from scratch (for example, creates a calendar event or creates a new document).
350
350
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`.
352
352
353
353
Customize
354
354
^^^^^^^^^
@@ -363,35 +363,35 @@ Delete
363
363
364
364
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).
365
365
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`.
367
367
368
368
Docs
369
369
^^^^
370
370
371
371
Opens a separate window containing the landing page for the product documentation.
372
372
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`.
374
374
375
375
Done
376
376
^^^^
377
377
378
378
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.
379
379
380
-
See also Close and Finish.
380
+
See also :ref:`Close` and :ref:`Finish`.
381
381
382
382
Download
383
383
^^^^^^^^
384
384
385
385
Transfers a file from a remote system to a local system.
386
386
387
-
See also Upload.
387
+
See also :ref:`Upload`.
388
388
389
389
Drop
390
390
^^^^
391
391
392
392
Use only when referring to dropping a database table.
393
393
394
-
In other scenarios, use Clear, Delete, or Remove.
394
+
In other scenarios, use :ref:`Clear`, :ref:`Delete`, or :ref:`Remove`.
395
395
396
396
E
397
397
-
@@ -406,14 +406,14 @@ Empty trash
406
406
407
407
Permanently deletes all files or objects that have been placed into a trash container.
408
408
409
-
See also Move to trash.
409
+
See also :ref:`Move to trash`.
410
410
411
411
Export
412
412
^^^^^^
413
413
414
414
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).
415
415
416
-
See also Import.
416
+
See also :ref:`Import`.
417
417
418
418
F
419
419
-
@@ -423,21 +423,21 @@ Filter
423
423
424
424
Shortens a list to objects that match the filter criteria.
425
425
426
-
See also Find and Search.
426
+
See also :ref:`Find` and :ref:`Search`.
427
427
428
428
Find
429
429
^^^^
430
430
431
431
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).
432
432
433
-
See also Filter and Search.
433
+
See also :ref:`Filter` and :ref:`Search`.
434
434
435
435
Finish
436
436
^^^^^^
437
437
438
438
Indicates completion of a series of steps, such as in a wizard.
439
439
440
-
See also Done.
440
+
See also :ref:`Done`.
441
441
442
442
G
443
443
-
@@ -447,7 +447,7 @@ Get help
447
447
448
448
Opens a search field from which the User can search for help information.
449
449
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`.
451
451
452
452
H
453
453
-
@@ -457,7 +457,7 @@ Hide
457
457
458
458
Removes an element that was previously shown (for example, enables the User to hide details or descriptions).
459
459
460
-
See also Show.
460
+
See also :ref:`Show`.
461
461
462
462
I
463
463
-
@@ -467,22 +467,22 @@ Import
467
467
468
468
Transforms data or objects from an external source. Typically opens a secondary window for the User to locate the external source.
469
469
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`.
471
471
472
472
Insert
473
473
^^^^^^
474
474
475
475
Adds an element at a particular position in an ordered view.
476
476
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`.
478
478
479
479
L
480
480
-
481
481
482
482
Launch
483
483
^^^^^^
484
484
485
-
Do not use Launch; use Start.
485
+
Do not use Launch; use :ref:`Start`.
486
486
487
487
Learn more
488
488
^^^^^^^^^^
@@ -496,14 +496,14 @@ Log in
496
496
497
497
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.
498
498
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`.
500
500
501
501
Log out
502
502
^^^^^^^
503
503
504
504
Exits an app or site.
505
505
506
-
Use instead of Sign out. See also Log in.
506
+
Use instead of Sign out. See also :ref:`Log in`.
507
507
508
508
M
509
509
-
@@ -518,7 +518,7 @@ Move to trash
518
518
519
519
A soft delete. Moves a file or object to an area from where it can later be permanently deleted or recovered.
520
520
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`.
522
522
523
523
N
524
524
-
@@ -528,14 +528,14 @@ New
528
528
529
529
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.
530
530
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`.
532
532
533
533
Next
534
534
^^^^
535
535
536
536
Advances the User to the next step in a sequence of steps, such as in a wizard.
537
537
538
-
See also Back and Finish.
538
+
See also :ref:`Back` and :ref:`Finish`.
539
539
540
540
O
541
541
-
@@ -564,7 +564,7 @@ Post
564
564
565
565
Adds a new comment to an online community or adds status to a log or record.
566
566
567
-
If you are editing an existing comment, use Save instead.
567
+
If you are editing an existing comment, use :ref:`Save` instead.
568
568
569
569
Preview
570
570
^^^^^^^
@@ -584,7 +584,7 @@ Redo
584
584
585
585
Redoes an undo action.
586
586
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`.
588
588
589
589
Refresh
590
590
^^^^^^^
@@ -602,14 +602,14 @@ Reject
602
602
603
603
Indicates the User doesn't approve. In a business process, typically blocks the process from proceeding to the next step.
604
604
605
-
See also Approve.
605
+
See also :ref:`Approve`.
606
606
607
607
Remove
608
608
^^^^^^
609
609
610
610
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).
611
611
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`.
613
613
614
614
Reply
615
615
^^^^^
@@ -621,28 +621,28 @@ Reset
621
621
622
622
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.
623
623
624
-
See also Cancel, Restore, Restore defaults, and Undo.
624
+
See also :ref:`Cancel`, :ref:`Restore`, :ref:`Restore defaults`, and :ref:`Undo`.
625
625
626
626
Restore
627
627
^^^^^^^
628
628
629
629
Brings a file back after deletion, corruption, or similar event.
630
630
631
-
See also Reset.
631
+
See also :ref:`Reset`.
632
632
633
633
Restore all
634
634
^^^^^^^^^^^
635
635
636
636
Completes a restore operation on all files or objects in a given system or container.
637
637
638
-
See also Restore.
638
+
See also :ref:`Restore`.
639
639
640
640
Restore defaults
641
641
^^^^^^^^^^^^^^^^
642
642
643
643
Sets Form values to the default settings.
644
644
645
-
See also Reset and Undo.
645
+
See also :ref:`Reset` and :ref:`Undo`.
646
646
647
647
Run
648
648
^^^
@@ -659,7 +659,7 @@ Save
659
659
660
660
Saves pending modifications made to a file or document. Doesn't close the window or panel.
661
661
662
-
See also Apply.
662
+
See also :ref:`Apply`.
663
663
664
664
Save as
665
665
^^^^^^^
@@ -671,7 +671,7 @@ Search
671
671
672
672
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.
673
673
674
-
See also Filter and Find.
674
+
See also :ref:`Filter` and :ref:`Find`.
675
675
676
676
Select
677
677
^^^^^^
@@ -683,7 +683,7 @@ Select all
683
683
684
684
Adds all objects in the view to the selection set or checks all checkboxes.
685
685
686
-
See also Clear.
686
+
See also :ref:`Clear`.
687
687
688
688
Send
689
689
^^^^
@@ -695,14 +695,14 @@ Show
695
695
696
696
Reveals an object that was previously hidden (for example, shows descriptions or shows further details).
697
697
698
-
See also Hide.
698
+
See also :ref:`Hide`.
699
699
700
700
Sign up
701
701
^^^^^^^
702
702
703
703
Creates a User account or registers a User in a system.
704
704
705
-
Use instead of Register.
705
+
Use instead of :ref:`Register`.
706
706
707
707
Sort
708
708
^^^^
@@ -721,9 +721,7 @@ Use instead of Launch.
721
721
Submit an idea
722
722
^^^^^^^^^^^^^^
723
723
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.
727
725
728
726
T
729
727
-
@@ -743,21 +741,21 @@ Undo
743
741
744
742
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.
745
743
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`.
747
745
748
746
Update
749
747
^^^^^^
750
748
751
749
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.
752
750
753
-
See also Edit.
751
+
See also :ref:`Edit`.
754
752
755
753
Upload
756
754
^^^^^^
757
755
758
756
Transfers a file from a local system to a remote system.
0 commit comments