home *** CD-ROM | disk | FTP | other *** search
/ Fujiology Archive / fujiology_archive_v1_0.iso / T / TYPHOON / TEXTOV11.ZIP / TEXTO!11 / TEXTO!.ENG < prev    next >
Text File  |  2013-07-28  |  15KB  |  332 lines

  1.  
  2.                                   T E X T O  !
  3.                                   ============
  4.  
  5.  
  6. *********************************** CONTENTS ***********************************
  7.  
  8. 1. What's that ? What is it doing ?
  9.    1.1. Quick description
  10.    1.2. How to use it quickly
  11.         1.2.1. Conversion formats
  12.         1.2.2. Options
  13.         1.2.3. Information
  14. 2. File conversion
  15.    2.1. From Atari ASCII format to HTML format
  16.    2.2. From Atari ASCII format to NTF format
  17. 3. Old and future versions
  18. 4. Are there any bugs ?
  19. 5. Contact, copyright and greetings
  20.  
  21. ********************************************************************************
  22.  
  23.  
  24. 1. What's that ? What is it doing ?
  25. ===================================
  26.  
  27.      Texto! is a little utility coded in GFA Basic 3.6, which main function is
  28. the conversion of texts in several formats. In Texto!, no sucking bits : you
  29. choose a source file, a destination name and that's all !
  30.  
  31.      At the beginning, I wanted to code a little text converter for my personnal
  32. use, and I've decided to distribute it around me because I used it a lot. I've
  33. created HTML Text Converter in order to help to create HTML pages from ASCII
  34. files. In fact, I've used it to convert the Toxic Mag into HTML format (this
  35. French diskmagazine is free, just send me a disk and international coupon reply
  36. to receive it, if you speak French of course). Texto! is the sequel to HTML Text
  37. Converter, which development is stopped now (the last version is 1.7). HTML Text
  38. Converter only allowed to convert from ASCII to HTML. But as I wanted to convert
  39. a text to other formats, I've added tons of options and I've renamed HTML Text
  40. Converter.
  41.  
  42.  
  43.      1.1. Quick description
  44.      ----------------------
  45.  
  46.      Texto! runs on all Atari computers, from the 520 STFM to the Falcon (and
  47. maybe on Hades ?). Unhappily, it doesn't work on MagiC without NVDI, and I don't
  48. know why yet.
  49.  
  50.      Texto! allows to convert a text, here are the different possibilities :
  51. - It can convert an ASCII file into HTML format, with different options (see the
  52.   paragraph 1.2).
  53. - It can convert an ASCII text created with Pro 2 into a "real" ASCII text.
  54. - It can convert an ASCII text into NTF format (Toxic Mag format).
  55. - It can convert an ASCII text into Windozz ASCII special format and vice-versa.
  56. - Finally, it can remove all the accents within an ASCII text.
  57.  
  58.      It is also possible to set the conversion parameters (for the HTML and NTF
  59. formats only) and to load and save the options. And if you want to copy Texto!
  60. to a non-English speaker ? Just go and put the right option !
  61.  
  62.  
  63.      1.2. How to use it quickly
  64.      --------------------------
  65.  
  66.      At the very beginning, if the TEXTO.INF file is missing, an alert box will
  67. ask you which language would you like. Of course, it is possible to disable this
  68. box, see in the option part for more info. After this, you will see a dialogue
  69. box we can share into 3 parts : the text conversion, options and information
  70. (well, you can also leave Texto! but that's easy so no more about it) :
  71.  
  72.  
  73.           1.2.1. Conversion formats
  74.           -------------------------
  75.  
  76.      No need to give you here more details about the conversion formats because
  77. I will write a lot more in the second part of this documentation. If you are in
  78. a hurry, here are some very short (but clear) information :
  79.  
  80. - Atari ASCII -> HTML Format : this conversion will use the parameters so don't
  81.   forget to set them (more info later).
  82. - Pro 2 ASCII -> Atari ASCII : if you're not French then you shouldn't use this
  83.   option. Pro 2 is a "minitel" emulator (a French lousy terminal running at 75/
  84.   1200 bauds). The accents in the ASCII savings are so bad that you should use
  85.   this option.
  86. - Atari ASCII -> NTF Format : no need about it if you're not French. The NTF
  87.   format is the Toxic Mag format. The NTF format isn't ASCII format because
  88.   empty lines are replaced by a space and the file ends with a special chara-
  89.   cter. It is possible to include pictures (maximum : 528x180, 4 colours).
  90. - Atari ASCII -> ANSI Windozz and ANSI Windozz -> Atari ASCII : Macro$oft, still
  91.   fucking computer-addicted people, has created a silly and illogical ASCII
  92.   format... Remember the MS-DOS ASCII format is the same that the Atari one.
  93. - Remove all the accents : only works with Atari ASCII files.
  94.  
  95.      Be careful with the length of the files : it is limited to 5000 lignes (it
  96. means about 250 KB). But as converted files are always bigger than the original
  97. ones, please never load a big file (200 KB should be a reasonnable limit). In
  98. fact, Texto! loads the whole file in the memory before working on it.
  99.  
  100.      Last point : Texto! uses a timekeeper for the conversion. At the end of
  101. each conversion, Texto! indicates two things :
  102. - The time used by the conversion algorithm only.
  103. - The time used by the whole process (loading, conversion, saving).
  104.      These times are indicated in seconds. Below each time, there is another
  105. indication, the unit is the 1/200 seconds. Indeed, the conversions are so fast
  106. with little files and they don't reach one second. In the dialogue box, I've
  107. used the term "unit" because it is shorter than "1/200 seconds".
  108.  
  109.  
  110.           1.2.2. Options
  111.           --------------
  112.  
  113.  
  114.      Click on the "Options" button, a dialogue box will appear. You will have to
  115. choose between several possibilities :
  116.  
  117. * Options for the HTML format : opens another dialogue box only for the HTML
  118.   format. You will see 8 selectable buttons, each one corresponds to a function.
  119.   Warning : the more you select buttons, the slower the conversion will be. See
  120.   the section "2.1.1" for more details.
  121.   - Tags at the beginning and the end : allows the conversion of an ASCII file
  122.     into a "real" HTML document.
  123.   - Enumeration mode ("-" ⇨ "<br>") : if a line in the ASCII file begins with a
  124.     "-", it will be replaced with a carriage return in HTML langage (it's the
  125.     "<br>" tag). Very useful in fact.
  126.   - Convert the accents : no comment.
  127.   - Convert the special characters : these are all the characters which ASCII
  128.     code is greater than 128, except the accents. E.g.: ©, ®, ™.
  129.   - Convert the Greek letters : warning, all the browsers don't accept all the
  130.     Greek letters !
  131.   The three following functions may seem you superfluous, but you will need them
  132.   for example if you would just like to convert the accents in an HTML document
  133.   (you will have to disable these 3 options). So, do not use these options with
  134.   an existing HTML document, otherwise you will have some surprises...
  135.   - Convert the "&" : the "&" will be replaced by the "&".
  136.   - Convert the "<" and ">" : they will be respectively replaced by "<" and
  137.     ">".
  138.   - Convert the quotation marks : they will be replaced by """.
  139.  
  140. * Options for the NTF format : opens another dialogue box for the NTF format
  141.   only. You will find 3 selectable buttons. For more info, see section "2.3.1".
  142.   - One space at each empty line : empty lines are forbidden for the Toxic Mag
  143.     interface (I don't really know why...).
  144.   - Include the pictures (*.BLK) : it will allow to include picture blocs (max.
  145.     length is 528x180 in 4 colours).
  146.   - Special character at the end : an NTF file must have a special character at
  147.     the end. The ASCII code of this character is 1. If Texto! sees this special
  148.     character at the end of the file, it doesn't add another one.
  149.  
  150. * In a special box called "General Options", you can modify 2 parameters :
  151.   - Automatic saving : ALL the parameters will be saved in "TEXTO.INF" when you
  152.     will leave Texto!. Do not select this option if you don't have a hard disk.
  153.   - French/English : you can change the language here. Of course, you will have
  154.     to restart Texto! if you want it takes into consideration your wish.
  155.  
  156. * Of course, it is possible to validate the options, to cancel (except for the
  157.   specific options concerning HTML and NTF formats), to save and to load them.
  158.  
  159.  
  160.           1.2.3. Information
  161.           ------------------
  162.  
  163.      If you want to get some information about Texto! (author, version...) click
  164. on the "Info" button in the main dialogue box. Then, you will know the version
  165. of Texto!, the date of its creation and the aim of this little piece of coding.
  166. As it is a postcardware (don't forget the cute postcard !), you can click on a
  167. special button for more info about it.
  168.  
  169.  
  170. 2. File conversion
  171. ==================
  172.  
  173.      In this part, we will only see the HTML and NTF formats. The other ones are
  174. easy to understand.
  175.  
  176.  
  177.      2.1. From Atari ASCII format to HTML format
  178.      -------------------------------------------
  179.  
  180.      The HTML format is the World Wide Web's document format. If you doesn't
  181. know what is HTML, this part isn't for you because Texto! was made to help those
  182. you want to make their own HTML pages on Atari.
  183.  
  184.      The structure of the converted files depend on selected (or non-selected)
  185. options in the dialogue box which concerns HTML format (see section "1.2.2"). I
  186. am going to present you the caracteristics of each function. But before this,
  187. two remarks : first of all, the lenght of a HTML file converted with Texto! will
  188. always be greater than the source file's one. Secondly, for those who want to
  189. convert quickly files, if you activate all the options then the conversion will
  190. be slower. So, just set the necessary options for maximum speed. And now, here
  191. are the descriptions of these options :
  192.  
  193. * Tags at the beginning and at the end : Texto! will put at the beginning and at
  194.   the end of your ASCII file some tags (HTML commands). Here is a list of the
  195.   modifications :
  196.   - A remark (it won't be taken into consideration by you favorite HTML browser)
  197.     in order to indicate that the conversion was made by Texto!. The version
  198.     number, the author's name, the date and the time of the conversion will be
  199.     added too (it may be useful).
  200.   - The traditionnal header of HTML documents :
  201.       <html>
  202.       <head><title>PUT YOUR TITLE HERE</titre></head>
  203.       <body>
  204.     By the way, don't forget to modify the title with a text editor.
  205.   - If Texto! notes an empty lines, it will put this instead :
  206.       <br><p>
  207.     It means : carriage return and new paragraph.
  208.   - And, last but not least, this is added at the end of the HTML file :
  209.       </body>
  210.       </html>
  211.     (Enjoy !)
  212.  
  213. * Enumeration mode : if Texto! notes a line beginning with "-", it will think it
  214.   is an enumeration and then will put "<br>" at the end of the line. But it is
  215.   recommended to replace this by the "true" HTML tag "<ul>" with your favorite
  216.   text editor.
  217.  
  218. * Converted accents : here is the list of the converted characters :
  219.   - A : à, À, å, Å, á, â, ä, Ä, ã, Ã, æ, Æ.
  220.   - E : é, É, è, ê, ë.
  221.   - I : î, ï, í, ì.
  222.   - O : ô, ö, Ö, ó, ò, õ, Õ, Ø, ø.
  223.   - U : û, ü, Ü, ú, ù.
  224.   - Y : ÿ.
  225.   - Cedilles : ç, Ç.
  226.   - Tildes : ~, ñ, Ñ.
  227.  
  228.  
  229. * Converted special characters : some characters are recognized only, I have
  230.   privileged the most used :
  231.  
  232.   ¡, ¢, £, ¥, |, §, ¨, ©, ®, «, », ª, ¬, ¯, °, ±, ², ³, ´, µ, ¶, ·, º, ¼, ½,
  233.   ¿, ÷, ß, æ, Æ.
  234.  
  235.   Other ATARI-specific characters aren't recognized yet by HTML language, so I
  236. have found some solutions :
  237.  
  238.   œ -> oe
  239.   Œ -> OE
  240.   ƒ -> f
  241.   ™ -> (TM)
  242.   ij -> ij
  243.   IJ -> IJ
  244.   ∧ -> ^
  245.  
  246. * Conversion of Greek letters : beware ! All the browsers don't accept this
  247.   possibility !
  248.  
  249.  
  250.      2.2. From Atari ASCII format to NTF format
  251.      ------------------------------------------
  252.  
  253.      The NTF format is Toxic Mag's format. It looks like ASCII format but there
  254. are some differences : empty lines are replaced by a space (and just ONE), the
  255. file must end with a special character, it is possible to include picture blocs
  256. (528x180 in 4 colours maximum) and to use the big font of the interface.
  257.  
  258.      In an NTF file, you will find 3 special characters. Their aim is to control
  259. the Toxic Mag's interface :
  260.  
  261. - The character 27 () indicates that the big font must be used (for the current
  262.   line only).
  263. - The character 11 (♪) indicates the beginning of a BLK picture.
  264. - The character 1 (⇧) indicates the end of the file. Thus, all the characters
  265.   after this one won't be taken into consideration.
  266.  
  267.      How can I include a picture in an NTF file ? If Texto! sees the character
  268. 11 (♪) in the text, it means there is already a picture here and it will jump
  269. until the next end of line. So, another special character is needed to indicate
  270. to Texto! that a picture has to be included. This character is number 3 (⇨). You
  271. can put it in the middle of a line if you want, for example. Two remarks :
  272.      - Please, jump enough lines after this special character if you don't want
  273. the text to be overwrited by the picture.
  274.      - Warning : the format of picture blocs is a special one. You have to use
  275. the "Boîte à outils" ("Toolbox") of the Toxic Mag to create such files with PI2
  276. pictures.
  277.  
  278.  
  279. 3. Old and future versions
  280. ==========================
  281.  
  282. Version 1.0 from September 16th, 1997 :
  283. - First distributed version after one week of intensive tests and optimisations.
  284.   Concerning the optimisations, I have converted the types of my variables : at
  285.   the beginning, I used long words (32 bits), but in fact the calculations can
  286.   be done with words only (16 bits). The result : conversions are faster. For an
  287.   ASCII conversion into HTML with all the options enabled, I've win one second.
  288.   It's not a lot but it's always faster. On the other side, Texto! now takes
  289.   more place in memory (160 bytes), but that's this or nothing.
  290.  
  291. Version 1.1 from September 27th, 1997 :
  292. - New option : possibility to remove the accents from an ASCII text.
  293. - Now it is possible to include picture blocs for NTF format.
  294.  
  295. Planed for future versions :
  296. - More and more special characters and Greek letters recognized.
  297. - I've noted that some ASCII characters were badly converted into the ANSI norm
  298.   of Windozz... it will be quickly corrected.
  299.  
  300.  
  301. 4. Are there any bugs ?
  302. =======================
  303.  
  304.      Yes, I've find only one bug for the moment : Texto! doesn't work very well
  305. with MagiC... It depends on the MagiC version, the NVDI version, etc. I don't
  306. know how appear the bug, but I think it is due to CHDRIVE and CHDIR instructions
  307. in GFA...
  308.  
  309.      Contact me if you find other bugs... 8^)
  310.  
  311.  
  312. 5. Contact, copyright and greetings
  313. ===================================
  314.  
  315.      Texto! is postcardware. It means you HAVE TO send me a beautiful postcard
  316. if you enjoy it, if you often use it or if you've installed it on your hard disk
  317. or a CD-Rom. You can (must ?) of course copy this software to all your friends
  318. and contacts, but you can't modify or sell it without my authorization.
  319.  
  320.      Contact me at this address : PEREZ Stéphane
  321.                                   328, Les Hauts du Louvarou
  322.                                   38560 HAUTE-JARRIE
  323.                                   FRANCE
  324.  
  325.      Or on Internet : "stephane_perez@hotmail.com"
  326.  
  327.      Thanks to Pierre-Louis LAMBALLAIS alias "Le Féroce Lapin" for his useful
  328. advices and to Yannick LECAILLEZ alias "FirST'" for his advices in GFA Basic.
  329.  
  330.  
  331.      Have fun with Texto!
  332.