Zikula Community

• Paustian
  
  

  • Rank: Softmore
  • Registered: May 30, 2005
  • Last visit: May 31, 2010
  • Posts: 340

  Posted: Apr 18, 2009 - 07:36 AM

  In the last week or so I have been making modifications to the developer docs, specifically Programming a Module Part 1,2 and 3 http://community.zik…hn_Module_authoring. Before I go on and do the rest I would love to hear some feedback on whether this is useful. I plan on expanding Parts 4, 5, and 6, adding a tutorial on forms, and then adding a real world example where I walk through making a StrainID module from start to finish. We use this module at work to help the students identify a strain of microbe that they have isolated from the environment.

  • 
  •  
• espaan
  
  

  • Rank: Developer
  • Registered: Aug 23, 2003
  • Last visit: May 31, 2010
  • Posts: 1428

  Posted: Apr 18, 2009 - 08:36 PM

  Nice, have to look in more detail, but one remark already on Part 1. You might want to mention the gettext language system coming in Zikula 1.2, if that is still the case.
  And the part on module functions you might want to take into account a basic hello world template already, or did you leave that out of the intro on purpose
  
  --
  campertoday.nl, Module development, Dutch Zikula Community

  • 
  •  
• Paustian
  
  

  • Rank: Softmore
  • Registered: May 30, 2005
  • Last visit: May 31, 2010
  • Posts: 340

  Posted: Apr 19, 2009 - 01:58 PM

  I am writing this as the language system exists now. I can update it later (time permitting) when the new language system comes out. Its a great idea to try to keep up with new technologies, but I want people to be able to use this with any zikula install if possible.
  
  I am a bit confused on the second part. What basic helloworld template? Is there one I am not aware of? I did want to have people build form a blank template to start off. Thanks for your comments!

  • 
  •  
• espaan
  
  

  • Rank: Developer
  • Registered: Aug 23, 2003
  • Last visit: May 31, 2010
  • Posts: 1428

  Posted: Apr 19, 2009 - 07:04 PM

  Hi, for the first part I can understand indeed. Gettext can be added later on when it is out. And it's probably only a minor update.
  
  In the second part I meant that you show how to add the helloworld code to the module function. But this is using a return 'string' for the module function output. What I meant that don't you want to show using pnRender templates right away there already. So using a very basic template that only displays 'hello world' (the basic hello world template does not exist I just made up a name).
  Ah I see now that Part 3 covers templating already. You could add a line in Part 1 sort of explaining that templating comes later in Part 3 or something like that.
  
  You might want to mention the Basic Module structure again in Part 2 and 3. Better to repeat that the module structure is in that Wiki page than that people have to search.
  
  BTW I only give some feedback to improve, it's great that you're updating it to begin with
  
  --
  campertoday.nl, Module development, Dutch Zikula Community

  • 
  •  
• xizhou
  
  

  • Rank: Registered User
  • Registered: May 31, 2009
  • Last visit: Apr 14, 2010
  • Posts: 35

  Posted: May 31, 2009 - 05:10 AM

  I found your real world example of the StrainID module tremendously helpful since I'm developing my first zikula module. However when I clicked on part 3, 4, and 5 of your module example, instead of seeing your tutorial it seems I was in the editing mode (not what I intended!). Unfortunately when trying to quit the editing mode I made the owner of part 4 myself and I don't know how to correct this.
  
  I'm sorry for what happened - please let me know how I can return the ownership to you. And I'm eager to see the rest (part 3, 4, 5) of your tutorial on the StrainID module; it'll really cut my learning curve deep so i can start working on my own module ASAP.

  • 
  •  
• Paustian
  
  

  • Rank: Softmore
  • Registered: May 30, 2005
  • Last visit: May 31, 2010
  • Posts: 340

  Posted: Jun 01, 2009 - 09:15 AM

  xizhou,
  
  I am glad you found this helpful. As far as ownership, it doesn't matter, it's a Wiki. I can edit the page no matter who it thinks the owner is. I hope to get back to finishing these as I have time.

  • 
  •  
• Paustian
  
  

  • Rank: Softmore
  • Registered: May 30, 2005
  • Last visit: May 31, 2010
  • Posts: 340

  Posted: Jun 01, 2009 - 09:27 AM

  espaan

  
  In the second part I meant that you show how to add the helloworld code to the module function. But this is using a return 'string' for the module function output. What I meant that don't you want to show using pnRender templates right away there already. So using a very basic template that only displays 'hello world' (the basic hello world template does not exist I just made up a name).
  Ah I see now that Part 3 covers templating already. You could add a line in Part 1 sort of explaining that templating comes later in Part 3 or something like that.
  
  You might want to mention the Basic Module structure again in Part 2 and 3. Better to repeat that the module structure is in that Wiki page than that people have to search.
  
  BTW I only give some feedback to improve, it's great that you're updating it to begin with

  
  
  Thanks for the suggestions! I get what you are saying now. As far as the tone of your suggestions, I have a very thick skin and besides, I did not take your comments in a negative fashion at all. Any and all comments are appreciated. You have my idea down. The first helloworld I wanted to make as simple as possible and not bring in the added complexity of templates. At this point, I just want the student developer to get something up and running and was afraid that adding templates to it, is another area where they could make a mistake. I added a bit mentioning templates explicitly as well as pnRender.

  • 
  •  
•  
•  

Users on-line

• 0 users

This list is based on users active over the last 60 minutes.