@database "AGImport Guide"
@author "Heiko Schröder"
@$VER: 3.0 (Release 3)
@wordwrap

@node main "AmigaGuide-Import V1.0"
                               @{" < Table of Contents " link "Macro-Package.guide/Main"}

@{fg shine}Benefits:@{fg text}
   How often you have tried to edit AmigaGuide documents with FinalWriter?
   You know how complicated this can be!

   From now on this macro will help you a lot. It imports guides with their
   correct layout and automatically sets up references to the corresponding
   chapters. 

@{fg shine}Requirements:@{fg text}
   Correctly formatted Amiga guides. ;-)

@{fg shine}Limitations:@{fg text}
   At the moment only guides consisting of a single file can be imported
   correctly.  

@{fg shine}Using the @{"macro" system "Sys:Utilities/Multiview AGImport.iff"}:@{fg text}

  In the top of the window you can see the preset data for the guide 
  importion.  You can easily alter the presets using: Project | @{"Preferences..." link "Voreinst"}


                     - - - - - - - - - - - - - - - - - 

   @{fg fill}A@{fg text}pply
      With this you start importing.  By selecting the Guide.
      The progress display shows you the approximated importing time.

      @{fg shine}Hint:@{fg text}
         * PROVISIONAL reference identifiers are set, created from the
           Amigaguide instruction: "link". 

         * If you require page numbers on the pages, you should set them up
           with the menu: Extra | Easy Page Number... 
           Unfortunately, this is not feasible with the macro.

* Please don't delete the reference identifiers in ANY CASE.
  You can recognize them by the characters @{fg shine}ð@{fg text} and @{fg shine}æ@{fg text} followed by a number.
  They are very important for reference setting later on.
 
   @{fg fill}L@{fg text}inks
      If you altered the layout Guides to your preferences, you can let the
      macro set the references (links). Afterwards, the reference identifiers
      are deleted.
      The document thereby is completed.

   @{fg fill}C@{fg text}ancel
   @{fg fill}ESC@{fg text} or closing the window
      Terminates the macro.

                     - - - - - - - - - - - - - - - - - 

@{fg shine}Hint:@{fg text}
      If there are any problems (e.g. the macro don't start any more or 
      something like this), please delete the preferences file

      "S:FW_AGImport.prefs". 

      Generally, this will fix the error.
@endnode

@node Voreinst "Preferences for Amigaguide-Import"

   With the preferences you can set the layout of the imported guide to your
   preferences.

   @{fg shine}Headlines:@{fg text}
      The guide identifies them through the instructions @node and/or @title.
      You can set the @{fg fill}F@{fg text}ont and Font S@{fg fill}i@{fg text}ze for all headlines.

   @{fg shine}Body Text:@{fg text}
      All the actual text of the guide is called body text. You change
      its appearance by setting the Fon@{fg fill}t@{fg text} and Font Si@{fg fill}z@{fg text}e.

   @{fg shine}Miscellaneous:@{fg text}
   @{fg fill}L@{fg text}ink Format:
      Here you can change the format of the references in the body text.        
      %K = Symbol, standing for section name
      %S = Symbol, standing for page numbers

      !!! Please don't use quotation marks. !!!

      A few examples:
                         (see %K on page %S)
         e.g. results in (see Preface on page 2)

                         (see chapter: %K on p.%S)
         e.g. results in (see chapter: Prehistory on p.24)

                          => %K, p. %S
         e.g. results in  => Prehistory, p. 2


   Write @{fg fill}@@{fg text}node:
      @node is an Amigaguide instruction which marks a new paragraph. 
      This instruction also hides the name of the paragraph or say the section
      name. Some programmers write the name of the section in the normal text 
      too. So you can suppress the writing of the @node section name to avoid
      a duplication.

   Page @{fg fill}B@{fg text}reak:
      Indicate here whether there should be a page break after each section of
      the Amigaguide (marked by @node and @endnode) or not.

   S@{fg fill}p@{fg text}eed:
      It is really useful to set the speed to "fast". The document view will 
      then be reduced to 20%, which results in an enormous speed increment.

                     - - - - - - - - - - - - - - - - - 

   @{fg fill}S@{fg text}ave
      The altered data will be saved permanently in the file
      "S:FW_AGImport.prefs".
      After a restart the macro will use these preferences after each start.

   @{fg fill}A@{fg text}pply
      The altered data is used only for the current session of the macro.
      After the next restart of the macro the old values are used again.

   @{fg fill}C@{fg text}ancel
      All adjustments are reset to the last saved values.

@endnode