diff -r 05d082ebf685 -r d22d8cd4f628 doc/loupe-test.txt --- a/doc/loupe-test.txt Tue Feb 07 08:15:12 2012 +0000 +++ b/doc/loupe-test.txt Sun Oct 27 17:01:47 2013 +0000 @@ -91,14 +91,35 @@ ------------------ One of the tests that bookloupe/gutcheck need to do is check that all -lines are ended with CR NL (as required by PG) rather than the UNIX -standard NL. loupe-test deliberately ignores the line endings in testcase -definition files and always uses CR NL. Thus there is needed a means +lines are ended with CR LF (as required by PG) rather than the UNIX +standard LF. loupe-test deliberately ignores the line endings in testcase +definition files and uses the expected CR LF. Thus there is needed a means to embed a linefeed (aka newline) character into the input to be sent to bookloupe/gutcheck to test that it correctly identified the problem. loupe-test recognises the unicode symbol for linefeed (U+240A): ␊ which can be used for this purpose instead of a normal newline. +UNIX-style newlines +------------------- + +To make life easier for users on UNIX and similar platforms, bookloupe +recognises the case of all lines terminated with UNIX-style newlines. +It notes this in the summary but does not issue any warnings. We thus +need some way to test this case which we do by the NEWLINES tag: + + ┌──────────────────────────────────────────────────────────────────────────┐ + │**************** NEWLINES **************** │ + │LF │ + │**************** INPUT **************** │ + │Katherine was assailed by a sudden doubt. Had she mailed that letter? Yes,│ + │she was certain of that. She had run out to the mail box at ten o'clock │ + │at night especially to mail it. What had gone wrong? Why wasn't there │ + │someone to meet her? │ + └──────────────────────────────────────────────────────────────────────────┘ + +The possible options are CRLF for DOS-style newlines (the default) and +LF for UNIX-style newlines. + Passing command line options ---------------------------- @@ -203,3 +224,16 @@ this, eg.: sample: PASS (with 1 of 1 false positives and 1 of 1 false negatives) + +The summary +----------- + +As part of the header (the first section of output), bookloupe may display +a number of summary lines. These are characterized by a leading ASCII +long arrow (-->) and generally say something about the ebook as a whole +rather than individual lines. Where it is desired to test for the presence +of a summary line, a "summary" node can be included within the "expected" +node of a testcase using structured warnings. The "summary" node can contain +one or more "text" nodes which indicate the text of lines that must be +present in the summary section in order for the test to pass. No account is +taken of the order of such lines and other summary lines may also be present.