OBS/Adminhilfe/Documentation Insight: Unterschied zwischen den Versionen

Aus OBS Wiki
Zur Navigation springen Zur Suche springen
Für diese Seite wurde eine Zugriffsbeschränkung eingerichtet. Falls du diese Nachricht siehst, bist du nicht berechtigt, diese Seite einzusehen.
(Die Seite wurde neu angelegt: „{{ZugriffOBS}}“)
 
(66 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
{{ZugriffOBS}}
{{ZugriffOBS}}
=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==
{{Hinweis|Die Daten müssen mit dem Benutzer www-data und nicht Root hochgeladen werden!}}
===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==
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 exportierten Dateien. <br/>
Die einzelnen Units sind durch Kommata aufgelistet. Die letzte Unit einkommentierte Unit muss allerdings ein Semikolon verwenden.<br/>
===OBS.dpr===
Über diese Datei kann gesteuert werden welche Dateien aus OBS mit in die Dokumentation übernommen werden.<br/>
===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===
[[Image:Documantation Insight General.PNG]]<br/>
'''Language:''' Hier muss die Sprache auf Deutsch gestellt werden.<br/>
'''Charset:''' Hier muss der Zeichensatz auf ANSI_CHARSET gestellt werden.<br/>
===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/>
===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/>
==Bearbeitung==
===In Delphi===
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">
/// <remarks>
///  Author:    %USER%
///  Date:      %DAY%-%MONTHSHORTNAME%-%YEAR%
///  Änderung:  %Cursor%
///  Änderungsdatum:
/// </remarks>
</syntaxhighlight>
===In VS Code===
{{Hinweis| Unter File -> Preferences -> Settings -> Text Editor -> Files: Muss das Charset auf windows 1252 umgestellt werden.}}
====Snippets====
Hier habe ich noch ein paar nützliche Snippets für VS Code.
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.


Admin-Hilfe

FAQ
FIBU
Häufige Fehler FAQs
Allgemeines
Tools
Widgets
Wiki Hilfe
Syntax
Wiki-Gruppen Benutzerlisten
MySQL
MySQL Installation
Programmierung und Mergen
Delphi
Einrichtung
MMX
Git/SmartGit
Programm Update
Schaltflächen
F10: Weitere Funktionen
PAX
Nützliche Funktionen
SteVe
OBS-Administration / Installation
Einrichtung
MySQL
OBS
Dienste
Kasse/Notfallkasse
Replikation
Zentrale
Fleet-Management einrichten
VirtualUI
OBS Umzug
Admin Funktionen
Service Firmen
F10
O Support
D Programmierer-Tools
V Crypt Autologin Edit
J Update Marko Lib/Pmode/Script Lib
kundenspezifische Anpassungen
OBS Protokolle
OBS DEMO
Shop-Administration
modified eCommerce
modified eCommerce 2.x
modified eCommerce 1.06
Amazon
VShop 4.0
Kundeninformationen
OfficeStar
MDS

Dokumentation für Makros und Scripting

Link zum Hersteller


HINWEIS: Auflistung der XML-Doc-Kommentare

Hochladen auf den Server

HINWEIS: Die Daten müssen mit dem Benutzer www-data und nicht Root hochgeladen werden!

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

Documantation Insight General.PNG
Language: Hier muss die Sprache auf Deutsch gestellt werden.
Charset: Hier muss der Zeichensatz auf ANSI_CHARSET gestellt werden.

Source Files

Documentation Insight Source Files.PNG
Es müssen die vier dpk bzw dpr Dateien aus dem Documentation_Insight Ordner eingetragen werden.

Publish

Documentation Insight Publish.PNG
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

HINWEIS: Unter File -> Preferences -> Settings -> Text Editor -> Files: Muss das Charset auf windows 1252 umgestellt werden.

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"
		}
Abgerufen von „http:///index.php?title=OBS/Adminhilfe/Documentation_Insight&oldid=57514“