Document Text2Guide Release 02.00 documentation

			Text2Guide Program Guide
			~~~~~~~~~~~~~~~~~~~~~~~~

		  Release 02.00 © Stephan Sürken 1993

			Finished 22 Aug 1993

0. Important
=============

0.1. Copyright & legal stuff
-----------------------------

 Text2Guide	02.XX is © Stephan Sürken 1993.

 Text2Guide is PUBLIC DOMAIN, that means you may copy and use it freely.

 For any comments, bug reports or similar stuff, contact me (see
 `The Author').
 
 Note the following:

  o If you copy it, you MUST copy the whole original archive.
  o You may include this copy on any Public Domain Series, but you
    MUST NOT include it on any disk that is selled for more than
    5 US Dollar (or an equivalent in other currencies).
  o The program must neither be used nor copied by any right wing
    organisations or persons.

0.2. Release Notes
-------------------

 Release: Text2Guide 02.00
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 This version is an update to version 01.00, that was included
 in the VideoMaxe Release 04.12.

 Additionally features:

 o improved whole program structure...
 o can now convert links in texts
 o multiple node test
 o cli options


1. Introduction
================

 After searching for a progam of this kind in various ftp nets for
 quite a time (without success), I decided to write it myself.
 
 Here it is!


2. Documentation
=================

  Text2Guide converts plain ASCII text into AmigaGuide (c) format.
 Sticking to some simple organisation of the text file one can
 simply realize a well structured guide file while still having
 a well readable text file at hand.
 
2.1. Startup
-------------
 
 Text2Guide is a CLI-Tool. Type Text2Guide and you`ll get:
 
 ---
 Text2Guide 02.00 (22 Aug 1993) © Stephan Sürken

 Failed: Can`t open input text file!

 SYNTAX: Text2Guide <text_file> <guide_file> {+-uwt}

 u: ignore underline of units, default on.
 w: out warnings,              default on.
 t: perform node test,         default on.
 ---

 That`s rather self-explaining, is it not??
 
 See `Options' for exact meaning of the options.
 
 Note that <guide_file> automatically is removed if existent.

2.2. Text file organization
----------------------------

 There are following rules for the text file:
 
 o The document starts with the keyword "Document" at the beginning
   of a line. The rest of this line will be taken as name of the
   AmigaGuide database.
   In the document you are reading this is in the first line (where
   it normally should be).
 
 o You have to divide your text document in units. These units must
   start at the beginning of a line, and consist of arabic numbers
   divided by dots. Whole hierarchical relations are recognized.
   The rest of the line after this unit number will be taken as
   title of this unit.
   Examples:
   	
   	1. Einleitung			-> unit number "1",
   					   title is "Einleitung"
        4.2.1. Das Spiel beginnen	-> unit number "4 2 1",
        				   title is "Das Spiel beginnen"
 
 o Lines that are neither the first document line nor start with
   a unit number are texts. In texts, there may be links to other
   units, e.g. like `Test Link'. Such links start with an 
   "`"-character and end with an
   "'"-character, containing the title of the required unit. Such
   links must be in one line.
   

  Example: Please look at this document as example!
  ~~~~~~~~

2.2.1. Test Link
---------------

 You have clicked on the test link, so you are now in this chapter.
 Simply retrace or click `Text file organization' to get back.

2.3. Options
-------------

 These options can be supplied to Text2Guide as arguments after
 the input and output file name. "-" will put off an option,
 "+" will put it on.

 Option u: ignore underline lines, default on.
 ~~~~~~~~~
 	If this option is on, lines directly following to lines
 	with unit numbers are ignored. That is to let you 
 	underline such units in the plain text file.
 	
 	For example this unit is defined in the text file by
 	these two lines:
 	
 	2.3. Options
        -------------
        
        If option u would be off, you would see the "-------------"
        at the top of the window in the guide document...
 
 Option w: out warnings, default on.
 ~~~~~~~~~
 	If this option is on, warnings are written, else not.
 	You should normally not put this off.
 	
 Option t: test for multiple nodes, default on.
 ~~~~~~~~~
 	If this option is on, Text2Guide will perform a test for
 	multiple defined nodes (->units) after transforming, and
 	produce warnings if multiple nodes are found.
 	Note that with "t" on and "w" off the test will be 
 	performed but no warnings written.
 	

 Example: Text2Guide Text2Guide.doc Text2Guide.guide -wt +u
 ~~~~~~~~
	This will recompile this document; no warnings will
	be written and not multiple node test will be 
	performed; underlines of units will be omitted (though
	"+o" is obsolete as the default is on).


3. The Author
==============

 The author is me and I am the author.
 
 Send your enthusiastic mails to:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 o Address:	Stephan Sürken
 		Kurt-Schumacher-Str. 34 A 161
 		D-67663 Kaiserslautern

 o E-Mail:	s_suerke@informatik.uni-kl.de

 Please send much money to:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 o Bank account:Stadtsparkasse Kaiserslautern, FRG

		BLZ: 540 501 10		identity of bank in germany
		KTO: 128 029 758	number of my bank account