New Module

Talk about writing modules and plugins for CMS Made Simple, or about specific core functionality. This board is for PHP programmers that are contributing to CMSMS not for site developers
Post Reply
cd163601
Forum Members
Forum Members
Posts: 14
Joined: Wed Aug 12, 2009 8:03 pm

New Module

Post by cd163601 »

I've created a very small module "Send Email".  This is the first module I've ever made, it is the first time I've ever used a Forge of any kind and the first time I have ever used subversion.

So have I done everything right? Have I managed to make something that people can use?

Any help would be greatfully received.

Thanks
Colin
Duketown

Re: New Module

Post by Duketown »

Colin,

Welcome to the club of module building persons. Also thanks for handing over your coding to the community. That is the way this open source product works/grows.

SVN seems to be to be filled properly.
Next thing would be to open the admin of the website that you have it up and running. Select the modules menu. On the right side you will see a button with XML on it. Use it. Save the generated XML file. Login in the forge and go to your module. Select from the admin part the file upload. Upload the earlier saved XML. Due to this action, your module will be made available for every one via the module manager. Next to the XML file in the forge, you will see that the majority of developers also prepare a zip or tar.gz file from the sources and include it in the list of available files on your project.
If possible enter some release notes.

Happy coding :-)

Duketown
cd163601
Forum Members
Forum Members
Posts: 14
Joined: Wed Aug 12, 2009 8:03 pm

Re: New Module

Post by cd163601 »

Thanks for the reply, I don't seem to be able to upload anything to the "Files" section of the Forge.  I have already exported the XML and it is part of my Subversion code.

Am I missing somthing with uploading to the Files section of the Forge? See screen shot attached.

Thanks
Colin
Attachments
files.png
Jos
Support Guru
Support Guru
Posts: 4019
Joined: Wed Sep 05, 2007 8:03 pm
Location: The Netherlands

Re: New Module

Post by Jos »

You have to add a "File Package" first. Then you can add a release to it. There you can put in a change log and release notes. Finally you can add files to that release.

Make sure the xml is valid. I uploaded a invalid xml once, so the new release didn't show up in Module Manager. After I changed it for a valid one, Module Manager still didn't get the update. At the time it didn't matter for me, because there was a bug and I had to make a new release, but it sure is something to take care for.
cd163601
Forum Members
Forum Members
Posts: 14
Joined: Wed Aug 12, 2009 8:03 pm

Re: New Module

Post by cd163601 »

Thanks for that.  So under the "Admin" menu (quite a way down the page) next to "Add a File Package" enter a name and click "Add Package".  Then adjacent to that new entry, click "Add Release", enter a version number, click "Create New Release". Finally you will see the "Add Files to Release" section.

Now I hope it works.

Thanks again
Colin
Jos
Support Guru
Support Guru
Posts: 4019
Joined: Wed Sep 05, 2007 8:03 pm
Location: The Netherlands

Re: New Module

Post by Jos »

Yep, it's working magically.  ;D I got a warm feeling when I went through this the first time  ;D

Could be the module doesn't show up in the Module Manager directly, maybe it needs some update time.
Last edited by Jos on Mon Sep 21, 2009 8:39 am, edited 1 time in total.
Post Reply

Return to “Developers Discussion”