RE: [FR-devel] Input requested on plugin directory naming.

[Rich Kilmer]

modification to my own post (I know...bad form...but whatever ;-)

drop the org_ (or com_) it just makes things longer and really does not
add anything.

rubyide_gui <- gui core components
rubyide_gui_fox <- fox renderer
rubyide_commands <- core commands
rubyide_util_... <- utility plugins like the logger
rubyide_tools_... <- tools like debugger, filebrowser, etc

The plugin names (in the yaml files) also have to be unique...so...i
recommend that we name them the same as their directory names+file names
so...

if the name of the plugin file was:

<pluginpath>/rubyide_gui/menubar.rb 

the plugin name would be:

rubyide_gui_menubar

Again, this a convention that we will follow and recommend others
follow.  If they don't there is nothing much we can do but shame them
into adhering.

Also, the internal ruby module namespace is yet another issue that this
does not address.  we still will have ours as:

FreeRIDE::GUI::MenuBar

So you can see that the convention is for plugin/file naming (and thus
'require' statements).  The module namespace is separate (but we will
publish our namespace as well).

-rich

> -----Original Message-----
> From: address@hidden 
> [mailto:address@hidden 
> On Behalf Of Rich Kilmer
> Sent: Thursday, December 19, 2002 3:40 PM
> To: address@hidden
> Subject: [FR-devel] Input requested on plugin directory naming.
> 
> 
> Our current naming structure for plugins is quite ad hoc.  We 
> have System_Commands, System_GuiCode and System_GuiRenderFox 
> for the basic IDE and then directories named after functions 
> (Debugger, FileBrowser,
> ScriptBrowser) for the rest.  I think this is a problem 
> waiting to happen.  We will quickly run out of names for 
> stuff (like the current Ruby naming problems.  My 
> recommendation is to rename the plugin directories and move 
> all their code.  The question is what naming convention to use.  
> 
> What are your thoughts about using Eclipse-like/Java-like 
> domain name dirs with underscores instead of dots for separators:
> 
> org_rubyide_core_gui
>   - Core GUI stuff (components)
> 
> org_rubyide_core_gui_fox
>   - Fox renderer...other renderers would be likewise named
> 
> org_rubyide_core_commands
>   - Standard commands
> 
> org_rubyide_util_logger
>   - the util groups holds all utility plugins
> 
> org_rubyide_tools_debugger
>   - all tool plugins go under org_rubyide_tools_...
> 
> And I want to add the "plugins" directory to the ruby path so 
> that if a plugin needed to reference other files, it would 
> use its directory+file (regardless of the "plugin" main 
> directory.)  This is a big issue because right now the plugin 
> directory name is a parameter, but the plugins themselves use 
> an absolute path ("plugins/System_GuiCore/Component.rb")...so 
> this change is needed.
> 
> Please respond soon, I want to roll this in.
> 
> -rich
> 
> _______________________________
> Rich Kilmer, InfoEther LLC
> trap("SIGINT") { raise [104, 101, 108, 108].pack("cccc") }
> 
> 
> 
> 
> _______________________________________________
> Freeride-devel mailing list
> address@hidden 
> http://mail.nongnu.org/mailman/listinfo/freeri> de-devel
> 
>