1.1 --- a/doc/loupe-test.txt	Tue Feb 07 08:15:12 2012 +0000
     1.2 +++ b/doc/loupe-test.txt	Sat Oct 26 18:47:33 2013 +0100
     1.3 @@ -91,14 +91,35 @@
     1.4  ------------------
     1.5  
     1.6  One of the tests that bookloupe/gutcheck need to do is check that all
     1.7 -lines are ended with CR NL (as required by PG) rather than the UNIX
     1.8 -standard NL. loupe-test deliberately ignores the line endings in testcase
     1.9 -definition files and always uses CR NL. Thus there is needed a means
    1.10 +lines are ended with CR LF (as required by PG) rather than the UNIX
    1.11 +standard LF. loupe-test deliberately ignores the line endings in testcase
    1.12 +definition files and uses the expected CR LF. Thus there is needed a means
    1.13  to embed a linefeed (aka newline) character into the input to be sent
    1.14  to bookloupe/gutcheck to test that it correctly identified the problem.
    1.15  loupe-test recognises the unicode symbol for linefeed (U+240A): ␊ which
    1.16  can be used for this purpose instead of a normal newline.
    1.17  
    1.18 +UNIX-style newlines
    1.19 +-------------------
    1.20 +
    1.21 +To make life easier for users on UNIX and similar platforms, bookloupe
    1.22 +recognises the case of all lines terminated with UNIX-style newlines.
    1.23 +It notes this in the summary but does not issue any warnings. We thus
    1.24 +need some way to test this case which we do by the NEWLINES tag:
    1.25 +
    1.26 +  ┌──────────────────────────────────────────────────────────────────────────┐
    1.27 +  │**************** NEWLINES ****************                                │
    1.28 +  │LF                                                                        │
    1.29 +  │**************** INPUT ****************                                   │
    1.30 +  │Katherine was assailed by a sudden doubt. Had she mailed that letter? Yes,│
    1.31 +  │she was certain of that. She had run out to the mail box at ten o'clock   │
    1.32 +  │at night especially to mail it. What had gone wrong? Why wasn't there     │
    1.33 +  │someone to meet her?                                                      │
    1.34 +  └──────────────────────────────────────────────────────────────────────────┘
    1.35 +
    1.36 +The possible options are CRLF for DOS-style newlines (the default) and
    1.37 +LF for UNIX-style newlines.
    1.38 +
    1.39  Passing command line options
    1.40  ----------------------------
    1.41  
    1.42 @@ -203,3 +224,16 @@
    1.43  this, eg.:
    1.44  
    1.45  sample: PASS (with 1 of 1 false positives and 1 of 1 false negatives)
    1.46 +
    1.47 +The summary
    1.48 +-----------
    1.49 +
    1.50 +As part of the header (the first section of output), bookloupe may display
    1.51 +a number of summary lines. These are characterized by a leading ASCII
    1.52 +long arrow (-->) and generally say something about the ebook as a whole
    1.53 +rather than individual lines. Where it is desired to test for the presence
    1.54 +of a summary line, a "summary" node can be included within the "expected"
    1.55 +node of a testcase using structured warnings. The "summary" node can contain
    1.56 +one or more "text" nodes which indicate the text of lines that must be
    1.57 +present in the summary section in order for the test to pass. No account is
    1.58 +taken of the order of such lines and other summary lines may also be present.