home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 13 / AACD13.ISO / AACD / Resources / Online / CheckHTML / Docs / English / CheckHTML.doc next >
Text File  |  2000-03-26  |  17KB  |  495 lines
  1.  
  2.                       Table of Contents
  3.  
  4.   Copyright                   - Copyright information
  5.   Distribution                - Copying conditions
  6.   Disclaimer                  - Legal Information
  7.   SGMLS License & Disclaimer  - SGMLS Legal Information
  8.   Trademarks                  - Trademark information
  9.   Support/Updates             - How to get updates and support
  10.   Author                      - How to reach the author
  11.  
  12.   Description                 - What is CheckHTML?
  13.   Requirements                - Requirements for using CheckHTML
  14.  
  15.   Installation                - How to install CheckHTML
  16.  
  17.   History                     - Revision history of CheckHTML
  18.   Todo                        - Todo list
  19.   Known problems              - List of known problems
  20.   Acknowledgments             - Acknowledgments
  21.   Please rate                 - Please rate CheckHTML
  22.   References                  - SGML References
  23.  
  24.  
  25.  
  26. Copyright
  27. ---------
  28.  
  29. CheckHTML, CountStrings, SelectString and the documentation are copyright
  30. 1997-2000 Dipl.-Inform. Kai Hofmann. All rights reserved!
  31.  
  32. - Permission for COMMERCIAL USE is only given by an extra available commercial
  33.   license that must be validated!
  34.   Contact me directly for this license, because it will be individually handed
  35.   out per your needs!
  36.  
  37. - Permission is hereby granted, without written agreement and without license,
  38.   to USE this software and its documentation for any NON-COMMERCIAL purpose,
  39.   provided that the above copyright notice and the following paragraph appear
  40.   in all copies of this software (Non-commercial includes Giftware!).
  41.  
  42.   Please send me a full version of your product at no cost including free
  43.   updates!
  44.  
  45.  
  46.  
  47. Distribution
  48. ------------
  49.  
  50. Permission is hereby granted, without written agreement and without license or
  51. royalty fees, to copy and distribute this software and its documentation for
  52. any purpose, provided that the above copyright notice and the following
  53. paragraphs appear in all copies of this software, to:
  54.  
  55. - All who will distribute this software for free!
  56. - All free accessible INTERNET servers!
  57. - All Aminet® sites
  58. - Fred Fish for his great Amiga-Software-Library
  59. - The German SAAR AG PD-Library
  60. - Angela Schmidt's Meeting Pearls series
  61. - All others who do NOT take more than US$ 5.- for one disk that includes this
  62.   software!
  63.  
  64.  
  65.  
  66. DISCLAIMER
  67. ----------
  68.  
  69. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
  70. LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDER AND/OR OTHER
  71. PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
  72. EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  73. MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE
  74. QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
  75. DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
  76.  
  77. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY
  78. COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAM AS
  79. PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
  80. INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  81. THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED
  82. INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE
  83. PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY
  84. HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  85.  
  86. THE AUTHOR HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
  87. ENHANCEMENTS, OR MODIFICATIONS.
  88.  
  89.  
  90.  
  91.  
  92. LICENSE AND DISCLAIMER OF WARRANTIES
  93.  
  94. Standard Generalized Markup Language Users' Group (SGMLUG)
  95. SGML Parser Materials
  96.  
  97. 1. License
  98.  
  99. SGMLUG hereby grants to any user: (1) an irrevocable royalty-free, worldwide,
  100. non-exclusive license to use, execute, reproduce, display, perform and
  101. distribute copies of, and to prepare derivative works based upon these
  102. materials; and (2) the right to authorize others to do any of the foregoing.
  103.  
  104. 2. Disclaimer of Warranties
  105.  
  106. (a) The SGML Parser Materials are provided "as is" to any USER.  USER assumes
  107.     responsibility for determining the suitability of the SGML Parser Materials
  108.     for its use and for results obtained.  SGMLUG makes no warranty that any
  109.     errors have been eliminated from the SGML Parser Materials or that they can
  110.     be eliminated by USER.  SGMLUG shall not provide any support maintenance or
  111.     other aid to USER or its licensees with respect to SGML Parser Materials.
  112.     SGMLUG shall not be responsible for losses of any kind resulting from use
  113.     of the SGML Parser Materials including (without limitation) any liability
  114.     for business expense, machine downtime, or damages caused to USER or third
  115.     parties by any deficiency, defect, error, or malfunction.
  116.  
  117. (b) SGMLUG DISCLAIMS ALL WARRANTIES, EXPRESSED OR IMPLIED, ARISING OUT OF OR
  118.     RELATING TO THE SGML PARSER MATERIALS OR ANY USE THEREOF, INCLUDING
  119.     (WITHOUT LIMITATION) ANY WARRANTY WHATSOEVER AS TO THE FITNESS FOR A
  120.     PARTICULAR USE OR THE MERCHANTABILITY OF THE SGML PARSER MATERIALS.
  121.  
  122. (c) In no event shall SGMLUG be liable to USER or third parties licensed by
  123.     USER for any indirect, special, incidental, or consequential damages
  124.     (including lost profits).
  125.  
  126. (d) SGMLUG has no knowledge of any conditions that would impair its right to
  127.     license the SGML Parser Materials.  Notwithstanding the foregoing, SGMLUG
  128.     does not make any warranties or representations that the SGML Parser
  129.     Materials are free of claims by third parties of patent, copyright
  130.     infringement or the like, nor does SGMLUG assume any liability in respect
  131.     of any such infringement of rights of third parties due to USER's operation
  132.     under this license.
  133.  
  134.  
  135.  
  136. Trademarks
  137. ----------
  138.  
  139. Amiga, AmigaDOS, AmigaGuide and Workbench are registered trademarks of Amiga
  140. International, Inc.
  141. Aminet is a registered trademark of Stefan Ossowskis Schatztruhe GmbH
  142. SAS/C is a registered trademark of SAS Institute Inc.
  143.  
  144. All other trademarked names used herein are used for the purposes of
  145. identification and for the benefit of the trademark holder. No infringement of
  146. trademarks is intended. Trademarks remain the property of the trademark holder.
  147.  
  148.  
  149.  
  150. Support/Updates
  151. ---------------
  152.  
  153. - Updates will be available via Aminet®
  154. - Support will be available via the authors email address and via
  155.   http://www.hofmann-int.de/products/amiga/CheckHTML.shtml
  156.  
  157.  
  158.  
  159. Author
  160. ------
  161.  
  162. Dipl.-Inform. Kai Hofmann
  163. Arberger Heerstraße 92
  164. 28307 Bremen
  165. Germany
  166.  
  167. Phone: (+49)-(0)421/480780
  168. EMail: hofmann@hofmann-int.de
  169. IRC  : PowerStat@#AmigaGer
  170. WWW  : http://www.hofmann-int.de/
  171.  
  172.  
  173.  
  174.  
  175. Description
  176. -----------
  177.  
  178. CheckHTML checks whether an HTML document is conforming with the HTML (4.01) DTD.
  179. This will be done by using the sgmls parser from James Clark, the HTML DTD,
  180. a small Shell script and an ARexx script.
  181. CheckHTML can verify HTML 4.01, HTML 4.0, HTML 3.2 and HTML 2.0 documents.
  182. Newer HTML versions can be easily supported by placing the new DTD into the
  183. 'sgml:' directory and adding their public identifier to the 'CATALOG' file.
  184.  
  185. Please note, that all your HTML documents must begin with the following line
  186. for backward compatibility with HTML 3.2:
  187.  
  188. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  189.  
  190. Otherwise (especially when using CSS) use:
  191.  
  192. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
  193.  
  194. or
  195.  
  196. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">
  197.  
  198. when using frames.
  199.  
  200. These lines are SGML code and identify the document to be HTML 4.01 - you can
  201. also use one of the HTML 4.0, HTML3.2 or HTML 2.0 identifiers (See 'CATALOG'
  202. file for more):
  203.  
  204. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
  205. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  206. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN">
  207. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
  208. <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
  209.  
  210. For more about the famous 'sgmls' parser and an optimized version for your CPU
  211. please download 'Aminet:dev/lang/sgmls.lha'
  212.  
  213. Server Side Includes:
  214.  
  215. SSI files must have the extension .shtml in order to be handled properly.
  216. In addition the include statement must be the only statement on a line
  217. (HTML tags on the same line as the include command will be removed). The
  218. following syntax has to be used:
  219.  
  220. <!--#include file="inc.html" -->
  221. <!--#include virtual="/include/inc.html" -->
  222. <!--#include virtual="../../include/inc.html" -->
  223.  
  224. The Unix path will be translated by adding ROOT before "/include/inc.html" and
  225. by removing "..".
  226. Please note that include commands within include files are not supported!
  227.  
  228. Template:
  229.  
  230. CheckHTML FILE,ROOT,QUIET/S
  231.  
  232. Using CheckHTML without the FILE argument will open a requester where you can
  233. select multiple files! When there is no FILE and no ROOT argument, first a
  234. requester for the web-site-root directory will be opened followed by  file-
  235. requester. When no root directory is given, the actual directory will be used.
  236. You can also use CheckHTML from the Workbench with the supplied icon file.
  237. Click CheckHTML first and then double click a HTML document.
  238.  
  239.  
  240. Toolmanager 3.0 users can find a preference within the archive.
  241.  
  242.  
  243. If you also want to check the correctness of the links within your HTML
  244. documents, please take a look at CheckLink from Fabio Rotondo which can be
  245. found on Aminet.
  246.  
  247.  
  248.  
  249. Requirements
  250. ------------
  251.  
  252. - OS 2.04
  253.  
  254.  
  255.  
  256.  
  257. Installation
  258. ------------
  259.  
  260. Use the installer script!
  261. (The Installer must be in your system-path!)
  262.  
  263.  
  264. Should you want to install by hand, do the following:
  265.  
  266. - Place c/sgmls, c/CountStrings, c/SelectString and s/CheckHTML somewhere
  267.   into your path
  268. - Place rexx/CheckHTML.rexx in rexx:
  269. - Create a SGML directory, assign 'SGML:' to it and copy the SGML dir from the
  270.   archive to it.
  271. - Copy the  documentation if needed (don't forget to use
  272.   WrapGuide on it if running under a pre V40 System).
  273.  
  274.  
  275.  
  276. History
  277. -------
  278.  
  279. 29.04.1997 -    First release on Aminet
  280. 03.06.1997 -    Second release on Aminet
  281.         * Improved documentation
  282.         * Added some @{AMIGAGUIDE} V40 features to the documentation
  283.         * Improved installer script
  284.         * Added CountStrings
  285.         * Added SelectString
  286.         * CheckHTML now asks for (multiple) files when started without
  287.           arguments
  288.         * Added German documentation
  289.         * HTML 3.2 Final DTD
  290.         * Renamed ISOlat1.sgml to ISOlat1.ent
  291. 30.06.1997 -    Third release on Aminet
  292.         * Added MagicWB readme
  293.         * SGMLS now compiled with SAS/C® 6.57
  294.         * Added new Eric Gerad icon
  295.         * Added Toolmanager 3.0 preferences
  296.         * Added "Finished" output for WB
  297. 29.01.1997 -    Fourth release on Aminet
  298.         * HTML 4.0 Final DTD
  299.         * Fixed installer script problem
  300. 07.03.1999 -    Fifth release on Aminet
  301.         * HTML 4.0 really Final DTD
  302. 29.11.1999 -    Sixth release on Aminet
  303.         * Added server side include processing (.shtml)
  304.         * New EMail- and WWW- address
  305. 08.12.1999 -    Seventh release on Aminet
  306.         * Fixed installer script bug
  307. 26.03.2000 -    Eigth release on Aminet
  308.         * Added HTML 4.01 support
  309.  
  310.  
  311.  
  312. Todo
  313. ----
  314.  
  315. - Uninstaller
  316. - Add TM3 prefs by Installer script
  317. - Accept multiple files as arguments
  318. - Accept pattern matching
  319. - Scan directories recursivly
  320. - MUI Interface
  321.   * Load the HTML document and highlight the problems
  322.   * Drop HTML documents onto an appicon
  323.  
  324.  
  325.  
  326. Known problems
  327. --------------
  328.  
  329. - Netscape or Microsoft extensions are not supported - you can add them by
  330.   yourself to the DTD, but CheckHTML will only support official standards!
  331.   You can find some DTDs at http://www.webtechs.com/
  332.  
  333. - The components of CheckHTML are placed in various directories and not in
  334.   only one. This happens to be the rules of AmigaOS and SGML.
  335.   Within the 'SGML:' directory only SGML documents and DTDs should be placed.
  336.   CheckHTML is placed in 'S:' because this is the place for Amiga Shell
  337.   scripts - for the same reason 'sgmls' is placed into 'C:'.
  338.   By running the installer script in expert modus you can change the
  339.   destinations for all files.
  340.  
  341. - Some of you wrote that they can't download the CheckHTML archive from
  342.   Aminet - this is a problem of your local mirror - and not a problem of
  343.   the CheckHTML release.
  344.  
  345. - You can't redirect the output of CheckHTML to a file, because this is
  346.   what sgmls sends to stderr.
  347.  
  348. - CheckHTML can generate English output only as long as sgmls is not
  349.   localized (very difficult task!)
  350.  
  351. - When CheckHTML won't run, try to set the script flag for it.
  352.  
  353. - HTML 4.0 is based on ISO10646 16bit characters - CheckHTML only supports
  354.   ISO8859-Latin1 8bit characters for now, don't worry, because this is
  355.   backward compatible!
  356.  
  357.  
  358.  
  359. Acknowledgments are going to the following people:
  360.  
  361. Rita Reichl         : for correcting my English and being my inspiration
  362.  
  363. James Clark         : for the famous sgmls parser
  364. People at Cern      : for HTML
  365. W3 Consortium       : for the standardized HTML DTDs
  366. Udo Schuermann      : for WrapGuide
  367. Stefan Kost         : for ag2txt
  368. Fabio Rotondo       : for CheckLink
  369. Thorsten Willert    : for CompressHTML
  370. Thomas Newsom       : for reporting an installer script bug
  371.  
  372. James Cooper,
  373. Steve Krueger,
  374. Doug Walker         : For supporting SAS/C® after SAS suspends the support.
  375.  
  376. Martin Huttenloher  : for MagicWB
  377. Eric Gerard         : for his great icons
  378.  
  379.  
  380.  
  381. Please rate
  382. -----------
  383.  
  384. Please rate CheckHTML. To do so, send an email to
  385. aminet-server@wuarchive.wustl.edu with the following content:
  386.  
  387. RATE comm/www/CheckHTML.lha <num>
  388.  
  389. where <num> is a mark from 0..10 with 10 being the best.
  390. You can rate several programs in one mail.
  391.  
  392. Thank you!
  393.  
  394.  
  395.  
  396. References
  397. ----------
  398.  
  399. The SGML Handbook
  400. Charles F. Goldfarb
  401. First Edition
  402. Oxford University Press, Walton Street, Oxford (USA); 1990
  403. ISBN 0-19-853737-9
  404.  
  405. SGMLS - SGML Parser
  406. James Clark
  407. http://www.jclark.com/
  408. Amiga port by Dipl.-Inform. Kai Hofmann
  409. http://www.hofmann-int.de/products/amiga/sgmls.shtml
  410.  
  411. Webtechs
  412. http://www.webtechs.com/
  413. DTDs can be found here
  414.  
  415. W3C - World Wide Web Consortium
  416. http://www.w3.org/
  417.  
  418. Dipl.-Inform. Kai Hofmann's SGML page
  419. http://home.pages.de/~i07m/SGML.html
  420.  
  421. PhoneLog Standard
  422. http://www.hofmann-int.de/PhoneLog/
  423.  
  424.  
  425.  
  426.                  This product is based on or uses parts of
  427.  
  428.                      MagicWB - The Workbench Enhancer
  429.                      --------------------------------
  430.  
  431.                  Copyright © 1992-1997, Martin Huttenloher
  432.  
  433. If  you  use  and like this product you should very much consider to take a
  434. look  at  MagicWB,  which  is the authentic source of the style, colors and
  435. design  elements  contained  in  this  package.   It  features  hundreds of
  436. original  icons,  patterns, image-drawers,  dock-brushes and some specially
  437. designed  high-quality  fonts  to  improve the comfort & legibility of your
  438. daily Workbench session.
  439.  
  440. What  is  MagicWB?   MagicWB  is  a full replacement for the Graphical User
  441. Interface  of the Workbench and has become the standard visual interface on
  442. the  Amiga.  Over the last years MagicWB has received various merits and an
  443. overwhelming  response from Amiga magazines and users worldwide proclaiming
  444. it  "a  must  for  all  Amiga  users".   Even  commercial  applications are
  445. supporting the multi-colored look & style of MagicWB.
  446.  
  447. Get yourself the latest version of MagicWB and see for yourself the wonders
  448. it  can  do by automatically transforming your old and dull Amiga Workbench
  449. into  an impressive workstation environment that will be the envy of all PC
  450. Windows  and  Mac users.  Update yourself to the state-of-the-art workbench
  451. standard  everyone uses on the Amiga!  It is also your key to enjoy the new
  452. look & feel of many applications and other MWB add-ons and extensions.
  453.  
  454. MagicWB  is  distributed as shareware.  Get yourself the latest FREE PUBLIC
  455. RELEASE of MagicWB now:  It is called
  456.  
  457.                              ----------------
  458.                               MagicWB21p.lha
  459.                              ----------------
  460.  
  461. and  can  be found everywhere on Aminet (or your local BBS or public domain
  462. series).   Install it and witness the instant magic it performs on your old
  463. Amiga  Workbench.   Also  included  is the latest SASG registration program
  464. with which you can order and get the full registered version of MagicWB.
  465.  
  466.              If you want to order directly, feel free to send
  467.  
  468.                   DM 30.- or US$ 20.- (cash, no checks!)
  469.  
  470.                                     to
  471.  
  472.                             Martin Huttenloher
  473.                              Am Hochstraess 4
  474.                                D-89081 Ulm
  475.                                  Germany
  476.  
  477. You  may  also  choose  to visit the official MagicWB homepage on the world
  478. wide  web.   There you can find the latest news & support and even register
  479. your  MagicWB  online  (which is much more comfortable and faster). You can
  480. even  benefit  from  various  special offers & discounts for MagicWB if you
  481. order through our website!  Come and visit MagicWB at:
  482.  
  483.                           ----------------------
  484.                            http://www.sasg.com/
  485.                           ----------------------
  486.  
  487.               Save 20% by using the discounts on our website!
  488.  
  489.            Ordering online also saves you a lot of time and work!
  490.  
  491.  
  492.  
  493. WrapGuide is Copyright 1994-1995 Udo Schuermann
  494. All rights reserved
  495.