home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / comms_networking / zonk / rawdocs / intro < prev    next >
Encoding:
Text File  |  1999-02-05  |  3.2 KB  |  87 lines
  1. $zonkpage 1.0
  2.  
  3. title: Introduction to Zonk
  4.  
  5. nobrs:
  6.  
  7. text:{
  8. <sh>What is it?</sh>
  9.  
  10.  
  11. Zonk is a program for creating html files. However it is not a WYSIWYG
  12. editor, in fact it is not an editor at all. Zonk creates html from
  13. templates and datafiles.
  14.  
  15. <sh>Why?</sh>
  16. There seems to be a general consensus that the best html is handwritten
  17. html. It also seems generally agreed that the <i>concept</i> of cascading
  18. style sheets (CSS) is a good one. Unfortunately at present, the
  19. implementation of CSS is not all that it could be. Finally, most sites
  20. have many pages which are similar and are often built using the
  21. error-prone 'cut and paste' method. All these problems can be addressed
  22. by using templates. Zonk is a quick and efficient system for working by
  23. this method.
  24.  
  25. <sh>Here are just a few of its features:</sh><ul>
  26.  
  27. <li>It is fast. A typical datafile/template will be processed in less
  28. than a second. (Actual runtimes do of course depend on the size of
  29. the datafile and the complexity of the template)
  30.  
  31. <li>Both datafiles and templates are plain text files.
  32.  
  33. <li>The layout of the datafiles is easily understood by a
  34. non-technical user
  35.  
  36. <li>Templates can be built quickly by anyone who is familiar with
  37. elementary programming concepts
  38.  
  39. <li>Includes a powerful perl-compatible regular expression engine if
  40. you need to manipulate your data in any way
  41.  
  42. <li>Can automatically substitute in html entities (things such as
  43. accents) if required
  44.  
  45. <li>You can define your own 'pseudo-styles'
  46.  
  47. <li>Can generate many html files from one datafile.
  48.  
  49. <li>Can generate 'index' pages of already existing html files
  50.  
  51. <li>Can read graphic files width and height information for inclusion
  52. in IMG tags
  53.  
  54. <li>Very configurable. One minor example of its configurability is that
  55. you can have the same datafile use a different template depending
  56. on, oh, the day of the week, the month, the year, the week
  57. number... and that doesn't just have to be based on today's date
  58. but can be based on a date variable that you supply.
  59. </ul>   
  60.  
  61. Zonk's output html is as compliant and reliable as the html you put into
  62. the template :-) You are in control. 
  63.  
  64. Zonk itself is 100% C (although the tiny !deskzonk frontend is in
  65. BASIC). I already have versions of the program running under Windows95
  66. and MacOS 8.5. Zonk is intended as a commercial product for those
  67. platforms, however as a lifelong user of Acorn systems I thought I would
  68. make my contribution to the Acorn community by releasing this version on
  69. a free licence.
  70.  
  71. Note also that this is a <b>beta</b> release. I would be most surprised if
  72. there are not some bugs still lurking somewhere. Backup any valuable
  73. data that you might throw Zonk's way.
  74.  
  75. As far as I am aware Zonk should run on any RISC systems from OS 3
  76. onwards. It will attempt to use dynamic areas if available but will
  77. still work if they are not (although you may need to increase the
  78. wimpslot). I run an RPC700 so I don't know for sure that it is StrongArm
  79. compatible but I see no reason why it shouldn't be. It was compiled with
  80. GCC version 2.7.2.1 and uses the SharedCLibrary, my version of which is
  81. 4.79, again I'm not sure what the earliest one it would need is.
  82.  
  83. <sh>Acknowledgements</sh>
  84. The author of the Perl-compatible regex code (PCRE) included in the
  85. program is Philip Hazel. All other code has been written by me from
  86. scratch.
  87.