Module Folder Layout - Modules

New Community Website

Ordinarily, you'd be at the right spot, but we've recently launched a brand new community website... For the community, by the community.

Yay... Take Me to the Community!

Welcome to the DNN Community Forums, your preferred source of online community support for all things related to DNN.
In order to participate you must be a registered DNNizen

Home All Forums

8/11/2014 6:38 PM

Keith Stone

Joined: 3/5/2004

Posts: 165

Module Folder Layout

I've been working on documenting a "standard" layout for modules, this is based on reviewing several modules and the Chris's DAL template. While I understand most any layout would work, and having a "standard" inhibits creativity, I feel having some guidance for structure (that's documented) will enhance the development of DNN modules. This is DAL so far and I'd like to add recommendations for DAL2, Javascript storage, etc, so there's something to work from. If more people follow a standard, then people trying to learn from modules will know where to look for certain functions.

Module	Primary	Secondary	Tertiary	CS Filename	VB Filename
<module name>	.build			MSBuild.Community.Tasks.dll
<module name>	.build			MSBuild.Community.Tasks.targets
<module name>	App_LocalResources			Edit.ascx.resx
<module name>	App_LocalResources			Settings.ascx.resx
<module name>	App_LocalResources			View.ascx.resx
<module name>	BuildScripts			ModulePackage.targets
<module name>	BuildScripts			MSBuild.Community.Tasks.Targets
<module name>	Components			FeatureController.cs	FeatureController.vb
<module name>	Components			<table name>Controller.cs	<table name>Controller.vb
<module name>	Components			<table name>Info.cs	<table name>Info.vb
<module name>	Data			DataProvider.cs	DataProvider.vb
<module name>	Documentation			Documentation.css
<module name>	Documentation			Documentation.html
<module name>	packages			repositories.config
<module name>	packages	MSBuildTasks.1.4.0.74		MSBuildTasks.1.4.0.74.nupkg
<module name>	packages	MSBuildTasks.1.4.0.74	content	MSBuild.Community.Tasks.ReadMe.md
<module name>	packages	MSBuildTasks.1.4.0.74	tools	Build.proj
<module name>	packages	MSBuildTasks.1.4.0.74	tools	Install.ps1
<module name>	packages	MSBuildTasks.1.4.0.74	tools	MSBuild.Community.Tasks.dll
<module name>	packages	MSBuildTasks.1.4.0.74	tools	MSBuild.Community.Tasks.Targets
<module name>	packages	MSBuildTasks.1.4.0.74	tools	MSBuild.Community.Tasks.xml
<module name>	packages	MSBuildTasks.1.4.0.74	tools	MSBuild.psm1
<module name>	Properties			AssemblyInfo.cs	AssemblyInfo.vb
<module name>	Providers	DataProviders	SqlDataProvider	00.00.01.SqlDataProvider
<module name>	Providers	DataProviders	SqlDataProvider	SqlDataProvider.cs	SqlDataProvider.vb
<module name>	Providers	DataProviders	SqlDataProvider	Uninstall.SqlDataProvider
<module name>	Services			RouteMapper.cs	RouteMapper.vb
<module name>	Services			ServicesController.cs	ServicesController.vb
<module name>				<module name>.dnn
<module name>				<module name>.sln
<module name>				<module name>.csproj	<module name>.vbproj
<module name>				<module name>.csproj.user	<module name>.vbproj.user
<module name>				<module name>ModuleBase.cs	<module name>ModuleBase.vb
<module name>				<module name>SettingsBase.cs	<module name>SettingsBase.vb
<module name>				Build.proj
<module name>				Edit.ascx
<module name>				Edit.ascx.cs	Edit.ascx.vb
<module name>				Edit.ascx.designer.cs	Edit.ascx.designer.vb
<module name>				License.txt
<module name>				module.css
<module name>				packages.config
<module name>				ReleaseNotes.txt
<module name>				Settings.ascx
<module name>				Settings.ascx.cs	Settings.ascx.designer.vb
<module name>				Settings.ascx.designer.cs	Settings.ascx.vb
<module name>				View.ascx
<module name>				View.ascx.cs	View.ascx.designer.vb
<module name>				View.ascx.designer.cs	View.ascx.vb

8/13/2014 10:09 AM

Joe Brinkman

blog.theaccidentalgeek.com
Joined: 5/18/2003

Posts: 2356

Re: Module Folder Layout

Keith,

One of the standards that I don't see here is the concept of an owner directory. In more modern DNN module development we recommend that people put modules in a structure that looks like this /desktopmodules/{ownerfolder}/{modulename}/. This structure helps keep different modules from inadvertently colliding.

Joe Brinkman
DNN Corp.

Page 1 of 1

These Forums are dedicated to discussion of DNN Platform and Evoq Solutions.

For the benefit of the community and to protect the integrity of the ecosystem, please observe the following posting guidelines:

No Advertising. This includes promotion of commercial and non-commercial products or services which are not directly related to DNN.
No vendor trolling / poaching. If someone posts about a vendor issue, allow the vendor or other customers to respond. Any post that looks like trolling / poaching will be removed.
Discussion or promotion of DNN Platform product releases under a different brand name are strictly prohibited.
No Flaming or Trolling.
No Profanity, Racism, or Prejudice.
Site Moderators have the final word on approving / removing a thread or post or comment.
English language posting only, please.

Products

Solutions

Resources

Partners

Community

Blog

About

QA

Ideas Test

New Community Website

DNN Corp. (DotNetNuke)