Projects/Oxygen/namingSpec/actions

    From KDE TechBase
    Revision as of 14:32, 2 September 2007 by Tampakrap (talk | contribs) (Add the remaining two Ark icons and a sufficient proposal for at least one of them.)

    Only partially ready for consumption. We 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.

     about-kde                      -> help-about-kde **
     add-user                       -> list-add-user **
     application-exit               OK
     ark-adddir                     -> list-add-directory-archive **
     ark-addfile                    -> list-add-file-archive **
     ark-delete                     -> list-remove-file-archive **
     ark-extract                    -> archive-extract *
     ark-view                       -> ?? (document-preview-archive? or
                                       maybe remove that icon altogether?)
     battery-discharging-000        -> status/battery-low-000 **
     battery-discharging-020        -> status/battery-low
     battery-discharging-040        -> status/battery-caution
     battery-discharging-060        -> status/battery-060 **
     battery-discharging-080        -> status/battery-080 **
     battery-discharging-100        -> status/battery-100 **
     battery-charging-000           -> status/battery-charging-low-000 **
     battery-charging-020           -> status/battery-charging-low **
     battery-charging-040           -> status/battery-charging-caution **
     battery-charging-060           -> status/battery-charging-060 **
     battery-charging-080           -> status/battery-charging-080 **
     battery-charging-100           -> status/battery-charging-100 **
     centrejust                     -> svn rm,
                                       there's already text-center
     compfile                       -> run-build-file **
     delete-user                    -> list-remove-user **
     dialog-apply                   OK *
     dialog-cancel                  OK
     dialog-close                   OK
     dialog-error                   -> status/dialog-error
     dialog-information             -> status/dialog-information
     dialog-ok                      OK
     dialog-warning                 -> status/dialog-warning
     document-new                   OK (or "new-document", wait for the
                                        outcome of the discussion)
     document-open                  OK (or "open", wait for the
                                        outcome of the discussion)
     document-open-recent           OK (or "open-recent", wait for the
                                        outcome of the discussion)
     document-print                 OK
     document-print-preview         OK
     document-properties            OK
     document-revert                OK
     document-save                  OK (or "save", wait for the
                                        outcome of the discussion)
     document-save-as               OK (or "save-as", wait for the
                                        outcome of the discussion)
     edit                           OK *
     editshred                      -> edit-delete-shred **
     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 (or "new-folder", wait for the
                                        outcome of the discussion)
     folder-open                    -> status/folder-open
     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
     goto-page                      -> go-jump
     go-last                        OK
     go-next                        OK
     go-previous                    OK
     go-top                         OK
     go-up                          OK
     help-contents                  OK
     help-whatsthis                 -> help-contextual *
     identity                       -> contact-new
                                       (maybe add a "new" sparkle?)
     list-add                       OK
     list-remove                    OK
     mail-delete                    -> edit-delete-mail
     mail-forward                   OK
     mail-get                       -> mail-receive *
     mail-ham                       -> mail-mark-notjunk
     mail-message-new               OK (or "new-message-mail", wait for
                                        the outcome of the discussion)
     mail-new                       -> svn rm,
                                       in favor of mail-message-new
     mail-reply-all                 OK
     mail-reply-sender              OK with the current spec, but in
                                       order to enable mail-reply-list,
                                       we rather want this to be
                                       mail-reply.
     mail-replylist                 -> mail-reply-list ** (see above)
     mail-send                      OK
     make-kdevelop                  -> run-build **
     media-eject                    OK
     media-playback-pause           OK
     media-playback-start           OK
     media-playback-stop            OK
     media-playlist-clear           -> edit-clear-playlist **
     media-playlist-refresh         -> view-refresh-playlist **
     media-record                   OK
     media-seek-backward            OK
     media-seek-forward             OK
     media-skip-backward            OK
     media-skip-forward             OK
     newfont                        -> list-add-font
     object-rotate-left             OK
     object-rotate-right            OK
     password                       -> status/dialog-password
     process-stop                   OK (Note: Only in CVS,
                                        not yet in 0.8 of the spec.)
     save-all                       -> document-save-all *
                                       (or save-all *, wait for the
                                        outcome of the discussion)
     switchuser                     -> system-switch-user *
     system-lock-screen             OK
     system-log-out                 OK
     system-run                     OK (or "run", wait for the
                                        outcome of the discussion)
     system-search                  OK (suggest to rename to
                                        system-find, for consistency)
     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 (or "close-window", wait for the
                                        outcome of the discussion)
     window-new                     OK (or "new-window", wait for the
                                        outcome of the discussion)
     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.
       (or "new-address-book", depending on the outcome
        of the discussion.)
    
     appointment-new
       The icon used for the action to create a new appointment
       in a calendaring application. (or "new-appointment",
       depending on the outcome of the discussion)
    
     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.
    
     format-text-direction-ltr
       The icon for the left-to-right text formatting action.
    
     format-text-direction-rtl
       The icon for the right-to-left formatting action.
    
     help-about
       The icon for the About item in the Help menu.
       (Editor's note: not used in KDE, probably a copy of
        the "(i)" icon is sufficient.)
    
     help-faq
       The icon for the FAQ item in the Help menu.
       (Editor's note: not used in KDE either, at the moment.)
    
     insert-image
       The icon for the insert image action of an application.
    
     insert-link
       The icon for the insert link action of an application.
    
     insert-object
       The icon for the insert object action of an application.
    
     insert-text
       The icon for the insert text action of an application.
    
     mail-mark-important
       The icon for the mark as important action of an
       electronic mail application.
    
     mail-mark-junk
       The icon for the mark as junk action of an
       electronic mail application.
    
     mail-mark-read
       The icon for the mark as read action of an
       electronic mail application.
    
     mail-mark-unread
       The icon for the mark as unread action of an
       electronic mail application.
    
     mail-send-receive
       The icon for the send and receive action of an
       electronic mail application.
    
     object-flip-horizontal
       The icon for the action to flip an object horizontally.
    
     object-flip-vertical
       The icon for the action to flip an object vertically.
    
     view-sort-ascending
       The icon used for the "Sort Ascending" item in the
       application's "View" menu, or in a button for
       changing the sort method for a list.
    
     view-sort-descending
       The icon used for the "Sort Descending" item in the
       application's "View" menu, or in a button for
       changing the sort method for a list.
    

    To do for Oxygen *and* the spec

    Icons that are neither in the spec nor in Oxygen but should be added to both.

     insert-table
       The icon for the insert table action of an application.
    

    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.

     archive-extract
       The icon used for the action that extracts files and directories
       from an archive.
    
     dialog-apply
       The icon used for the "Apply" button that might appear
       in dialog windows.
    
     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.)
    
     help-contextual
       The icon for the contextual help / "What's this" icon
       in the Help menu.
    
     insert-table
       The icon for the insert table action of an application.
    
     mail-receive
       The icon for the receive action of an
       electronic mail application.
    
     mail-reply-sender -> mail-reply
       (Rationale: In order to support more reply methods than
        the expected ones. KMail, at least, has "Reply" as
        "intelligent reply" - automatically do the right thing -
        and also "Reply to all", "Reply to author" and
        "Reply to mailing list". The latter is not in the spec,
        and doesn't need to be, but in order to enable
        mail-reply-list, we need a mail-reply fallback.)
    
     system-switch-user
       The icon used for the "Switch User" item in the
       desktop's panel application.
    
     system-search -> system-find
       The icon used for the "Find Files/Folders" item in the
       desktop's panel application.
       (Rationale: For consistency - edit-find also uses Find,
        and there's no good reason to use Search here.)
    
     tab-detach
       The icon used for the "Detach Tab" action.
    
     tab-duplicate
       The icon used for the "Duplicate Tab" action.
    
     tab-new (or possibly new-tab, see below)
     tab-remove (or possibly close-tab, see below)
    
     zoom-fit-height
       The icon used for the "Zoom to Height" item
       in the application's "View" menu.
       
     zoom-fit-width
       The icon used for the "Zoom to Width" item
       in the application's "View" menu.
       
     zoom-fit-best (instead of zoom-best-fit)
    

    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
        mail-message-new -> new-message-mail
        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)