Menu

EDE apps naming convention

EDE
Double 12
2008-07-17
2013-04-05
  • Double 12

    Double 12 - 2008-07-17

    What is the naming convention for EDE apps? A small 'e' and then a capitalized second letter? Like 'eFiler'?
    If that's the case, I think we must change all program names to that format, because there are other desktop environments that have program names starting with 'e' as well. For example Enlightenment, they use program names starting with a capitalized 'E'.
    We must stay unique, so people know which programs belong to Equinox by just looking at the name of the program.

    Also, I'm afraid we're not the only ones using the name 'eFiler': http://www.efiler.net/ :O

     
    • Anonymous

      Anonymous - 2008-07-17

      I agree. That's the same thought I posted here some time ago.
      I would prefer prefix "ede-" (e.g. ede-notepad, ede-filer, ede-panel, ede-desktop, ede-calc, ...).
      With the one BIG advantage: command-completion on the console:
      just type ede- TAB TAB and you will see all EDE-applications (HU! the "ede-"prefix again ;-))

      gnome does the same...

       
    • Double 12

      Double 12 - 2008-07-17

      "ede-" as prefix indeed makes pretty clear the program is part of EDE...but it sounds rather boring :) I know Gnome also does this, but that's one of the points I don't like from Gnome ;)
      I prefer the KDE-way, everything start with a K or has a K in it. We're doing the same thing with the 'e'.
      We could still use the 'e', but then think of a unique name. Like "eXplore" instead of "eFiler". A wrong example though, in this case eFiler sounds better in my opinion.

       
    • Vedran Ljubovic

      Vedran Ljubovic - 2008-07-18

      Hello,

      I agree that we need a naming convention, and your suggestions sound good. My previous thoughts about this were that the really simple apps that are not likely to be used outside of EDE should have generic names (e.g. "File manager", "Image viewer") and filenames should be e.g. ede-image-viewer. Meanwhile, it seems that efiler could be of interest to users of other desktops so it could have a unique name, e.g. like you suggest - eFiler.

      As for other efilers, when choosing the name I did look around :) and I saw the page your link points to, but it contains absolutely no info about what is that efiler.net thing. Most other references are about some web app. IMHO it is pretty much impossible to come up with completely unique names that don't sound awkward, we should strive to have unique name in the given domain e.g. I haven't found a file manager named efiler, as for PHP download manager named efiler I don't care ;) there probably won't be any confusion or trademark dilution there.

       
    • Double 12

      Double 12 - 2008-08-16

      vljubovic, I think that is a good idea. But I also think a lot of programs may be used outside EDE in the future, like the image viewer.
      Only programs that will never be used outside EDE (like ede-panel, ede-desktop, or if that would exist ede-controlpanel) should get the ede-prefix in my opinion.

      You could call the image viewer eXpose...although that capital X looks a bit cheap.

       
    • Sanel Zukan

      Sanel Zukan - 2008-08-20

      I'm jumping here a bit late... as usually :)

      I'm very glad to see this discussion; not only there is a good chance we get name clashes with something outside, but also I found sounding of some names we are using now, pretty dumb. E.g. "eiconman" and "eworkpanel" means nothing to the ordinary user without checking either docs or contacting us.

      Gnome way can be helpful here: ede-desktop and ede-panel names speaks for itself; also, as Ralf noticed, we gets shell completion for free.

      > You could call the image viewer eXpose
      I'm highly against camel case names for programs. Not only that no one uses it, there is also a small chance you get a naming pattern correctly; e.g. you want to start efiler from shell, you would ask yourself: Was it "eFiler" or "efiler" or "Efiler"? Even shell completion will not be from use here.

      > Only programs that will never be used outside EDE
      IMHO, this is not a good way either. _Any_ program can be used outside, even panel, desktop and window manager: we are having standards now :).

      We could have preference on "ede-" names and keep cool names too (efiler, enjoy). In some cases, mostly due variety in application capabilities, "ede-" naming should not be prefered (e.g. evoke looks better than "ede-session-holder-splash-and-xsettings-manager"). Even KDE/gnome allow diversities, like: totem, tomboy, amarok.

      Ideas?

      Sanel

       
    • Double 12

      Double 12 - 2008-08-21

      I'd say: Give the "system" parts (window manager, panel, desktop, etc.) an "ede-" name.
      Give the rest of the programs an attracting name. An attracting name can be  a name starting with "e", if you can think of a nice word starting with "e", like eNjoy and evoke. If there is no cool word starting with "e", just think of a completely different name.
      Xfce did the same, they were tired of all programs starting with "Xf": there aren't any normal words with "Xf". They just thought of different names, like Thunar for their file manager and Ristretto for their image viewer.

      if (SYSTEM_PART)
      {
         name = "ede-" + task
      }
      else
      {
         if (WORD_STARTING_WITH_E_FOUND)
         {
            name = word_starting_with_e()
         }
         else
         {
            name = completely_different_name()
         }
      }

       
    • Sanel Zukan

      Sanel Zukan - 2008-08-22

      Others? Vedran, Ralf?

       
      • Vedran Ljubovic

        Vedran Ljubovic - 2008-08-22

        I agree with last post by double_12 on this one.

         
      • Anonymous

        Anonymous - 2008-08-22

        my first opinion was:
        prefix all EDE programs with "ede-" for those reasons:
        - command completion
        - to state the fact that the program is a program depending on edelib
        - to "brand" it

        So for a democratic decission, let's go through the list:

        eabout:           ede-about (Ralf)
        ecalc:              ede-calc (Ralf)
        ecolorconf:      ede-colorconf (Ralf)
        econtrol:         ede-control (Ralf)
        ecrasher:        ede-crasher (Ralf)
        edesktopconf: ede-desktopconf (Ralf)
        edewm:          ede-wm (Ralf)
        edialog:          ede-dialog (Ralf)
        edisplayconf:  ede-displayconf (Ralf)
        efiler:              efiler (Ralf)
        efinder:           ede-finder (Ralf)
        ehelp:             ede-help (Ralf)
        eiconman:       ede-desktop (Ralf)
        eimage:          ede-image (Ralf)
        einstaller:       ede-installer (Ralf)
        ekeyconf:        ede-keyconf (Ralf)
        elauncher:      ede-launcher (Ralf)
        elma:               ede-loginmanager (Ralf)
        emenueditor:  ede-menueeditor (Ralf)
        emountd:        ede-mountd (Ralf)
        epanelconf:     ede-panelconf (Ralf)
        esvrconf:         ede-screensaver (Ralf)
        etimedate:      ede-timedate (Ralf)
        etip:                ede-tip (Ralf)
        evoke:             ede-invoke (evoke sounds better...) (Ralf)
        evolume:         ede-volume (Ralf)
        ewmconf:        ede-wmconf (Ralf)
        eworkpanel:    ede-workpanel (Ralf)
        exset:             ede-xset (Ralf)

        new programs to be added:
        ede-notepad (Ralf)
        enjoyMP (Ralf)

        I think that these programs are not really "system programs":
        ecalc, efiler, eimage
        so their names could be something else...

        Please, add your name and wished program-name at each line, so that we have a complete decision list.
        Thanks in advance!

         
        • Anonymous

          Anonymous - 2008-08-25

          I try a conclusion of our discussion (to this point) as the following:

          Ralf:
          prefix "ede-" (command completion, edelib-dependency)

          double_12:
          prefix "ede-" for "system"-parts
          attracting names for rest of programs (starting with "e" or not)
          "-conf"-postfix for configuration programs

          Vedran:
          prefix "ede-" for system-programs of EDE
          prefix "e" for programs that may be of interest outside of EDE

          Sanel:
          prefix "ede-" preferenced (command completion, no camel-cases)
          unique program names where "ede-"-name leads to no clear description what program does

          I divide the list in three parts:
          "system"-programs, "conf"-programs, other applications:

          SYSTEM:
          eabout: ede-about
          ecrasher: ede-crasher
          edewm: edewm
          edialog: ede-dialog
          efinder: ede-finder (maybe no system-app...)
          ehelp: ede-help
          eiconman: ede-desktop
          einstaller: ede-installer
          elauncher: ede-launcher
          elma: elma
          emenueditor: ede-menueditor
          emountd: ede-mountd
          etimedate: ede-timedate
          etip: ede-tip
          evoke: evoke
          evolume: ede-mixer
          eworkpanel: ede-workpanel
          (exset: ede-xset) deprecated? (what use instead for setting resolution?)

          CONF:
          ecolorconf: ede-color-conf
          econtrol: ede-control-center / ede-conf
          edesktopconf: ede-desktop-conf
          edisplayconf: ede-display-conf
          ekeyconf: ede-keyboard-conf
          epanelconf: ede-panel-conf
          esvrconf: ede-screensaver-conf
          ewmconf: ede-wm-conf

          OTHER APPLICATIONS:
          ecalc: ede-calc / ecalc
          efiler: efiler
          eimage: ede-image

          new applications to be added (binary names):
          ede-notepad
          enjoy

          How to make changes?
          I suggest the following steps:
          - documentation: HOWTO for EDE2 devlopers (setting up development environment, checkout, how to compile, ...): done in WIKI (I volunteer myself, ok?)
          - documentation: EDE2 installation (perhaps using some parts of EDE1 and EFLTK): done in WIKI (I volunteer myself, ok?)
          - Sanel and Vedran (as project leaders) delegate some work to double_12 and me (how they think is the best)

          Here we go ;-)!

           
          • Double 12

            Double 12 - 2008-08-25

            Your conclusion of the discussion is absolutely right, in my opinion.

            I agree with most of your list. Just a few comments:
            - Couldn't we call ede-wm-conf "edewm-conf"? It is not just the config of *a wm*, it is the config of edewm!
            - Now most of the apps changed from "e" to "ede-", "ecalc" looks a bit lost. Couldn't we call it "ede-calc"?
            - efiler is also a bit lost...but I still like it. ede-filer doesn't sound like an attracting alternative, so it should be either "efiler" or a completely different word.
            - ede-image is OK, but I prefer the name "expose". Expose starts with an e, and if we want to use a different word, let it be something which has to do something with photos, like: "focus", "panorama".

            I'll be happy to do something for the documentation.

            Ralf, I have an idea for the EDE2 developer documentation. Of course edelib has doxygen documentation (you could make a link to those doxygen docs in the EDE2 developer docs), but it would also be nice if you list some of the most remarkable, smart features of edelib (like edelib::Window, DBus) and give small examples of them.

             
            • Anonymous

              Anonymous - 2008-08-25

              hi double_12,

              - edewm-conf is really better
              - ede-calc is ok I think
              - efiler: it's Vedran's project, so he should decide
              - expose: think it does not clearly describe what program does... so eimage/ede-image: Sanel and Vedran should decide...

              documentation together: cool. I could start this week's evenings... Sanel/Vedran: could you please make a starting point "DevelopmentHowTo" for us on the start page of the wiki http://www.equinox-project.org/cgi-bin/trac.cgi/wiki/WikiStart?

              > Of course edelib has doxygen documentation (you could make a link to those doxygen docs in the EDE2 developer docs),
              > but it would also be nice if you list some of the most remarkable, smart features of edelib (like edelib::Window, DBus) and give small examples of them.
              Think you are right, but unfortunately I am not a official member of EDE-Team and no indepth C/C++-developer: active EDE-Team is Sanel and Vedran...

              Perhaps we should move further discussion related to project internal things to ede-devel-Mailinglist?
              https://sourceforge.net/mail/?group_id=49891

               
              • Sanel Zukan

                Sanel Zukan - 2008-08-26

                > Sanel/Vedran: could you please make a starting point
                > "DevelopmentHowTo"

                Done :)

                > I suggest the following steps:
                > - documentation: HOWTO for EDE2 devlopers (setting up development
                > environment, checkout, how to compile, ...): done in WIKI (I volunteer
                > myself, ok?)

                Ok.

                > - documentation: EDE2 installation (perhaps using some parts of
                > EDE1
                > and EFLTK): done in WIKI (I volunteer myself, ok?)

                Ok.

                > - Sanel and Vedran (as project leaders) delegate some work to
                > double_12 and me (how they think is the best)

                Agree. But guys, let we be more active on ede-devel list, please :).
                It is a much better place for discussions.

                >> but it would also be nice if you list some of the most remarkable,
                >> smart features of edelib (like edelib::Window, DBus) and give small
                >> examples of them.
                > Think you are right, but unfortunately I am not a official member of
                > EDE-Team and no indepth C/C++-developer: active EDE-Team is
                > Sanel and Vedran...

                I tried to put some samples inside doxygen documentation, although
                they can be better, but it should not be the stop point for not looking
                at the code :).

                A starting point for dbus can be edelib-dbus-introspect in edelib/tools
                and I'm recommending seeing http://www.freedesktop.org/wiki/Software/dbus
                as intro, just to give some insight about the idea and used terms.

                For Window, currently there is no simple example except "use it like
                Fl_Window or Fl_Double_Window"...

                > - edewm-conf is really better

                +1.

                > - ede-calc is ok I think

                Agree.

                > so eimage/ede-image: Sanel and Vedran should decide...

                Or maybe ede-imageview? Althought I find "expose" a very nice name,
                I would like to reserve it for the future when we extend viewer to
                to... "a-little-bit-extended-viewer-than-current-is" :)

                > Perhaps we should move further discussion related to project
                > internal things to ede-devel-Mailinglist?

                That would be highly recommended ;)

                Sanel

                 
    • Double 12

      Double 12 - 2008-08-22

      eabout: ede-about (Ralf)
      ecalc: ede-calc (Ralf)
      ecolorconf: ede-colorconf (Ralf)
      econtrol: ede-control (Ralf)
      ecrasher: ede-crasher (Ralf)
      edesktopconf: ede-desktopconf (Ralf)
      edewm: ede-wm (Ralf) this looks weird, IMO it should stay edewm (double_12)
      edialog: ede-dialog (Ralf)
      edisplayconf: ede-displayconf (Ralf)
      efiler: efiler (Ralf)
      efinder: ede-finder (Ralf)
      ehelp: ede-help (Ralf)
      eiconman: ede-desktop (Ralf)
      eimage: ede-image (Ralf)
      einstaller: ede-installer (Ralf)
      ekeyconf: ede-keyconf (Ralf)
      elauncher: ede-launcher (Ralf)
      elma: keep it elma - btw what does elma mean? (double_12)
      emenueditor: ede-menueeditor (Ralf)
      emountd: ede-mountd (Ralf)
      epanelconf: ede-panelconf (Ralf)
      esvrconf: ede-screensaver (Ralf) ...is this the screensaver itself, or screensaver config tool? (double_12)
      etimedate: ede-timedate (Ralf)
      etip: ede-tip (Ralf)
      evoke: evoke (double_12)
      evolume: ede-volume (Ralf)
      ewmconf: ede-wmconf (Ralf)
      eworkpanel: ede-workpanel (Ralf)
      exset: ede-xset (Ralf)

      I think there may be a much cooler name than ede-notepad for your editor. But I couldn't think of something good. Maybe an exotic word is better than something with "e".

      At the moment, the name of my media player is "eNjoy" (pronounce "ee-enjoy") and the name of the binary is "enjoy" (so there's no confusion). As it's my own project, I can ultimately decide the name :P But of course, I'll listen to your suggestions. enjoyMP sounds a bit cool...but I actually find just one word cooler than saying it's an "MP" (Media Player).

       
    • Sanel Zukan

      Sanel Zukan - 2008-08-23

      > elma: keep it elma - btw what does elma mean? (double_12)
      Ede Login MAnager

      > exset: ede-xset (Ralf)
      This is obsolete, left from old code, so you can freely omit it :)

      I'm just thinkig for these ede-somethingconf: how about putting that "conf" as separate, e.g. ede-display-conf or ede-display-config (same applies for other "multi word" names, like ede-login-manager)? Or this sounds too much gnome-ish and looks a bit longer than is needed?

      > esvrconf: ede-screensaver (Ralf) ...is this the screensaver itself, or screensaver config tool? (double_12)
      A screensaver config tool.

      I will post mine proposed "corrections", instead a full list, primarly I'm founding your proposals pretty good, which implies my agreement with them.

      * evolume: ede-volume (Ralf) - better name would be ede-mixer since other calls it that way
      * edewm: ede-wm (Ralf) - could stay edewm (no need for "ede-" completion since you definitely don't want to run it from console manualy)
      * econtrol: ede-control (Ralf) - IMHO both sounds a bit ambiguous ("control of what?"); maybe ede-control-panel or ede-control-center?

      Maybe I'll have more inspiration tomorrow :)
      Sanel

       
    • Double 12

      Double 12 - 2008-08-23

      Putting "conf" as a seperate word is a good idea. But then be consistent in that: use "-conf" always and don't use "config".
      Putting "login" and "manager" seperate from eachother is not needed in my opinion, "login" is not a noun, these two words belong together. But in this case, I still prefer the short name "elma".

      I'd say: call esvrconf "ede-screensaver-conf". It is a bit long, but it makes clear it is a configuration tool and not the screensaver itself.

      If "ede-screensaver-conf" configures the screensaver and "ede-display-conf" configures the display,  we should call econtrol "ede-conf": it configures entire EDE.
      No other desktop environment does this, but I think it is very consistent to call the control center just "ede-conf".

      I agree with the rest of your ideas (ede-mixer and edewm).

       
    • Sanel Zukan

      Sanel Zukan - 2008-08-25

      > Putting "login" and "manager" seperate from eachother is not needed
      > in my opinion, "login" is not a noun, these two words belong together.
      Ok.

      > I'd say: call esvrconf "ede-screensaver-conf". It is a bit long, but it
      > makes clear it is a configuration tool and not the screensaver itself.
      Agree.

      > ...we should call econtrol "ede-conf": it configures entire EDE.
      > No other desktop environment does this, but I think it is very consistent
      > to call the control center just "ede-conf".
      Excelent idea! :)

      So, here is my list, incorporating above ideas and previous changes:
      eabout: ede-about (Ralf) 
      ecalc: ede-calc (Ralf) 
      ecolorconf: ede-color-conf (Sanel) 
      econtrol: ede-conf (double_12) 
      ecrasher: ede-crasher (Ralf) 
      edesktopconf: ede-desktop-conf (Sanel) 
      edewm: edewm (Sanel)
      edialog: ede-dialog (Ralf) 
      edisplayconf: ede-display-conf (Ralf) 
      efiler: efiler (Ralf) 
      efinder: ede-finder (Ralf) 
      ehelp: ede-help (Ralf) 
      eiconman: ede-desktop (Ralf) 
      eimage: ede-image (Ralf) 
      einstaller: ede-installer (Ralf) 
      ekeyconf: ede-key-conf: (a temporary name; it is a highly chance this tool be removed or drastically changed when window manager/panel be completed) (Sanel) 
      elauncher: ede-launcher (Ralf) 
      elma: elma (Sanel)
      emenueditor: ede-menu-editor or ede-menueditor? (Sanel) 
      emountd: ede-mountd (Ralf) 
      epanelconf: ede-panel-conf (Ralf) 
      esvrconf: ede-screensaver-conf (double_12)
      etimedate: ede-timedate-conf (Sanel) 
      etip: ede-tip (Ralf) 
      evoke: evoke (double_12)
      evolume: ede-mixer (Sanel) 
      ewmconf: ede-wm-conf (Sanel) 
      eworkpanel: ede-panel (Sanel)

      Any more proposals?
      Sanel

       

Log in to post a comment.

MongoDB Logo MongoDB