Difference between revisions of "Developer Area"

From Mahara Wiki
Jump to: navigation, search
(API Documentation)
(API Documentation)
(17 intermediate revisions by 4 users not shown)
Line 2: Line 2:
  
 
This is for people who want to understand how Mahara works, or want to develop new code or plugins for Mahara. If you want to customise your Mahara - e.g. change the language/theme, or simply install plugins, check out the [[Customising]] section.
 
This is for people who want to understand how Mahara works, or want to develop new code or plugins for Mahara. If you want to customise your Mahara - e.g. change the language/theme, or simply install plugins, check out the [[Customising]] section.
 +
 +
<div align="right">__TOC__</div>
  
 
== Overview ==
 
== Overview ==
  
* [[Developer Area/Mahara development overview|Mahara development overview]] - explains how Mahara gets developed, who does it, and how people become Mahara developers
+
* [[Developer Area/Mahara project overview|Mahara development overview]] - explains how Mahara gets developed, who does it, and how people become Mahara developers
 
* [[Developer Area/Mahara Architecture Introduction|Mahara Architecture Introduction]] - this series of articles explains how Mahara fits together, where it's pluggable and why it's written the way it is.
 
* [[Developer Area/Mahara Architecture Introduction|Mahara Architecture Introduction]] - this series of articles explains how Mahara fits together, where it's pluggable and why it's written the way it is.
 
* [[Developer Area/Plugins|Plugins]] - (soon to be) your one-stop-shop for information about developing plugins for Mahara
 
* [[Developer Area/Plugins|Plugins]] - (soon to be) your one-stop-shop for information about developing plugins for Mahara
Line 12: Line 14:
 
* And if you just want the [[Developer Area/Source code|source code]], it's available via [http://en.wikipedia.org/wiki/git git] at
 
* And if you just want the [[Developer Area/Source code|source code]], it's available via [http://en.wikipedia.org/wiki/git git] at
 
** Our gerrit code review system: <tt>git clone https://reviews.mahara.org/mahara</tt>
 
** Our gerrit code review system: <tt>git clone https://reviews.mahara.org/mahara</tt>
** Gitorious: https://gitorious.org/mahara/mahara
+
** git.mahara.org: https://git.mahara.org/mahara/mahara
 
** Github: https://github.com/MaharaProject/mahara
 
** Github: https://github.com/MaharaProject/mahara
  
Line 20: Line 22:
 
* [[Developer_Area/Core_Subsystems|Core Subsystems]]
 
* [[Developer_Area/Core_Subsystems|Core Subsystems]]
 
* [[Developer_Area/Database_conventions|Database conventions]]
 
* [[Developer_Area/Database_conventions|Database conventions]]
 +
** [[Developer_Area/Database_design_strategies|Database design strategies]]
 
* [[Developer_Area/Development_Tutorials|Development Tutorials]]
 
* [[Developer_Area/Development_Tutorials|Development Tutorials]]
* [[Developer_Area/HowToWriteAViewTemplate|How to write a view template]]
 
 
* [[Developer_Area/Import//Export|Import/Export]]
 
* [[Developer_Area/Import//Export|Import/Export]]
 
* [[Developer_Area/Language_Packs|Language Packs]]
 
* [[Developer_Area/Language_Packs|Language Packs]]
Line 34: Line 36:
 
* [[Developer_Area/Getting_Code_from_Git|Getting Code from Git]]
 
* [[Developer_Area/Getting_Code_from_Git|Getting Code from Git]]
 
* [[Developer_Area/Changing_Hostnames|Changing Hostnames]]
 
* [[Developer_Area/Changing_Hostnames|Changing Hostnames]]
 +
* [[Developer Area/Setting up Elasticsearch|Setting up Elasticsearch]]
  
 
=== Contributing improvements ===
 
=== Contributing improvements ===
 +
* '''[[Developer_Area/Contributing_Code|Contributing Code]]'''
 +
* '''[[Developer_Area/Coding_guidelines|Coding guidelines]]'''
 +
* '''[[Developer_Area/Code_Review|Commit Policy]]'''
 
* [https://mahara.org/tracker/ How to submit good bug reports]
 
* [https://mahara.org/tracker/ How to submit good bug reports]
 
* [[Developer_Area/Accessibility_Checklist|Accessibility Checklist]]
 
* [[Developer_Area/Accessibility_Checklist|Accessibility Checklist]]
 
* [[Developer_Area/Bug_Status|Bug Status Policy]]
 
* [[Developer_Area/Bug_Status|Bug Status Policy]]
 
* [[Developer_Area/Bite_Sized|Bite sized code tasks]]
 
* [[Developer_Area/Bite_Sized|Bite sized code tasks]]
* [[Developer_Area/Coding_guidelines|Coding guidelines]]
 
* [[Developer_Area/Contributing_Code|Contributing Code]]
 
* [[Developer_Area/Code_Review|Commit Policy]]
 
 
* [[Developer_Area/How_to_Review_Code|How to Review Code]]
 
* [[Developer_Area/How_to_Review_Code|How to Review Code]]
 
* [[Developer_Area/Unit_Testing|Unit Testing]]
 
* [[Developer_Area/Unit_Testing|Unit Testing]]
 +
* [[Developer_Area/Behat_Testing|Behat Testing]]
 +
* [[Developer_Area/User_manual_setup|User manual setup]]
  
 
=== Join in the discussion ===
 
=== Join in the discussion ===
Line 81: Line 86:
 
** aka "What to use instead of $_GET and $_POST"
 
** aka "What to use instead of $_GET and $_POST"
 
* [[Developer_Area/Cron API|Cron API]]
 
* [[Developer_Area/Cron API|Cron API]]
 +
* [[Developer_Area/CLI_Framework|CLI Framework]] for writing command-line Mahara scripts
 
* [[Developer_Area/Events API|Events API]]
 
* [[Developer_Area/Events API|Events API]]
 
* [[Developer_Area/File uploads API|File uploads API]]
 
* [[Developer_Area/File uploads API|File uploads API]]
Line 86: Line 92:
 
* [[Developer_Area/Mahara global variables|Mahara global variables]]
 
* [[Developer_Area/Mahara global variables|Mahara global variables]]
 
** $SESSION, $USER, $THEME, etc
 
** $SESSION, $USER, $THEME, etc
* [[Developer_Area/Mahara pagetop constants|Mahara pagetop constants]]
+
* [[Developer_area/Mahara Mobile|Mahara Mobile]]
 
* [[Developer_Area/Notification Plugins & Activities|Notification Plugins & Activities]]
 
* [[Developer_Area/Notification Plugins & Activities|Notification Plugins & Activities]]
 
* [[Developer_Area/Pagetop Constants|Pagetop Constants]]
 
* [[Developer_Area/Pagetop Constants|Pagetop Constants]]
Line 93: Line 99:
 
* [[Developer_Area/Site menus|Site menus]]
 
* [[Developer_Area/Site menus|Site menus]]
 
* [[Developer_Area/Smarty&Dwoo|Smarty&Dwoo]]
 
* [[Developer_Area/Smarty&Dwoo|Smarty&Dwoo]]
 +
* [[Developer_Area/Themes|Themes]]
 +
* [[Developer_Area/Webservices|Webservices]]
  
 
== Useful Resources ==
 
== Useful Resources ==

Revision as of 12:34, 23 September 2016

Here is a bunch of developer documentation for Mahara, including design, policy and specific feature documents.

This is for people who want to understand how Mahara works, or want to develop new code or plugins for Mahara. If you want to customise your Mahara - e.g. change the language/theme, or simply install plugins, check out the Customising section.

Overview

Finding your way around

Getting set up

Contributing improvements

Join in the discussion

We have a discussion forum on mahara.org.

You can also find us in #mahara-dev on irc.freenode.net

If you have not got an IRC client or cannot connect with one, you can use the freenode web client.

Meeting minutes & dev team notes

API Documentation

These pages describe specific Mahara APIs. Note: we're in the process of reorganizing our developer documentation, so not all API documentation pages will be present in this list. Please use the wiki's search feature if you don't find what you need here. Also, not all API's are documented. :(

Useful Resources

  • You can subscribe to the master branch on Launchpad to receive an email everytime a commit is made. There is also an  RSS feed of commits if you prefer to receive information that way.
  • #mahara-dev on freenode (irc.freenode.org) is an IRC channel where the core developers discuss the development of Mahara. This channel is not for support of Mahara (use #mahara instead), but you can lurk and listen in on developer conversations - and even hear about the latest new features as they're added ;)