Info: Enthaelt die fuer das Hilfesystem notwendigen Befehle. Die Hilfetexte werden in den Listen 'help' und 'helpindex' abgespeichert.
Sonstiges: make_help_html
Einfuehrung: Die Benutzung in den eigenen Files ist ganz einfach:
Diese Schluesselworte koennen verwendet und natuerlich auch erweitert werden:
info 0 Info:
syn 0 Syntax:
misc 0 Sonstiges:
adapt 1 Anpassen an Mud:
ex 0 Beispiel:
return 1 Rueckgabewert:
see 0 Siehe auch:
comm 0 Kommandos:
mak 1 Makros:
hook 1 Hooks:
trig 1 Trigger:
over 1 TF-Befehle:
func 1 TF-Funktionen:
var 1 Variablen:
list 1 Listen:
fileinfo 0 Datei:
type 2 Typ:
Ein Hilfeeintrag sieht z.B. so aus:
/addh info \
Holt eine/viele Variable aus dem Stack. Wenn Variablenname(n) uebergeben werden, wird der Wert in dieser Variablen gespeichert.
/addh ex /pop
/pop test
/pop test test2
/addh return der Inhalt der letzten Variablen
/addh see push, getstack, putstack
/addh pop mak
Die Hilfe im tf sieht dann so aus:
Makros: pop
Info: Holt eine/viele Variable aus dem Stack. Wenn Variablenname(n) uebergeben
werden, wird der Wert in dieser Variablen gespeichert.
Beispiel: /pop
/pop test
/pop test test2
Siehe auch: push, getstack, putstack
Datei: util.tf
Aus der Hilfe koennen dann auch HTML-Seiten erzeugt werden. Durch eine Angabe am Ende der Files kann eine Zusammenfassung fuer das Makrofile erzeugt werden.
Da die Erzeugung der Hilfeinformationen nur auf Wunsch geschieht, sind die Ladezeiten ansonsten kaum beeinflusst.
Es gibt eine Moeglichkeit, Makros mit /defh zu definieren, so dass sie interaktiv Hilfe liefert. Z.B. zeigt "/showway -?" oder "/showway -h" den Hilfeeintrag an.
Kommandos: make_help, hilfe, make_html_file, hilfe_html
Makros: addh, addh_fileinfo, fi_add0, fi_add, defh, show_help, show_help_html, make_hrefs
Benoetigt: !lists.tf util.sfunc.tf
Variablen: tf_html
Listen: help(tf), helpindex, addh_sublist, help_keywords
Datei: help.tf
Version: help.tf,v 1.8 2001/09/11 23:49:30 mh14 (Mesirii@mg.mud.de)
Aenderungen: 1.01 Help keyword changes = Aenderungen ist dazugekommen.
1.02 neues Hilfekeyword req=Benoetigt:, einige Dateien haben jetzt Tutorials anbei.
-------------------------
(top) Source of: help.tf
Info: Wird von /mload beim Laden eines Files aufgerufen. Es werden die Variable 'file_name' gesetzt und
Datei: help.tf
Info: Enthaelt die moeglichen Schluesselworte fuer die Hilfebefehle.
Beispiel:
mak(key) 1 Makros:(value, 0|1|2 Detailstufe, Ueberschrift)
Datei: help.tf
Info: Ermoeglicht es, neue Eintraege in das Hilfesystem einzufuegen. Dazu werden zuerst die gewuenschten Rubriken gefuellt und danach alle in die Hilfe eingetragen. Bei den Texten koennen alle von /echo(tf) -p bekannten Formatierungen benutzt werden und ausserdem noch @@\{N} fuer Zeilenumbrueche.
Syntax:
/addh info|syn|var|list|return|mak|comm|ex|see Text mit Formatierungen
und zum Schluss: /addh eintrag
Siehe auch: help(tf), echo(tf), echo2
Listen: help(tf), helpindex, addh_sublist, help_keywords
Datei: help.tf
Info: Fuegt die in dieser Makrodatei erstellten Kommandos und Makros in den Hilfeeintrag fuer die Datei ein und schliesst diesen Hilfeeintrag ab.
Variablen: fi_list, file_name
Listen: file_comm, file_mak
Datei: help.tf
Info: Hilfsmakro, das die einzelnen Teillisten oder Subtopics eines Eintrags in die Hilfeliste schreibt.
Variablen: temp_list, fi_list, help_list_%help_keywords
Datei: help.tf
Info: Haengt Parameter an Variable %fi_list an.
Variablen: fi_list
Datei: help.tf
Info: Erzeugt Makros, die mit den Parametern '-h' und '-?' ihren entsprechenden Hilfetext darstellen. Das sollten alle interaktiven Makros sein.
Datei: help.tf
Info: Falls vorhanden zeigt es den Hilfetext fuer den angegebenen Parameter an. Mit einem vorangestellten '+' wird eine ausfuehrliche Hilfe angezeigt. Ansonsten gibt es den Parameter an das tf-Hilfesystem weiter.
Syntax:
/hilfe [+][/]eintrag
Variablen: addh_sublist
Listen: helpindex, help(tf), addh_sublist
Datei: help.tf
Info: Erzeugt ein HTML-Hilfefile aus dem uebergebenen Hilfeeintrag, moeglichst eine Makrodatei, aber auch ein einzelnes Kommando ist moeglich. An den uebergebenen Namen wird ein .html angehaengt. Es werden auch die in der Hilfebeschreibung referenzierten im selben File definierten Makros mit auf die Seite gepackt. Ein '+' vor dem Namen erzeugt eine Entwicklerversion (ausfuehrlicher).
Syntax:
/make_html_file [+]macro(datei)
Kommandos: hilfe_html
TF-Funktionen: tfio(tf)
Variablen: html_eval_list, html_full,
Datei: help.tf
Info: Gibt per /echo(tf) eine HTML-Version der Onlinehilfe fuer einen Hilfeeintrag aus.
Siehe auch: hilfe, make_html_file
Kommandos: help(tf)
Makros: forEach, show_help_html
Variablen: html_full, html_file_name,
Listen: addh_sublist, help_keywords
Datei: help.tf
Info: Zeigt die einzelnen Rubriken eines Hilfethemas an. Dabei ist der komplette Eintrag in der Liste 'addh_sublist' enthalten.
Syntax:
/show_help 0|1 Hilfeschluesselwort 0|1 Titel
Makros: echo2, getvalueof
Listen: addh_sublist
Datei: help.tf
Info: Zeigt die einzelnen Rubriken eines Hilfethemas als HTML-Quelltext an. Dabei ist der komplette Eintrag in der Liste 'addh_sublist' enthalten.
Syntax:
/show_help_html 0|1 Hilfeschluesselwort 0|1 Titel
Makros: echo2, getvalueof
Listen: addh_sublist,
Datei: help.tf
Info: Pfad zu tf-Hilfe HTML-Seiten.
Beispiel:
tf_html=file://localhost/data/docs/tf/commands/index.html
Datei: help.tf
Info: Scannt uebergebene Strings nach potentiellen Links und erzeugt diese, Parameteruebergabe in %value.
Rueckgabewert: in %value der modifizierte String
Kommandos: help(tf)
Variablen: html_file_name, html_eval_list, value
Listen: help_keywords, help(tf)
Datei: help.tf
Info: Eine Einfuehrung als solche gibt es nicht, bitte die Hilfeseite zum Dateisystem mit "/hilfe loading.tf" anschauen und dann von dort weiter verzweigen.
Siehe auch: loading.tf
Datei: help.tf
help.tf,v 1.8 2001/09/11 23:49:30 mh14 (Mesirii@mg.mud.de) Hilfesystem mit Hilfegenerierung (Listen+Html) Requires: !lists.tf util.sfunc.tf
This file was created using TinyFugue (c) 1998 by Ken Keys at Fre 14 Sep 2001 23:34:07 MEST by Michael Hunger (mh14@inf.tu-dresden.de).