diff --git a/doc/calendar.md b/doc/calendar.md index beec2b5..a1f887a 100644 --- a/doc/calendar.md +++ b/doc/calendar.md @@ -118,6 +118,13 @@ granularity. The period contains fields ```since``` which is the first month of the period and ```before``` which is the first month just after the period. + (*current-month* [month]) + +* ```month``` - valid month structure as specified in the ```month``` module + +Configuration parameter specifying the current month. Defaults to the +current month derived from the current system time. + (period-since p) * ```p``` - valid period diff --git a/doc/modules.md b/doc/modules.md index 2d722ba..c94028c 100644 --- a/doc/modules.md +++ b/doc/modules.md @@ -13,29 +13,33 @@ questionable. ### Configuration + (import configuration) + The exact behavior of some algorithms in other modules can be changed via configuration parameters in this global configuration module. - (*current-month* [month]) +This module also handles configuration file loading. -* ```month``` - valid month structure as specified in the ```month``` module + (*etc-hackerbase* path) -Configuration parameter specifying the current month. Defaults to the -current month derived from the current system time. +* ```path``` - path to file with configuration - (*member-file-context* [lines]) +Used by ```load-configuration!``` to load the system-specific default +configuration values. + +*members-directory* -* ```lines``` - number of context lines +*apikeys-file* -How many lines of context are to be shown in source file -listing. Mainly used by the member file module parser and processor. +*jendasap-checked* - (*member-suspend-max-months* [number]) +*bank-dir* -* ```number``` - number of months (nonnegative integer) +*email-from* + + (load-configuration!) -Determines how many months the member can be suspended before any -action is required. +Loads configuration from ```(*etc-hackerbase*)``` file. ### Member Record diff --git a/doc/specification.md b/doc/specification.md new file mode 100644 index 0000000..df20e1b --- /dev/null +++ b/doc/specification.md @@ -0,0 +1,19 @@ +Organization Specification +========================== + +Modules +------- + +### Specification + + (import specification) + +This module contains organization specificaiton in an extensible +format. + + member-suspend-max-months + +Determines how many months the member can be suspended before any +action is required. + +