Actions

Difference between revisions of "Mahara日本語ドキュメント/開発者エリア"

From Mahara Wiki

< Mahara日本語ドキュメント
Line 1: Line 1:
ここには、デザイン、ポリシーおよび特定の機能ドキュメントを含む、数多くの開発ドキュメントがあります。
+
再作成中です - [[User:Mits|mits]]
  
これらは、Maharaがどのように動作するか、またはMaharaの新しいコードまたはプラグインを開発したい人のためのドキュメントです。あなたがMaharaをカスタマイズしたい場合 - 例) 言語/テーマまたはプラグインのインストール等 - [[Customising|カスタマイズ]]セクションをご確認ください。
+
Here is a bunch of developer documentation for Mahara, including design, policy and specific feature documents.
  
<div id="section_1">
+
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 ==
  
* [[開発者エリア/Maharaアーキテクチャインストラクション]] - この一連の記事では、Maharaがどのように組み合わされているか、どこで着脱可能か、またなぜこのように書かれているか説明します。
+
* [[Developer Area/Mahara development overview|Mahara development overview]] - explains how Mahara gets developed, who does it, and how people become Mahara developers
* [[Developer Area/Plugins|プラグイン]] - Maharaのプラグイン開発情報に関して、あなたのワンストップショップとなります。
+
* [[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/Language Packs|言語パック]] - Maharaの言語パックをどのように記述するか、またはどのように貢献するか説明します。
+
* [[Developer Area/Plugins|Plugins]] - (soon to be) your one-stop-shop for information about developing plugins for Mahara
* [[Developer Area/Documentation_Wishlist|ウィシュリスト]] - どのようなドキュメンテーションが不足していますか? あなたが追加して欲しい機能は何ですか?
+
* [[Developer Area/Language Packs|Language Packs]] - how to write a language pack for Mahara, and how to contribute it back
 +
* [[Developer Area/Documentation Wishlist|Wishlist]] - what documentation did you find missing and would like people to contribute?
 +
* [[User:Aaronw]] - Aaron's work-in-progress Developer Docs version 2
 +
 
 +
=== Finding your way around ===
 +
 
 +
* [[Developer_Area/Mahara_Architecture_Introduction|Mahara Architecture Introduction]]
 +
* [[Developer_Area/Core_Subsystems|Core Subsystems]]
 +
* [[Developer_Area/Database_conventions|Database conventions]]
 +
* [[Developer_Area/Development_Tutorials|Development Tutorials]]
 +
* [[Developer_Area/HowToWriteAViewTemplate|How to write a view template]]
 +
* [[Developer_Area/Import//Export|Import/Export]]
 +
* [[Developer_Area/Language_Packs|Language Packs]]
 +
* [[Developer_Area/Plugins|Plugins]]
 +
* [[Developer_Area/Release_Policy|Release Policy]]
 +
* [[Developer_Area/CLI_Framework|Command Line Interface Framework]]
 +
 
 +
=== Getting set up ===
 +
 
 +
* [[Developer_Area/Developer_Tools|Setting up your development tools]]
 +
* [[Developer Area/Developer Environment|Setting up a development environment]]
 +
* [[Developer_Area/Getting_Code_from_Git|Getting Code from Git]]
 +
* [[Developer_Area/Changing_Hostnames|Changing Hostnames]]
 +
 
 +
=== Contributing improvements ===
 +
* [https://mahara.org/tracker/ How to submit good bug reports]
 +
* [[Developer_Area/Bug_Status|Bug Status Policy]]
 +
* [[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/Unit_Testing|Unit Testing]]
 +
 
 +
=== Join in the discussion ===
 +
 
 +
We have [http://mahara.org/group/view.php?id=1 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 [http://webchat.freenode.net/?channels=mahara-dev&uio=MTE9MTAz8d freenode web client].
 +
 
 +
=== Meeting minutes & dev team notes ===
 +
 
 +
* [[Developer_Area/Developer_Meetings|Developer Meetings]]
 +
* [[Developer_Area/Packaging|Packaging]]
 +
* [[Developer_Area/Release_Instructions|Release Instructions]]
 +
* [[Developer_Area/Security_Team|Security Team]]
 +
* [[Developer_Area/Specifications_in_Development|Specifications in Development]]
 +
* [[Developer_Area/Significant_Bug_Documentation|Fixes for significant bugs that might bite later]]
 +
 
 +
== 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. :(
 +
 
 +
* [[Developer_Area/Mahara_Architecture_Introduction/Core_Subsystems|Architecture Introduction]]
 +
* [[Developer_Area/Hello World|Hello World]]
 +
** https://mahara.org/interaction/forum/topic.php?id=5515&offset=0&limit=10#post23705
 +
** My sample page with pieforms and dwoo: https://wiki.mahara.org/index.php/BasicPHPFileTemplates#Sample_page_using_pieforms_and_dwoo
 +
* [[Developer_Area/Database-DML|Database-DML]]
 +
* [[Developer_Area/Database-DDL|Database-DDL]]
 +
** I wrote a forum post here that gives an outline of how the database works: https://mahara.org/interaction/forum/topic.php?id=5515&offset=0&limit=10#post23753
 +
* [[Developer_Area/Language strings|Language strings]]
 +
* [[Developer_Area/Config API|Config API]]
 +
* [[Developer_Area/Retrieving user input|Retrieving user input]]
 +
** aka "What to use instead of $_GET and $_POST"
 +
* [[Developer_Area/Cron API|Cron API]]
 +
* [[Developer_Area/Events API|Events API]]
 +
* [[Developer_Area/File uploads API|File uploads API]]
 +
* [[Developer_Area/Login form|Login form]]
 +
* [[Developer_Area/Mahara global variables|Mahara global variables]]
 +
** $SESSION, $USER, $THEME, etc
 +
* [[Developer_Area/Mahara pagetop constants|Mahara pagetop constants]]
 +
* [[Developer_Area/Notification Plugins & Activities|Notification Plugins & Activities]]
 +
* [[Developer_Area/Pagetop Constants|Pagetop Constants]]
 +
* [[Developer_Area/Pieforms|Pieforms]]
 +
* [[Developer_Area/Sideblocks API|Sideblocks API]]
 +
* [[Developer_Area/Site menus|Site menus]]
 +
* [[Developer_Area/Smarty&Dwoo|Smarty&Dwoo]]
  
</div><div id="section_2">
 
  
 
==有用なリソース==
 
==有用なリソース==
  
* [http://lists.catalyst.net.nz/cgi-bin/mailman/listinfo/mahara-commits mahara-commits mailing list] では、開発者がgitリポジトリにコミットした時点で、メール送信されるメーリングリストです。コミットを追跡するため、あなたは、このメーリングリストを購読することができます。また、コミット情報を取得したい場合、あなたは[http://git.mahara.org/ git.mahara.org]にて、適切なブランチにアクセスして、コミットのRSSフィードを購読することも可能です。
+
* You can [https://code.launchpad.net/~vcs-imports/mahara/master/+subscribe subscribe to the master branch] on Launchpad to receive an email everytime a commit is made. There is also an  [http://gitorious.org/mahara/mahara.atom RSS feed of commits] if you prefer to receive information that way.
* freenode (irc.freenode.org)  の「#mahara-dev」は、Maharaの主要開発者がMaharaの開発に関して議論する、IRCチャネルです。このチャネルは、Maharaのサポート用ではありませんが (代わりに#maharaをお使いください)、あなたは、気付かれずに開発者の会話を聴くことができます - また、開発者たちが追加する、Maharaの最新機能に関しても知ることができます ;)
+
* #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 ;)
  
</div>
+
[[Category:開発者エリア]]

Revision as of 04:30, 13 February 2014

再作成中です - mits

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

  • Mahara development overview - explains how Mahara gets developed, who does it, and how people become Mahara developers
  • 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.
  • Plugins - (soon to be) your one-stop-shop for information about developing plugins for Mahara
  • Language Packs - how to write a language pack for Mahara, and how to contribute it back
  • Wishlist - what documentation did you find missing and would like people to contribute?
  • User:Aaronw - Aaron's work-in-progress Developer Docs version 2

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. :(


有用なリソース

  • 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 ;)