Better developer documentation

You need to be logged in to post messages in the forums. New users may register here.

Marko Zmak

Member since:
09 January 2008

Posts: 25

Friday 17 September 2010 5:24:37 am

Just a suggestion...

There should be a better documentation for more experienced developers, especially for the templates. For example if I want to customize ezcomments with my own highly customized templates I have to inspect the existing templates and figure it out by myself.

having a piece of docs that explains how to make your own custom templates would be really usefull.

--
Nothing is impossible. Not if you can imagine it!

Hubert Farnsworth

Up

Chen Xiongjie

Member since:
24 August 2009

Posts: 14

Tuesday 28 September 2010 5:55:49 am

Hello Marko,

Thank you for the suggestion. Maybe you want some documentations explaining what does one ezcomments template do in detail? If it's possible, could you tell me what kinds of customization you want to do?

This is not so advanced, but might be helpful: http://doc.ez.no/Extensions/eZ-Co...ser-guide-1.1/Template-customization

Thanks
--
Best regards
Chen
Up

Marko Zmak

Member since:
09 January 2008

Posts: 25

Tuesday 28 September 2010 8:00:12 am

Here are some suggestions:

- document all the fetch functions, and all their parameters (the same way like the fetch functions are documented on eZ docs

- document the attributes of the comments items

- document the modules an their functions - which one exist, how to use them, what post variables do they accept...

--
Nothing is impossible. Not if you can imagine it!

Hubert Farnsworth

Up

Chen Xiongjie

Member since:
24 August 2009

Posts: 14

Monday 04 October 2010 8:38:21 am

Marko,

For those undocumented fetch functions(like function in ezcomFunctionCollection), since they are not public fetch functions, it's not guaranteed that they will work well.

- document the attributes of the comments items: good suggestion, it will be done and put on news.

"document the modules an their functions". Let me find a time so that I could post a blog on it. I guess you want to know the mechanism of the add/edit/delete logic and extend them.

For any more suggestion(like what kind of advanced feature to develop), which could help me to gather ideas, please put it here.

Thanks.
Up

You need to be logged in to post messages in the forums. New users may register here.