Split out specification documentation, prepare for better configuration overides.
This commit is contained in:
		
							parent
							
								
									0a49319730
								
							
						
					
					
						commit
						6cf116ce98
					
				
					 3 changed files with 42 additions and 12 deletions
				
			
		|  | @ -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 | ||||
|  |  | |||
|  | @ -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. | ||||
|    | ||||
| * ```lines``` - number of context lines | ||||
| *members-directory* | ||||
| 
 | ||||
| How many lines of context are to be shown in source file | ||||
| listing. Mainly used by the member file module parser and processor. | ||||
| *apikeys-file* | ||||
| 
 | ||||
|     (*member-suspend-max-months* [number]) | ||||
| *jendasap-checked* | ||||
| 
 | ||||
| * ```number``` - number of months (nonnegative integer) | ||||
| *bank-dir* | ||||
| 
 | ||||
| Determines how many months the member can be suspended before any | ||||
| action is required. | ||||
| *email-from* | ||||
|    | ||||
|     (load-configuration!) | ||||
| 
 | ||||
| Loads configuration from ```(*etc-hackerbase*)``` file. | ||||
| 
 | ||||
| ### Member Record | ||||
| 
 | ||||
|  |  | |||
							
								
								
									
										19
									
								
								doc/specification.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										19
									
								
								doc/specification.md
									
										
									
									
									
										Normal file
									
								
							|  | @ -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. | ||||
| 
 | ||||
| 
 | ||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue