Return to Variable_Naming_Conventions.tex CVS log

Up to [LON-CAPA] / loncom / html / adm / help / tex

This commit implements the .tex-based online help system in LON-CAPA. It
may be necessary to manually run loncom/build/help_graphics_converter.pl
and doc/help/rebuildLabelHash.pl after a cvs update, and
loncapa_apache.conf may need to be manually copied to /etc. (The
loncapafiles.lpml has been updated.)

After merging this, the URL http://[loncapahost]/adm/help/Foils.hlp
should display a help file.

Also, some *very* out-of-date files have been removed from the /doc
directory.

There are many variable naming conventions, covering both how to name and
how to capitalize variables%
\footnote{The author favors \texttt{capsOnNewWords}. Some people use \texttt{underscore\_to\_separate\_words}.
Many use uppercase letters to specify constants like \texttt{PI} or \texttt{GOLDEN\_MEAN}.
Some people always \texttt{StartWithCapatalization}. What's really important
is to be consistent, so you don't have to guess whether the variable you're
thinking of is \texttt{coefFriction}, \texttt{CoefFriction}, \texttt{COEF\_FRICTION},
or something else.%
}. It is a good idea to adopt a standard. If you are working with a group,
you may wish to discuss it in your group and agree on a convention.