Zikula: A Flexible Open Source Content Management System
home | forum | contact us

Dizkus

Goto page: [-1] 1 - 2 - 3 [+1]

Bottom
Documenting the example module
  • Posted: 20.12.2005, 01:51
     
    jediping
    rank:
    Helper Helper
    registered:
     November 2004
    Status:
    offline
    last visit:
    12.03.07
    Posts:
    387
    Fantastic! We've needed this for a long time!

    I'm still reading through it, but one thing you might want to comment on is that pnversion.php is also necessary for modules provided to the public, because it lets the PostNuke module system know when a new version has been uploaded and needs to be updated.

    That's as far as I've gotten so far. :)
  • Posted: 20.12.2005, 20:02
     
    jbirchett
    rank:
    Helper Helper
    registered:
     November 2002
    Status:
    offline
    last visit:
    29.05.07
    Posts:
    203
    I haven't gone back through and read it myself. Keep in mind that when I started the first section, I knew nothing. Now that I have been through the entire module, I will go back and fill in some of the stuff I now know. Also, keep in mind that I have never programmed in PHP or SQL. I actually learned most of my programming knowledge from LPC on a mud called igormud a LONG time ago. Since then I have dabbled with perl, python, C, C++, and C#, but I would not call myself a strong programmer.

    If you see places where I have made incorrect assumptions or outright mistakes, please let me know. I'll add that bit to the pnversion section right away. I'm also looking at docbook to see if I can make this beast conform to the PostNuke standards. I downloaded the trial of w2xml and converted it, but I haven't run any docbook commands on the source to produce HTML or pdf. I would also like to take a look at phpdocumentor before I start writing my module.
  • Posted: 21.12.2005, 21:53
     
    jbirchett
    rank:
    Helper Helper
    registered:
     November 2002
    Status:
    offline
    last visit:
    29.05.07
    Posts:
    203
    I started reading it from the beginning again and noticed that I had just given an overview of the pninit.php stuff, so I rewrote that part. I'm glad I skimmed it the first time through. ;) It's a little more complex in parts, describing how it interacts with the Modules module's functions. I'm still working on it, but I'll have a new version up soon.
  • Posted: 21.12.2005, 22:09
     
    ctimmer
    rank:
    Helper Helper
    registered:
     February 2003
    Status:
    offline
    last visit:
    11.06.08
    Posts:
    226
    Looks good! I will be 'borrowing' some of your documentation for my ModGen module help screens. Thanks much!
  • Posted: 22.12.2005, 02:47
     
    jbirchett
    rank:
    Helper Helper
    registered:
     November 2002
    Status:
    offline
    last visit:
    29.05.07
    Posts:
    203
    I updated the document with the interactive init stuff. It took about ten pages to cover it, so I haven't gotten to the interactive upgrade or interactive delete yet.
  • Posted: 01.01.2006, 12:22
     
    GamersRadio
    rank:
    Helper Helper
    registered:
     December 2003
    Status:
    offline
    last visit:
    10.10.06
    Posts:
    172
    Wow! I really, really needed something like this.

    Thank You!

    --
    Atomm Nihilo
    /www.gamenuke.org" title="PostNuke Resources For Gamers">/www.rtfg.net" title="Read The F#$%ing Google!">
  • Posted: 02.01.2006, 02:41
     
    mhalbrook
    rank:
    Legend Legend
    registered:
     December 1969
    Status:
    offline
    last visit:
    22.11.08
    Posts:
    6523
    See, I told you it'd be a good project for you. Based on what I've read of the document, and the comments on it, you done pretty good, oh ye of little faith ;)
  • Posted: 02.01.2006, 07:46
     
    jbirchett
    rank:
    Helper Helper
    registered:
     November 2002
    Status:
    offline
    last visit:
    29.05.07
    Posts:
    203
    :twisted: Thanks. Now I just have to write a module to see if I really understand it.
  • Posted: 05.01.2006, 21:32
     
    jbirchett
    rank:
    Helper Helper
    registered:
     November 2002
    Status:
    offline
    last visit:
    29.05.07
    Posts:
    203
    I have uploaded a new version that has the interactive upgrade and interactive delete detailed. This should complete the first draft of the document. The link.
  • Posted: 05.01.2006, 21:52
     
    rank:
    Moderator Moderator
    registered:
     March 2002
    Status:
    offline
    last visit:
    26.08.08
    Posts:
    7720
    Johnny,

    Today is the first chance i've had to take a look at this documentation and i'm really impressed with the results. I'd definately recommend this as a valuable resource for those looking to get started with PN development.

    Thanks for taking the time out to make such a useful guide.

    -Mark
  • Posted: 06.01.2006, 14:44
     
    rgasch
    rank:
    Steering Committee Steering Committee
    registered:
     January 2003
    Status:
    offline
    last visit:
    19.11.08
    Posts:
    567
    Hi there,

    congratulations on a job well done! This looks like a really comprehensive and well written module writing guide. There'll be some changes for 0.8 but 95% of the info will carry over. Thank you for providing this for all the would-be developers who still have to get started.

    Can we convince you to join Hammerhead in creating PN docs?

    Greetings
    --> R
  • Posted: 07.01.2006, 03:24
     
    AmmoDump
    rank:
    Professional Professional
    registered:
     December 2003
    Status:
    offline
    last visit:
    21.11.08
    Posts:
    2975
    I would like to see it as a Wiki doc. so the rest of wannabe hackers/slashers can add comments or whatever and update the doc.

    Just a thought :)

    Regards,
    Ammodump

    --
    David Pahl
    Zikula Support Team
  • Posted: 08.01.2006, 23:20
     
    jbirchett
    rank:
    Helper Helper
    registered:
     November 2002
    Status:
    offline
    last visit:
    29.05.07
    Posts:
    203
    rqasch: yes
    AmmoDump: If someone can set it up as a Wiki, that would be fine with me. I can post a docbook version of the doc. (Straight conversion with w2xml 30-day trial)
  • Posted: 09.01.2006, 04:38
     
    mhalbrook
    rank:
    Legend Legend
    registered:
     December 1969
    Status:
    offline
    last visit:
    22.11.08
    Posts:
    6523
    Please do create a docbook version, that would definitly be a huge plus :)
  • Posted: 10.01.2006, 01:16
     
    jbirchett
    rank:
    Helper Helper
    registered:
     November 2002
    Status:
    offline
    last visit:
    29.05.07
    Posts:
    203
    It's at the same link. I've never used docbook, so I don't know how it looks, but I uploaded the resultant set of files files from the w2xml conversion process.

    Link.

Goto page: [-1] 1 - 2 - 3 [+1]

Extensions Moderation

Main Menu

Extensions Database

Documentation

Development

Login

Donate to Zikula