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.
Zeile 35: Zeile 35:


===General===
===General===
'''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/>
Zeile 40: Zeile 41:


===Source Files===
===Source Files===
Es müssen die vier dpk bzw dpr Dateien aus dem Documentation_Insight Ordner eingetragen werden.
Es müssen die vier dpk bzw dpr Dateien aus dem Documentation_Insight Ordner eingetragen werden.<br/>
[[Documentation_Insight_Source_Files.PNG]]
[[Documentation_Insight_Source_Files.PNG]]


===Publish===
===Publish===


Es muss nur Web pages ausgewählt werden und der Pfad des obs_doc Ordners von dem aus hochgeladen wird eingetragen werden.
Es muss nur Web pages ausgewählt werden und der Pfad des obs_doc Ordners von dem aus hochgeladen wird eingetragen werden.<br/>
[[Documentation_Insight_Publish.PNG]]
[[Documentation_Insight_Publish.PNG]]



Version vom 20. Februar 2020, 15:40 Uhr

Dies ist eine zugriffsgeschützte Seite.


Admin-Hilfe

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

Dokumentation für Makros und Scripting

HINWEIS: [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

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

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.

Documentation Insight Projektdatei

General

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

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