OBS/Adminhilfe/Documentation Insight: Unterschied zwischen den Versionen
| Zeile 95: | Zeile 95: | ||
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"> | <syntaxhighlight lang="JSON"> | ||
"Author Datum Header": { | "Author Datum Header": { | ||
Version vom 21. Februar 2020, 10:15 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
Dieser Ordner befindet sich mit projekte und lib auf einer Ebene. Hier rein werden die HTML Dateien generiert.
Kennzeichnung im Code
Hier sieht man ein Beispiel der fertig integrierten Header im Sourcecode:
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"
}