Magazyn Amiga Shareware Floppies

home *** CD-ROM | disk | FTP | other *** search

/ Magazyn Amiga Shareware Floppies / ma63.dms / ma63.adf / MWM / Docs / MWM_eng.DOC next >

Wrap

Text File | 1996-07-03 | 26KB | 853 lines

Version 1.08 +--- - - - - ---+--- - - - - ---+ | ! Welcome to the first very easy-to-use HTML file generator ! | +--- - - - - ---+--- - - - - ---+ __ __ __ __ __ __ / \_/ \ \ \ / / / \_/ \ / /\ /\ \ \ \ _ / / / /\ /\ \ / / \_/ \ \ \ \ / \ / / / / \_/ \ \ / / \ \ \ \/ _ \/ / / / \ \ /_/ \_\ \__/ \__/ /_/ \_\ -->* Magic WWW (World-Wide Web) files Maker *<-- _______________________________________ | | \|/ X ___________________________________ | | | from an idea of Maurizio Fabiani | | developed by Massimo Baglione | |___________________________________| 1. INTRODUCTION One day my friend Maurizio asked me: "Hey Max, do you think that it's possible to write a program to create files in HTML format by just loading a simple ASCII text and using the mouse to define the final HTML file?" I said: "Oh my God! Miracles are not my speciality!"... but he was right! Well, the final result is near. MWM allows you to load a normal text file and you can attach images, texts, lists and many other HTML object to the selected lines and/or words just by using the mouse. The GUI is essentially composed of: - The Main Window This will show the normal text file. If a part of text is defined by an action, it will be highlighted with a different color from the rest of the text. Like some word processors, this window contains a lot of small graphic gadgets linked to different actions. - The Single Line Window - The Labels Window This will show all labels included in an HTML file to be linked. - The Help Window (or Log Window) - The "What is?" Window 2. THE MAIN WINDOW Once a simple text file is loaded, you will see it in the Main Window. Use the left mouse button to select part of the text, either by dragging, or by clicking. Then select one of the Action Gadgets to attach an action to it the selected text. The action can be lists, texts, images, hyperlinks, or many other things permitted by the HTML 3.0 specs. If you need to attach an action to a single word on a line, just double-click on the line. Your desired line will appear in the Single Line Window. Then you can drag select only the desired word(s). Different actions will create objects that are shown in different colors in the Main Window. All created objects are numbered in order of creation. By selecting the object, you can see information about it in the Log Window. Keys ==== If the text is larger than the the window, you can scroll it by pressing the arrows keys or using the scroll gadgets. The arrow keys, by themselves, will scroll one line or column. Shifted arrow keys will scroll one page up / down / left / right. Pressing the alt key with the arrow keys will go to the beginning / end, or to the top left / top right. Pressing the control key with the arrow keys will attempt to resize the window to fit the text. The help key will open or close the Log Window. The del key will open or close the "What is?" Window. Pressing enter will edit the first selected line. Pressing return will insert an empty line. The Action gadgets ================== Starting from the left, the Action gadgets are: TEXT Gadget This action will define a particular type of text for selected lines. If you are working in the Single Line Window, MWM will show the following choices: - It's a link to a previously defined label into the current document. - It's a link to another document. A web browser like AMosaic will highlight this part of the text. If the user click on this object, a new text defined by this action will called. After choosing the file to be linked, MWM will ask you if you need to refer to a particular label into the linked text. If so, a listview will show all of the labels. Just double-click to choose one. - It's a link to a site. MWM will show a requester to find out where it can go to read the site name. You can choose from: - Selected line If the site name is the current selected text, MWM will concatenate all the selected lines. - Keyboard The site name will be defined manually from the keyboard. - PATH:file The site name is defined in the site file. You may define a list of sites in advance for MWM to use. The list MUST look like this: www.vol.it agnus.livewire.com www.lycos.com www.yahoo.com ... If the location of the site list has not been previously defined, MWM will look for it in "PROGDIR:MWM.sites". You may define a different location for the site file using the "PREFS" gadget, "Sites list" item. MWM will give you the following list of link types: file://localhost/ http:// ftp:// mailto: news: gopher: telnet: Once you have chosen a link type, you will be asked to add the complete name of the site. If you chose: - Selected line You're done with the current link. - Keyboard. MWM will ask you to enter the complete name of the site. - PATH:file MWM will present the choices in the site file, and ask you to choose one. - It's a simple text. Otherwise, if you are working in the Main Window with one or more selected lines, MWM will add the following choices to the previous choices: - It's a preformatted text. Selected lines will be included between <PRE> and </PRE>. They will usually be displayed in a fixed width (typewriter) font. - It's a paragraph. Selected lines will be included between <P> and </P>. MWM will ask you to choose an alignment: DEFAULT, LEFT, RIGHT, JUSTIFY. - It's information about you. Selected lines will be included between <ADDRESS> and </ADDRESS>. IMAGE Gadget This action will _REPLACE_ selected text with an image. A file requester will ask you to select the image file. Next, MWM will ask you to choose what kind of alignment you want for the image. The possible choices are: - BOTTOM - MIDDLE - TOP Then, MWM will ask you what type of image you desire: - It's a link to an already defined label into the current document. - It's a link to an other document. (See the TEXT Gadget, above) - It's a link to a site. (See the TEXT Gadget, above) - It's a MAP image. - It's a simple image. LIST Gadget This action will define selected lines as a list. There are three types of lists: - Unnumbered, for example: * it's cold * it's warm * it's rain - Numbered, for example: 1- Don't drink if you must drive 2- Don't drive if you have drunk 3- Cappuccino is more greedy than beer 4- Milk is finish, give me a beer! - Definition, for example: Colors Red Green Blue Planets Mercury Mars Jupiter Earth ... After choosing the type of list you want, MWM will ask you if you want to add more infos to every element of the list. If you select no, the list will become a simple list of words. If you select yes, MWM will show you line by line the selected text, and ask you how you want to define it: - It's a link to an already defined label into the current document. - It's a link to an other document. (See TEXT and IMAGE) - It's a link to a site. (See above on the TEXT part) - It's a simple text. FORM Gadget This action is composed by two steps: In the first step you define the part of the text that will become the FORM. MWM will ask you for the type. The possible responses are: - GET - POST - Cancel After this, MWM needs to know the desired Action (a URL, for instance). This is an example of an Action: "http://x/y/sample". You will see that the color of the selected text has changed. With FORM objects you may select one or more lines for each group. In the second step you get to define all other parts of the FORM. Select as many or as few of the previously selected lines as you wish, and select the FORM Gadget again. MWM will ask you to choose between the following possibilities: - It's a simple text. This is useful to describe some other more important objects. - It's an INPUT. This choice will open a requester with the following type of INPUTs: 1. Text 7. File 2. Password 8. Hidden 3. Checkbox 9. Submit 4. Radio 10. Image 5. Range 11. Reset 6. Scribble If you choose number 4 (RADIO) MWM will check if you have selected more than one line. In so, MWM will ask you if you want to include these into the same RADIO group. If yes, the RADIO group will have the same field name. In this way, a program like AMosaic can be sure that one, and only one, of them can be selected by the user. - It's a list of INPUTs This won't work if you are working in the Single Line Window. Any single INPUTs to define will be included in a list. Every element of the FORM (except that inserted in a list) will be saved into the final HTML file prefixed by the <P> string in order to print each line separately. If you need to insert two or more element of the FORM into the same line, you can double-click on it in the Single Line Window. MORE Gadget This action changes depending if you are working in the Main Window or in the Single Line window. If you are working in the Main Window: If the selected text is uninitialized (in other words, without objects), MWM will consider the first selected line and ask you what you want to do with this line. The possibilities are: - Insert label here (<ID>) for hyperlinks; - Insert comment here (); - Define title for current document (<TITLE>). - Define the background image (<BODY BACKGROUND>). - Insert empty line. (<P>) - Insert horizontal graphic line (<HR>). If the selected text has been initialized, MWM will add the following choices to the previous choices (not for HEAD): - Citation (Typically in italic). (CITE) - Emphasis (EM) - Strong emphasis (STRONG) - Code (CODE) Looks like preformatted text, for example: 1 + 1 = 2. - Author (AU) For an author of a book, etc. - Person (PERSON) For a generic person name. - Sequence of chars. (SAMP) - Keyboarded text. (KBD) - Variable name. (VAR) - Definition. (DFN) - Short quote. (Q) - Acronyms. (ACRONYM) - Abbreviations. (ABBREV) - Inserted text. (INS) - Deleted text. (DEL) - Bold text. (B) - Italic text. (I) - Typewriter text. (TT) - Underscored text. (U) - "Lined" text. (S) - Big text. (BIG) - Small text. (SMALL) - To understand (;-)). (SUB) - To understand (;-)). (SUP) If the selected text is a link to a site, a requester will ask you if you want to: - Link to a document into this site This action allows you to edit _MANUALLY_ the name of the document to be linked into desired site. If the selected lines are part of the HEAD, a different requester will ask you if you want to: - Attach a BANNER With this action you can choose an HTML file to be a fixed banner. Example: <LINK REL=Banner HREF=mypath:mybanner.HTML> If you are working in the Single Line Window, and a previously created and currently selected text object is present, MWM will show you these choices: - Citation (Typically in italic). (CITE) - Emphasis (EM) - Strong emphasis (STRONG) - Code (CODE) Looks like preformatted text, for example: 1 + 1 = 2. - Author (AU) For an author of a book, etc. - Person (PERSON) For a generic person name. - Sequence of chars. (SAMP) - Keyboarded text. (KBD) - Variable name. (VAR) - Definition. (DFN) - Short quote. (Q) - Acronyms. (ACRONYM) - Abbreviations. (ABBREV) - Inserted text. (INS) - Deleted text. (DEL) - Bold text. (B) - Italic text. (I) - Typewriter text. (TT) - Underscored text. (U) - "Lined" text. (S) - Big text. (BIG) - Small text. (SMALL) - To understand (;-)). (SUB) - To understand (;-)). (SUP) If the selected text is a link to a site, a requester will ask you if you want to: - Link to a document into this site This action allows you to edit _MANUALLY_ the name of the document to be linked into desired site. HEAD Gadget This action will define selected lines as the HEAD. The HEAD consists of the TITLE of the document, some other information, and the selected text. By using MORE action you can insert a banner. SIZE Gadget With this action you can modify the font size of the selected lines. The following choices are possible: - <H1> Very large font, bold. - <H2> Large font, bold. - <H3> Large font, italic.. - <H4> Normal font, bold. - <H5> Normal font, italic. - <H6> Small font. Note that these values are just an indication. Depending on what browser they are using, and how the browser and their system is set up, your text may look different on each system. MWM sets this value to <H5> for all lines defined as simple text. Use the "HTML defaults" option in PREFS action to change this default. Once the size has been chosen, you can select an alignment: - LEFT (default) - CENTER - LEFT - JUSTIFY VIEW Gadget This action allows you to call a program like AMosaic to see how the page looks at any time. The program that will be called is defined by using the "Prefs" gadget. PREFS Gadget This action will open the following list of options: - Texts path Define a common path for all text files. - Images path Define a common path for all image files. - Work dir Define your favorite working directory (RAM:T, for example). - Browser Choose the preview program, for example AMosaic, AWeb or IBrowse. - Sites list Choose the file containing the list of sites. - Screen prefs Change the graphic mode for MWM's screen. I like CUSTOM mode. - Select new font Change the current font in the Main Window. - Edit log window Allows you to personalize the Log Window. - HTML defaults Allows you to personalize some defaults in the final HTML file. This action will open the following requester: - Heading size; when you load an ASCII text, MWM assign to every line a value equal to zero (default) so, if you need to change default heading size, MWM saves the selected value instead of zero. If you want a different heading size, select one of: H1 H2 H3 H4 H5 H6 in the listview. 3. THE "What is?" WINDOW The "What is?" Window is always to the left of the Main Window. It's purpose is to provide short descriptions of the object(s) on that line. Here are some examples of object descriptions: +-----------++----------------------------------+ | What is? || MWM Edit Window | +-----------++----------------------------------+ | ......... || Uninitialized text | | Text Hn X || Initialized Text | | Head || Text of the <HEAD> block | | Form ABC_1|| Text of the <FORM> block | | Preformat || Preformatted text <PRE> | | Address || Text of the <ADDRESS> block | | Paragraph || Paragraph text <P> | | List XL || Text of the <LIST> block | | Image || Text that will be an image | | To site || Hyperlink to a site | | Multi obj || Text including more objects | | Label || There is a label <ID> | | Comment || There is a comment  | | Lab & Com || There is both label and comment | +-----------++----------------------------------+ Key to object descriptions: Hn = Heading <H1> to <H6>, <HD> for default value X = Alignment: L = LEFT, C = CENTER, R = RIGHT, J = JUSTIFY XL = List type: UL = Unnumbered, OL = Numbered, DL = Definition ABC_1 = Form method: GET or POST 4. THE MENUS When the Main Window is active, you can use the menus. They contain the following items: * Project Menu - Load text Allows you to load a normal ASCII text file. If a text file was previously loaded, MWM will ask if you want to replace it, or to insert the new file into the old one. If the latter, MWM will ask where you want it to be inserted: - To the beginning; - To the end; - After the first selected line. - Save html Allows you to save the work you've done creating the HTML file. MWM will ask if you also want to save all uninitialized text. If not, than only created objects, labels and comments will be included in the HTML file. If so, all uninitialized text will be saved as simple text and the string <BR> will be added to the end of each line. After this, MWM will check for title and, if one doesn't exist, a requester will help you. - Load saved work Load a previously saved work. - Save work Save the entire work in a file to be recalled at any time so that the development of it may continue. - Delete all Delete all current work or only all objects. (Handle with care!). - Help keys List of all magic keys. - About The MWM's brain and arm! (;-)) - Quit End of work. MWM will save the preferences and the last size/position of the "Main window" into "MWM.prefs" in ENV: and ENVARC:. * Edit Menu - Cut A requester will ask if you want to: - Completely kill all selected lines Deleted text will be copied to clipboard. - Kill only the created infos. - Cancel - Copy This action copies all selected lines to clipboard. - Paste Insert text from the clipboard to after the first selected line. If you are using KCON: for the log window, for example, you can type whatever you need into this window, select all your text with the mouse and press "Amiga+C" to copy all text into the clipboard. NOTE: Remember to hit return after the last line otherwise the console will block and MWM won't be able to write messages. Afterwards, select MWM's main window and press "Amiga+V". This also works with the ConClip and ConPaste commodities. - Search new Search for a new string. - Search again. Search for the next instance of the same string. - Edit selected lines This action allows you to modify the selected text. If the selected line is not a multi-object, the previously created objects will NOT be touched. Otherwise, if you edit the line, all objects in it will be deleted. * Special Menu - Go to label This action allows you to go to a previously defined label into the current document. - Mark location 1, 2 and 3 Mark three positions in the current text. - Jump to mark 1, 2 and 3 Jump to the previously marked position. * Action Menu - Text \ - Image \ - List \ - Form \___\ Same functions as the Gadgets in Main Window. - More / / - Head / - Size / - Viev / - Prefs / 5. WHAT CAN MWM DO ? MWM is able to do all the following HTML 3.0 things: - HEAD LINK REL=Banner - TITLE - BODY - ADDRESS - A HREF="...#..." - A ID="..." - IMG ISMAP ALIGN=TOP|MIDDLE|BOTTOM SRC="..." ALT="..." - UL LI - OL LI - DL DT DD -  - BR - HR - P ALIGN=LEFT|RIGHT|JUSTIFY - CITE - CODE - EM - STRONG - AUTHOR - PERSON - SAMP - KBD - VAR - DFN - Q - ACRONYM - ABBREV - INS - DEL - B - I - TT - U - S - BIG - SMALL - SUB - SUP - < > & " Á À Â Ã Å Ä Æ Ç É È Ê Ë Í Ì Î Ï Ð Ñ Ó Ò Ô Õ Ö Ø Ú Ù Û Ü Ý Þ ß á à â ã ã ä æ ç é è ê ë í ì î ï ð ñ ó ò ô õ ö ø ú ù û ü ý ÿ þ - URL for the links - FORM METHOD=GET|POST - INPUT TYPE=TEXT|PASSWORD|CHECKBOX|RADIO|RANGE|SCRIBBLE|FILE|HIDDEN| SUBMIT|IMAGE|RESET NAME,VALUE,SIZE,MAXLENGTH,CHECKED,MIN,MAX,SRC,ACCEPT - List of INPUTs - Headings: <H1|H2|H3|H4|H5|H6 ALIGN=LEFT|CENTER|RIGHT|JUSTIFY> 6. GENERAL INFORMATION MWM needs version 3.0 of the OS or greater. This program was constructed following the HTML specs included in the archive HTML30GU.LHA. This archive can be found on any BBS and on Aminet. This version of MWM is Copyright ©1996 Massimo Baglione. World Rights Reserved. If you like this program, and you would like to use the disabled functions, you can send me US$25 to the following address: Massimo Baglione Via Della Chiesa 1 67019 Civitatomassa Scoppito L' AQUILA (Italy) Please specify where I should send the KEY file. For any suggestions, ideas or mail bombs, you can contact us faster by: Massimo Baglione Maurizio Fabiani (MAUI for Amiga BBS) 39:102/1.5 AmigaNet 39:102/1 39:102/2.5 39:102/2 2:335/602.5 FidoNet 2:335/602 2:335/607.5 2:335/607 InterNet (Maurizio Fabiani) maui@mbox.vol.it 7. CREDITS I want to thank all my beta testers for their good bug reports about MWM. In particular, I want to quote: Troy Bouchard (Snowy Hill) and Mel Greer for their incredible minds! Alessandro Di Michele for his advices about the GUI. Kirk Strauser for his various and detailed report. Girish V Nath for his very professional reports. (waiting for the beer.;-) Paul Stevens (another beer dependent..(;-)) Arnold Schwarzenegger ... (Hey Arnie, are you really you or it's just the effect of the beer ? (;-)) and, for the rest of MWM developement: Ross Delaforce for his FTP support. Jeff Lavin for his great help about this doc! David Putzier for his wonderful MWMlogo.iff, just see it! Pierluigi Sferrella for the italian amigaguide docs. Mike Handley for the English Amigaguide docs. Moreover, a big kiss (!) is flying to my Boss (Maurizio Fabiani) for his never ending patience! The last credit is reserved to Amiga: (all together) ...THANKS AMIGA!!! -----+----- -=> * \X/ Amiga! \X/ MAUI BBS! \X/ Love and Beer! * <=- _The revenge of the italian products_ ...enjoy this program!!!