OBS/Adminhilfe/Documentation Insight: Unterschied zwischen den Versionen
| (40 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
{{ZugriffOBS}} | {{ZugriffOBS}} | ||
=Dokumentation für Makros und Scripting= | =Dokumentation für Makros und Scripting= | ||
[http://www.devjetsoftware.com/products/documentation-insight Link zum Hersteller] | |||
{{Hinweis|[http://docwiki.embarcadero.com/RADStudio/Rio/de/Kommentare_in_der_XML-Dokumentation Auflistung der XML-Doc-Kommentare]}} | |||
==Hochladen auf den Server== | ==Hochladen auf den Server== | ||
| Zeile 9: | Zeile 12: | ||
===obs_doc=== | ===obs_doc=== | ||
Es gibt 2 obs_doc Ordner. <br/> | |||
Der Erste befindet sich mit im dev Ordner projekte und lib auf einer Ebene. Hier drin werden die HTML Dateien generiert. <br/> | |||
Der Zweite befindet sich auf dem Wiki-Server unter www/html/wiki/obs_doc und hier werden die Daten dann hochgeladen für das Wiki. | |||
==Kennzeichnung im Code== | |||
Hier sieht man ein Beispiel der fertig integrierten Header im Sourcecode:<br/> | |||
<syntaxhighlight lang="Delphi"> | |||
/// <summary> | |||
/// Prüft, ob die Zeichen aus sInput in der Zeichencodierung cSet enthalten sind. | |||
/// </summary> | |||
/// <param name= "sInput"> | |||
/// String zum Testen. | |||
/// </param> | |||
/// <param name= "cSet"> | |||
/// Alle möglichen Zeichen des CharSets. z.B. ANSI | |||
/// </param> | |||
/// <return> | |||
/// Gibt True zurück, wenn alle Zeichen in dem CharSet enthalten sind. | |||
/// </return> | |||
function StringInSet( | |||
const sInput : string; | |||
cSet : CharSet | |||
) : boolean; | |||
</syntaxhighlight> | |||
==Neue Projektdatei== | ==Neue Projektdatei== | ||
Die folgenden Dateien liegen in einem neuen Ordner unter Projekte und wurden in SmartGit integriert.<br/> | Die folgenden Dateien liegen in einem neuen Ordner unter Projekte und wurden in SmartGit integriert.<br/> | ||
Hierfür werden die .DPR und .DPK Dateien genutzt. Diese enthalten allerdings nur die | Hierfür werden die .DPR und .DPK Dateien genutzt. Diese enthalten allerdings nur die exportierten Dateien. <br/> | ||
Die einzelnen Units sind durch Kommata aufgelistet. Die letzte Unit einkommentierte Unit muss allerdings ein Semikolon verwenden.<br/> | |||
===OBS.dpr=== | ===OBS.dpr=== | ||
Über diese Datei kann gesteuert werden welche Dateien aus OBS mit in die Dokumentation übernommen werden. | Über diese Datei kann gesteuert werden welche Dateien aus OBS mit in die Dokumentation übernommen werden.<br/> | ||
===OBS_Lib.dpk=== | ===OBS_Lib.dpk=== | ||
| Zeile 32: | Zeile 62: | ||
Über diese Datei kann gesteuert werden welche Dateien aus OBS mit in die Dokumentation übernommen werden. | Über diese Datei kann gesteuert werden welche Dateien aus OBS mit in die Dokumentation übernommen werden. | ||
// Base.Debug in '..\..\LIB\BASELIB\Base.Debug.pas', | Über das auskommentieren kann man steuern welche Units verwendet werden sollen. | ||
Base.Def in '..\..\LIB\BASELIB\Base.Def.pas', | |||
// Base.DataIO in '..\..\LIB\BASELIB\Base.DataIO.pas', Wird nicht verwendet! | |||
Base.DB in '..\..\LIB\BASELIB\Base.DB.pas', Wird verwendet! | |||
// Base.Debug in '..\..\LIB\BASELIB\Base.Debug.pas', Wird nicht verwendet! | |||
Base.Def in '..\..\LIB\BASELIB\Base.Def.pas', Wird verwendet! | |||
Base.Exception in '..\..\LIB\BASELIB\Base.Exception.pas', Wird verwendet! | |||
Base.GFile in '..\..\LIB\BASELIB\Base.GFile.pas', Wird verwendet! | |||
Base.Hash in '..\..\LIB\BASELIB\Base.Hash.pas', Wird verwendet! | |||
==Documentation Insight Projektdatei== | ==Documentation Insight Projektdatei== | ||
| Zeile 39: | Zeile 76: | ||
===General=== | ===General=== | ||
[[ | [[Image:Documantation Insight General.PNG]]<br/> | ||
'''Language:''' Hier muss die Sprache auf Deutsch gestellt werden.<br/> | '''Language:''' Hier muss die Sprache auf Deutsch gestellt werden.<br/> | ||
'''Charset:''' Hier muss der Zeichensatz auf ANSI_CHARSET gestellt werden.<br/> | '''Charset:''' Hier muss der Zeichensatz auf ANSI_CHARSET gestellt werden.<br/> | ||
===Source Files=== | ===Source Files=== | ||
[[Image:Documentation Insight Source Files.PNG]]<br/> | |||
Es müssen die vier dpk bzw dpr Dateien aus dem Documentation_Insight Ordner eingetragen werden.<br/> | Es müssen die vier dpk bzw dpr Dateien aus dem Documentation_Insight Ordner eingetragen werden.<br/> | ||
===Publish=== | ===Publish=== | ||
[[Image:Documentation Insight Publish.PNG]]<br/> | |||
Es muss nur Web pages ausgewählt werden und der Pfad des obs_doc Ordners von dem aus hochgeladen wird eingetragen werden.<br/> | Es muss nur Web pages ausgewählt werden und der Pfad des obs_doc Ordners von dem aus hochgeladen wird eingetragen werden.<br/> | ||
==Bearbeitung== | ==Bearbeitung== | ||
| Zeile 57: | Zeile 95: | ||
Für Delphi habe ich | Für Delphi habe ich in CnPack ein Autor Datum Header erstellt.<br/> | ||
Unter Ansicht -> Tool-Fenster -> Vorlagen findet ihr weitere Vorlagen.<br/> | |||
'''Autor Datum Header:''' | |||
<syntaxhighlight lang="Delphi"> | <syntaxhighlight lang="Delphi"> | ||
/// <remarks> | /// <remarks> | ||
| Zeile 85: | Zeile 116: | ||
Hier habe ich noch ein paar nützliche Snippets für VS Code. | Hier habe ich noch ein paar nützliche Snippets für VS Code. | ||
Ablegen unter: | Ablegen unter: ...\AppData\Roaming\Code\User\snippets\ | ||
<syntaxhighlight lang="JSON"> | |||
"Author Datum Header": { | |||
"scope": "", | |||
"prefix": "", | |||
"body": [ | |||
"/// <remarks>", | |||
"/// Author: ${Author:Tom}" , | |||
"/// Datum: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}", | |||
"/// Änderung: $1", | |||
"/// Änderungsdatum: $2", | |||
"/// </remarks>", | |||
], | |||
"description": "Erstellt den Author Datum Header" | |||
} | |||
</syntaxhighlight> | |||
Aktuelle Version vom 21. Februar 2020, 16:47 Uhr
Dies ist eine zugriffsgeschützte Seite.
- System Überwachung
- DEP deaktivieren
- Darstellung unter Windows 7
- Einwahl auf Windows 2000 Server
- Preislisten
- Datenbank Sicherung
- Customize
- Zentrale
- Support Macro
- Service Debug
- Historienprotokoll (Datenänderung OBS)
- Fernwartungsprobleme
- Startparameter
- Fehler beim Kassenabschluss
- Diverse Informationen
- A ras.pbk
- B Command Line Interpreter
- C File Zilla Benutzer XML erzeugen
- D1 OBS_UPDATE.EXE zum OBS Update Server hochladen
- D2 SUPPORT_MACRO zum OBS Update Server hochladen
- H1 Remote Service Protokoll-Übersicht (Alles)
- H Remote ServiceProtokoll-Übersicht
- I Remote Service Commands
- I1 (Admin) Globaler Hinweis für Updates
- J Liste der OBS Updates
- K Angemeldete Service Firmen
- L Systeminformationen einlesen
- M Kundendaten anzeigen
- M1 Kundendatenbankinformationen anzeigen
- N Kundendaten einlesen
- O Kunden-Update Informationen anzeigen
- P Modul Registrierung OBS
- Q App Verwaltung
- S1 Firmen Statistik Protokolle OBS
- S2 Statistik Notfallkassen
Dokumentation für Makros und Scripting
Hochladen auf den Server
obs_doc
Es gibt 2 obs_doc Ordner.
Der Erste befindet sich mit im dev Ordner projekte und lib auf einer Ebene. Hier drin werden die HTML Dateien generiert.
Der Zweite befindet sich auf dem Wiki-Server unter www/html/wiki/obs_doc und hier werden die Daten dann hochgeladen für das Wiki.
Kennzeichnung im Code
Hier sieht man ein Beispiel der fertig integrierten Header im Sourcecode:
/// <summary>
/// Prüft, ob die Zeichen aus sInput in der Zeichencodierung cSet enthalten sind.
/// </summary>
/// <param name= "sInput">
/// String zum Testen.
/// </param>
/// <param name= "cSet">
/// Alle möglichen Zeichen des CharSets. z.B. ANSI
/// </param>
/// <return>
/// Gibt True zurück, wenn alle Zeichen in dem CharSet enthalten sind.
/// </return>
function StringInSet(
const sInput : string;
cSet : CharSet
) : boolean;
Neue Projektdatei
Die folgenden Dateien liegen in einem neuen Ordner unter Projekte und wurden in SmartGit integriert.
Hierfür werden die .DPR und .DPK Dateien genutzt. Diese enthalten allerdings nur die exportierten Dateien.
Die einzelnen Units sind durch Kommata aufgelistet. Die letzte Unit einkommentierte Unit muss allerdings ein Semikolon verwenden.
OBS.dpr
Über diese Datei kann gesteuert werden welche Dateien aus OBS mit in die Dokumentation übernommen werden.
OBS_Lib.dpk
Über diese Datei kann gesteuert werden welche Dateien aus OBS mit in die Dokumentation übernommen werden.
PASLIB.dpk
Über diese Datei kann gesteuert werden welche Dateien aus OBS mit in die Dokumentation übernommen werden.
BASELIB.dpk
Über diese Datei kann gesteuert werden welche Dateien aus OBS mit in die Dokumentation übernommen werden.
Über das auskommentieren kann man steuern welche Units verwendet werden sollen.
// Base.DataIO in '..\..\LIB\BASELIB\Base.DataIO.pas', Wird nicht verwendet! Base.DB in '..\..\LIB\BASELIB\Base.DB.pas', Wird verwendet! // Base.Debug in '..\..\LIB\BASELIB\Base.Debug.pas', Wird nicht verwendet! Base.Def in '..\..\LIB\BASELIB\Base.Def.pas', Wird verwendet! Base.Exception in '..\..\LIB\BASELIB\Base.Exception.pas', Wird verwendet! Base.GFile in '..\..\LIB\BASELIB\Base.GFile.pas', Wird verwendet! Base.Hash in '..\..\LIB\BASELIB\Base.Hash.pas', Wird verwendet!
Documentation Insight Projektdatei
General
Language: Hier muss die Sprache auf Deutsch gestellt werden.
Charset: Hier muss der Zeichensatz auf ANSI_CHARSET gestellt werden.
Source Files
Es müssen die vier dpk bzw dpr Dateien aus dem Documentation_Insight Ordner eingetragen werden.
Publish
Es muss nur Web pages ausgewählt werden und der Pfad des obs_doc Ordners von dem aus hochgeladen wird eingetragen werden.
Bearbeitung
In Delphi
Für Delphi habe ich in CnPack ein Autor Datum Header erstellt.
Unter Ansicht -> Tool-Fenster -> Vorlagen findet ihr weitere Vorlagen.
Autor Datum Header:
/// <remarks>
/// Author: %USER%
/// Date: %DAY%-%MONTHSHORTNAME%-%YEAR%
/// Änderung: %Cursor%
/// Änderungsdatum:
/// </remarks>
In VS Code
Snippets
Hier habe ich noch ein paar nützliche Snippets für VS Code.
Ablegen unter: ...\AppData\Roaming\Code\User\snippets\
"Author Datum Header": {
"scope": "",
"prefix": "",
"body": [
"/// <remarks>",
"/// Author: ${Author:Tom}" ,
"/// Datum: ${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}",
"/// Änderung: $1",
"/// Änderungsdatum: $2",
"/// </remarks>",
],
"description": "Erstellt den Author Datum Header"
}