Hallo Leute,
habe da mal eine Frage an euch.
Hat einer von euch mal eine Hilfe für eine eigen entwickelte Datenbank geschrieben? Wenn ja wie habe ihr es gemacht? Gibt es da irgendwo eine kleine Anleitung wie man das am besten macht?
Hilfe in Notes erstellen
- Benim
- Erledigt
-
-
da gibt es der Möglichkeiten viele.
1. Feldhilfe
2. Benutzen dieser DB
3. Über diese DB
4. eine eigene Hilfe DB, dann kannst Du relativ einfach per Formel darauf zugreifen und die Hilfe ist (falls gewünscht) vom Anwender erweiterbar.
5. externes Wiki (hängt von Eurer Umgebung ab)Inhalt für Hilfe:
- Benutzung und Zweck der Ansichten, Masken
- ggf. Symbollegenden
- Wirkung von Schaltflächen
- Welche Automatismen werden verwendet?
- Rechte ACL (Infos für den Admin)
- An welche Regeln wurde sich beim Entwickeln gehalten (Infos für Entwickler)Quellen:
- eventuell Pflichtenheft
- Vorbesprechung mit Kunden, in denen die Anforderungen an die DB besprochen wurden.War jetzt alles allgemein und ist bestimmt auch nicht vollständig.
Gruß
Dirk -
Hallo Benim,
ich habe für jede eigene Anwendung eine extra Hilfe-DB erstellt.
Der Pfad zu der Hilfe-DB/Server/Startansicht ist im jeweiligen Profil-Doc konfigurierbar.Natürlich sind alle Hilfe-DBs identisch aufgebaut und von einer Schablone (umgebaute Diskussionsschablone) erstellt.
Grund: wenn die Anwendung irgendwann stirbt (d.h. durch eine andere ersetzt wird), dann kann man auch die Hilfe-DB beruhigt mitlöschen.)Die Poweruser dürfen auch was reinschreiben.
Eine globale Hilfe-DB (hatten wir früher) hat sich als unleserlich und schlecht administrierbar erwiesen.
"Benutzen dieser DB" nutzen wir gar nicht.
In "Über diese DB" haben wir übliche Informationen: wozu die Anwendung gut ist, Entwickler, Version usw.
Manchmal nutzen wir Field Hints für die konkrete Felder.
-
In den Masken, Ansichten, Pages...gibt es das onHelp-Event.
Hier kann man sehr schön via Formel einen Agenten aufrufen.
Über set doc = workspace.CurrentDocument.Document kann man für Masken den Namen bestimmen: doc.Name bzw. doc.Aliases.
Wenn dabei nix rauskommt, ist es wohl eine Ansicht: workspace.currentview. In der/n Hilfedatenbanken kann man so das passende Hilfe-Dokument suchen zB. docHilfe = vw.getdocumentbykey, search...
dann noch
Call workspace.opendatabase(dbserver,dbname)
Set uidb = workspace.currentdatabase
Call uidb.openview("Hilfe")
Set uivw = workspace.currentview
Call uivw.selectdocument(docHilfe)
Call workspace.viewrefresh()
Call workspace.settargetframe("HilfeInhaltFrame")
Call workspace.editDocument(True)so öffnet jedes F1 das passende Doc zum focussierten Designelement.
-
schau Dir dazu mal in der Designer-Hilfe @Command( [OpenHelpDocument]) an.
Gruß
Dirk