From f7b868a52965de110016e3ef05385a3321e00189 Mon Sep 17 00:00:00 2001 From: sternenseemann Date: Tue, 19 May 2020 13:09:28 +0200 Subject: fix spelling etc. for documentation --- README.md | 4 ++-- doc/logbook-log.7 | 22 +++++++++++----------- doc/logbook-template.7 | 2 +- doc/logbook.1 | 8 ++++---- 4 files changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 9edf462..515a2b8 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ For more details read on! ## (Post-)Privacy mechanism -The `log` format differenciates between three privacy levels, which can be used +The `log` format differentiates between three privacy levels, which can be used to control what parts of your `log` file is shared with whom. These levels can be applied to the items of a `log` entry and indicate to which group of people the respective items are allowed to be displayed. @@ -124,7 +124,7 @@ a block indented using 2 spaces, it uses a block indented by 2 spaces for the ti the item's text would be indented using 4 spaces. While it allows for multi-line titles, it has the major drawback that — when using -indentation-sensitive markup — it can't be differenciated between a line of the title +indentation-sensitive markup — it can't be differentiated between a line of the title which is indented using 2 spaces and the beginning of the 4 space indented block of the item text. I decided to rework this in order to avoid such cases altogether. diff --git a/doc/logbook-log.7 b/doc/logbook-log.7 index ef2fc45..d74cc6e 100644 --- a/doc/logbook-log.7 +++ b/doc/logbook-log.7 @@ -5,16 +5,16 @@ \fIfile\fB.log\fR .SH DESCRIPTION A \fBlog\fR file contains one or more \fBentries\fR which each are associated -with a specific \fBdate\fR. There shouldn't be more than one entry for a \fBdate\fR. +with a specific \fBdate\fR. There should not be more than one entry for a \fBdate\fR. Every \fBentry\fR consists of the mentioned \fBdate\fR, a \fBsummary\fR and zero or more \fBitems\fR. .PP Every \fBitem\fR consists of a \fBprivacy level\fR which is indicated by a preceding -symbol which determines which individuals may access this item, its \fBtitle\fR and +symbol which determines which individuals may access it, its \fBtitle\fR and its \fBtext\fR. .PP \fBsummary\fR, \fBtitle\fR and \fBtext\fR may contain markup of any kind, as long -as it doesn't interfer with the parsing of the log format. +as it does not interfere with the parsing of the log format. .SH PRIVACY LEVELS \fBlog\fR knows three different \fBprivacy levels\fR which indicate by whom an item may or may not be accessed: @@ -48,9 +48,9 @@ An example of this are the \fB\-\-private\fR, \fB\-\-semi\-private\fR and .BR logbook (1). .SH FORMAT A \fBlog\fR file consists of multiple \fBentries\fR separated by zero or more -empty lines. It uses unix line endings. An entry has the following format. +empty lines. It uses unix line endings. An entry has the following format: .PP -Every \fBentry\fR is initiated with a line containing \fBdate\fR of the format \fBYYYY-MM-DD\fR +Every \fBentry\fR is initiated with a line containing a \fBdate\fR of the format \fBYYYY-MM-DD\fR in brackets. .PP .nf @@ -60,8 +60,8 @@ in brackets. .fi .PP This is then followed by a \fBsummary\fR which is an unindented block of text -which is terminated by any number of empty lines or a \fBitem\fR. A \fBsummary\fR -may contain any markup that doesn't interfer with the parsing of a log file. +which is terminated by any number of empty lines or an \fBitem\fR. A \fBsummary\fR +may contain any markup that does not interfere with the parsing of a log file. .PP .nf .RS @@ -81,10 +81,10 @@ meaning of the privacy levels see the section of the same name. After the indica the item's \fBtitle\fR on the same line that is terminated by the line break. .PP Next is the item's \fBtext\fR which is a text block indented using 2 spaces. Both the \fBtext\fR -and the \fBtitle\fR may contain any markup that doesn't mess with the parsing. The \fBtext\fR +and the \fBtitle\fR may contain any markup that does not mess with the parsing. The \fBtext\fR block is terminated by any following item or empty lines. After parsing \fBtext\fR may contain an empty line, however. This can be achieved by using a line which only contains 2 spaces \- -a indented empty line so to say. +an indented empty line so to say. .PP .nf .RS @@ -106,8 +106,8 @@ separated by any number of empty lines. The \fBlog\fR format used by .BR logbook (1) is based on a specification by Profpatsch, but it has been simplified. -The original specifications specified that item titles wouldn't be limited -to a single line, but its own block of indent level 2, and the item text +Profpatsch allowed that item titles would not be limited +to a single line, but be its own block of indent level 2, and the item text a block with indent level 4. This creates a lot of unsolvable issues when parsing, so it has been simplified. .SH EXAMPLE diff --git a/doc/logbook-template.7 b/doc/logbook-template.7 index 6947d98..30859ff 100644 --- a/doc/logbook-template.7 +++ b/doc/logbook-template.7 @@ -26,7 +26,7 @@ might already have been preprocessed by a markup like markdown. following fields: .RS .IP \[bu] 2 -\fBtitle\fR: The title (in heading) of the item as a string. Might already have been +\fBtitle\fR: The title (as in heading) of the item as a string. Might already have been preprocessed by a markup. .IP \[bu] 2 \fBtext\fR: The text block of the item as a string. Might already have been diff --git a/doc/logbook.1 b/doc/logbook.1 index 1289470..435ee8c 100644 --- a/doc/logbook.1 +++ b/doc/logbook.1 @@ -20,7 +20,7 @@ Use \fIPATH\fR as input log file instead of standard input. .TP .B \-\-public Sets the privacy level to public meaning that only log items with this privacy level -(signified using a leading \fB+\fR) will be included in the output HTML. Shouldn't be given +(signified using a leading \fB+\fR) will be included in the output HTML. Should not be given at the same time as \fB\-\-semi-private\fR or \fB\-\-private\fR (the last one given will overwrite the previous ones). .TP @@ -28,13 +28,13 @@ overwrite the previous ones). Sets the privacy level to semi-private meaning that only semi-private and public log items will be included in the output HTML (signified using \fB*\fR and \fB+\fR respectively). The semi-private level is typically used when creating a rendering of a log file for -trusted individuals. This option shouldn't be given at same time as \fB\-\-public\fR or +trusted individuals. This option should not be given at same time as \fB\-\-public\fR or \fB\-\-private\fR (the last one given will overwrite the previous ones). .TP .B \-\-private Sets the privacy level to private which means that all log items will be included in the output HTML. This level is typically used for the author(s) of the log file. -Private log items are signified using \fB+\fR. This option shouldn't be given at same +Private log items are signified using \fB+\fR. This option should not be given at same time as \fB\-\-public\fR or \fB\-\-semi-private\fR (the last one given will overwrite the previous ones). .TP @@ -48,7 +48,7 @@ except for wrapping it with \fB

\fI...\fB

\fR. This emulates a behavior of which also wraps normal text blocks with an HTML paragraph and is intended to make templates written with markdown markup in mind work better with plain text log files. This was the default behavior of \fBlogbook\fR 0.2 and prior, so \fB\-\-paragraph\fR -can be used to restore the old behavior. Shouldn't be set at the same time as +can be used to restore the old behavior. Should not be set at the same time as \fB\-\-markdown\fR (the option set last will overwrite the previous one). .TP .B \-\-template \fIPATH\fR -- cgit 1.4.1