home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / htmlg120.zip / htmlgen.HLP (.txt) < prev    next >
OS/2 Help File  |  1996-03-18  |  20KB  |  562 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. HTMLGen - An Overview ΓòÉΓòÉΓòÉ
  3.  
  4.  HTMLGen is a HTML script generator for OS/2. 
  5.  
  6. HTML scripts are used to generate Home Pages for World Wide Web browsers. 
  7.  
  8. HTMLGen provides a simple method for generating scripts.  By selecting the 
  9. appropriate tag, a dialog box will pop-up to gather data and fill in the 
  10. script. 
  11.  
  12.  
  13. ΓòÉΓòÉΓòÉ 2. Adding To Desktop ΓòÉΓòÉΓòÉ
  14.  
  15.  To place the program on your WPS Desktop use the following rexx script. 
  16.  
  17.   /* Place HTMLGen on Your Desktop */
  18.   rc = RxFuncAdd("SysLoadFuncs","RexxUtil","SysLoadFuncs")
  19.   rc = SysLoadFuncs()
  20.   rc = SysCreateObject("WPProgram","HTMLGen","","exename="||directory()||"\htmlgen.exe")
  21.   rc = SysSetIcon(directory()||"\htmlgen.exe","htmlgen.ico")
  22.  
  23.  
  24. ΓòÉΓòÉΓòÉ 3. Register ΓòÉΓòÉΓòÉ
  25.  
  26. REGISTRATION FORM FOR HTMLGen Version 1.20
  27.  
  28. Registration fee is $45.00 per copy.
  29.  
  30. North Carolina residents must include sales tax.
  31. In USA and Canada add $5.00 for shipping/handling.
  32. All other international shipments add $10.00.
  33.  
  34. See other documentation.
  35.  
  36. Send to: HTMLGen 1.20
  37.          American Coders, LTD
  38.          P.O. Box 97462
  39.          Raleigh, NC  27624
  40.  
  41. Name:______________________________________      Phone: ____________
  42. Company: ___________________________________     Phone: ____________
  43. Address: ___________________________________________________________
  44.          ___________________________________________________________
  45. City: _________________________    State: ______  Zip: _____________
  46.  
  47. InterNet ID: _____________________________________________________
  48.  
  49. Where did you find HTMLGen: _______________________________________
  50.  
  51. Registered users get a 30 day money back guarantee, 60 days free telephone
  52. support, unlimited support on CompuServe, free upgrades to the next release,
  53. and the VisPro/Rexx source code.
  54.  
  55. Internet: joe@usacoder.rtp.nc.us
  56.  
  57. CompuServe ID:  74150,2370
  58. CompuServe Support: GO OS2SHARE
  59.  
  60. Phone: (919) 846-2014.
  61.  
  62.  
  63. ΓòÉΓòÉΓòÉ 4. Cut and Paste ΓòÉΓòÉΓòÉ
  64.  
  65.  OS/2 Cut and Paste functions to the OS/2 clip-board are available. 
  66.  
  67. Cut       Press CTRL-Delete. To place mark text into the clipboard and remove 
  68.           it from the script area. Or use menu function from the Edit pull 
  69.           down. 
  70.  
  71. Copy      Press CTRL-Insert. To copy the marked area to the clip-board.Or use 
  72.           menu function from the Edit pull down. 
  73.  
  74. Paste     Press Shift-Insert to copy clip-board text at the cursors position. 
  75.           Or use menu function from the Edit pull down. 
  76.  
  77. Marking Text To Cut and Copy Press Shift and use the arrow keys to mark pieces 
  78.           of text in the script area. 
  79.  
  80.  
  81. ΓòÉΓòÉΓòÉ 5. Primary Window Menu ΓòÉΓòÉΓòÉ
  82.  
  83.  There are several window menus to simplify your job. 
  84.  
  85.  
  86. ΓòÉΓòÉΓòÉ 5.1. File ΓòÉΓòÉΓòÉ
  87.  
  88.  The file pull down provides access to OS/2 file system. 
  89.  
  90.  
  91. ΓòÉΓòÉΓòÉ 5.1.1. Open ΓòÉΓòÉΓòÉ
  92.  
  93.  Open will load the script area with an existing.  Any text in the script area 
  94. will be lost. 
  95.  
  96.  
  97. ΓòÉΓòÉΓòÉ 5.1.2. New ΓòÉΓòÉΓòÉ
  98.  
  99.  This will restart a script by removing existing text. 
  100.  
  101.  
  102. ΓòÉΓòÉΓòÉ 5.1.3. Save ΓòÉΓòÉΓòÉ
  103.  
  104.  This will save the script area to a file.  If a filename has not been defined 
  105. the File dialog will pop-up. 
  106.  
  107.  
  108. ΓòÉΓòÉΓòÉ 5.1.4. Save As ΓòÉΓòÉΓòÉ
  109.  
  110.  This will save the script area to a file. The File dialog will pop-up. 
  111.  
  112.  
  113. ΓòÉΓòÉΓòÉ 5.1.5. Insert Text ΓòÉΓòÉΓòÉ
  114.  
  115.  This will insert text from another file into the script area. Text in the 
  116. existing area will not be lost. 
  117.  
  118.  
  119. ΓòÉΓòÉΓòÉ 5.1.6. Browser ΓòÉΓòÉΓòÉ
  120.  
  121.  This will load the current text area to the defined file and call the Web 
  122. Browser you have defined on your system. 
  123.  
  124.  
  125. ΓòÉΓòÉΓòÉ 5.1.7. IPF Build ΓòÉΓòÉΓòÉ
  126.  
  127.  This will translate your HTML script into the IPF format. IPF is used by the 
  128. IBM IPFC compiler to generate INF and HLP files. 
  129.  
  130. IPFC compiler is not provide with HTLMGen. 
  131.  
  132.  
  133. ΓòÉΓòÉΓòÉ 5.1.8. Editor ΓòÉΓòÉΓòÉ
  134.  
  135.  This will load the current text area to the defined file and call an editor 
  136. you have defined. 
  137.  
  138.  
  139. ΓòÉΓòÉΓòÉ 5.1.9. Exit ΓòÉΓòÉΓòÉ
  140.  
  141.  This will exit the program.  Short-cut key is F3. 
  142.  
  143.  
  144. ΓòÉΓòÉΓòÉ 5.2. Edit ΓòÉΓòÉΓòÉ
  145.  
  146.  There are eight options provided to simplify editting the HTML text. 
  147.  
  148.  
  149. ΓòÉΓòÉΓòÉ 5.2.1. Copy ΓòÉΓòÉΓòÉ
  150.  
  151.  Copies marked text to clip board. 
  152.  
  153.  
  154. ΓòÉΓòÉΓòÉ 5.2.2. Cut ΓòÉΓòÉΓòÉ
  155.  
  156.  Copies marked text to clip board and deletes it. 
  157.  
  158.  
  159. ΓòÉΓòÉΓòÉ 5.2.3. Paste ΓòÉΓòÉΓòÉ
  160.  
  161.  Copies clip board to current cursor position. 
  162.  
  163.  
  164. ΓòÉΓòÉΓòÉ 5.2.4. Delete ΓòÉΓòÉΓòÉ
  165.  
  166.  Deletes marked  text. 
  167.  
  168.  
  169. ΓòÉΓòÉΓòÉ 5.2.5. Undo ΓòÉΓòÉΓòÉ
  170.  
  171.  Undoes last change to text.  One-level only 
  172.  
  173.  
  174. ΓòÉΓòÉΓòÉ 5.2.6. Search ΓòÉΓòÉΓòÉ
  175.  
  176.  Brings up Search dialog to find and change text. 
  177.  
  178.  
  179. ΓòÉΓòÉΓòÉ 5.2.7. Find Next ΓòÉΓòÉΓòÉ
  180.  
  181.  Find text as specified in search dialog. 
  182.  
  183.  
  184. ΓòÉΓòÉΓòÉ 5.2.8. Change Next ΓòÉΓòÉΓòÉ
  185.  
  186.  Changes text as specified as specified in search dialog. 
  187.  
  188.  
  189. ΓòÉΓòÉΓòÉ 5.3. Options ΓòÉΓòÉΓòÉ
  190.  
  191.  There are three options to provide HTMLGen with Browser/Editor and Text 
  192. prompting indicators. 
  193.  
  194.  
  195. ΓòÉΓòÉΓòÉ 5.3.1. Browser Defined ΓòÉΓòÉΓòÉ
  196.  
  197.  Will pop-up a dialog box asking for the command to load your Web browser. 
  198.  
  199.  
  200. ΓòÉΓòÉΓòÉ 5.3.2. Editor Defined ΓòÉΓòÉΓòÉ
  201.  
  202.  Will pop-up a dialog box asking for the command to load your editor. 
  203.  
  204.  
  205. ΓòÉΓòÉΓòÉ 5.3.3. Text Prompting ΓòÉΓòÉΓòÉ
  206.  
  207.  This will turn-on/off the dialog boxes when the Tagging functions are used. 
  208.  
  209.  
  210. ΓòÉΓòÉΓòÉ 5.3.4. IPF Conversion Options ΓòÉΓòÉΓòÉ
  211.  
  212.  There are three options available for the IPFC Conversion. 
  213.  
  214. RES for Headings  Turn this on and a resource number will be assigned to each 
  215. heading. This is useful for creating HLP files.  HLP files work with PM Help 
  216. functions.  Resources are associated with PM items such when F1 is pressed when 
  217. the cursor is on a button, defining the HELP push button, etc... 
  218.  
  219. Index for Headings  Turn this on and each heading will have a IPF index 
  220. assigned to it. For the Heading 1, only an I1 tag is created.  For all other 
  221. headings an I1 tag is created and an I2 tag with a reference to the previous I1 
  222. tag.  Indexes define what shows up in the INDEX for your both HLP and INF 
  223. files. 
  224.  
  225.  
  226. ΓòÉΓòÉΓòÉ 5.3.5. Edit Macros ΓòÉΓòÉΓòÉ
  227.  
  228.  This provides a dialog box to maintain your macros.  Prompts are shown in the 
  229. macro list and text is entered into the macro list when the prompt is 
  230. double-clicked. 
  231.  
  232. Macros are maintained an editable file HTMLGEN.MAC. The format is rather 
  233. simple.  A keyword "PROMPT:" is used to indicate a new macro. Text on the same 
  234. line as "PROMPT:" is used for the macro prompt. All text following the prompt 
  235. is considered to be macro "text" that is inserted into the HTML document when 
  236. the prompt is double-clicked. 
  237.  
  238.  
  239. ΓòÉΓòÉΓòÉ 5.4. Tags ΓòÉΓòÉΓòÉ
  240.  
  241.  Tags are the identifies for the browser on how to display and format text, 
  242. pull in external files, and layout the general document. 
  243.  
  244.  
  245. ΓòÉΓòÉΓòÉ 5.4.1. Headings ΓòÉΓòÉΓòÉ
  246.  
  247. Title  <Title> </Title> The Title Tag describes the title of the HTML Document 
  248.  
  249. Heading 1 <H1> </H1> The Heading 1 Tag marks the highest level sections in the 
  250.           document. Its text and font are the same size as the TITLES.  Think 
  251.           of Heading 1 Tags as chapter indicators. 
  252.  
  253.           Short-Cut Key is Ctrl-1. 
  254.  
  255. Heading 2 <H2> </H2> The Heading 2 Tag marks the second highest level sections 
  256.           within a Heading 1 section. Its text and font are smaller than a 
  257.           Heading 1.
  258.  
  259.           Short-Cut Key is Ctrl-2. 
  260.  
  261. Heading 3 <H3> </H3> The Heading 3 Tag marks the third highest level sections 
  262.           in a document and follows a Heading 2 section. Its text and font are 
  263.           smaller than a Heading 2.
  264.  
  265.           Short-Cut Key is Ctrl-2. 
  266.  
  267. Heading 4 <H4> </H4> The Heading 4 Tag marks the fourth highest level sections 
  268.           in a document and follows a Heading 3 section. Its text and font are 
  269.           smaller than a Heading 3.
  270.  
  271.           Short-Cut Key is Ctrl-3. 
  272.  
  273. Heading 5 <H5> </H5> The Heading 5 Tag marks the fifth highest sections and 
  274.           second lowest in a document and follows  a Heading 4 section. Its 
  275.           text and font are smaller than a Heading 4.
  276.  
  277.           Short-Cut Key is Ctrl-5. 
  278.  
  279. Heading 6 <H6> </H6> The Heading 6 Tag marks the lowest sections in a document 
  280.           and follows a Heading 5 section. Its text and font are smaller than a 
  281.           Heading 5.
  282.  
  283.           Short-Cut Key is Ctrl-6. 
  284.  
  285.  
  286. ΓòÉΓòÉΓòÉ 5.4.2. Lists ΓòÉΓòÉΓòÉ
  287.  
  288. Unordered Lists <UL> </UL> Unordered lists provide the ability to set off lists 
  289.           of text that are prefixed by bullets, dashes and filled circles. 
  290.           Unordered lists may be contained within other list types and may 
  291.           contain other list types.
  292.  
  293.           Short-cut key is Alt-u. 
  294.  
  295. Ordered Lists <OL> </OL> Ordered lists provide the ability to set off lists of 
  296.           text that are prefixed by a sequence of numbers.  Ordered lists may 
  297.           be contained within other list types and may contain other list types.
  298.  
  299.           Short-cut key is Alt-o. 
  300.  
  301. List Item (Order/Unordered List) <LI> </LI> List Item Tag provides an item 
  302.           within an Unordered or Order list. List Items must appear within an 
  303.           <UL> </UL> or <OL> </OL> block.
  304.  
  305.           Short-cut key is CTRL-i. 
  306.  
  307. Descriptive Lists <DL> </DL> Provides a list that contains a title and a 
  308.           description items.
  309.  
  310.           Short-cut key is Alt-d. 
  311.  
  312. Descriptive Title and Description. Descriptive Titles and Descriptions are used 
  313.           to mark informative areas of text. Descriptive Title and Text appear 
  314.           in pairs with in a <DL> </DL> block.
  315.  
  316.           Short-cut key is Ctrl-d. 
  317.  
  318.    Descriptive Title <DT> </DT> This provides for title for the following 
  319.              descriptive text. 
  320.  
  321.    Descriptive Description <DD> </DD> This provides a description used with the 
  322.              Descriptive Title. It may contain paragraphs, other lists and 
  323.              other information. 
  324.  
  325.  
  326. ΓòÉΓòÉΓòÉ 5.4.3. Blocks ΓòÉΓòÉΓòÉ
  327.  
  328. Preformatted Text <PRE> </PRE> The preformatted tag marks text for fixed-width 
  329.           font with carriage returns, spaces and tabs kept in place.  This 
  330.           section may contain other tags.
  331.  
  332.           Short-cut key is Alt-p. 
  333.  
  334. Quoted Text <BLOCKQUOTE> </BLOCKQUOTE> The block quote tag marks text for 
  335.           fixed-width font with carriage returns, spaces and tabs kept in 
  336.           place.  This section may contain other tags.
  337.  
  338.           Short-cut key is Alt-q. 
  339.  
  340. Address <ADDRESS> </ADDRESS> The address tags is used to describe the author of 
  341.           the document.  It is usually the last item in the document.  This 
  342.           section may contain other tags.
  343.  
  344.           Short-cut key is Alt-a. 
  345.  
  346. Anchor Name <A> </A> The anchor name text provides to ability for other 
  347.           sections of the document to refer back to this section of text. 
  348.  
  349.           Short-cut key is Alt-n. 
  350.  
  351. Anchor Reference <A HREF=> </A> The anchor name text provides to ability to 
  352.           refer back to another section of text mark by an anchor name. 
  353.  
  354.           Short-cut key is Alt-r. 
  355.  
  356.  
  357. ΓòÉΓòÉΓòÉ 5.4.4. Formats ΓòÉΓòÉΓòÉ
  358.  
  359.  Formats provide changing the fonts of text.
  360.  
  361. o ITALICS 
  362.  
  363.    - Italics <I> </I> - Short-cut key is Ctrl-i. 
  364.  
  365.    - Emphasized Italics <em> </em> - Short-cut key is Ctrl-e. 
  366.  
  367.    - Citation <cite> </cite> - Short-cut key is Ctrl-c. 
  368.  
  369.    - Variable <var> </var> - Short-cut key is Ctrl-i. 
  370.  
  371. o BOLDS 
  372.  
  373.    - Bold <b> </b> - Short-cut key is Ctrl-b. 
  374.  
  375.    - Strong bold <strong> </strong> - Short-cut key is Ctrl-s. 
  376.  
  377. o MONO-SPACED 
  378.  
  379.    - Typewriter <TT> </TT> - Short-cut key is Ctrl-t. 
  380.  
  381.    - Code <CODE> </CODE> - Short-cut key is Ctrl-C. 
  382.  
  383.    - Sample <SAMP> </SAMP> - Short-cut key is Ctrl-s.. 
  384.  
  385.    - Keyboard <KDB> </KBD> - Short-cut key is Ctrl-k. 
  386.  
  387. o Definition <DFN> </DFN> - Short-cut key is Ctrl-d. 
  388.  
  389.    May not work with some Mosaic browsers. 
  390.  
  391.  
  392. ΓòÉΓòÉΓòÉ 5.4.5. Special Characters ΓòÉΓòÉΓòÉ
  393.  
  394. o 'Less Than' character '<' is <. 
  395.  
  396. o 'Greater Than' character '>' is >. 
  397.  
  398. o 'Ampersand' character '&' is &. 
  399.  
  400. o The paragraph marker indicates a new paragraph. <P> </P> - can be used to 
  401.   indicate an end of a paragraph block. Short-cut key is Ctrl+Enter. 
  402.  
  403.  
  404. ΓòÉΓòÉΓòÉ 5.4.6. Images ΓòÉΓòÉΓòÉ
  405.  
  406. Inline Images <IMG SRC=...> Provides inline GIF or x-systems XBM pictures to 
  407.           display within your the document. 
  408.  
  409.           Short-cut key is ALT-SHIFT-I. 
  410.  
  411. External Images <A HREF = ...>link anchor</A> Refers to GIF or XBM files that 
  412.           reside elsewhere. It also provides for referencing. See Anchors. 
  413.           Short-cut key is ALT-SHIFT-E. 
  414.  
  415.  
  416. ΓòÉΓòÉΓòÉ 6. Dialog Boxes ΓòÉΓòÉΓòÉ
  417.  
  418.  There are several dialog boxes to assist you in generating your HTML script. 
  419. These boxes can be disabled by turning off the Text Prompting off of options. 
  420. When Text Prompting is turned off, you are not prompted for text and the tag is 
  421. immediately inserted into the script.
  422.  
  423.  The titles of the dialog boxes will change depending on the tag being 
  424. generated and what type of work it is doing. 
  425.  
  426.  
  427. ΓòÉΓòÉΓòÉ 6.1. Desc Dialog Box ΓòÉΓòÉΓòÉ
  428.  
  429.  This box is used to define both the Descriptive Item Heading and Descriptive 
  430. Item Text.  This will generate the <DT> and </DD> tags.  If text is not entered 
  431. into either fields the tagged items are added to the script only, respectfully. 
  432.  
  433.  
  434. ΓòÉΓòÉΓòÉ 6.2. Ext Dialog Box ΓòÉΓòÉΓòÉ
  435.  
  436.  This box is used to define an external file anchor.  The dialog will generate 
  437. the <A HREF=xxxxx#yyyyy>zzzzz</A> tag.  Where xxxxx is the name of the external 
  438. (referenced) file, yyyyy is the named anchor and zzzzz is the text that will be 
  439. highlighted and provide linking. 
  440.  
  441.  
  442. ΓòÉΓòÉΓòÉ 6.3. Extern Dialog Box ΓòÉΓòÉΓòÉ
  443.  
  444.  This box is used to define an external image file and reference text. The 
  445. dialog will generate the <A HREF=xxxxx>zzzzz</A> tag.  Where xxxxx is the name 
  446. of the external(image file and zzzzz is the text that will be highlighted and 
  447. provide linking.
  448.  
  449.  The FIND button starts the PM Find File dialog to help you search for a file.
  450.  
  451.  Supported image files are 
  452.  
  453. o GIF 
  454.  
  455. o TIFF 
  456.  
  457. o JPEG 
  458.  
  459. o RGB 
  460.  
  461. o HDF 
  462.  
  463.  
  464. ΓòÉΓòÉΓòÉ 6.4. Inline Image Dialog Box ΓòÉΓòÉΓòÉ
  465.  
  466.  This box provides the IMG tag to alloc for XBM and GIF format images inside 
  467. your HTML document.  This tag is not recognized by all browsers. 
  468.  
  469. The FIND button starts the PM Find File dialog to help you search for a file. 
  470.  
  471. This window is also used to define files for browsers and editors. We took a 
  472. short cut here. This dialog box is multipurpose. 
  473.  
  474.  
  475. ΓòÉΓòÉΓòÉ 6.5. Single Line Dialog Box ΓòÉΓòÉΓòÉ
  476.  
  477.  This box is used for tags that use a single line of text, such as headers and 
  478. the address tags. 
  479.  
  480.  
  481. ΓòÉΓòÉΓòÉ 6.6. Anchor Dialog Box ΓòÉΓòÉΓòÉ
  482.  
  483.  The box will allow you to define an anchor title and text. It generates an <A> 
  484. </A> tag. 
  485.  
  486.  
  487. ΓòÉΓòÉΓòÉ 6.7. Simple Text Dialog Box ΓòÉΓòÉΓòÉ
  488.  
  489.  This box is used for tags that use multiple lines of text, such as tagging 
  490. formatted text or defining block quotes. The dialogs main item is a multi-line 
  491. edit field.  This field supports most of OS/2 cut and paste functions. 
  492.  
  493.  
  494. ΓòÉΓòÉΓòÉ 6.8. Tables ΓòÉΓòÉΓòÉ
  495.  
  496.  Several functions are available to assist in creating tables. 
  497.  
  498. Create    This kicks off a dialog for creating a complete definition for a 
  499.           table. All rows and columns are filled in based on response to the 
  500.           dialog. 
  501.  
  502. Header    This creates a tag for specifying a column heading in a table. <TH> 
  503.           </TH> 
  504.  
  505. Data      This creates a tag to indicate data in a column row. <TD> </TD> 
  506.  
  507. Row       This inserts a new row tag in the dialog <TR>. 
  508.  
  509.  
  510. ΓòÉΓòÉΓòÉ 7. History Of Changes ΓòÉΓòÉΓòÉ
  511.  
  512.  HTMLGen 1.20  A HTML Script Generator 
  513.  
  514.  History of changes. 
  515.  
  516.  1. Version 1.20 Mar. 15, 1996 
  517.  
  518.    o Improved editor 
  519.  
  520.    o Added tables to tags. 
  521.  
  522.    o Rearranged screen layout. 
  523.  
  524.  2. Version 1.10 Aug. 15, 1995 
  525.  
  526.    o Added user-defined macro support. 
  527.  
  528.    o Added a backslash to the end of the special characters & . 
  529.  
  530.  3. Version 1.05 Jan. 31, 1995 
  531.  
  532.    o Corrected problem with data entry fields being too short or not usable. 
  533.  
  534.    o Improved help. 
  535.  
  536.    o Allowed both HTML script and IPF script screens to be re-sizable. 
  537.  
  538.  4. Version 1.04 Jan. 25, 1995 
  539.  
  540.    o Corrected problem with files, i.e. your browser, being corrupted 
  541.  
  542.    o Enlarged field lengths. 
  543.  
  544.    o Corrected problem with some tags. 
  545.  
  546.  5. Version 1.03 Jan. 21, 1995 
  547.  
  548.    o Integrated Browser/Editor programs. 
  549.  
  550.    o Added INI file. 
  551.  
  552.    o Improved IPF converter. 
  553.  
  554.  6. Version 1.02 Jan. 14, 1995 
  555.  
  556.    o First general release. 
  557.  
  558.  
  559. ΓòÉΓòÉΓòÉ 8. Author's Address and Information. ΓòÉΓòÉΓòÉ
  560.  
  561.  American Coders, LTD  joe@usacoder.rtp.nc.us (919) 846-2014 Copyright 1995 - 
  562. All rights reserved