Basic documentation of web-static module.
This commit is contained in:
		
							parent
							
								
									35a20a8a1a
								
							
						
					
					
						commit
						6658b1ebcf
					
				
					 1 changed files with 28 additions and 0 deletions
				
			
		|  | @ -11,6 +11,8 @@ Functional Modules | |||
| These modules are specific to this project and their generic usage is | ||||
| questionable. | ||||
| 
 | ||||
| ### Members Fees Computation | ||||
| 
 | ||||
| ### Members Payments Processor | ||||
| 
 | ||||
| ### Members Info Printer | ||||
|  | @ -19,3 +21,29 @@ questionable. | |||
| 
 | ||||
| ### Web Static | ||||
| 
 | ||||
|     (import web-static) | ||||
| 
 | ||||
| This module implements JendaSAP-compatible DokuWiki static files export. | ||||
| 
 | ||||
|     (gen-web-static-member mr [dir]) | ||||
| 
 | ||||
| * ```mr``` - member structure | ||||
| * ```dir``` - optional output directory | ||||
| 
 | ||||
| For given member ```mr``` Generates the following files in given | ||||
| directory ```dir``` which defaults to current directory: | ||||
| 
 | ||||
| * nick.id - contains member id | ||||
| * nick.balance - total current balance | ||||
| * nick.misc - whole member file | ||||
| * nick.log - git log of the member file | ||||
| 
 | ||||
| All four files use members' nick as base name. | ||||
| 
 | ||||
|     (gen-web-static mb dir) | ||||
| 
 | ||||
| * ```mb``` - mbase instance | ||||
| * ```dir``` - path to destination directory | ||||
| 
 | ||||
| Generates static web files for all members in given mbase ```mb``` and | ||||
| stores them in the destination directory ```dir```. | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue