OBS/Adminhilfe/Documentation Insight

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.

Dies ist eine zugriffsgeschützte Seite.


Admin-Hilfe

OBS-Administration / Installation
kundenspezifische Anpassungen
OBS Protokolle
Shop-Administration

Dokumentation für Makros und Scripting

Link zum Hersteller

Hochladen auf den Server

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

obs_doc

Dieser Ordner befindet sich mit projekte und lib auf einer Ebene. Hier rein werden die HTML Dateien generiert.

Neue Projektdatei

HINWEIS: Diese Units enthalten ausschließlich Dateien die auch exportiert werden!


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

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

Publish

Es muss nur Web pages ausgewählt werden und der Pfad des obs_doc Ordners von dem aus hochgeladen wird eingetragen werden.
Documentation Insight Publish.PNG

Bearbeitung

In Delphi

Für Delphi habe ich im CnPack einige nützliche Templates erstellt.

Für den summary header

/// <summary>
///    %Cursor%
/// </summary>


und für den Header mit Autor und Datum

/// <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: c:\Users\obs-merge\AppData\Roaming\Code\User\snippets\

Codesnippets