Work on member-record documentation.

This commit is contained in:
Dominik Pantůček 2023-04-01 10:45:44 +02:00
parent e5f7a3ef47
commit 21d3af2ac3

View file

@ -58,6 +58,11 @@ The ```'id``` key is filled with any four-digit file-name or symlink
converted to a number. Preferably the four-digit symbol should be the converted to a number. Preferably the four-digit symbol should be the
file-name but it is not required. file-name but it is not required.
(member-file-path mr)
* ```mr``` - a member record structure
Returns the path used for accessing this member's file.
(member-record-input-file mr) (member-record-input-file mr)
* ```mr``` - a member record structure * ```mr``` - a member record structure
@ -74,13 +79,34 @@ Any keyword arguments are stored in the member record dictionary as
keys obtained by converting the keyword to symbol with values keys obtained by converting the keyword to symbol with values
following the keyword. following the keyword.
### Member Parser (member-record-add-highlight mr line message pass type)
### Member Info Printer * ```mr``` - a member record structure
* ```line``` - line number in the source file
* ```message``` - a string with message for highlight
* ```pass``` - parsing stage
* ```type``` - symbol representing the highlight type
Adds a new highlight to member record to be used when displaying the
source file listing.
Known types are:
* ```'error``` - to denote fatal problem in the source
* ```'warning``` - to signal known problem which does not make the record invalid
* ```'info``` - supplemental information
The structure is perfectly suited for ```print-source-listing``` function.
### Member Parser
### Members Directory ### Members Directory
### Member Base ### Members Base
### Members Payments Processor
### Members Info Printer
### Cards ### Cards
@ -531,8 +557,12 @@ for those lines.
Prints given text file represented by the ```lines``` list of strings. Prints given text file represented by the ```lines``` list of strings.
Lines to be highlighted can be specified in the ```highlights``` Lines to be highlighted can be specified in the ```highlights```
list. The highlight specification is either a number or a list list. The highlight specification a list containing the following:
containing the line number and string comment.
* line number (number)
* message (string)
* pass stage (number)
* type (symbol)
By default the lines are actually highlighted by prepending them with By default the lines are actually highlighted by prepending them with
```hl-pre``` string and the highlight is finished by appending ```hl-pre``` string and the highlight is finished by appending
@ -787,8 +817,8 @@ This module provides a very simple, incomplete and incorrect but fast
CSV loader. CSV loader.
(csv-parse filename (csv-parse filename
[#:separator ";"] [#:separator #\;]
[#:string-delimiter "\""]) [#:string-delimiter #\"])
* ```separator``` - cell separator in CSV file * ```separator``` - cell separator in CSV file
* ```string-delimiter``` - for introducing strings possibly with separators * ```string-delimiter``` - for introducing strings possibly with separators
@ -800,4 +830,4 @@ representing its contents.
* ```csv``` - list of lists of strings * ```csv``` - list of lists of strings
Splits given loaded CSV into at the first empty row. Splits given loaded CSV into two tables at the first empty row.