Documentation

Discussion and education for beginner / novice programmers interested in embarking on the development process to take advantage of the extensible nature of the Joomla! CMS.
Locked
User avatar
jalil
Joomla! Guru
Joomla! Guru
Posts: 925
Joined: Wed Jul 04, 2007 4:54 am
Location: Kuala Lumpur, Malaysia
Contact:

Documentation

Post by jalil » Thu Aug 09, 2007 8:54 am

i don't really know where to post this, so i'll use this base. this is perhaps for @Chris Davenport who is involved with documentation, but anyone else who might have answers please help.

two things...

1) some the documentation nicely done have width/css definition problems and drops to the bottom of my page ( IE6 ).
this is an example.
http://dev.joomla.org/component/option, ... llo_world/

the new db page also has the same problem, the components page is fine.

2) i have been looking and looking for a map of joomla. some call it architechure map, but basically it is a map of all the various functions in joomla core. this is extremely useful for a developer, who needs this and a list of available function calls, conveniently documented.
the function calls are already put out i think, its just a matter of preferred format, which the user can reformat as desired.

but the complete map, there is none. where can i find it please ?
us newbies here in a new land without a map is very scarry.

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1385
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Documentation

Post by Chris Davenport » Thu Aug 09, 2007 11:44 am

Hi Jalil,
jalil wrote: i don't really know where to post this, so i'll use this base. this is perhaps for @Chris Davenport who is involved with documentation, but anyone else who might have answers please help.

two things...

1) some the documentation nicely done have width/css definition problems and drops to the bottom of my page ( IE6 ).
this is an example.
http://dev.joomla.org/component/option, ... llo_world/

the new db page also has the same problem, the components page is fine.
Confirmed.  I don't use Windows any more so hadn't spotted it before.  I'll try to get it fixed.
jalil wrote: 2) i have been looking and looking for a map of joomla. some call it architechure map, but basically it is a map of all the various functions in joomla core. this is extremely useful for a developer, who needs this and a list of available function calls, conveniently documented.
the function calls are already put out i think, its just a matter of preferred format, which the user can reformat as desired.

but the complete map, there is none. where can i find it please ?
us newbies here in a new land without a map is very scarry.
Not entirely sure what you're after.  How about these:
http://dev.joomla.org/content/view/1137/80/ gives an overview, although the UML diagrams are a bit out-of-date.
http://dev.joomla.org/component/option, ... framework/ is the front-page of the wiki API reference and the UML is more up-to-date.

Regards,
Chris.
Chris Davenport

Davenport Technology Services http://www.davenporttechnology.com/
Lion Coppice http://www.lioncoppice.org/

User avatar
jalil
Joomla! Guru
Joomla! Guru
Posts: 925
Joined: Wed Jul 04, 2007 4:54 am
Location: Kuala Lumpur, Malaysia
Contact:

Re: Documentation

Post by jalil » Thu Aug 09, 2007 1:18 pm

Chris Davenport wrote: Not entirely sure what you're after.  How about these:
http://dev.joomla.org/content/view/1137/80/ gives an overview, although the UML diagrams are a bit out-of-date.
http://dev.joomla.org/component/option, ... framework/ is the front-page of the wiki API reference and the UML is more up-to-date.
Regards,
Chris.
thanks chris, they are bits and peices of what i'm looking for and they are very helpful.

what i need is a whole map complete, need not be uptodate, just complete.
i'll see if i can find any, and if there's none i'll make one, but not pretty soon.

heh...thanks again.

User avatar
jalil
Joomla! Guru
Joomla! Guru
Posts: 925
Joined: Wed Jul 04, 2007 4:54 am
Location: Kuala Lumpur, Malaysia
Contact:

Re: Documentation

Post by jalil » Mon Aug 13, 2007 6:37 am

anyone has a flow chart of joomla!  ?
if theres none i better get started on it. if i need it, many others would.

User avatar
seadap
Joomla! Enthusiast
Joomla! Enthusiast
Posts: 123
Joined: Mon Dec 04, 2006 12:22 am
Contact:

Re: Documentation

Post by seadap » Mon Aug 13, 2007 3:04 pm

I'm convinced that we all would benifit from that.  Sounds like a lot of work!
Knowledge is realizing that the street is one-way, wisdom is looking both directions anyway.

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1385
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Documentation

Post by Chris Davenport » Mon Aug 13, 2007 3:15 pm

I seem to recall there being a flowchart for 1.0.x but I can't seem to find it right now.  I doubt it would be of much use for 1.5 anyway.

Regards,
Chris.
Chris Davenport

Davenport Technology Services http://www.davenporttechnology.com/
Lion Coppice http://www.lioncoppice.org/

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7056
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: Documentation

Post by AmyStephen » Mon Aug 13, 2007 10:04 pm

jalil wrote: anyone has a flow chart of joomla!  ?
if theres none i better get started on it. if i need it, many others would.
I agree with seadap - a flowchart would be excellent. How would that look, I wonder? I wouldn't want too much detail. It would be great, though!

User avatar
Fuqaha
Joomla! Ace
Joomla! Ace
Posts: 1211
Joined: Fri Jan 13, 2006 3:58 pm
Location: Kuala Lumpur, Malaysia
Contact:

Re: Documentation

Post by Fuqaha » Sat Aug 25, 2007 1:26 pm

Chris Davenport wrote: I seem to recall there being a flowchart for 1.0.x but I can't seem to find it right now.  I doubt it would be of much use for 1.5 anyway.

Regards,
Chris.
Yup, i think ive seen it somewhere too. lemme do a search first.

User avatar
tagore79
Joomla! Fledgling
Joomla! Fledgling
Posts: 3
Joined: Sat Jul 28, 2007 6:00 am
Location: Singapore

Re: Documentation

Post by tagore79 » Thu Aug 30, 2007 3:01 am

jalil wrote: anyone has a flow chart of joomla!  ?
if theres none i better get started on it. if i need it, many others would.
Yes, a flow chart or a class diagram of sorts would be excellent for newbies like me =)
Whereof one cannot speak, thereof one must be silent.

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7056
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: Documentation

Post by AmyStephen » Thu Aug 30, 2007 4:11 am

It would for me, as well. Now that Scott has provided instructions for an IDE environment, we can "walk" the code and begin plotting that flow out.

So, does anyone know what that documentation should look like? Is there a certain format or standard that is best for this purpose? The benefit of wanting something - and needing to learn - is that by doing it - our knowledge will be deeper.  8) So, if there is something missing that we want, let's figure out how to do it. Then, the experts can review and revise our work.

If people want help configuring your IDE environment, or want to get more involved, join us on the Skype line - everything we are using is free of charge and you are all invited to participate.

Amy :)

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1385
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Documentation

Post by Chris Davenport » Thu Aug 30, 2007 12:50 pm

I finally found one of the "flowcharts" that I remembered.  You can use it as a starting point to create a new one.  The other one was for 1.0.x and is almost certainly irrelevant.  If you do create a new one, then please donate it back to the community.

Thanks,
Chris.
You do not have the required permissions to view the files attached to this post.
Chris Davenport

Davenport Technology Services http://www.davenporttechnology.com/
Lion Coppice http://www.lioncoppice.org/

AmyStephen
Joomla! Champion
Joomla! Champion
Posts: 7056
Joined: Wed Nov 22, 2006 3:35 pm
Location: Nebraska
Contact:

Re: Documentation

Post by AmyStephen » Thu Aug 30, 2007 1:45 pm

Great!  8) I have not seen that before, or, if I did it made no sense. For me, I like it because it's like a Globe. You can see the entire world at once and also locate your country.

In addition to this, I would also like one lower layer that links to specific files / classes in the files. Maybe that's too detailed? Maybe that would be too difficult to maintain over time. If so, then I would want to document how you can get from this image to that detail. Understanding that process might be enough.

Thanks very much, Chris.

Who else is interested in working on this?

Amy :)

User avatar
seadap
Joomla! Enthusiast
Joomla! Enthusiast
Posts: 123
Joined: Mon Dec 04, 2006 12:22 am
Contact:

Re: Documentation

Post by seadap » Thu Aug 30, 2007 2:55 pm

I love it.  I like your idea too Amy but maybe the files/classes layer would have to wait until 1.5 is official.  Sure would be difficult to track changes to to the code base I think.
Knowledge is realizing that the street is one-way, wisdom is looking both directions anyway.

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1385
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Documentation

Post by Chris Davenport » Thu Aug 30, 2007 3:16 pm

No significant changes are being made to the codebase for 1.5 (with the single exception of the media manager refactoring).  It's just bug fixing.  So feel free to write up what you see.

Oh.  And have fun!  ;)

Regards,
Chris.
Chris Davenport

Davenport Technology Services http://www.davenporttechnology.com/
Lion Coppice http://www.lioncoppice.org/


Locked

Return to “Joomla! Coding 101”