From 6658b1ebcfc8e3bbf4f865df52ca2f39f72e865b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Sun, 23 Apr 2023 18:53:07 +0200 Subject: [PATCH] Basic documentation of web-static module. --- doc/modules.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/modules.md b/doc/modules.md index 512264f..1c4a898 100644 --- a/doc/modules.md +++ b/doc/modules.md @@ -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```.