home *** CD-ROM | disk | FTP | other *** search
/ Aminet 33 / Aminet 33 - October 1999.iso / Aminet / util / misc / HTML-Creator.lha / HTML-Creator / HTML-Creator.doc < prev    next >
Encoding:
Text File  |  1999-07-12  |  11.1 KB  |  366 lines
  1.         ****************************
  2.         *                          *
  3.         *       Documentation      *
  4.         *            for           *
  5.         *    HTML-Creator V1.24    *
  6.         *                          *
  7.         *   © Martin Henke, 1998   *
  8.         *   All rights reserved.   *
  9.         *                          *
  10.         ****************************
  11.  
  12.  
  13.  
  14.    Introduction
  15.    ============
  16.  
  17. Do you know the problem? You want to clearly arrange a lot of graphics in
  18. HTML-documents (e.g. for a CD-ROM) and don't like to do all this work by hand?
  19. Lean back, that's no longer necessary. Now there's `HTML-Crator'. `HTML-Creator'
  20. is no single program, but a program package with 4 programs, you execute one
  21. after the other. Because you might hardly wait, let's begin!
  22. The programs have been placed how they have to be executed (from the top to
  23. the bottom).
  24.  
  25. Notice: A word in pointed brackets (e.g. <RETURN>) means you have to press
  26.     a button.
  27.  
  28.  
  29.    Requirements
  30.    ------------
  31.  
  32. Amiga with OS 2.0, 1 MB of memory
  33. `Viewtek' (`VT') © Thomas Krehbiel, 1992-1994
  34.  
  35.  
  36.  
  37.    Installation
  38.    ------------
  39.    
  40. Just copy the directory `HTML-Creator' on any drive you like.
  41.  
  42.  
  43.    Tool Types
  44.    ----------
  45.    
  46. You can set your national language. This is currently German and English.
  47. Just enter DEUTSCH or ENGLISH.
  48. If no Tool Type is set or it is in brackets, e.g. (DEUTSCH), English is set
  49. as a standard.
  50.  
  51.  
  52.  
  53.    Tip for beginners:
  54.    ------------------
  55.  
  56.  You reach the Tool Types, if you click once on the icon and select
  57.  `Information...' from Workbench's `Icons' menu. Now click on `New' and enter
  58.  the desired language (DEUTSCH or ENGLISH) and press <RETURN>.
  59.  Now click on `Save' and the selected program will display its messages in
  60.  German or English.
  61.  
  62.  
  63.  
  64. !!  Directory layout  !! (s. Verz.aufbau.iff)
  65.     ================
  66.  
  67. `HTML-Creator' expects this directory layout as a standard:
  68.  
  69.  
  70.     [root directory]
  71.            |
  72.       graphics directory
  73.            |
  74.       graphics directory2----subdirectory
  75.            |
  76.       graphics directory..n
  77.            |
  78.          ICONS--+
  79.             |
  80.           graphics directory
  81.             |
  82.           graphics directory2----subdirectory
  83.             |
  84.           graphics directory..n
  85.  
  86.  
  87. - The root directory can be any path (e.g. DH1:, WORK:, WORK:graphics/Test,...)
  88.  
  89. - The graphics directory MUST be in the root directory.
  90.   Max. 1 subdirectory is allowed.
  91.  
  92. - There MUST be a directory named ICONS. In the directory 'ICONS' must be the
  93.   same directory structure like in the root directory, which means that a
  94.   directory 'graphics_dir' must exist, if it exists in the [root directory].
  95.   If there's a subdirectory in the directory 'graphics_dir' it has also to
  96.   exist in 'ICONS/graphics_dir'.
  97.   
  98.  
  99.  
  100. !!  Graphic formats  !!
  101.     ===============
  102.  
  103. `HTML-Creator' has been written by me to create a PC-compatible CD-ROM. This
  104. is the reason, why all files in the directory 'ICONS' are recognized as
  105. GIF files (#?.GIF) (even if this is not true). Due to compatibility you should
  106. use JPG, GIF and PNG as graphic formats anyway.
  107.  
  108.  
  109.  
  110.   Usage
  111.   =====
  112.  
  113.  
  114. I. '   CREATE_Dir-List'
  115.    --------------------
  116.  
  117. 1. Start the program '   CREATE_Dir-List'.
  118.  
  119. 2. Enter the path, where you keep the directories with the graphics
  120.    (e.g. 'Graphicsdisk:Test').
  121.  
  122. 3. Enter the directory in this path (e.g. 'graphics1'). So the graphics are
  123.    in the path 'Graphicsdisk:Test/graphics1'.
  124.  
  125. 4. If the graphics are within a subdirectory type a <Y>, when you're asked
  126.    'Does a subdirectory exist? y/n', else type <N>.
  127.    If you entered "Y", you can enter the subdirectory (e.g. 'subdir1'). So
  128.    the graphics are within the path 'Graphicsdisk:Test/graphics1/subdir1'.
  129.    Further directory levels are not supported by `HTML-Creator'.
  130.  
  131. 5. If the name of the HTML file shall differ type a <Y>, when you're asked
  132.    'Shall the pages' name differ from the directories' name? y/n', else type
  133.    <N>.
  134.    If you entered "Y" you can enter the new page name.
  135.  
  136. 6. If your last entry was a subdirectory you are asked if there's another
  137.    subdirectory in the directory (e.g. 'Graphicsdisk:Test/graphics1').
  138.    Type a <Y> if this is true, else type a <N>.
  139.  
  140. 7. Now you're asked, if you want to quit. If you enter a <Y> the program will
  141.    exit at once. If you enter a <N> the program continues with topic 2.
  142.  
  143.  
  144.  
  145. Ia. Files created from `   CREATE_Dir-List'
  146.     ---------------------------------------
  147.  
  148.    Now `CREATE_Dir-List' created 4 files (`   CREATE_Lists',
  149.    `   CREATE_ListsII', `  Sort_ListsII' and `directories.txt'.
  150.    
  151.    These files, except `directories.txt' are batch files, which means that
  152.    they contain commands AmigaDOS executes one after the other.
  153.  
  154. 1. If you started the AmigaBASIC version, select `Update' from the `Window'
  155.    menu.
  156.  
  157. 2. Now start `   CREATE_Lists' with a double click. The window `Execute A File'
  158.    opens with the entry "   CREATE_Lists". Now move the cursor to the left and
  159.    enter 'EXECUTE '. Click on `OK' and `   CREATE_Lists' will be executed.
  160.  
  161. 3. Handle the file `   CREATE_ListsII' the same way like
  162.    described in topic 2.
  163.  
  164.  
  165.  
  166. II. `   Swap_ListsII'
  167.     -----------------
  168.  
  169.    Now start `   Swap_ListsII'. `   Swap_ListsII' works completely automatically
  170.    and swaps all entries in the files created by `   CREATE_ListsII'
  171.    (`ram:#?2.txt'). `   Swap_ListsII' will create new files (`ram:#?.icon.txt').
  172.  
  173.  
  174.  
  175. III. `  Sort_ListsII'
  176.      ----------------
  177.  
  178.     Now start `  Sort_ListsII'. This batch file works completely automatically.
  179.     The files created from `   Swap_ListsII' will be sorted by the 'sort'
  180.     command. Unfortunately 'sort' recognizes the umlauts Ä,ä,Ö,ö,Ü,ü and ß
  181.     as own characters and not as Ae, ae, Oe, oe, Ue, ue and ss. So you should
  182.     avoid these characters in file names.
  183.  
  184.  
  185.  
  186. IV. ` CREATE_HTM's'
  187.     ---------------
  188.     
  189. 1. Start the program ` CREATE_HTM's'.
  190.  
  191. 2. Enter the path the HTML files have to be stored. It is recommended to use
  192.    the same path as in I.2.
  193.  
  194. 3. ` CREATE_HTM's' asks, if you would like to use a background picture for
  195.    your pages. Please notice, that the background picture will be the same
  196.    for all pages. If you enter 'Y' you will be asked for the picture name.
  197.    The picture must be within the path entered in topic 2 (subdirectories
  198.    are allowed). After the input the program continues with topic 4.
  199.    If you entered 'N' the program continues with topic 4.
  200.    
  201. 4. ` CREATE_HTM's' will create the HMTL files for the graphic files as a file
  202.    `INDEX.HTM', which contains links to the other HTML files.
  203.  
  204.      
  205.  
  206. V. 'DOS'
  207.    -----
  208.  
  209.    The program 'DOS' is only required, if you want to check, whether the
  210.    file names are MS-DOS compatible or not.
  211.    Use it this way:
  212.  
  213. 1. Open a Shell.
  214.  
  215. 2. Change to the desired [root directory], e.g. 'Graphicsdisk:Test' using
  216.    cd Graphicsdisk:Test <RETURN>
  217.  
  218. 3. Enter:
  219.    list #?/#? >ram:List.txt <RETURN>
  220.  
  221.    This lists the graphic files within the directories and writes the output
  222.    into the file `List.txt' on the "Ram Disk".
  223.  
  224. 4. Enter:
  225.    list #?/#?/#? >>ram:List.txt <RETURN>
  226.  
  227.    This lists the graphic files within the subdirectories and writes the output
  228.    into the file `List.txt' on the "Ram Disk".
  229.  
  230.  
  231. 5. Start `DOS' and enter:
  232.    ram:Liste.txt <RETURN>
  233.  
  234. 6. Now 'DOS' checks the files listed in the file 'List.txt' you stored on the
  235.    "Ram Disk". The result will be stored into the file 'Errors.txt' on the
  236.    "Ram Disk".
  237.  
  238.  
  239.  
  240. VI.`Dateigröße' (Filesize)
  241.    ------------
  242.  
  243.   This program is not required for the creation. It does only show how many
  244.   files are within the specified directories and how much space the files in
  245.   them require.
  246.   Use it this way:
  247.  
  248. 1. Open a Shell.
  249.  
  250. 2. Change to the desired [root directory], e.g. 'Graphicsdisk:Test' using
  251.    cd Graphicsdisk:Test <RETURN>
  252.  
  253. 3. Enter:
  254.    list #?/#? >ram:List.txt <RETURN>
  255.  
  256.    This lists the graphic files within the directories and writes the output
  257.    into the file `List.txt' on the "Ram Disk".
  258.  
  259. 4. Enter:
  260.    list #?/#?/#? >>ram:List.txt <RETURN>
  261.  
  262.    This lists the graphic files within the subdirectories and writes the output
  263.    into the file `List.txt' on the "Ram Disk".
  264.  
  265. This method has on disadvantage: If there are already thumbnails (within the
  266. `ICONS' directory, these will be listed as well. So you get more files than
  267. pictures present on the disk. If you do not want this, you have to name the
  268. directories by hand
  269. (e.g. list graphics1/#? >ram:List.txt <RETURN>)
  270.  
  271. 5. Start `Dateigröße' and enter:
  272.    ram:List.txt <RETURN>
  273.  
  274. The program reads the file List.txt and will display shortly after that the
  275. number of files and the required space.
  276.  
  277. VII. `Create_Index'
  278.      --------------
  279.  
  280. ~Create_Index' creates an index page as you might know from various ftp servers, which is a list of the file names/directories
  281. as links and information about the file size and attributes. The program requires a text file, which contains these informations.
  282. The textfile has to be made using the List command that way: List >filelist
  283. It is also possible to list only certain files: List #?.txt >filelist
  284. or to exclude files: List ~(#?(.html|.info)) >filelist
  285. If you want to append one file list to another you do it that way: List >>filelist
  286. After creating the file list you start `Create_Index'.
  287. Now the program asks you for the file name of the file list and the save path. There the file 'index.html' will be created.
  288. This name should not be changed, because the common WWW-browsers expect this name for directories.
  289.  
  290.  
  291.   History
  292.   =======
  293.  
  294.  V1.24 `Create_Index' added
  295.        New address of the author
  296.  
  297.  V1.23 ` Create_HTM's' is able to use background pictures, now.
  298.        Now ` Create_HTM's' uses the <TR>-tag correctly. (Just a little
  299.        error, that did not really matter.)
  300.  
  301.  V1.22a New eMail address. (s. 'The author')
  302.     No further changes.
  303.  
  304.  V1.22 Bugfix of V1.2. ` CREATE_HTM's' had problems with subdirectories.
  305.        Error 62 should not appear anymore.
  306.  
  307.  V1.21 Bugfix of V1.2. `DOS' did not add the errors found correctly.
  308.        Now `DOS' does not show any 5th line anymore, but the line currently
  309.        processed.
  310.        'Error 53' has been replaced by 'File not found.'.
  311.  
  312.  V1.2  Bugfix of V1.1. `Dateigröße' did not use its error management.
  313.        Created Program `DOS'.
  314.  
  315.  V1.1  Bugfix of V1.01. `Dateigröße' did not read all files in the directory.
  316.        Added English outputs.
  317.        Added Tool Types DEUTSCH and ENGLISH.
  318.        Created English documentation.
  319.  
  320.  V1.01 Bugfix of V1.0. `INDEX.HTM' was not being closed correctly, so Netscape
  321.        Navigator 3.0 could not display the page.
  322.  
  323.  V1.0  First version (programmed in AmigaBASIC,
  324.        compiled with Cursor © Jürgen Forster)
  325.  
  326.  
  327.  
  328.   Future
  329.   ======
  330.  
  331.  Maybe I'll write a C-Version, that does all the stuff internally.
  332.  
  333.  
  334.  
  335.   Disclaimer
  336.   ==========
  337.   
  338.  The program package `HTML-Creator' is not PD, nor Freeware or Shareware.
  339.  
  340.  The author is not responsible for any damage, that may occur directly or
  341.  indirectly, if you used `HTML-Creator'.
  342.  
  343.  If you want to use `HTML-Creator' to create HTML pages for storage media that
  344.  are for commercial use or those that are not for own use you need a written
  345.  permission from the author.
  346.  
  347.  `HTML-Creator' may appear without written permission only on the
  348.  `AMINET'-CD-ROMs.
  349.  
  350.  The source code may be altered for own use. The altered versions may not
  351.  be distributed.
  352.  
  353.  MS-DOS is Copyright, Microsoft Corp.
  354.  AmigaBASIC is Copyright, Microsoft Corp.
  355.  
  356.  
  357.  
  358.  The Author
  359.  ==========
  360.  
  361.  Martin Henke
  362.  Oelinghovener Str. 2
  363.  D-53639 Koenigswinter
  364.  
  365.  eMail: m.henke@01019freenet.de
  366.