Location(s) of CPL macro files

[maharper]

I think we should decide a location for local (CPL level local) macro files. I propose: champlain-problem-library/macros/.

When a problem requests a macro file like PGML.pl, or CPL-diagnostic.pl, or MH-contrib.pl, or just-for-this-problem.pl, WW looks for the macro file in directories, searching the directories in order until it finds a matching .pl file. The directory list is specified in defaults.config and can be overridden or added to in localOverrides.conf (system-wide impact) or in course.conf (only affects that specific course).

The default search order is (currently):

• . (the same directory as the problem file)
• [TMPL]/macros (the course macros directory)
• [PG]/macros/ (if this directory is not on the list WW will break)
• then a list of macro directories in the OPL (currently 16) of the shape
  [TMPL]/Library/macros/<institution name>

I would strongly recommend that we not override the default list as that would create problems when we upgrade WW. We can add to the list without creating those problems and I think we should add [TMPL]/champlainLibrary/macros to the bottom of the list in localOverrides.conf.

[maharper]

Other macro file locations

Very local

For function definitions that are very local, perhaps for only one problem or a small collection of problems local to a course, the .pl file can go in the same directory as the problem.

Course level

For function definitions to be used course-wide, but not shared further, macro files should go in the macros subdirectory of the course templates directory.

Contrib level

For function definition files that I am using in problems in my contrib directory, I see two possible locations:

1. In a macros subdirectory the top level of my contrib directory, ie CPL-Contrib/MH-Contrib/macros/
2. In a top level subdirectory of the contrib directory ie CPL-Contrib/macros/

Both locations have pros and cons.

[maharper]

CPL level macros:

• These will live in champlain-problem-library/macros/.
• Adding [TMPL]/champlainLibrary/macros to localOverrides.conf will make them available in every course where the CPL problems are available.

Contrib level macros:

• These will live in CPL-Contrib/<author>-Contrib/macros/ so that it is clear that they are subject to the author's whim in the same way that contrib level problems are.
• They will require adding one line to localOverrides.conf for each <author>-Contrib/macros/ directory.
• An author's contrib level macros will be available in any course where their contrib level problems are.