home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_disks / 300-399 / ff332.lzh / Helper / Helper_D.dok < prev    next >
Text File  |  1990-03-20  |  7KB  |  178 lines
  1. HELPER V1.01
  2. ============
  3.  
  4. Der Helper ist ein Utility zum Erhellen des Schattendaseins der HELP-Taste.
  5. Der  Aufruf  erfolgt vom CLI aus mit »Run« oder besser »RunBack«.  Wird als
  6. Argument ein "?" angegeben, so zeigt der Helper seine möglichen Optionen an
  7. (diese  werden weiter unten noch genauer erklärt).  Der Helper benötigt die
  8. "req.library" von Colin Fox und Bruce Dawson. (Great work, Colin and Bruce!
  9. I  don't  know,  how  I  ever  made  it  without that masterpiece of Amiga-
  10. programming-art!)
  11.  
  12. Das  Programm installiert einen InputEventHandler mit der Priorität 51, der
  13. die  Aufgabe hat, beim Betätigen der Helptaste dem Hauptprogramm ein Signal
  14. zu   senden.   Das  Hauptprogramm  bringt  dann  einen  Requester  auf  den
  15. Bildschirm, der in etwa folgendes Aussehen hat:
  16.  
  17.           +---------------------------------------------------+
  18.           |   Was möchtest du?                                |
  19.           | +------------+ +---------------+ +--------------+ |
  20.           | | Notizblatt | | Farben ändern | | Text ansehen | |
  21.           | +------------+ +---------------+ +--------------+ |
  22.           +---------------------------------------------------+
  23.  
  24. Durch  Anklicken  des dem eigenen Wunsche am nächsten kommenden Feldes kann
  25. nun eine der drei Funktionen des Helpers aktiviert werden.
  26.  
  27.  
  28. Farben ändern:
  29. ==============
  30.  
  31. Dazu ist nicht viel zu sagen.  Man erhält den Farb-Requester der Requester-
  32. Library  auf  dem  aktuellen Screen, und kann somit auch in Programmen, die
  33. keine   Farbwahlmöglichkeit   anbieten,   eine   andere  Farbkonstellation
  34. erstellen.   Die  Funktionen  eines  Farb-Requesters  werden wohl allgemein
  35. bekannt  sein,  so  daß  ich  darauf an dieser Stelle nicht weiter eingehen
  36. werde.
  37.  
  38.  
  39. Notizblatt:
  40. ===========
  41.  
  42. Ich  glaube  nicht, daß es hier nötig ist, über den Sinn eines Notizblattes
  43. zu  meditieren.   Für  das  Notizblatt wird ein 640*256er-Fenster geöffnet,
  44. wenn  möglich  auf  dem  aktuellen  Screen  (wie auch die anderen Requester
  45. soweit  möglich  auf  jenem  Screen  erscheinen,  in  welchem die Helptaste
  46. betätigt  wurde).   Sind  die Screendimensionen des aktuellen Screens nicht
  47. groß  genug  für  das  Fenster, dann wird es auf der Workbench geöffnet und
  48. gleichzeitig  der  Workbenchscreen  in  den  Vordergrund  geschaltet.   Das
  49. Notizblatt ist wirklich nur ein "Blatt", als Schreibfläche steht nur der im
  50. Fenster  sichtbare  Bereich zur Verfügung.  Geschlossen wird das Notizblatt
  51. wie gewohnt über das CloseGadget in der linken oberen Ecke.  Der Inhalt des
  52. Notizblattes bleibt über das Schließen hinweg erhalten.
  53.  
  54. Folgende Tastenfunktionen sind implementiert:
  55.  
  56.  - CURSOR, BACKSPACE, DELETE und RETURN: Standard
  57.  
  58.  - SHIFT-CURSOR: Anfang/Ende der Zeile bzw. oberer/unterer Rand in der
  59.                  Spalte.
  60.  
  61.  - CTRL-K: Zeile löschen
  62.  - CTRL-L: Ganzen Text löschen
  63.  - CTRL-E: Zeichen einfügen
  64.  - CTRL-S: Blatt speichern
  65.  - CTRL-Z: Blatt zurückholen (laden)
  66.  - CTRL-U: Uhrzeit einsetzen
  67.  - CTRL-D: Datum einsetzen
  68.  
  69. Notizblatt-Dateien  werden  per  Voreinstellung  im  logischen  Gerät  "T:"
  70. abgelegt  und  gesucht.   Sie  haben  ein eigenes Format und sind durch die
  71. Endung ".note" identifizierbar.
  72.  
  73.  
  74. Text ansehen:
  75. =============
  76.  
  77. Das  ist  die  eigentliche  und  ursprüngliche Funktion, die ich dem Helper
  78. zugedacht  hatte.   Wer  ist noch nicht in der Situation gewesen, plötzlich
  79. mal  schnell  einen Blick in irgendein Dokumentationsfile werfen zu müssen?
  80. Die  bisherige  Prozedur  war  sicherlich  von der Art Shell starten - Text
  81. suchen  - Text anzeigen (mit Editor oder More).  Daß dies eine umständliche
  82. und  bisweilen den Arbeitsablauf sehr störende Prozedur ist, muß wohl nicht
  83. extra betont werden.
  84.  
  85. Der  Helper  kann  Folgendes  tun,  um diesen Mißstand zu beseitigen:  Beim
  86. Aktivieren  der Funktion »Text ansehen« wird ein Datei-Requester angezeigt,
  87. dessen  Voreingestelltes  Verzeichnis das logische Gerät "HELP:" ist.  Hier
  88. kann   nun   eine   Datei   (evtl.    aus   einem   Unterverzeichnis,  etwa
  89. "HELP:ARP_Docs")  ausgewählt  werden.   Diese  Datei wird nun an ein vorher
  90. definiertes     Programm     übergeben.     Dies    ist    im    Normalfall
  91. "SYS:Utilities/More",  und  für  den  Fall,  daß  man sich gerade auf einem
  92. anderen  Screen  befand,  wird  auch automatisch der Workbenchscreen in den
  93. Vordergrund geschaltet.
  94.  
  95. Um  diese  Funktion flexibler zu gestalten, kann man dem Helper beim Aufruf
  96. zwei  Parameter  mit  auf  den  Weg  geben, nämlich "-mPRG" und "-f0/1" (in
  97. dieser Reihenfolge).  Mit der Option "m" kann ein Anzeigeprogramm (de Facto
  98. ein  beliebiges  Programm)  bestimmt werden, daß an Stelle von More benutzt
  99. werden  soll.   Die  Option "f" bestimmt dann, ob beim Aufruf des Programms
  100. der Workbenchscreen nach vorn geholt werden soll ("1") oder nicht ("0", für
  101. die Programme, die einen eigenen Screen öffnen).
  102.  
  103. Man  kann  sich also auf seiner Platte ein Verzeichnis anlegen, in dem sich
  104. die wichtigsten Dokumente und Hilfstexte befinden.  Diesem Verzeichnis wird
  105. dann   in  der  startup-sequence  via  Assign  der  logische  Name  "HELP:"
  106. zugewiesen.    Für   die  Nichtgeplätteten  User  gibt's  natürlich  die
  107. Möglichkeit,  eine  Disk  mit  Namen  "HELP"  anzulegen  und auf dieser die
  108. benötigten Dateien unterzubringen.  Man kann diese Disk dann vor dem Aufruf
  109. der  »Text  ansehen«-Funktion,  oder  wenn der Comp "Volume HELP" verlangt,
  110. einlegen.
  111. Also, ihr Programmierer da draußen:  Verschwendet keine Zeit auf Extramenüs
  112. für Hilfsseiten oder dergleichen, packt einfach den Helper mit bei!
  113.  
  114.  
  115. startup-sequence:
  116. =================
  117.  
  118. Die startup-sequence kann zum Beispiel folgendermaßen aussehen:
  119. ...
  120. assign HELP: DH0:HilfsTexte
  121. runback Helper -mSYS:Tools/Less -f0
  122. ...
  123.  
  124.  
  125. BREAK_CTRL_C:
  126. =============
  127.  
  128. Der Helper kann im Wartezustand (d.h.  wenn keine Funktion aktiv ist) durch
  129. eine  normale Unterbrechung der Klasse C beendet werden.  Also zum Beispiel
  130. mit Hilfe des Break-Kommandos.  Beispiel:
  131.  
  132. 1> status
  133. Process  2: Loaded as command: status
  134. Process  3: Loaded as command: C:Helper
  135. 1> break 3
  136. 1> status
  137. Process  2: Loaded as command: status
  138. 1>
  139.  
  140.  
  141. Warnung:
  142. ========
  143.  
  144. Der  Helper  hängt sich an das erste Fenster des aktuellen Screens an.  Das
  145. bedeutet,  daß  alle  in  dem  Aufruf  folgenden  Requester sich auf dieses
  146. Fenster  beziehen.   Das bedeutet auch, daß man seinen Amiga todsicher nach
  147. Indien  schickt,  wenn  man  dieses  Fenster  schließt,  solange der Helper
  148. irgendwie sichtbar ist.  Alles klar?
  149.  
  150.  
  151. Allgemeine Info:
  152. ================
  153.  
  154. Der  Helper  (Version  1.01)  ist  Public  Domain,  er  darf  frei kopiert,
  155. weitergegeben  und  über  Mailboxen  und  ähnliche  Einrichtungen  verteilt
  156. werden,  SOLANGE  das  Executable,  diese  Dokumentation und der Sourcecode
  157. unverändert  und zusammen bleiben.  Die NTSC-Version unterscheidet sich von
  158. der "normalen" durch NTSC-Fenstergröße im Notizblatt und englische Texte in
  159. den Requestern.
  160. Entwickelt  und  kompiliert  wurde  der Helper mit Manx Aztec C, mit 16 Bit
  161. Integern und Small Code/Data.
  162.  
  163. Der   Helper   darf  NICHT  von  militärischen  Organisationen  und  deren
  164. Beauftragten benutzt werden.
  165.  
  166. Wenn  der Helper einem kommerziellen Programm beigefügt werden soll, so ist
  167. eine EINMALIGE Gebühr von 100 DM zu bezahlen.  Die req.library ist FreeWare
  168. und steht einer solchen Nutzung nicht im Wege.
  169.  
  170. Anregungen und Kritik gehen an:
  171.  
  172.                               Michael Balzer
  173.                             Wildermuthstraße 18
  174.                              5828 Ennepetal 14
  175.                                  W-GERMANY
  176.  
  177. Happy Programming!
  178.