/api.joomla.org

Repository containing the source files for building the Joomla! API website
  1. HTML 84.3%
  2. JavaScript 7.7%
  3. CSS 4.4%
  4. ApacheConf 3.6%
HTML JavaScript CSS ApacheConf

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit 7473bce Jun 1, 2017 @mbabker mbabker Add monitoring script
Permalink
Failed to load latest commit information.
base
class
css
graphs
images
img
js
reports
.gitignore
.htaccess
LICENSE
README.md
class.html.twig
index.html
index.html.twig
interface.html.twig
layout.html.twig
namespace.html.twig
package.html.twig
results.html
robots.txt
template.xml
trait.html.twig

README.md

Joomla! API Documentation

This repository hosts the source files used to build the Joomla! API Documentation website.

Static Files

The following static files are used for the general website

  • index.html is the site's homepage
  • results.html is the search results page; this uses Google's Custom Search platform
  • .htaccess and robots.txt should be self explanatory

phpDocumentor Template

Most of the other files in this repository are used by phpDocumentor for generating the API documentation. A general structure can be found in the template.xml file.

Most of the static media assets in this repository (CSS, JavaScript, and images) are used within the generated documentation; some of the images are template assets or used by the homepage.

Website Structure

The live website currently has the following top level directories. The generated documentation is not checked into version control.

  • cms-2.5 contains the API documentation for the Joomla! 2.5 branch
  • cms-3 contains the API documentation for the Joomla! 3.x branch
  • framework-1 contains the API documentation for the Joomla! Framework 1.x branch
  • framework-2 contains the API documentation for the Joomla! Framework 2.x branch

The following directories are no longer indexed by search engines but are still present on the server.

  • 1.5 contains the API documentation for the Joomla! 1.5 branch
  • 11.4 contains the API documentation for the Joomla! Platform 11.4 release
  • 12.1 contains the API documentation for the Joomla! Platform 12.1 release