rzDelphiGuide - a tiny knowledge base

[taaktaak]

Moin, Moin.

Nach nunmehr fast genau einem Jahr "Bauzeit" möchte ich hier mein aktuelles Projekt

rzDelphiGuide

vorstellen. Obwohl noch nicht komplett (welche Software ist überhaupt jemals "fertig"?), gibt es eine ganze Reihe von Funktionalitäten, die ausgiebig getestet werden können; vermutlich ist das Programm bereits für die tägliche Verwendung einsetzbar. Zunächst aber vielleicht eine kurze Vorstellung des Programms:

Die Basisfunktionen von rzDelphiGuide entsprechen zunächst einmal denen der vielen anderen bereits auf dem Markt befindlichen Wissensdatenbanken - aber es gibt auch einige Features, die ich bisher nicht gefunden habe:

• Besonders kompakte Datenhaltung der Texte in einer proprietären Datenbank, dadurch ist keine Installation einer Datenbank erforderlich.

• Übersichtliche Darstellung der Themen in Form einer separaten Baumdarstellung in Funktionsbereichen (Themenübersicht, Suche, Favoriten, Historie).

• Ein weiterer Funktionsbereich "Projekte" ist derzeit in Vorbereitung. NEU

• Umfangreiche Darstellungsoptionen in den Baumansichten; wie z.B. Ein-/Ausblenden der Struktur-/Themenknoten, der Baumstruktur und der "Themenpfade".

• Im Funktionsbereich "Themenübersicht" ist eine Lesezeichenverwaltung verfügbar, die ein bequemes "Bewegen" in großen Baumstrukturen ermöglicht. NEU

• Jedes Thema führt ein Attribut, welches die Textqualität darstellt (Rohtext, fehlerhafter Text, Text in Bearbeitung, Text abgeschlossen). Die Textattribute können in allen Funktionsbereichen editiert werden.

• Umfangreiche Suche nach Themenüberschriften und Stichworten innerhalb der Texte; optionale Hervorhebung gefundener Suchbegriffe im Text und "Durchlaufen" der Fundstellen.

• Zusätzliche komfortable Schlagwortverwaltung. NEU

• Individuelle Benennung der drei verfügbaren Favoriten-Bereiche.

• Teilbares Textanzeigefenster, um in zwei unabhängigen Bereichen in den Thementexten blättern zu können.

• In zusätzlichen "Quickview-Fenstern" können zusätzliche Texte unabhängig vom Inhalt der Haupt-Textanzeige betrachtet werden.

• Besonders umfangreiche Möglichkeiten die Texte im Editiermodus zu erfassen und zu formatieren. Die Texte können Links auf andere Texte innerhalb der "Datenbank", beliebige lokale Dateien und Internetadressen enthalten.

• Komfortable Bearbeitungsmöglichkeiten der Struktur- und Themenknoten direkt in den Baumansichten. Zusätzlich steht ein spezieller Strukturknoten-Editor zur Verfügung.

• Aufruf beliebiger externer Programme über individuell gestaltbares Tools-Menü.

• Zusätzliche Menüs und Listenanzeigen zum direkten Aufruf von eBooks und Internet-Adressen.

• Separate, editierbare (und erweiterbare) Listen für virtuelle Tastencodes und Fehlermeldungen.

• Integrierte ToDo-Funktionalitäten, die bei größerer Anzahl von Themen eine gezielte Bearbeitung der Texte unterstützt. Die ToDo-Verwaltung definiert ein zusätzliches Attribut "Bearbeitungsdringlichkeit".

• Neben diversen Anzeigefiltern bietet die ToDo-Verwaltung eine Auswertung aller vergebenen Themenattribute (Attribut-Statistik).

• Die ToDo-Tabelle kann nach MS EXCEL exportiert werden. NEU

• Integrierte Backup/Restore-Funktion, die sowohl automatische als auch manuelle Sicherungen der "Datenbank" und weiterer vom Programm angelegter Dateien ermöglicht.

• Umfangreiche Möglichkeiten der individuellen Programmkonfiguration.

• Ausführliche Hilfetexte.

Das Programm verwendet keine Fremdkomponenten - alles über den Standard-Funktionsumfang hinausgehende wurde selbst entwickelt.

Von etwa 850 Todo-Einträgen und vermutlich mindestens so vielen zusätzlichen Notizen sind die meisten Punkte nunmehr erledigt - mit diesem Stand möchte ich mich in die Öffentlichkeit wagen. Der Source besteht derzeit aus über 90 Units mit mehr als 50.000 Zeilen; das Projekt beinhaltet über 60 Forms/Frames - das ist für meine Verhältnisse schon 'ne ganze Menge.

Damit der Test der Funktionalitäten möglichst praxisgerecht erfolgen kann, stelle ich einen Test-Datenbestand zur Verfügung. Hierbei handelt es sich um alte und neue Texte, die überwiegend nicht formatiert sind. Die Texte enthalten teilweise unsinnige, falsche oder für einen Dritten uninteressante Information. Die Daten sind zur weiteren Verwendung nicht geeignet.

Ich bitte daher ausdrücklich darum, die Textinhalte hier im Forum nicht zu kommentieren oder diesbezügliche Diskussionen zu beginnen!

Eine Installation des Programmes ist nicht erforderlich; die Registry wird nicht verwendet. Wichtige Hinweise zur Inbetriebnahme sind in der Hilfe unter "Allgemeines, Basisinformationen" und "Allgemeines, Detailinformationen" zu finden - bitte unbedingt lesen!

[taaktaak]

Moin, Moin.

Es ist nun ein viertes Update (Build 1236) der Vorabversion im ersten Post verfügbar; hier einige Erläuterungen zum aktuellen Sachstand:

Aktuelle Änderungen des Build 1236 sind:

• Die Lesezeichen können mit der Tastenkombination Ctrl+Space jetzt in einer Endlosschleife durchlaufen werden.

• Es stehen jetzt maximal 8 Favoritengruppen zur Verfügung, Konfiguration angepasst und korrigiert (Eingabe von doppelten Bezeichner wird jetzt verhindert). Um unnötig große (Popup)Menüs zu vermeiden, ist die Anzahl der verwendeten Favoritengruppen vom Anwender festlegbar. Die Gruppenbezeichner können zusätzlich auch direkt in der Baumdarstelung des Funktionsbereiches umbenannt werden.

• Fehlerhafte Datums-Sortierung im History-Filter-Fenster beseitigt.

• Die im Zuge der farblichen Markierung der "FilterButtons" verloren gegangene "Disabled-Schrift" der Buttons wieder nachgerüstet.

• Freigabe-Fehler eines Filter-Auswahlfensters beseitig.

• Letzten (?!) Fehler infolge Einführung des SingleClickMode beseitigt.

• Die von WInfo gemeldete lange Ladenzeit in einer VM kann ich nicht reproduzieren; innerhalb einer neu aufgesetzen VM mit englischem XP SP 3 (128MB RAM) auf einem nicht sonderlich schnellen PC werden die Texte ohne spürbare Verzögerung geladen - Thema wird erst weiter verfolgt, wenn weitere und konkrete Informationen vorliegen.

• Das ebenfalls von WInfo gemeldete Fehlverhalten, mit Klick auf "Font" im Editiermodus würde sich der Druckerdialog öffnen, kann ebenfalls nicht reproduziert werden; was auch wunderlich wäre, da die Anwendung bisher den Druckerdialog nicht verwendet - Thema wird erst weiter verfolgt, wenn weitere und konkrete Informationen vorliegen.

• Das von WInfo gemeldete "Aufhängen" der ToDo-Verwaltung nach längerem Betrieb konnte bisher ebenfalls nicht reproduziert werden - Thema wird erst weiter verfolgt, wenn weitere und konkrete Informationen vorliegen.

• Die maximale Strukturtiefe der Themen wurde von 5+1 auf 8+1 Ebenen vergrößert; Hilfetexte angepasst.

• Die Datenbankstruktur ist jetzt für ein "tagging" aller Themen vorbereitet. Erfassung, Pflege, Anzeige und Suche der Stichworte sind noch nicht verfügbar.

• Eine (optionale) zusätzliche Strukturierung der einzelnen Themen ist ebenfalls vorbereitet: Auf der rechten Hälfte des Hauptfensters kann jetzt ein zusätzliches PageControl eingeblendet werden, das die zusätzlichen Strukturen aufnehmen wird. Die Bezeichner der zusätzlichen Strukturen werden auf Datensatzebene individuell festlegbar sein. Derzeit gibt es allerdings noch keine benutzbaren Funktionalitäten.

• Die ToDo-Verwaltung hat ein zusätzliches Attribut "Erledigt" erhalten; außerdem wurden einige kleine Erweiterungen und Korrekturen vorgenommen und der Hilfetext angepasst.

• Vorhandene Datenbestände (konkret: deren Indexdatei) müssen mit dem zur Verfügung gestellten Hilfsprogramm "DelphiGuideConvertIDX" konvertiert werden um von der aktuellen Version von rzDelphiGuide gelesen werden zu können! Die Beispieldaten besitzen natürlich bereits die aktuelle Datenstruktur!

• Der Funktionsbereich "Projects" ist neu hinzugekommen; Hilfetexte und Konfiguration sind rudimentär angelegt - der Funktionsbereich bietet noch keine Funktionalitäten.

• Geplante nächste Schritte:
  
  • Erfassung, Pflege und Anzeige der Topic-Stichworte, Erweiterung der Suchfunktion.
  • Spalten des ToDo-Grids individuell ein-/Ausblenden können.
  • Export des ToDo-Grids nach EXCEL.
  • Vereinheitlichung der Tastenbefehle, Erstellung der Hilfe-Befehlsübersichten.
  • Konkretisierung der zusätzlichen Gliederungsstruktur innerhalb eines Themas.
  • Konkretisierung des neuen Funktionsbereichs "Projects".

[Optiplex]

Hallo taaktaak,
will mich mal wieder melden, das Programm gefällt mir immer besser, allerdings ist heute beim Schließen folgender Fehler aufgetreten (siehe Anhang). Ich vermute dass es etwas mit deiner Hilfe zu tun hat. Zwar hatte ich die Hilfe einmal geöffnet aber ich hatte sie danach wieder geschlossen, so dass sie nicht mehr beim schließen des Programms geöffnet war. Ich hoffe dass du damit den Fehler reproduzieren kannst.

Gruß
Dieter

[taaktaak]

Hallo Optiplex.

Danke für das Lob - mit der Fehlermeldung kann ich so leider nix anfangen. Mir ist eine solche noch nie untergekommen; die Hilfe funktioniert seit Monaten ohne Probleme. Hoffentlich hält das nun nicht andere Benutzer davon ab, dort mal hineinzuschauen, das wäre sehr schade! Vermutlich hat der Fehler aber eine andere Ursache. Sind durch diesen Fehler, wie in der Meldung spekuliert, tatsächlich Daten verloren gegangen? Wenn etwas konkreteres bekannt wird, will ich mich sofort darum kümmern.

Im Augenblick bin ich mit dem Aufgabenbereich "Verschlagwortung" beschäftigt. Dazu gibt es einige gute (?!) Ideen, wie der Anwender bei dieser eher nervigen Aufgabe durch das Programm Unterstützung finden kann. Das sollte zum Ende der Woche vorstellungsreif sein.

[v2afrank]

Hallo taaktaak,
weiter oben hast Du gesagt, dass Du dir beim erstellen der Hilfe immer viel Mühe gibst. Ich habe gerade ein bischen in der Hilfe gestöbert und gesehen, dass im Topic Befehlsübereischt die Grafiken für die Buttons fehlen. Das könntest Du noch mal ändern.
Ansonsten kann ich mich nur an das Lob für Dein Programm nur anschliessen. Es wird immer besser

[taaktaak]

Moin, Moin v2afrank.
Jooo, die Hilfe macht 'ne Menge Arbeit. Und das Korrekturlesen der Texte steht noch an, sind also vermutlich noch reichlich Tippfehler enthalten. Die Befehlsübersichten sind im Augenblick nur Platzhalter und noch nicht mit Informationen gefüllt. Nächster Schritt wird sein, gemeinsam mit der Vereinheitlichung der Tastenbefehle, diese Übersichten zu erstellen. Puh, das wird 'ne Fleißarbeit

[Optiplex]

Hallo Taaktaak,
bezüglich der Fehlermeldung kann ich dahingehend beruhigen, dass keine Daten verloren gehen. Auch ist es mir nicht gelungen den Fehler zu reproduzieren.

Gruß
Dieter

[taaktaak]

Moin, Moin.

Es ist nun ein fünftes Update (Build 1287) im ersten Post verfügbar; hier einige Erläuterungen zum aktuellen Sachstand:

• Fehler in den Bereichen "MainForm" (SetSplitterPos), "Find" (Highlighting), "Struktur-Editor" und "Topics" (MoveNode+Anzeige) sowie "ToDo" (diverse) beseitigt.

• Die Lesezeichenverwaltung musste grundlegend überarbeitet werden: Änderungen der Baumstruktur konnten zuvor definierte Lesezeichen in ein heilloses Durcheinander bringen. Bei einem Update auf die aktuelle Programmversion werden vorhandene Lesezeichen nicht übernommen - das ist aber hoffentlich nicht sonderlich tragisch.

• Im Strukturknoten-Editor musste die Prüflogik für Aktivierung/Deaktivierung der Schaltfläche "Delete" korrigiert werden, da auch Strukturknoten mit untergeordneten Themenknoten (manchmal) gelöscht werden konnten.

• Damit bei Verwendung extrem langsamer USB-Sticks eine Datensicherung bei Programmstart praktikabel ist, wurde die Untergrenze der Backups in der Konfiguratin heruntergesetzt und zugleich der Sicherungsvorgang in einen Thread ausgelagert. Das Speichern der INI-Datei bei Beendigung des Programms wurde erheblich beschleunigt.

• Optional wird das Hauptfenster jetzt in Standardgröße an die Standardposition gebracht, wenn es zwischen zwei Monitore gezogen wird und dabei keine Fensterbereiche außerhalb des darstellbaren Desktops liegen.

• Die minimal einzustellende Breite des Hauptfensters wurde auf 768 Pixel herabgesetzt, damit das Programm auch auf einem Tablet PC im Hochformat nutzbar ist.

• Im SingleClickModus wird jetzt nach Sprung zu einem Lesezeichen erforderlichenfalls sofort der assoziierte Text geladen.

• In den Funktionsbereichen "Topics", "ToDo" und "TextEditor" ist jetzt der Zugriff auf eine Schlagwort-Verwaltung verfügbar. Das Formular der schlagwort-Verwaltung verfügt über eine Anzeige aller dem aktuellen Thema zugewiesenen Schlagworte - diese können erfasst, editiert und gelöscht werden.

• Neben der "manuellen Verschlagwortung" können neue Schlagworte alternativ bequem aus drei Auswahllisten eingefügt werden:
  
  • Liste "Topic token" - Liste enthält alle im aktuellen Thema vorhandenen Worte.
  • Liste "Used tags" - Liste enthält alle in der Datenbank bereits verwendeten Schlagworte. Mit dieser Liste erhält der Anwender die Möglichkeit, die Menge unterschiedlicher Begriffe durch "Wiederverwendung" bereits zugewiesener Schlagworte zu reduzieren; zusätzlich wird die Verwendung identischer Begrifflichkeiten gefördert.
  • Liste "Query masks" - Liste enthält (sofern in der Konfiguration aktiviert) alle vom Anwender in den verschiedenen Funktionsbereichen verwendeten Suchmasken (mit Ausnahme von Suchmasken, die Wildcards verwenden). Diese Vorschlagsliste gibt die Möglichkeit, bei der Vergabe von Schlagworten gezielt die Begriffe verwenden zu können, nach denen der Anwender typischerweise tatsächlich sucht.
  • In der Liste "Used tags" sind zusätzlich Funktionalitäten (PopUp-Menü) verfügbar, die es ermöglichen, bereits verwendete Schlagworte datenbankweit umzubenennen und zu löschen.

• Im Zuge der Einführung der Schlagwortverwaltung wurde das Dateiformat der Indexdatei erneut geändert. Die Konvertierung von Datenformat Version 1.0 in das neue Format Version 2.0 erfolgt automatisch mit dem ersten schreibenden Zugriff auf die Indexdatei - der Einsatz des Konvertierungstools ist nicht erforderlich.

• Der Funktionsbereich "Find" durchsucht nun zusätzlich die Schlagworte. Der Anwender kann die Suchmaske alternativ zur manuellen Erfassen, jetzt auch aus der Liste der verwendeten Schlagworte auswählen. Die Volltextsuche wird bei konsequenter und geschickter "Verschlagwortung" nur noch in Ausnahmefällen notwendig sein.

• Der Funktionsbereich "ToDo" hat jetzt eine zusätzliche Spalte "Tags" erhalten. (Fast) alle Spalten können nun individuell ein-/ausgeblendet werden: Nach RechtsKlick auf eine beliebige Zelle der obersten (fixen) Zeile öffnet sich ein kleines Dialogfenster, in dem die Spaltenauswahl erfolgt.

• Die Toolbar des Funktionsbereichs "ToDo" hat einen weiteren Button erhalten, mit dem ein Dialogfenster geöffnet wird, in dem der Export der ToDo-Daten nach MS EXCEL gestartet werden kann. Optional wird die Excel-Tabelle grundlegend formatiert.

• Die Popup-Menüs der Baumdarstellungen haben unterhalb der Auswahl "Layout" einen neuen Eintrag "Collapse up to sibling level" erhalten. Der bisher an dieser Stelle vorhandene Eintrag wurde in "Collapse up to parent level" umbenannt.

• Die Konfiguration wurde erweitert; diverse Hilfetexte angepasst oder neu erstellt.

So, ich denke das war so ziemlich alles, was in den letzten 4 Wochen verändert wurde. Hoffentlich haben sich nicht gar so viele Fehler eingeschlichen - dass alles Neue bereits perfekt funktioniert, ist wohl leider doch recht vermessen anzunehmen.

Geplante Aktivitäten: Vereinheitlichung der Tastenbefehle und Erstellung der Hilfe-Befehlsübersichten. Konkretisierung des neuen Funktionsbereichs "Projects" - Da habe ich schon eine Menge guter Ideen; "Optiplex", magst du deine Wünsche hierzu noch einmal konkretisieren?!

[DeddyH]

Moin Ralph,

schönes Tool, ich fühle mich an den EDH erinnert. Was mich ein wenig verwirrt, ist der Sprachmischmasch (Programm in Englisch, Hilfe und Topics in Deutsch). Gibt es auch eine Möglichkeit, eigene Topics anzulegen (falls ja, bin ich wohl zu blöd zum Suchen)? Ansonsten gute Arbeit, weiter so

[taaktaak]

Moin Detlef,
es freut mich besonders, dass du es dir mal angesehen hast!

Sprachmischmasch - ist z. Zt. leider notwendig! Das Programm wird auch in der Slowakei verwendet. Viel mehr als "dobre rano" und "velmi dobre" bringe ich nicht über die Lippen (und auf die Tastatur), da ist die Oberfläche in Englisch der kleinste gemeinsame Nenner. Wie schon in einem vorhergehenden Post erwähnt, steht eine "richtige Lokalisierung" auf der ToDo-Liste, allerdings mit keiner besonders hohen Priorität.

Knoten anlegen - Detlef, of course you can!!! Das Programm verwendet sehr viele Popup-Menüs (also immer mal auf die rechte Maustaste klicken und schauen was da kommt). Die Verwaltung der Struktur- und Themenknoten ist im Funktionsbereich "Topics" über das Popup-Menü der Baumansicht zu erreichen. Dort findest du unter "Structure node ..." die Funktionen zum Erstellen, Umbenennen und Löschen der Strukturknoten. Das Verschieben der Knoten erfolgt (nur) komfortabel im separaten "Structure node editor" (die übrigen Aktionen natürlich auch). Das Verschieben von Knoten direkt in der Baumansicht mit der Maus halte ich in großen Baumstrukturen für nicht praktikabel und eigentlich nur für eine Spielerei. Alle Aktionsmöglichkeiten der Themenknoten findest du dann unter "Topic node ..."

By the way: In den Text-Editier-Modus gelangst du mittels Doppelklick auf die (obere) Textanzeige - oder (wen wundert es) auch über das Popup-Menü der Textanzeige

[DeddyH]

Ahja, dann war ich doch mal wieder zu doof . Die Möglichkeit eines Abgleichs mit einer online verfügbaren Version der DB(?) wäre noch ein schönes Feature (ich weiß nicht, ob das schon erwähnt wurde, habe nicht den gesamten Thread gelesen).