home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / unix / volume12 / cake / part06 / Lib / Newtext.doc < prev    next >
Encoding:
Text File  |  1987-10-15  |  2.2 KB  |  55 lines
  1. Documentation for the cakefile Newtext.
  2.  
  3. This file explains what you can do with Newtext; the macros used by
  4. Newtext are described in Newtext.defs.
  5.  
  6. Newtext assumes that your document is in a file with a .orig or .frame
  7. suffix; if the suffix is .frame it assumes that it is a skeleton
  8. with .so statements including the "meat" of the document. In either case
  9. the file should have a line containing the word NEED followed by a list
  10. of program names from the set lbl, bib, listrefs, pic, tbl and eqn.
  11. This line may be a ditroff comment (a line beginning with .\")
  12. and should preferably occur near the beginning of the file.
  13.  
  14. The targets available through Newtext are:
  15.  
  16. %.laser:    Ditroff output, after putting %.orig through the listed
  17.         preprocessors. (The names of the preprocessor commands
  18.         and their options may be altered (see Newtext.defs).)
  19.  
  20. %.refs:        The list of bib references in the document.
  21. %.srefs:    %.refs sorted without duplicates.
  22. %.cit:        %.srefs looked up in a source bibliography.
  23.         This is useful for making a local copy of the
  24.         necessary references, allowing faster retrieval.
  25. %.chnr:        The output of checknr.
  26. %.cheq:        The output of checkeq.
  27. %.ol:        Outline for -me documents.
  28. %.fix:        A pseudo-target to invoke fix, an ispell-type spelling
  29.         corrector.
  30. %.ispell:    A pseudo-target to invoke ispell.
  31. %.spell:    A list of misspelled words in the document.
  32. %.dict:        Questionable phrases used in the document.
  33. %.style:    Readability indexes for the document.
  34. %.astyle:    Readability indexes for every sentence in the document.
  35. %.exp:        Expletives in the document (as defined by style(1)).
  36. %.mod:        Moderately hard-to-read sentences in the document.
  37. %.hard:        Hard-to-read sentences in the document.
  38. %.long:        Long sentences in the document.
  39. %.pass:        Sentences containing passives.
  40.  
  41. %.all:        Run the most useful document analysis programs:
  42.         %.spell, %.style, %.exp, %.mod, %.long, %.pass, %.dict
  43.         and %.chnr.
  44.  
  45. %.count:
  46. %.ocount:    The number of words in a document, measured in two ways.
  47.         %.count counts equations, references, programs etc
  48.         as one word; %.ocount counts them as they appear.
  49.  
  50. %.clean:    Remove the files generated from %.orig.
  51. %.vclean:    Remove the files generated from %.frame.
  52.  
  53. clean:        Run %.clean for all %.orig.
  54. vclean:        Run %.vclean for all %.frame.
  55.