Agnes' PDM plug ins

This document describes Agnes' plug-ins for PDM in english.

Dieses Dokument beschreibt Agnes' plug-ins für PDM in deutsch.

English

This group of plug-ins is grown up on a documentation of a larger framework. It goes some other ways then the original plug-ins of PDM but keeps the old style as possible. A transformation tool will be provided.

Let's see the differnce:

Extended use of xhtml to declare pdm information. In special the use of <see> and <seealso>.
Better transformation of non html signs
Extended description of parameters on DIAMP. plug in
Extended description of return value on DIAMP. plug in
Extended description of property values on DIAP. plug in
Feature to autolink to a parameter of a procedure in DIAMP. plug in
Ability to switch to a "Automatic XHTML" mode that will skip the old "prefix" style.
Options to control the use of a link in "See Also" and to create a "back refernce" (not implemented yet) on plug-in, element and link level.
New section "changes" to track changes on your code.
Ability to switch the use of "changes" section "Off", "On" and "Merge" to merge from source code and external source table.
Add automatic date of documentation or PDM run
Handling of PDM footer
Create your own "Note" blocks within a section.
Select CSS classes to use

The following plug ins will be available:

A description of shared options is also available.
See also the description of the external source table (sometimes also named "table with meta data").

With this plug in ships a example pdm job, it is found in the AB_Bases\Test directory. This example is written in mixed style in procdure StrExtract of programm DIAMP_PDM_AB_DEMO. You can see the what happens if you toggle the "Automatic XHTML". You may also use the "See Also" switch to see how links add automatic to the "See Also" section. Further try the "Include Changes" to see changes add up. This will be visible in method ExitForm. Play around with the example to see how the plug-in works.

See the example AB_Bases\Extras\VCX2DIAMP.pdm too.

Also included (This is the stuff I use with the plug in):

A program "VCX2DIAMP.prg" to extract all classes, properties (with value analysis) and methods (with parameter analysis) from an vcx into the source table There is a PDM project to create a PDMdocumentation for this file.
A program "Transform_See.prg" that will transform old styled <see> and <seealso> tags to new style.
A file "TAGLIST_AB.TXT" for the UltraEdit editor to create tags used with this plug in. You need to know how to add to taglist.
A file "WordList_AB.TXT" for the UltraEdit editor to create syntax coloring. You need to know how to add to wordlist.
A table "FoxCode_Diamp.DBF" for the use with VFP's intelliscript. It declares a script zpdm to add a complete pdm block to a method (with parameter analysis), and a script zchange that will add a comment block marking a change as traceable to the plug-in.
Note that you have to know how to add a custom script to intellisense, see FAQ on Universal thread ID#23882

This plug in is tested with IE 6.0 only because it's the only browser I use. If it comes to problems with your favorite browser alter the CSS files and if this is of no help feel free to alter the plug-in code to your needs.

Deutsch

Diese plug ins entstanden während der Dokumentation eines längern Frameworks. Sie benutzten einige andere Ideen als das originale plug-in bemühen sich aber um Kompatibilität. Ein Programm um notwendige Transformationen auszuführen liegt bei.

Was ist geändert:

Erweiterte nutzung von xhtml zur definition von PDM Informationen. Speziell sind hier <see> and <seealso> zu nennen.
Bessere Transformation von nicht HTML Zeichen
Erweiterte Beschreibung von Parametern im DIAMP. plug in
Erweiterte Beschreibung von Rückgabewerten im DIAMP. plug in
Erweiterte Beschreibung von Eigenschaften im DIAP. plug in
Die Option links zu einem Parameter einer Methode zu erstellen. DIAMP. plug in
Die Möglichkeit mit Hilfe des Schalter "Automatisch XHTML" die Nutztung des alten "prefix" Stieles zu unterdrücken.
Die Möglichkeit die Verwendung eines Links "Siehe auch" und einer "Refernz" (noch nicht implementiert) auf plug-in, Element und Link Ebene zu steuern.
Neuer Abschnitt "Änderungen" um Änderungen im Code zu verfolgen.
Diese Funktion kann "Aus", "An" oder "Zusammenfließen", also es werden Informationen aus dem Quellcode und der Quelltabelle genutzt.
Automatisches Zufügen des Datums der Dokumentation oder des PDM Laufes
Nutzung des PDM Fußes
Erstellen eigener "Notiz" Abschnitte.
Festlegen der verwendeten CSS Klassen.

Folgende plug ins stehen zur Verfügung:

Eine Beschreibung gemeinsam genutzter Optionen ist verfügbar.
Siehe auch die Beschreibung der externen Quelltablle (manchmal auch "Tabelle mit Metadaten").

Zu diesem plug in gehört ein Beispiel, es kann im AB_Bases\Test Verzeichnis gefunden werden.. Diese Beispeil nutzt gemischte Stiele in der Prozedur StrExtract des Programmes DIAMP_PDM_AB_DEMO. Testen Sie den Schalter "Automatisch XHTML". Testen Sie außerdem den "Siehe auch" Schalter und beobachten Sie wie links automatisch zum "Siehe Auch" Abschnitt zugefügt werden und "Änderungen einbeziehen" um mit Änderungen zu arbeiten. Sichtbar ist dies in der Methode ExitForm. Veränderen Sie das Beispiel um die plug ins kennenzulernen.

Beachten Sie auch das Beispielprojekt AB_Bases\Extras\VCX2DIAMP.pdm.

Diese plug in beinhaltet zusätzlich:

Ein Programm "VCX2DIAMP.prg" das alle Kassen, Eigenschaften (mit Wert Analyse) und Methoden (mit Parameter Analyse) aus einer vcx ausliest und in die Quelltablle schreibt. Zu diesem Programm existiert ein PDM Projekt mit dem die Verwendung des Programmes näher erläutert wird.
Ein Programm "Transform_See.prg" das alte <see> und <seealso> tags in den neuen Stiel überführt.
Eine Datei "TAGLIST_AB.TXT" für den UltraEdit editor zum Erstellen von tags die dieses plug in nutzt.Sie müssen die "taglist" selbstständig erweitern.
Eine Date "WordList_AB.TXT" für den UltraEdit editor welches die Textfärbung steuert. Sie müssen die "wordlist" selbstständig erweitern.
Eine Tabelle "FoxCode_Diamp.DBF" für VFP's intelliscript. Es definiert ein Script zpdm welches einen kompletten PDM block (mit Parameter Analyse) zum Quellcode zufügt, und ein Script zchange das einen Kommentarblock zur Änderungsverfolgung zufügt.
Beachten Sie bitte, daß Sie die Scripts selbstständig aktivieren müssen, siehe FAQ im Universal thread ID#23882

Dieses plug-in wurde nur mit IE 6.0 getestet. (Ich habe keinen anderen Browser). Sollte es zu Problemen kommen kann zunächst das CSS angepaßt werden und, wenn dies nicht hilft, kann auch der Quellcode entsprechend angepaßt werden.