[BACK]Return to Guts_Coding_Guidelines.tex CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / html / adm / help / tex
File:  [LON-CAPA] / loncom / html / adm / help / tex / Guts_Coding_Guidelines.tex
Revision 1.2: download - view: text, annotated - select for diffs
Mon May 17 22:08:56 2004 UTC (20 years, 1 month 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_X, version_2_4_99_0, version_2_4_2, version_2_4_1, version_2_4_0, version_2_3_X, version_2_3_99_0, version_2_3_2, version_2_3_1, version_2_3_0, version_2_2_X, version_2_2_99_1, version_2_2_99_0, version_2_2_2, version_2_2_1, version_2_2_0, version_2_1_X, version_2_1_99_3, version_2_1_99_2, version_2_1_99_1, version_2_1_99_0, version_2_1_3, version_2_1_2, version_2_1_1, version_2_1_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, version_2_0_X, version_2_0_99_1, version_2_0_2, version_2_0_1, version_2_0_0, version_1_99_3, version_1_99_2, version_1_99_1_tmcc, version_1_99_1, version_1_99_0_tmcc, version_1_99_0, version_1_3_X, version_1_3_3, version_1_3_2, version_1_3_1, version_1_3_0, version_1_2_X, version_1_2_99_1, version_1_2_99_0, version_1_2_1, version_1_2_0, version_1_1_99_5, version_1_1_99_4, version_1_1_99_3, version_1_1_99_2, version_1_1_99_1, version_1_1_99_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
- add missing \label
- add errormessage generation to lonhelp.pm in case it does not find a label for
   the reference

- This should fix #3016, and make it easier to find these errors in the fututre

\label{Guts_Coding_Guidelines}

Things to keep in mind while coding handlers for LON-CAPA:

\begin{enumerate}
\item \textbf{DON'T} write to Access machine disks with permanent data.
Use \texttt{Apache::lonnet::store/restore}.
\item \textbf{DO} \texttt{use strict;}
\item \textbf{DON'T} use \texttt{print()}. Use \texttt{\$request->print()}.
(Unfortunately, \texttt{print} sometimes seems to work while writing
the handler, but will it will fail unpredictably in real usage.)
\item \textbf{DON'T} launch children.
\item \textbf{DO} \texttt{use strict;}
\item \textbf{DO} use \texttt{\$Apache::lonnet::perlvar\{'lonDaemons'\}/tmp}
for temporary data.
\item \textbf{DO} query the return value of every file operation.
\item \textbf{DO} familiarize your self with the functions in lonnet.pm
and use them to communicate with other servers and when your handler
needs to ask questions.
\item \textbf{DON'T} use \texttt{\&Apache::lonnet::reply()}; use the proper
wrapper functions.
\item \textbf{DO} \texttt{use strict;}\end{enumerate}
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>