loncom/html/adm/help/tex/About_Developers_Manual.tex - view

File: [LON-CAPA] / loncom / html / adm / help / tex / About_Developers_Manual.tex
Revision 1.2: download - view: text, annotated - select for diffs
Tue Aug 7 21:29:16 2007 UTC (16 years, 10 months ago) by albertel
Branches: MAIN
CVS tags: version_2_9_X, version_2_9_99_0, version_2_9_1, version_2_9_0, version_2_8_X, version_2_8_99_1, version_2_8_99_0, version_2_8_2, version_2_8_1, version_2_8_0, version_2_7_X, version_2_7_99_1, version_2_7_99_0, version_2_7_1, version_2_7_0, version_2_6_X, version_2_6_99_1, version_2_6_99_0, version_2_6_3, version_2_6_2, version_2_6_1, version_2_6_0, version_2_5_X, version_2_5_99_1, version_2_5_99_0, version_2_5_2, version_2_5_1, version_2_5_0, version_2_4_99_0, version_2_12_X, version_2_11_X, version_2_11_4_uiuc, version_2_11_4_msu, version_2_11_4, version_2_11_3_uiuc, version_2_11_3_msu, version_2_11_3, version_2_11_2_uiuc, version_2_11_2_msu, version_2_11_2_educog, version_2_11_2, version_2_11_1, version_2_11_0_RC3, version_2_11_0_RC2, version_2_11_0_RC1, version_2_11_0, version_2_10_X, version_2_10_1, version_2_10_0_RC2, version_2_10_0_RC1, version_2_10_0, loncapaMITrelate_1, language_hyphenation_merge, language_hyphenation, bz6209-base, bz6209, bz5969, bz2851, PRINT_INCOMPLETE_base, PRINT_INCOMPLETE, HEAD, GCI_3, GCI_2, GCI_1, BZ5971-printing-apage, BZ5434-fox, BZ4492-merge, BZ4492-feature_horizontal_radioresponse

- fixing broken \label{} (BUG#5352)

\label{About_Developers_Manual} The purpose of this document is to introduce developers people to LON-CAPA, and enable them to start doing real work with the system as quickly as possible. This should prove useful both to people who already intend to develop with LON-CAPA, and to technical people who are evaluating LON-CAPA to see if it suits their needs. The most daunting task facing new developers is understanding how the whole system fits together; individual pieces are usually sensible but like any large program it is difficult to understand the forest by looking at just the trees. Therefore, this document will start out with the highest-level overview of the system, which can be safely skipped if you already know what LON-CAPA is. Next, we'll look at the major subsystems of LON-CAPA and how they fit together at a high level, with enough detail to understand the context a given piece of the system functions in. Appropriate pointers will be given to the detailed documentation on the various subsystems, so this section can be used as an expanded {}``Table of Contents''. Then a brief tutorial in adding a {}``handler'' to LON-CAPA will be given, enabling you both to understand how to add brand-new functionality to LON-CAPA, and better understand the majority of the code in the system which is in the form of handlers. Finally, the last and largest portion of this document will be extremely detailed examinations of the subsystems from a technical point of view, including API descriptions suitable for use in programming. Obviously you will not need to read this over entirely, unless you really want to know what the system can do.