home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 31 / CDASC_31_1996_juillet_aout.iso / internet / htmle93b.zip / HTMLED.DOC < prev    next >
Text File  |  1996-04-08  |  24KB  |  513 lines
  1.  
  2.  
  3.  
  4. HTML-Ed v0.93b
  5. (C) Copyright 1996, Ian Prest
  6. All Rights Reserved.
  7.  
  8.  
  9.    Thank you for trying this beta of HTML-Ed!  HTML-Ed is a full-featured
  10.    editor for HTML code.  HTML is the markup language used on the World
  11.    Wide Web.
  12.  
  13.    Note:  This is a BETA copy of HTML-Ed.  There may still be a few
  14.    buglets remaining in the program that I haven't found.  There are
  15.    currently no known bugs, but I'm sure they're present, so please backup
  16.    all your data before using the program just in case.
  17.  
  18.    This manual, like HTML-Ed itself, is in a constant state of
  19.    modification.  I will be improving it over the next few revisions of
  20.    HTML-Ed.
  21.  
  22.  
  23. The Features of HTML-Ed!
  24. ========================
  25.  
  26.    1. HTML-Ed, unlike other HTML editors, features a built-in viewer!  No
  27.       more waiting for WebExplorer to load; testing of HTML code is almost
  28.       instantaneous!  
  29.    2. HTML-Ed support all of the common HTML 2.0 tags (with the exception
  30.       of forms), and selected HTML 3.0 tags (background, colours, etc).
  31.    3. HTML-Ed is FAST!  It is written in pure C for speed.  Most other
  32.       HTML editors have been written in VX-REXX and you are therefore
  33.       stuck with poor VX-REXX performance.
  34.    4. HTML-Ed is SMALL!  It won't gobble megabytes of disk space, and
  35.       doesn't require much in the way of RAM to run.  The executable file
  36.       is currently hovering around the 60 kb mark!  Because HTML-Ed is so
  37.       small, starting multiple copies of it will not bring your system to 
  38.       its knees.
  39.    5. HTML-Ed has an intelligent keyboard interface.  Most of the common
  40.       tags are easily available from the keyboard.
  41.    6. HTML-Ed was designed with speed of use in mind.  Everything is
  42.       keyboard driven; there is no need to use the mouse.  There is
  43.       (currently) no graphical toolbar to get in the way.  
  44.    7. HTML-Ed is configurable.  You can toggle word-wrap, toggle the
  45.       loading of graphics (in TEST mode), change the font of the MLE, and
  46.       save the window position for future use.
  47.    8. Multi-File editing via a ring-type system (like EPM).
  48.  
  49.  
  50. Installation
  51. ============
  52.  
  53.    Installing HTML-Ed is easy.  Simply unzip the archive it came in
  54.    (HTMLE093B.ZIP) and move the files to a directory of your choice.
  55.    Then, change the current directory so that you're in the same directory
  56.    as HTML-Ed (this is important!  The program object will not be created
  57.    properly if you don't do this), and run the INSTALL.CMD file.  It will
  58.    ask you if you want to create a program object for HTML-Ed in this
  59.    directory.  Enter 'n' and ENTER if you want to quit, otherwise, press
  60.    'y' and ENTER.
  61.  
  62.    You will then be asked if you want to associate *.HTM?  files with
  63.    HTML-Ed.  If you answer yes to this question, any time you double-click
  64.    on an HTML file from the WPS, HTML-Ed will be started with that file.
  65.  
  66.    The install program will then Create a program object for you on the
  67.    desktop with the correct icon.  Then you can double-click on this icon
  68.    to start HTML-Ed.  Or, you can drag an HTML file (or any text file) to
  69.    the HTML-Ed program object, and HTML-Ed will start using that file.
  70.  
  71.  
  72. Starting HTML-Ed
  73. ================
  74.  
  75. From the command line:
  76.  
  77.    HTML-Ed accepts only one command-line parameter - a filename.  You can
  78.    tell HTML-Ed to load an HTML file by specifying the file to load on the
  79.    command line.  If you put HTML-Ed somewhere in your path, or you add 
  80.    the HTML-Ed directory to the path statement in CONFIG.SYS, using 
  81.    HTML-Ed from the command-line becomes very easy.
  82.  
  83.    As of v0.93b, HTML-Ed accepts multiple files and wildcards on the 
  84.    command-line.  They will all be loaded into the file ring.
  85.  
  86. From the desktop:
  87.  
  88.    After you create the program icon for HTML-Ed (see "Installation" for 
  89.    more information), you can start HTML-Ed is one of several ways. 
  90.    The easiest method is to simply double-click on the HTML-Ed icon. 
  91.    HTML-Ed will then start, and you will be able to edit a new document.
  92.  
  93.    Another method is to drag an HTML file to the HTML-Ed program icon.
  94.    HTML-Ed will then start and open the file you dragged to it.
  95.  
  96.    If, when you ran the installation program, you answered yes to the 
  97.    association question, you can simply double-click on any HTML file 
  98.    (with an extension of .HTM or .HTML) and HTML-Ed will start and load 
  99.    the file you double-clicked on.
  100.  
  101.  
  102. How to use HTML-Ed!
  103. ===================
  104.  
  105. The Menus
  106. ---------
  107.  
  108. File -    The FILE menu contains items pertaining to files.  You can open 
  109.           a file, create a new file, save the current file, or close the 
  110.           current file.  NOTE: The OPEN and NEW menu items will insert a 
  111.           new file into the file ring - they do NOT close the current 
  112.           file.  Also, under the file menu you will find:
  113.  
  114.  
  115.        CLOSE FILE      Closes the current file in the ring.  If the file 
  116.                        has been changed, you will first be prompted to 
  117.                        save it.  If this is the last file in the ring, 
  118.                        choosing "Close File" will exit HTML-Ed.
  119.        RING LEFT/RIGHT These commands move one file left or right in the 
  120.                        file ring.  See "The edit/file ring" for more 
  121.                        information.
  122.        FILE RING       This menu option will bring up a dialog that 
  123.                        displays a listbox with all the files in the edit 
  124.                        ring.  You can switch to another file by selecting 
  125.                        one with the arrow keys and clicking on OK.  EXIT 
  126.                        Exits HTML-Ed.  If any files have been changed, you
  127.                        will be prompted before exiting.
  128.  
  129. Edit -    From the EDIT menu you can CUT, COPY, PASTE, or CLEAR, marked 
  130.           text, or UNDO the last action.  Also, you can:
  131.  
  132.        SELECT ALL      Selects all the text in the editor.  The cursor is   
  133.                        moved to the end of the text.
  134.        DESELECT ALL    Unselects any selected text.  The cursor is not   
  135.                        moved.
  136.        CONVERT \ TO /  Converts all DOS-style backslashes to UNIX-style 
  137.                        forward slashes in the selected text.  NOTE:  You 
  138.                        MUST use forward slashes, even for local viewing, 
  139.                        or the TEST window may not load the correct 
  140.                        graphic, or link to the correct page.
  141.        CONVERT TAGS    You can convert all HTML tags in the selected text 
  142.                        to uppercase or lowercase.
  143.        REMOVE TAGS     Removes any HTML tags in the selected text (removes
  144.                        anything between '<' and '>').
  145.  
  146. Search -  
  147.  
  148.        SEARCH          Allows you to search for a text string in the 
  149.                        current file.  
  150.        REPLACE         Allows you to replace a text string in the current 
  151.                        file with another.
  152.        FIND NEXT       Repeats the last search or replace command.
  153.        GO TO LINE      Allows you to jump to s specific line in the 
  154.                        current file.
  155.  
  156. Options - The first two menu items in the OPTIONS menu are toggles.  The      
  157.           first is a word-wrap toggle for the  editor.  The second, the       
  158.           "Load Graphics" option, toggles whether or not you wish to load       
  159.           graphics when you TEST your HTML code.  Not viewing graphics         
  160.           will speed up the display, and allow you to get an
  161.           approximate idea of what the page would look like without
  162.           graphics.
  163.  
  164.           Note that word wrap is enabled/disabled for the current file
  165.           only, and when new files are entered into the ring, they 
  166.           inherit the word wrap style of the current file.
  167.  
  168.           The third menu item is a submenu, and allows you to change       
  169.           the font used in the MLE.  There are currently five choices.
  170.  
  171.           The "Registration" menu option will bring up the registration       
  172.           dialog.  In this dialog, you can enter your name, and the       
  173.           Registration Code you receive upon registration.  If the code is
  174.           accepted, HTML-Ed will no longer pause on startup, and when you      
  175.           quit.
  176.  
  177.           The final choice under the OPTIONS menu, "Save Options/Position"       
  178.           allows you to save your pre-set options, and the current window       
  179.           position for future sessions.
  180.  
  181. Page -    The PAGE and STYLE menus are where you will spend most of your       
  182.           time.  The PAGE menu contains tags that affect the layout of the
  183.           text, such as lists, the paragraph tag, etc, as well as tags         
  184.           that indicate entities - images, anchors/links, and      
  185.           horizontal rules.
  186.  
  187.           The HTML Skeleton command is new in HTML-Ed v0.93b.  It will
  188.           place a general HTML skeleton into the editor.
  189.  
  190.           Also new in v0.93b is the "End Paragraph" tag, </P>.  This tag
  191.           is optional, and does not have to be used.  It can be added to
  192.           your document with the Ctrl+Shift+P hotkey.  If you mark a block
  193.           of text and select either the "Paragraph" or "End paragraph" 
  194.           menu options, the selected text will be wrapped in a <P>...</P> 
  195.           pair.
  196.  
  197.           There is now a "Other Special Character" dialog box, available
  198.           in the "Page/Special Characters" submenu.  This dialog allows
  199.           you to insert the character-based names for much of the ISO
  200.           Latin character set.  To insert a code, simply select it in the
  201.           listbox and click on OK, or press ENTER.  Alternatively you can
  202.           double-click on the entry in the listbox.
  203.  
  204.           You can use the radio buttons in this dialog to display only the
  205.           foreign letters (accented letters, mostly), only
  206.           symbols/punctuation, or both.
  207.  
  208. Style -   The STYLE menu contains options that will directly affect the 
  209.           way the actual text looks.  This menu contains items such
  210.           as "Bold," "Italics," "Underline," etc.
  211.  
  212.           HOTKEYS:  In HTML-Ed, I have set up the hotkeys so that similar
  213.           functions are invoked similarly.  STYLES are all "Control"
  214.           hotkeys, which are hotkeys using the Ctrl key.  Likewise,
  215.           FORMATTING codes such as paragraphs and line-breaks are
  216.           Control-hotkeys.
  217.  
  218.           On the other hand, entities such as images, links, special
  219.           characters, etc.  are all "Alt" hotkeys, invoked using the Alt
  220.           key.  The menus are also activated with the Alt key.
  221.  
  222.           Spend some time to familiarize yourself with both the PAGE and
  223.           STYLE menus, and their associated hotkeys.  This will
  224.           significantly decrease the amount of time it takes to compose
  225.           most HTML code.
  226.  
  227. Test! -   The TEST menu option will put HTML-Ed into TEST mode.  In this
  228.           mode, you get to see exactly what your HTML code will look like,
  229.           right in the same window!  To do this, HTML-Ed employs DLL's
  230.           from WebExplorer 950814 (beta of 1.03) or later.  Since most
  231.           OS/2 users have WebExplorer installed, I didn't include this DLL
  232.           in the package.
  233.  
  234.           Since HTML-Ed relies on WebExplorer for it's inline testing, any
  235.           bugs in WebExplorer could possibly manifest themselves in
  236.           HTML-Ed.  To minimize the possibility of the dreaded swapper
  237.           growth bug in WebEx, I have dutifully disabled the "Streaming
  238.           graphics" option in the WebExplorer window.  Any graphics will
  239.           have to completely load before they will be displayed.
  240.  
  241.           When you choose TEST, most of the menu options will be disabled.
  242.           After the page has completely loaded, the TEST option will
  243.           change to "WRITE" which will take you back to the editor when
  244.           selected.  The hotkey "Alt-T" will toggle between TEST and WRITE
  245.           modes.
  246.  
  247.           Note, only one file can be tested at once.  If the current file 
  248.           is being tested and you switch to another file (via the arrow 
  249.           buttons or the file list) then HTML-Ed switches the file back to
  250.           WRITE mode first.
  251.  
  252. Help -    The only option currently available under the Help menu is the
  253.           product information dialog, which displays information about the
  254.           program and author.
  255.  
  256. The Dialogs, and Inserting Tags
  257. -------------------------------
  258.  
  259.    I specifically designed HTML-Ed to be easy to use from the keyboard
  260.    only.  You do NOT need to use a mouse for anything.  I feel that using
  261.    the keyboard, and memorizing a few simple hotkeys, can and will
  262.    drastically improve productivity.
  263.  
  264.    However, I also wanted HTML-Ed to be easy to use from a novice's
  265.    standpoint, as well as relieve myself from having to remember many
  266.    different tags and their attributes.  I have, therefore, included
  267.    dialog boxes to facilitate the editing of several tags.
  268.  
  269.    For all of these dialogs, if you wish to do the editing yourself,
  270.    simply press ENTER (or click on OK), and the code will be inserted
  271.    without any information.  The cursor will be placed in an appropriate
  272.    position.  In this way, you can easily avoid the dialogs if you prefer.
  273.  
  274.    I've also made it easy to add tags to text AFTER you've typed it.  For
  275.    example, type some text, select it, then press Ctrl-B (or choose
  276.    Styles/Bold from the menus), and the selected text will be enclosed in
  277.    a <B>...</B> pair.
  278.  
  279.    On the other hand, if you press Ctrl-B without first selecting any
  280.    text, your cursor will be placed within the two tags, allowing you to
  281.    then fill in the text that will be bolded.
  282.  
  283.    Similarly, if you select text and then select one of the dialog box
  284.    commands, the selected text will be inserted into an appropriate place
  285.    in the dialog.  When creating a "Definition Term," HTML-Ed treats any
  286.    selected text as the definition.  When creating an anchor/link,
  287.    selected text is treated as the anchor text.
  288.  
  289.    In several of the dialogs (ie:  the Anchor/Link and IMG dialogs), there
  290.    is a FIND button beside an entryfield.  If you press this button, you
  291.    will be presented with the standard OS/2 file dialog, and will be asked
  292.    to choose a filename.  The filename will be parsed and then returned to
  293.    the entryfield.  If you choose to manually enter the filename, remember
  294.    to use forward slashes ('/') instead of backslashes ('\'), or you will
  295.    have problems viewing the file, or following the links.
  296.  
  297.    Please play with the tags and dialogs, and let me know if there are any
  298.    further enhancements I could make that would improve the usability of
  299.    the program.
  300.  
  301.  
  302. Test vs. Write Modes
  303. --------------------
  304.  
  305.    In WRITE mode (the default), you are allowed to edit your HTML-Code. 
  306.    When you select TEST from the menu, HTML-Ed switches to TEST mode.
  307.  
  308.    In TEST mode, you are presented with a WebExplorer window that will 
  309.    show you exactly what your web page will look like (when viewed with 
  310.    WebExplorer anyways).  In TEST mode, most of the menu options are 
  311.    disabled.  To return to WRITE mode, select WRITE from the menu (it 
  312.    replaces TEST).
  313.  
  314.    In TEST mode, you can follow _LOCAL_ links.  This will allow you to
  315.    make sure your local links are working properly.  Currently, the file
  316.    you are editing is not changed when you follow a local link, nor are
  317.    the other pages inserted into the edit ring.
  318.  
  319.    As mentioned earlier, switching between documents via the file list or
  320.    the right/left buttons will switch you to WRITE mode if you are
  321.    currently in TEST mode.
  322.  
  323.  
  324. The Edit/File RING
  325. ------------------
  326.  
  327.    HTML-Ed now supports loading multiple documents via a file ring.  This 
  328.    means that while only one document is visible at once, the others are 
  329.    available by clicking on the right or left arrows on the title bar. 
  330.    Also, you can switch between documents by selecting "File/Active File 
  331.    List" from the menu, or pressing the hotkey (Alt+`).  
  332.  
  333.    Selecting NEW from the FILE menu will create a new file and insert it
  334.    into the edit ring.  Similarly, when you OPEN a file, it is inserted
  335.    into the ring.  To remove a file from the ring, use the CLOSE command
  336.    from the FILE menu.
  337.  
  338.    Since the file ring is a new feature with v0.92b, there are bound to be
  339.    a few problems with it still.  I believe I have found most of them, 
  340.    but it always pays to be careful.  Be sure to report any problems to me 
  341.    ASAP so they can be fixed.
  342.  
  343.  
  344. Planned Enhancements
  345. ====================
  346.  
  347.    1. Online help.  I am definitely going to get write some online help
  348.       for the GA...  anything would be better than this manual <g>.
  349.    2. The ability to use an external browser (for those of you who like
  350.       Lynx better <g>).
  351.    3. Printing.
  352.    4. Suggestion from users!  I need suggestions!  What tags do you need
  353.       in an HTML editor?  What am I missing?  What am I doing wrong?
  354.       Please, send me comments!  I am toying with the idea of adding
  355.       forms, and will eventually add table support (probably not in the GA
  356.       though), but I want to know the best way to go about it.  What would
  357.       be the easiest method, from a users point of view?  Please, without
  358.       your comments, HTML-Ed will not get any better!
  359.    5. Bug fixes - please report any bugs you find, ASAP!
  360.    6. Improved documentation <g>.
  361.  
  362.  
  363. A Note about the "File Dialog" crash and FixPack 17:
  364. ----------------------------------------------------
  365.  
  366.    To those of you who've experienced the "File Dialog" crash (this is a
  367.    crash that occurs when HTML-Ed tries to open a standard file dialog -
  368.    it can occur either from the "Open" or "Save/Save as" menu functions,
  369.    as well as from any of the "Find" buttons present in dialogs):  I
  370.    believe the problem can either be attributed to
  371.  
  372.       a) Fixpack 17; or
  373.       b) LXLITE 1.01
  374.  
  375.    I had run LXLITE on my OS/2 directories.  This had several side effects
  376.    - one of which was a problem with HELPMGR.DLL - so I decided to back
  377.    out of Fixpack 17 in order to restore myself to original DLL's (albeit,
  378.    Fixpack 10 DLL's).  As a result, the "File Dialog" crash stopped
  379.    occurring.
  380.  
  381.    It must, therefore, have either been a problem with lxlite, or with
  382.    FixPack 17.  I tend to believe it was FixPack 17, as the crash occured
  383.    occaisionally before I compressed everything.  The final nail in the
  384.    coffin is that FixPack 17 altered the standard file dialog, so it's
  385.    likely it also altered the code behind it.  Either way, using FixPack
  386.    10 and uncompressed DLL's, the File Dialog crash doesn't occur anymore.
  387.  
  388.    If you are experiencing the File Dialog crash please mail me and tell
  389.    me what FixPack you're running, and if you've compressed your DLL's
  390.    with lxlite or not.
  391.  
  392.    Another problem has cropped up, this time with pre-FP17 systems.  It 
  393.    seems that on FP17, you can have multiple wildcards listed in the 
  394.    filespec (eg: "*.GIF;*.JPG") as I was doing with the IMG and BODY 
  395.    "Find" buttons.  Apparently this doesn't work on pre-FP17 systems.  I 
  396.    have, therefore, changed the wildcard to "*" for v0.93b.
  397.  
  398.  
  399. Contacting the Author
  400. =====================
  401.  
  402.    The author of HTML-Ed, Ian Prest, can be contacted in the following
  403.    ways:
  404.  
  405.              email:   ianprest@connect.reach.net
  406.  
  407.       surface mail:   Ian Prest
  408.                       R.R.#1
  409.                       Shannonville, Ontario
  410.                       CANADA, K0K 3A0
  411.  
  412.    Send all comments, bug reports, and questions to either of those
  413.    addresses.  Thanks for your help!
  414.  
  415.  
  416. License/Disclaimer
  417. ==================
  418.  
  419.    HTML-Ed (the program) is supplied as is.  Ian Prest (the author)
  420.    disclaims all warranties, expressed or implied, including, and without
  421.    limitation to, the warranties of merchantability and of fitness for any
  422.    purpose.  The author assumes no liability for damages, direct or
  423.    consequential, which may result from the use of the program.
  424.  
  425.    HTML-Ed is a "shareware program" and is provided at no charge to the
  426.    user for evaluation.  Feel free to share it with your friends, but
  427.    please do not give it away altered or as part of another system.  The
  428.    essence of "user-supported" software is to provide personal computer
  429.    users with quality software without high prices, and yet to provide
  430.    incentive for programmers to continue to develop new products.  If you
  431.    find this program useful and find that you are using HTML-Ed and
  432.    continue to use HTML-Ed after a 14-day trial period, you must register.
  433.    (See below for the registration details.)  The registration fee will
  434.    license one copy for use on any one computer at any one time, by the
  435.    original purchaser.  You are free to keep a copy on each of your
  436.    computers so long as you only use HTML-Ed on one computer at a time.
  437.  
  438.    Commercial users of HTML-Ed must register and pay for their copies
  439.    within 14 days of first use or their license is withdrawn.
  440.  
  441.    Anyone distributing HTML-Ed for any kind of remuneration must first
  442.    register the program.
  443.  
  444.    You are encouraged to pass a copy of HTML-Ed along to your friends for
  445.    evaluation as long as you include this license file in the copy.  The
  446.    file htmle93b.zip contains all the files, including this one, and is
  447.    the easiest way to pass on a copy.  Do NOT pass along the HTMLED.INI 
  448.    file, as it contains your personal registration information.  Please 
  449.    encourage them to register their copy if they find that they can use
  450.    it.
  451.  
  452.  
  453. Registration Information
  454. ========================
  455.  
  456.    The registration fee for HTML-Ed is $20 (US).  You may register using
  457.    your credit card by calling BMT Micro and placing your order.  Make
  458.    sure you give us your email address so we can be sure you get your
  459.    registration code as soon as possible.
  460.  
  461.    Registration of HTML-Ed v0.93b will entitle you to hassle-free use of
  462.    all 0.9x beta versions, and all 1.xx GA releases of HTML-Ed.  I reserve
  463.    the right to charge a nominal upgrade fee for 2.xx versions.  If an
  464.    upgrade fee is implemented, it would certainly be less than the $20
  465.    (US) you pay originally.
  466.  
  467.    When you receive your registration code, start HTML-Ed, and choose 
  468.    OPTIONS/REGISTRATION from the menus.  You will be prompted for your 
  469.    name and registration code.  Enter them EXACTLY as they appear in the 
  470.    email/letter you are sent.  If the code is accepted, you will see a 
  471.    message to that effect on the statusline, and HTML-Ed will no longer 
  472.    pause on startup or shutdown.
  473.  
  474.    The easiest way to enter your name and registration code is to cut
  475.    and paste them from your registration email.
  476.  
  477.         Mail Orders To: BMT Micro
  478.                         PO Box 15016
  479.                         Wilmington, NC  28408
  480.                         U.S.A.
  481.  
  482.           Voice Orders: 8:00am - 7:00pm EST (-5 GMT)
  483.                         (800) 414-4268 (Orders only)
  484.                         (910) 791-7052 (Orders / Order Inquires)
  485.  
  486.             Fax Orders: (800) 346-1672 24 hours, 7 days a week
  487.                         (910) 350-2937 24 hours, 7 days a week
  488.  
  489.  Online Orders via BBS: (910) 350-8061 10 lines, all 14.4K
  490.                         (910) 799-0923 28.8k v.FC
  491.  
  492.         via Compuserve: Thomas Bradford, 74031,307
  493.           via Internet: orders@bmtmicro.com
  494.  
  495.    We accept Visa, Mastercard, Discover, American Express, Diner's Club,
  496.    money order, cashiers checks, and personal checks.  We also accept DM
  497.    and British currency via registered mail.
  498.  
  499.    Personal checks are subject to clearance.
  500.  
  501.    We accept purchase orders from educational institutions, governmental
  502.    agencies and other verifiable businesses.  Terms are "Due Upon Receipt"
  503.    with a $250 minimum.
  504.  
  505.    Please read or print the ORDER.FRM for detailed shipping information 
  506.    (if you don't have an email address) and a printable order form.
  507.  
  508.  
  509. HTML-Ed v0.93b
  510. (C) Copyright 1996, Ian Prest
  511. All Rights Reserved.
  512.  
  513.