Document how translation table is passed to back-ends.

This commit is contained in:
Dianne Skoll
2024-12-11 15:35:31 -05:00
parent 84e8244e48
commit d76c5499b5

View File

@@ -337,6 +337,11 @@ older format contains enough information for them to work properly.
\fBRemind \-p\fR sends the following lines to standard output.
The information is designed to be easily parsed by back-end programs:
.TP
.B # translations
This line signifies that the next line will be the translation table.
The line following \fB# translations\fR is a JSON object (on a single
line) containing all of the entries of the translation table.
.TP
.B # rem2ps begin
This line signifies the start of calendar data. Back-ends can search
for it to verify they are being fed correct information.
@@ -435,6 +440,11 @@ each reminder as a one-off event.
.PP
The lines emitted by \fBremind \-pp\fR are as follows:
.TP
.B # translations
This line signifies that the next line will be the translation table.
The line following \fB# translations\fR is a JSON object (on a single
line) containing all of the entries of the translation table.
.TP
.B # rem2ps2 begin
This line signifies the start of calendar data. Back-ends can search
for it to verify they are being fed correct information. Note the
@@ -664,6 +674,9 @@ The number of days in the following month.
The year of the following month. (The same as \fByear\fR unless the
current month is December.)
.TP
.B translations \fR{\fIobject\fR}
A complete dump of the Remind translation table.
.TP
.B entries \fR[\fIarray\fR]
The \fBentries\fR key consists of an array of calendar entries; each
entry is a JSON object that has the same format as described in the