Difference between revisions of "Projects/Oxygen/namingSpec/actions"

(Minor fix: I'm sure JRT wanted to have user-delete instead of delete-user.)
(More progress, covers all items in the spec until (and including) edit-*)
Line 6: Line 6:
  
 
<pre>
 
<pre>
  add-user                     -> user-add *
+
add-user                       -> edit-add-user **
  centrejust                   -> svn rm,
+
                                  (In case edit-add is approved.)
 +
application-exit              OK
 +
centrejust                     -> svn rm,
 
                                   there's already text-center
 
                                   there's already text-center
  delete-user                   -> user-delete *
+
delete-user                   -> edit-delete-user **
  dialog-apply                 -> dialog-ok
+
                                  (In case edit-delete is approved.)
  dialog-cancel                 OK
+
dialog-apply                   -> dialog-ok
  dialog-close                 OK
+
dialog-cancel                 OK
  document-new                 OK
+
dialog-close                   OK
  document-open                 OK
+
document-new                   OK
  document-open-recent         OK
+
document-open                 OK
  document-print               OK
+
document-open-recent           OK
  document-print-preview       OK
+
document-print                 OK
  document-properties           OK
+
document-print-preview         OK
  document-revert               OK
+
document-properties           OK
  document-save                 OK
+
document-revert               OK
  document-save-as             OK
+
document-save                 OK
  edit-copy                     OK
+
document-save-as               OK
  edit-cut                     OK
+
edit                          OK *
  edit-delete                   OK
+
edit-add                      OK *
  edit-find                     OK
+
edit-clear                    OK (Note: Only in CVS,
  edit-paste                   OK
+
                                    not yet in 0.8 of the spec.)
  edit-redo                     OK
+
edit-copy                     OK
  edit-undo                     OK
+
edit-cut                       OK
  edit-user                     -> user-edit *
+
edit-delete                   OK *
  folder-new                   OK
+
edit-find                     OK
  format-indent-less           OK
+
edit-paste                     OK
  format-indent-more           OK
+
edit-redo                     OK
  format-justify-fill           OK
+
edit-undo                     OK
  format-text-bold             OK
+
edit-user                     OK **
  format-text-italic           OK
+
                                  (In case "edit" is approved.)
  format-text-strikethrough     OK
+
folder-new                     OK
  format-text-underline         OK
+
format-indent-less             OK
  go-bottom                     OK
+
format-indent-more             OK
  go-down                       OK
+
format-justify-fill           OK
  go-first                     OK
+
format-text-bold               OK
  go-home                       OK
+
format-text-italic             OK
  go-last                       OK
+
format-text-strikethrough     OK
  go-next                       OK
+
format-text-underline         OK
  go-previous                   OK
+
go-bottom                     OK
  go-top                       OK
+
go-down                       OK
  go-up                         OK
+
go-first                       OK
  help-contents                 OK
+
go-home                       OK
  identity                     -> contact-new
+
go-last                       OK
  list-add                     OK
+
go-next                       OK
  list-remove                   OK
+
go-previous                   OK
  mail-forward                 OK
+
go-top                         OK
  mail-ham                     -> mail-mark-notjunk
+
go-up                         OK
  mail-message-new             OK
+
help-contents                 OK
  mail-reply-all               OK
+
identity                       -> contact-new
  mail-reply-sender             OK
+
                                  (maybe add a "new" sparkle?)
  mail-send                     OK
+
list-add                       OK
  media-eject                   OK
+
list-remove                   OK
  media-playback-pause         OK
+
mail-delete                    -> edit-delete-mail
  media-playback-start         OK
+
mail-forward                   OK
  media-playback-stop           OK
+
mail-ham                       -> mail-mark-notjunk
  media-record                 OK
+
mail-message-new               OK
  media-seek-backward           OK
+
mail-reply-all                 OK
  media-seek-forward           OK
+
mail-reply-sender             OK
  media-skip-backward           OK
+
mail-send                     OK
  media-skip-forward           OK
+
media-eject                   OK
  object-rotate-left           OK
+
media-playback-pause           OK
  object-rotate-right           OK
+
media-playback-start           OK
  system-lock-screen           OK
+
media-playback-stop           OK
  system-log-out               OK
+
media-record                   OK
  system-run                   OK
+
media-seek-backward           OK
  system-search                 OK
+
media-seek-forward             OK
  tab-breakoff                 -> tab-detach *
+
media-skip-backward           OK
  tab-duplicate                 OK *
+
media-skip-forward             OK
  tab-new                       -> tab-new-background *
+
object-rotate-left             OK
  tab-new-raised               -> tab-new *
+
object-rotate-right           OK
  tab-remove                   OK *
+
save-all                      -> document-save-all *
  text-center                   -> format-justify-center
+
system-lock-screen             OK
  text-left                     -> format-justify-left
+
system-log-out                 OK
  text-right                   -> format-justify-right
+
system-run                     OK
  tools-check-spelling         OK
+
system-search                 OK
  view-fullscreen               OK
+
tab-breakoff                   -> tab-detach *
  view-refresh                 OK
+
tab-duplicate                 OK *
  view-restore                 OK
+
tab-new                       -> tab-new-background **
  window-close                 OK
+
tab-new-raised                 -> tab-new *
  window-new                   OK
+
tab-remove                     -> tab-close *
  zoom-best-fit                 OK
+
                                  (in accordance to window-close)
  zoom-in                      OK
+
text-center                   -> format-justify-center
  zoom-original                OK
+
text-left                     -> format-justify-left
  zoom-out                     OK
+
text-right                     -> format-justify-right
 
+
tools-check-spelling           OK
 +
viewmag1                      -> zoom-original
 +
view-fullscreen               OK
 +
view-refresh                   OK
 +
view-restore                   OK
 +
window-close                   OK
 +
window-new                     OK
 +
zoom-original                  -> svn rm, or zoom *
 +
zoom-best-fit                 -> zoom-fit-best
 +
zoom-in                        OK
 +
zoom-out                       OK
 
  *  suggesting this for inclusion into the icon naming specification
 
  *  suggesting this for inclusion into the icon naming specification
 
  ** not in the spec, but let's keep it out of there anyways,
 
  ** not in the spec, but let's keep it out of there anyways,
Line 101: Line 113:
  
 
<pre>
 
<pre>
 +
address-book-new
 +
  The icon used for the action to create a new address book.
 +
 +
appointment-new
 +
  The icon used for the action to create a new appointment
 +
  in a calendaring application.
 +
 +
document-page-setup
 +
  The icon for the page setup action of a document editor.
 +
 
  edit-find-replace
 
  edit-find-replace
 
   The icon for the find and replace action.
 
   The icon for the find and replace action.
Line 113: Line 135:
  
 
<pre>
 
<pre>
 +
edit
 +
  The icon for the generic edit action.
 +
  (Rationale: There are a lot of things that need to be edited:
 +
    bookmarks, contacts, todos, away messages, fill/stroke colors,
 +
    app specific item properties of any kind, ...
 +
    There should be a generic edit icon as a common ground
 +
    and fallback for these use cases.)
 +
 +
edit-add
 +
  The icon for the add action.
 +
  (The icon for the add to list action would
 +
    subsequently be named edit-add-list.)
 +
  (Rationale: There are a good number of things that need to be
 +
    added - not created - but still cannot necessarily be counted
 +
    as list items: breakpoints, files in an archive, bookmarks,
 +
    fonts, friends' accounts in instant messaging, ...
 +
    There should be a generic add icon as a common ground and
 +
    fallback for these use cases, also as an opposite to
 +
    edit-delete.)
 +
 
  tab-detach
 
  tab-detach
 
  tab-duplicate
 
  tab-duplicate
  tab-new
+
  tab-new (or possibly new-tab, see below)
tab-new-background
+
  tab-remove (or possibly close-tab, see below)
  tab-remove
+
  zoom-fit-height
user-add
+
  zoom-fit-width
  user-delete
+
  zoom-fit-best (instead of zoom-best-fit)
user-edit
 
view-fit-height
 
  view-fit-width
 
  view-fit-window
 
 
  view-next
 
  view-next
 
  view-previous
 
  view-previous
 
</pre>
 
</pre>
 +
 +
And now for the radical stuff:
 +
 +
<pre>
 +
 +
new
 +
  The icon for the create action.
 +
  (Rationale: Right now, the spec has quite a number of *-new
 +
    icons, but is totally unflexible when it comes to adding
 +
    other stuff that can be created. I propose edit-create as a
 +
    basis and fallback for all "new" icons, regardless if they
 +
    create documents, mails, podcasts, windows, menu entries in
 +
    the start menu editor, classes and functions in integrated
 +
    development environments, whatever. If this icon is there,
 +
    every app and KDE core library can have "new" items while
 +
    staying specification compliant.)
 +
  (Consequences for existing icons in the spec:
 +
    address-book-new -> new-address-book
 +
    appointment-new  -> new-appointment
 +
    contact-new      -> new-contact
 +
    document-new    -> new-document
 +
    folder-new      -> new-folder
 +
    window-new      -> new-window)
 +
 +
Of course, doing that breaks the current namespacing scheme
 +
of the spec's actions category, as for example document-new
 +
is ripped apart from the other document icons. I think this
 +
is ok for actions that are not solely specific to
 +
documents/windows/dialogs, because it is important for
 +
extensibility, hence the idea of fallbacks.
 +
 +
Consequently, there should be at least one more "generalization":
 +
 +
close
 +
  The icon for the close action.
 +
  (Consequences for existing icons in the spec:
 +
    dialog-close -> close-dialog
 +
    window-close -> close-window)
 +
  (Opens up opportunities for:
 +
    close-document
 +
    close-tab
 +
    close-project)
 +
<pre>

Revision as of 23:33, 15 July 2007

Only partially ready for consumption. JRT already found out about which Oxygen icons already conform to the spec, but the ones that don't conform are not yet listed in here, and there's not yet a plan at the moment on how to proceed with those.

Specification compliance of icon names

Icon names without notes already exist in the freedesktop.org icon naming specification.

 add-user                       -> edit-add-user **
                                   (In case edit-add is approved.)
 application-exit               OK
 centrejust                     -> svn rm,
                                   there's already text-center
 delete-user                    -> edit-delete-user **
                                   (In case edit-delete is approved.)
 dialog-apply                   -> dialog-ok
 dialog-cancel                  OK
 dialog-close                   OK
 document-new                   OK
 document-open                  OK
 document-open-recent           OK
 document-print                 OK
 document-print-preview         OK
 document-properties            OK
 document-revert                OK
 document-save                  OK
 document-save-as               OK
 edit                           OK *
 edit-add                       OK *
 edit-clear                     OK (Note: Only in CVS,
                                    not yet in 0.8 of the spec.)
 edit-copy                      OK
 edit-cut                       OK
 edit-delete                    OK *
 edit-find                      OK
 edit-paste                     OK
 edit-redo                      OK
 edit-undo                      OK
 edit-user                      OK **
                                   (In case "edit" is approved.)
 folder-new                     OK
 format-indent-less             OK
 format-indent-more             OK
 format-justify-fill            OK
 format-text-bold               OK
 format-text-italic             OK
 format-text-strikethrough      OK
 format-text-underline          OK
 go-bottom                      OK
 go-down                        OK
 go-first                       OK
 go-home                        OK
 go-last                        OK
 go-next                        OK
 go-previous                    OK
 go-top                         OK
 go-up                          OK
 help-contents                  OK
 identity                       -> contact-new
                                   (maybe add a "new" sparkle?)
 list-add                       OK
 list-remove                    OK
 mail-delete                    -> edit-delete-mail
 mail-forward                   OK
 mail-ham                       -> mail-mark-notjunk
 mail-message-new               OK
 mail-reply-all                 OK
 mail-reply-sender              OK
 mail-send                      OK
 media-eject                    OK
 media-playback-pause           OK
 media-playback-start           OK
 media-playback-stop            OK
 media-record                   OK
 media-seek-backward            OK
 media-seek-forward             OK
 media-skip-backward            OK
 media-skip-forward             OK
 object-rotate-left             OK
 object-rotate-right            OK
 save-all                       -> document-save-all *
 system-lock-screen             OK
 system-log-out                 OK
 system-run                     OK
 system-search                  OK
 tab-breakoff                   -> tab-detach *
 tab-duplicate                  OK *
 tab-new                        -> tab-new-background **
 tab-new-raised                 -> tab-new *
 tab-remove                     -> tab-close *
                                   (in accordance to window-close)
 text-center                    -> format-justify-center
 text-left                      -> format-justify-left
 text-right                     -> format-justify-right
 tools-check-spelling           OK
 viewmag1                       -> zoom-original
 view-fullscreen                OK
 view-refresh                   OK
 view-restore                   OK
 window-close                   OK
 window-new                     OK
 zoom-original                  -> svn rm, or zoom *
 zoom-best-fit                  -> zoom-fit-best
 zoom-in                        OK
 zoom-out                       OK
 *  suggesting this for inclusion into the icon naming specification
 ** not in the spec, but let's keep it out of there anyways,
    it's not really suited to be a standard icon

To do for Oxygen

Icons that are in the spec, but not yet in Oxygen's actions/ (after renaming) so they need to be added. Descriptions taken from the specification

 address-book-new
   The icon used for the action to create a new address book.

 appointment-new
   The icon used for the action to create a new appointment
   in a calendaring application.

 document-page-setup
   The icon for the page setup action of a document editor.

 edit-find-replace
   The icon for the find and replace action.

 edit-select-all
   The icon for the select all action.

Summary of the suggested changes and additions

The ones marked with * and should therefore go into the icon naming specification, presented here in a shorter list for a better overview. Including a suggested short description text like needed for inclusion in the spec.

 edit
   The icon for the generic edit action.
   (Rationale: There are a lot of things that need to be edited:
    bookmarks, contacts, todos, away messages, fill/stroke colors,
    app specific item properties of any kind, ...
    There should be a generic edit icon as a common ground
    and fallback for these use cases.)

 edit-add
   The icon for the add action.
   (The icon for the add to list action would
    subsequently be named edit-add-list.)
   (Rationale: There are a good number of things that need to be
    added - not created - but still cannot necessarily be counted
    as list items: breakpoints, files in an archive, bookmarks,
    fonts, friends' accounts in instant messaging, ...
    There should be a generic add icon as a common ground and
    fallback for these use cases, also as an opposite to
    edit-delete.)

 tab-detach
 tab-duplicate
 tab-new (or possibly new-tab, see below)
 tab-remove (or possibly close-tab, see below)
 zoom-fit-height
 zoom-fit-width
 zoom-fit-best (instead of zoom-best-fit)
 view-next
 view-previous

And now for the radical stuff:

 new
   The icon for the create action.
   (Rationale: Right now, the spec has quite a number of *-new
    icons, but is totally unflexible when it comes to adding
    other stuff that can be created. I propose edit-create as a
    basis and fallback for all "new" icons, regardless if they
    create documents, mails, podcasts, windows, menu entries in
    the start menu editor, classes and functions in integrated
    development environments, whatever. If this icon is there,
    every app and KDE core library can have "new" items while
    staying specification compliant.)
   (Consequences for existing icons in the spec:
    address-book-new -> new-address-book
    appointment-new  -> new-appointment
    contact-new      -> new-contact
    document-new     -> new-document
    folder-new       -> new-folder
    window-new       -> new-window)

Of course, doing that breaks the current namespacing scheme
of the spec's actions category, as for example document-new
is ripped apart from the other document icons. I think this
is ok for actions that are not solely specific to
documents/windows/dialogs, because it is important for
extensibility, hence the idea of fallbacks.

Consequently, there should be at least one more "generalization":

 close
   The icon for the close action.
   (Consequences for existing icons in the spec:
    dialog-close -> close-dialog
    window-close -> close-window)
   (Opens up opportunities for:
    close-document
    close-tab
    close-project)

Content is available under Creative Commons License SA 4.0 unless otherwise noted.