Dizkus

It was suggested to me in this thread that I am a good candidate to write a module coding tutorial because I know nothing about PN module coding and I want to learn PN module coding. Despite the obvious flaws with that argument, I set out to do it anyway.

I have some PHP experience, some MySQL experience, and lots of PostNuke admin and user experience, so what I decided to do first was to research the example module. I figured the best way to learn the API and the methodology would be to dissect the Example module line-by-line, so that is what I have started. I began documenting the Example module in as much detail as I could, putting links to API functions, Smarty references, and ADODB references. At this point, I have twenty-nine pages of documentation covering general background, pninit.php, pntables.php, pnadmin.php, pnadminapi.php, and the admin templates.

Whenever I came across something new, I documented it in-line. So the first time I came across a pnRender reference, I described the reference in detail. The next time I encountered the same thing, I breezed over it with a slight mention, so it's a bit jumpy and if you skip a section, you may find that I skim over something I've explained in detail in an earlier function.

The structure of the document is probably not ideal, but since I came at this knowing nothing, I had no idea what I didn't know if you know what I mean. :twisted: Because of this, I structured it on-the-fly as I learned about more stuff that I didn't know needed to be included in the document. Because I am not an expert, there are probably inaccuracies in the document and my terminolgy may not always be correct, but I understand what I mean.

I'd be happy to donate this to the community if someone wants it, but it does need to be "cleaned up" first. If anyone would like to look at the progress I've made so far, I can put it somewhere for people to review, but I still need to finish documenting the user.php and the userapi.php.

My goal is to finish the document and then create a Guild Wars gaming module. As I write the module code, I will try to document the steps I took getting the thing written and working, noting any snafus I create along the way.

How about creatig a project at the NOC? You'd get forums, CVS and you''ll be able to provide downloads.

You could apply for a project covering all your PostNuke development you want to share with the community. That way you can also host the development of your GuildWars module on the NOC and maybe have other developers participate . I applied for a project and it was up and running in a day!

Of course releases of the documentation should also be placed on docs.postnuke.com, IMHO anyway...

Whatever you decide to do I wouldn't mind taking a look at what you made sofar and commenting on it (deep down in our hearts we're all critics anyway )

Actually, I have registered a project at the NOC. I was more interested in where to post this Word document when I finish it. And just to answer the question that will follow this comment, it's in Word because I did most of it at work and I have the easiest access to MS Word. I'll be glad to convert it to PDF or whatever.

:shock:

Hadn't seen that yet.... [taking foot out of mouth]

If it's a document for review just do a file release at the NOC and do a post here and/or create a news article at news.postnuke.com. Something like a Request For Comment.

As soon as the document has reached "a stable version" you could ask one of the admins to make it available on docs.postnuke.com.

HTH

And the name is ?
(Interested for translation)

--
Chestnut !
Support via Private message won't be answered...
http://dev.pnconcept.com
http://www.postnuke-france.org

congrats!

i wouldnt mind taking a look @ it.

That wouldn't be the Guild Wars BattleTracker would it ?

Well, I registered Guild Wars Battle Tracker and Guild Wars Rank. I currently have a Smarty function posted elsewhere on the site that you can use to put your current rank in your theme, but I wanted to do something a little more sophisticated with it to let you do some historical reporting. That one is going to take me awhile as I have never really done any coding with real-time-ish or historical graphing stuff.

The Guild Wars Battle Traker module will be more like the GvG Reports you can see at Final Dynasty's Website. At least, that's what I'm modelling after as it seems to have a good setup.

I submitted the doc a couple of days ago to pnDocs, but it hasn't been approved. Here's a link to the doc.

I'm a link!

Thanks! I just skimmed it and you really made an effort didn't you?
I'll see if I can give you some feedback this weekend. From what I've seen sofar this could be thé starting point for new module developers.

Very, very impressive. :wink:

I also only took a quick look and saw little things here and there that might need a review but for the most of what I saw : Excellent work !

--
Chestnut !
Support via Private message won't be answered...
http://dev.pnconcept.com
http://www.postnuke-france.org

I approved your pnDocs submission ! :wink:

Here

--
Chestnut !
Support via Private message won't be answered...
http://dev.pnconcept.com
http://www.postnuke-france.org

Thanks. That was about two to three days' work. I'll try to finish the user stuff as soon as I get a chance. I had to work this Saturday for 13 hours, so I probably won't work on it again until Monday, then the hoidays hit. Again, this is just a starting point. Anyone is free to fix my mistakes. :twisted:

This looks great. If you've got no objection, I'll look at putting this in to our docs matrix on the new site.

--
Regards,
Simon

itbegins.co.uk - Zikula Consulting

Please read the Support Guide

I have no objections. My only request is that someone check out my facts to make sure I'm not leading anyone astray. I've uploaded a new version that has the user portion documented and the blocks section started. Here's a more general link to the documents. Click me now.

I've finished the first draft. It has the user, userapi, and blocks documented as well. Link