home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d8xx / d827 / askreq.lha / AskReq / AskReq.dok < prev    next >
Text File  |  2001-02-25  |  9KB  |  288 lines

  1.  
  2.  
  3.                                 Dokumentation
  4.  
  5.                                 AskReq 1.00
  6.  
  7.                      (c) und geschrieben 1992 H.P.G FreeWare
  8.  
  9.  
  10.  
  11. Index:
  12.         Index
  13.         Was ist AskReq
  14.         System Anforderungen
  15.         Rechtliches
  16.         AskReq starten
  17.         Cli Argumente
  18.         Beispiele
  19.         Technisches
  20.         Adresse
  21.         Liste der Dateien
  22.  
  23.  
  24. Was ist AskReq:
  25.  
  26.     AskReq ist noch ein Batch Requester Tool. Man wird sich fragen WOZU denn.
  27.     AskReq kann den Benutzer nicht nur zwischen OKAY oder ABBRUCH entscheiden
  28.     lassen, sondern auch Text und Zahleneigaben tätigen lassen. Die Resultate
  29.     können in jeder Art von Batch-Dateien verwendet werden. AskReq ist ähn-
  30.     lich der Requester Funktion in der rexxarplib.library, aber es werden nur
  31.     OS 2.0 Funktionen benutzt.
  32.  
  33. System Anforderungen:
  34.  
  35.     AskReq benötigt mindestens OS 2.04 (37L) um zu laufen.
  36.  
  37. Rechtliches:
  38.  
  39.  
  40.         Ich habe mich entschlossen dieses Programm und alle beigefügten
  41.         Dateien und Scripts, sowie aller Anleitungen, als FREEWARE   zu
  42.         deklarieren.
  43.  
  44.         D.h.:
  45.  
  46.             Jeder kann AskReq benutzen.
  47.             Jeder darf AskReq weitergeben, wenn:
  48.  
  49.                 1. Alle unten aufgeführten Programme mit  weitergegeben
  50.                    werden,
  51.  
  52.                 2. Keinerlei Veränderungen der unten aufgeführten  Pro-
  53.                    grammen (am Ende der Anleitung)  vorgenommen wurden,
  54.  
  55.                 3. Bei  Nachkompilierungen  der QuellCodes muß ein Hin-
  56.                    weis  auf  den  Orginalprogrammierer beigefügt sein,
  57.                    bei  Herausgabe  dieser,  muß  eine  Kopie  an  mich
  58.                    gesandt werden.
  59.  
  60.                 4. AskReq darf nicht verkauft werden.
  61.  
  62.                        Außnahme: Es darf eine geringe  Kopiergebühr er-
  63.                                  hoben werden, die aber  5 DM  bzw. den
  64.                                  entsprechenden  Gegenwert  in  anderen
  65.                                  Währungen nicht übersteigt.
  66.  
  67.                 5. AskReq  darf  nur als Teil eines kommerziellen Produktes
  68.                    herrausgegeben  werden,  mit ausdrücklicher schrift-
  69.                    licher Genehmigung des Autors (Adresse siehe unten).
  70.  
  71.                 Zuwiderhandlungen  der  oben  Aufgeführten  Konditionen
  72.                 werden Zivilrechtlich verfolgt.
  73.  
  74.  
  75.         Ferner  wird  für  die Funktion des Programmes ,sowie möglicher
  76.         Folgen  der  Benutzung  des Programmes sowie der u. a. Dateien,
  77.         keinerlei Gewährleistung übernommen.
  78.  
  79.         !!! Alle Risiken trägt der Benutzer allein !!!
  80.  
  81. AskReq starten:
  82.  
  83.     AskReq kann nur vom CLI aus gestartet werden. Zur Zeit keinen WBench-
  84.     support. Alternativ kann man Programme wie XIcon oder IconX benutzen oder
  85.     aber den `Execute Command ...` Menupunkt der WBench oder das ToolType CLI
  86.     setzen.
  87.  
  88. Cli Argumente:
  89.  
  90.     Wenn man AskReq vom CLI aus startet, benutzt es die folgende
  91.     Kommandozeilensyntax:
  92.  
  93. Syntax: AskReq [Hail=H/K]<Message=M/K>[Pos=P/K][Neg=N/K][GadgetText=G/K]
  94.                [STRING=S/K][INT=I/S][TimeOut=T/K/N]
  95.  
  96.     mit:
  97.  
  98.     Hail
  99.  
  100.         Dies ist der Titel des Requesters. Wird Hail weggelassen, benutzt
  101.         der Requester die Voreinstellung: `Ask Requester ...`
  102.  
  103.     Message
  104.  
  105.         Dies ist die Nachricht, die an den Benutzer geschickt werden soll.
  106.         Der Text kann bis zu 4 Zeilen enthalten, die durch ein `|` abge-
  107.         trennt werden können. Wenn der Text Leerzeilen enthält, muß er in
  108.         ""`s gesetzt werden.
  109.         Als Message existiert keine Voreinstellung.
  110.  
  111.     Pos
  112.  
  113.         Dies ist der Text des positiven (linken) Gadgets. Wird Pos angegeben,
  114.         so stellt AskReq ein positives Gadget dar, sonst wird kein positives
  115.         Gadget dargestellt.
  116.  
  117.     Neg
  118.  
  119.         Dies ist der Gadgettext des negativen (rechten) Gadgets. Wird Neg an-
  120.         gegeben, wird ein negatives Gadgets dargestellt, sonst nicht. In die-
  121.         sem Fall muß aber entweder String oder Integer (siehe später) ange-
  122.         geben werden. Ansonsten wird ein voreingestelltes Gadget mit dem
  123.         Text `Proceed` (Fortfahren) angezeigt.
  124.  
  125.     GadgetText
  126.  
  127.         Das ist der voreingestellte Text des Integer oder String Gadgets.
  128.         Wenn Integer angegeben wird, (siehe später) muß dies eine Nummer
  129.         sein.
  130.  
  131.     STRING
  132.  
  133.         Wird String angegeben, wird ein String Gadget dargestellt.
  134.         Voreinstellung: keines.
  135.  
  136.     INT
  137.  
  138.         Wird INT angegeben, wird ein Integer Gadget dargestellt.
  139.         Voreinstellung: keines.
  140.  
  141.     TimeOut
  142.  
  143.         Mittels TimeOut kann man ein optionales Zeitlimit für das Beantworten
  144.         des Requesters setzen. Wurde bis nach Ablauf dieser Zeit der Reques-
  145.         ter nicht beantwortet, wird er selbstständig beendet und liefert als
  146.         Returncode 0.
  147.         Voreinstellung: keiner.
  148.  
  149.  
  150.     Man kann String oder INT mit oder ohne weiteren Gadgets angeben.
  151.  
  152.  
  153.     Wird kein Gadget angegeben, wird das voreingestellte Proceed Gadget
  154.     angezeigt.
  155.  
  156.     Wird nur String oder INT angegeben, wird der Requester nach Drücken der
  157.     Return-Taste beendet.
  158.  
  159.     Wird ein positives Gadget ausgewählt, so liefert AskReq den Returncode
  160.     5 (WARN). Dieser kann in Batch Dateien auf einfache Art abgefragt werden.
  161.  
  162.  
  163. Beispiele:
  164.  
  165.     Es folgen nun einige Beispiele, wie man AskReq benutzen kann.
  166.  
  167.     1.) Ein einfacher Nachrichten Requester
  168.  
  169.     1.> AskReq M "Dies ist Version 1.00 des|fabelhaften AskReq Requesters"
  170.  
  171.     Da kein Gadget angegeben wurde, wird das voreingestellte Proceed Gadget
  172.     dargestellt.
  173.  
  174.     2.) Ein Entscheidungsrequester, daß den Benutzer eine Entscheidung er-
  175.         möglicht.
  176.  
  177.     ;-----------  Batch Datei
  178.  
  179.     AskReq M "Dies ist Version 1.00 des|fabelhaften AskReq Requester?|
  180.     Mögen Sie es?" POS "Oh Jaa !!!" NEG "Niemals"
  181.  
  182.     ; Öffnet einen Requester mit zwei Gadgets und drei Zeilen Text
  183.  
  184.     If WARN    ; Der Benutzer wählte `Oh Jaa !!!`
  185.         Echo "Oh wie schön :-)"
  186.     Else
  187.         Echo "Warum mögen Sie mich nicht :-( ???"
  188.     Endif
  189.  
  190.     ;----------- END
  191.  
  192.  
  193.     3.) Ein Requester, der nach dem Namen des Benutzers fragt und sich
  194.         dieses nocheinmal bestätigen läßt. Die englische VErsion dieses
  195.         Beispiels ist auch im Examples-Verzeichnis.
  196.  
  197.  
  198.  
  199.  
  200.  
  201.     ;-----------  Batch Datei
  202.  
  203.     Set ANSW `AskReq M "Bitte geben Sie Ihren Namen ein,|damit ich weiß wer
  204.     Sie sind!" S`
  205.  
  206.     ; Dies öffnet einen Requester mit nur einem String Gadget und zwei Zeilen
  207.     ; Text. Das Resultat wird dann in die Variable ANSW gespeichert.
  208.  
  209.     Set AGE `AskReq M "Und nun möchte ich gerne Ihr Alter erfahren.|Sind Sie
  210.     überhaupt schon alt genug,|um mich etwas zu fragen :-| ?" I`
  211.  
  212.     ; Dies öffnet einen Requester mit nur einen INT Gadget und drei Zeilen
  213.     ; Text. das Resultat wird dann in die Variable AGE gespeichert.
  214.  
  215.     AskReq M "Da ich jetzt Ihre Daten habe, kann ich weitermachen"
  216.  
  217.     ; Nur ein Informationsrequester
  218.     ; Nun fragen wir den Benutzer, ob die Daten korrekt sind
  219.  
  220.     Set ANSW `AskReq M "Sie sagten, Ihren Namen|Ist dies wirklich Ihr
  221.     richtiger Name ?" S G $ANSW POS OKAY NEG "Vergiß es"`
  222.  
  223.     ; Öffnet eienen Requester mit einem String Gadget und zwei BOOL Gadgets.
  224.     ; Das String Gadget enthält jetzt die zuvor gemachte Eingabe für den
  225.     ; Namen des Benutzers.
  226.  
  227.     If $ANSW EQ ""  ; Kein Name angegeben
  228.         echo "Sie wollen also lieber anonym bleiben!"
  229.     Else
  230.         echo "Ihr Name ist "
  231.         echo $ANSW
  232.     Endif
  233.  
  234.     Set AGE `AskReq M "Sie gaben Ihr Alter an|Ist dies wirklich Ihr Alter ?"
  235.      I G $AGE POS OKAY NEG "Vergeß es"`
  236.  
  237.     ; Dies öffnet einen Requester mit einen Integer Gadget und zwei BOOL
  238.     ; Gadgets. Das Integer Gadget beinhaltet da szuvor eingegebene Alter
  239.  
  240.     If $AGE EQ ""  ; Kein Alter angegeben
  241.         echo "Sie wollen mir Ihr Alter nicht erzählen"
  242.         return 5
  243.     Else
  244.         echo "Sie sind"
  245.         echo $AGE
  246.         echo "Jahre alt"
  247.     Endif
  248.  
  249.     echo "Danke, "ANSW " Für Ihre Daten"
  250.  
  251.     ;----------- END
  252.  
  253.  
  254.     Man sieht, AskReq kann für alle Arten von Batch Dateiabfragen verwendet
  255.     werden. AskReq läßt den Benutzer Entscheidungen fällen, mit deren Hilfe
  256.     man in Scripts zu verschiedenen Labels usw. springen kann.
  257.  
  258. Technical:
  259.  
  260.     AskReq benutzt die GadTools.Library und die ReadArgs DOS-Funktionen.
  261.     Es ist komplett mit dem Aztec C System Version 5.2 geschrieben worden.
  262.     Quellcodes sind von Autor anzufordern.
  263.  
  264. Adresse:
  265.  
  266.     Bitte alle Arten von Post, BUG Reporte, Geschenke etc. an die folgende
  267.     Adresse schicken:
  268.  
  269.         Hans-Peter Günther
  270.         Grüner Weg 5
  271.         3501 Fuldatal 2
  272.         W-Germany
  273.  
  274. Viel Spaß ...
  275.  
  276. Liste der Dateien:
  277.  
  278.     Das komplette AskReq-Paket umfaßt:
  279.  
  280.     AskReq             : Das Programm
  281.     AskReq.info
  282.     AskReq.doc         : Englische Dokumentation
  283.     AskReq.doc.info
  284.     AskReq.dok         : Deutsche Dokumentation
  285.     AskReq.dok.info
  286.     example.bat       : das 3. Beispiel in Englisch
  287.     example.bat.info
  288.