home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / CPM / PROGRAMS / WSTAR / SOFTEN.LBR / SOFTEN.DZC / SOFTEN.DOC
Text File  |  2000-06-30  |  3KB  |  110 lines

  1.                              SOFTEN
  2.  
  3.                A program to convert an ASCII text 
  4.                file to WordStar document format.
  5.  
  6. SOFTEN  is an example of a simple filter program.  It  reads  in 
  7. characters  from one file, modifies them in some way, and  reads 
  8. them  out to another file.  In this case the modification is  to 
  9. the  carriage  returns that occur at the ends  of  lines  within 
  10. paragraphs.
  11.  
  12. WordStar  distinguishes  between  "hard"  and  "soft"   carriage 
  13. returns in order to facilitate reformatting paragraphs.  A hard
  14. return  is used to designate the last line of a paragraph  or  a 
  15. blank  line  and  is not altered during  reformatting.   A  soft 
  16. return, on the other hand, is only temporary.  If a soft  return 
  17. is  encountered  during  reformatting it is  ignored  unless  it 
  18. happens  to fall at the end of a reformatted line.  
  19.  
  20. In an ASCII text file, all returns are hard.  The job of  SOFTEN 
  21. is to determine which of the carriage returns must be  softened.  
  22. It   does  this  by  looking  ahead  and   checking   subsequent 
  23. characters.   The next character after a return will be  a  line 
  24. feed.   The  character  after that will  be  another  return,  a 
  25. letter, a space or a tab.  If the character is a letter,  SOFTEN 
  26. assumes  that  the current line is within a  paragraph  and  the 
  27. carriage  return  is  softened by setting the  high  bit  (i.e., 
  28. changing the byte from 0Dh to 8Dh).  In the other cases,  SOFTEN 
  29. assumes the current line is at the end of a paragraph and passes 
  30. the return unchanged as a hard return.
  31.  
  32. There  is  another distinguishing feature of  WordStar  document 
  33. files  that can be considered when converting a file.   That  is 
  34. the  use  of "soft" hyphens to split a word between  two  lines.  
  35. WordStar  prints a soft hyphen if it is the last character on  a 
  36. line and ignores it within a line.  The program HSOFTEN is prov-
  37. ided  to  convert  end-of-line hyphens in  text  files  to  soft 
  38. hyphens in addition to softening carriage returns.  It should be 
  39. used with caution, however, since there are times when a  hyphen 
  40. shouldn't  be softened.  An example is in the case  of  compound 
  41. adjectives (e.g., non-English-speaking countries). 
  42.  
  43. Both  SOFTEN and HSOFTEN are written for a generic  CP/M  system 
  44. and  do not require a Z80 CPU. The source code is  provided  for 
  45. the  adventurous  who may wish to make other  changes  during  a 
  46. conversion  or  perhaps  enlarge the buffers  to  minimize  disk 
  47. accesses.   Both routines are based on a series  of  subroutines 
  48. from   Eric   Meyer's  tutorial  on   CP/M   assembly   language 
  49. programming.   The  tutorial is available  on  various  bulletin 
  50. boards and should be referred to for additional details.
  51.  
  52. WordStar  is  a registered trademark of  MicroPro  International 
  53. Corporation.   Comments and bug report messages can be left  for 
  54. the author on Znode #45 (Houston) at (713) 937-8886.
  55.  
  56.                                    John Smaardyk
  57.                                    February 6, 1988
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.