Actions

Archived

Difference between revisions of "API Reference Project"

From Joomla! Documentation

(Notes on Joomla Versions)
m (ok, this should do it, too much templating, subst, and other improvements...brain overload)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
The aim of the API Reference Project is to construct a useful reference manual on the Joomla 1.5 (and later) Framework API which will complement, rather than replace, the automatically generated material on http://api.joomla.org.  The starting point for the API Reference is the [[Framework]] page which lists all of the classes in the Framework API.
+
The aim of the API Reference Project is to construct a useful reference manual on the Joomla 1.5 (and later) Framework API which will complement, rather than replace, the automatically generated material on http://api.joomla.org.  The starting point for the API Reference is the Framework page ([[API16:Framework|Joomla 1.6 Framework]] | [[API15:Framework|Joomla 1.5 Framework]]) which lists all of the classes in the Framework API.
  
 
If you would like to help us with this massive project, then all you need to do is register on this wiki.  You don't need to join a Working Group and you don't need to ask permission.  You just register and get started.  A good idea is to pick a class you know something about, or have spent time researching, and start there.  Also feel free to add examples, improve explanations, or correct mistakes on existing pages.
 
If you would like to help us with this massive project, then all you need to do is register on this wiki.  You don't need to join a Working Group and you don't need to ask permission.  You just register and get started.  A good idea is to pick a class you know something about, or have spent time researching, and start there.  Also feel free to add examples, improve explanations, or correct mistakes on existing pages.
Line 9: Line 9:
  
 
==Guidance notes==
 
==Guidance notes==
The starting page for the API Reference is the Framework page ([[API16:Framework|Joomla 1.6 Framework]] | [[API15:Framework|Joomla 1.5 Framework]] where you can see a complete list of all the classes in the API.  Each class will be given its own wiki page linked to from the [[Framework]] page.  Each class page includes a list of all the public methods available and each of those methods will also have its own page (actually a "sub-page").
+
The starting page for the API Reference is the Framework page ([[API16:Framework|Joomla 1.6 Framework]] | [[API15:Framework|Joomla 1.5 Framework]]) where you can see a complete list of all the classes in the API.  Each class will be given its own wiki page linked to from the Framework page.  Each class page includes a list of all the public methods available and each of those methods will also have its own page (actually a "sub-page").
  
 
To simplify the documentation process, the class and method pages have already been created automatically. We reduced the documentation process to three pieces of knowledge, only humans can provide:
 
To simplify the documentation process, the class and method pages have already been created automatically. We reduced the documentation process to three pieces of knowledge, only humans can provide:
Line 47: Line 47:
 
'''What does this mean?'''
 
'''What does this mean?'''
 
If you provide code, that is valid for one version of Joomla only (say for 1.6 but not for 1.5), please tell us that within your code example / description / see also link.
 
If you provide code, that is valid for one version of Joomla only (say for 1.6 but not for 1.5), please tell us that within your code example / description / see also link.
 +
<noinclude>[[Category:JDOC Projects|API Reference Project]]</noinclude>

Revision as of 10:59, 2 September 2012