Programm Dokumentation: Unterschied zwischen den Versionen
Weitere Optionen
Epos (Diskussion | Beiträge) Einstiegsseite des Bereichs Programm Dokumentation angelegt |
Epos (Diskussion | Beiträge) H3: Vertragstabelle der Hilfeseiten eingetragen (Konzept Hilfesystem/Wikidokumentation) |
||
| Zeile 6: | Zeile 6: | ||
{{Anker|hilfeseiten|seiten}} | {{Anker|hilfeseiten|seiten}} | ||
''Die | Die folgende Tabelle ist die Zuordnung, an die sich das Programm hält: 26 Aufrufstellen verweisen auf 23 Unterseiten dieses Bereichs. Wer eine Seite umbenennen möchte, sieht hier, welche Programmstellen daran hängen – die Spalte ''Formular / Schaltfläche'' entspricht der Zuordnungsdatei in der Anwendung. | ||
{| class="wikitable" | |||
! Programmstelle !! Formular / Schaltfläche !! Hilfeseite | |||
|- | |||
| Startmaske, Knopf ''Programmablauf'' || <code>Form_Start.btn_Help</code> || [[Programm Dokumentation/Programmablauf|Programmablauf]] | |||
|- | |||
| Startmaske, Registerkarte ''Projekt'', Knopf ''Kurzanleitung'' || <code>Form_Start.btn_Help_Kurzanleitung</code> || [[Programm Dokumentation/Kurzanleitung|Kurzanleitung]] | |||
|- | |||
| Projektassistent (Neuanlage und Bearbeiten) || <code>WizardParent.btn_Help</code> || [[Programm Dokumentation/Kurzanleitung|Kurzanleitung]] | |||
|- | |||
| Startmaske, Registerkarte ''Wärmebedarf'' || <code>Form_Start.btn_Help_Waermebedarf</code> || [[Programm Dokumentation/Wärmebedarf|Wärmebedarf]] | |||
|- | |||
| Dialog ''Wärmebedarf Extern'' || <code>Form_Waermebedarf.btn_Help</code> || [[Programm Dokumentation/Wärmebedarf|Wärmebedarf]] | |||
|- | |||
| Startmaske, Registerkarte ''Strombedarf'' || <code>Form_Start.btn_Help_Strombedarf</code> || [[Programm Dokumentation/Strombedarf|Strombedarf]] | |||
|- | |||
| Dialog ''Klimadaten'' || <code>Form_Klimadaten.btn_Help</code> || [[Programm Dokumentation/Klimadaten|Klimadaten]] | |||
|- | |||
| Dialog ''Kosten'' || <code>Form_Kosten.btn_Help</code> || [[Programm Dokumentation/Kosten|Kosten]] | |||
|- | |||
| Dialog ''Datenbank Wärmepumpen'' || <code>Form_WP.btn_Help</code> || [[Programm Dokumentation/Wärmepumpe|Wärmepumpe]] | |||
|- | |||
| Dialog ''Verwaltung Heizkessel'' || <code>Form_Heizkessel.btn_Help</code> || [[Programm Dokumentation/Heizkessel|Heizkessel]] | |||
|- | |||
| Dialog ''BHKW Verwaltung'' || <code>Form_BHKWEing.btn_Help</code> || [[Programm Dokumentation/BHKW|BHKW]] | |||
|- | |||
| Dialog ''Eingabe der Solarkollektoren'' || <code>Form_SolarKollektoren.btn_Help</code> || [[Programm Dokumentation/Solarthermie|Solarthermie]] | |||
|- | |||
| Dialog ''Verwaltung Photovoltaik Module'' || <code>Form_PV.btn_Help</code> || [[Programm Dokumentation/Photovoltaik|Photovoltaik]] | |||
|- | |||
| Dialog ''Verwaltung Pufferspeicher'' || <code>Form_PufferSp.btn_Help</code> || [[Programm Dokumentation/Pufferspeicher|Pufferspeicher]] | |||
|- | |||
| Dialog ''Stromspeicher'' || <code>Form_Stromspeicher.btn_Help</code> || [[Programm Dokumentation/Stromspeicher|Stromspeicher]] | |||
|- | |||
| Dialog ''Eingabe der Gebäudedaten'' || <code>Form_Gebaeude.btn_Help</code> || [[Programm Dokumentation/Gebäude|Gebäude]] | |||
|- | |||
| Dialog ''Brauchwasser Verwaltung'' || <code>Form_Brauchwasser.btn_Help</code> || [[Programm Dokumentation/Brauchwasser|Brauchwasser]] | |||
|- | |||
| Dialog ''Prozesswärme Verwaltung'' || <code>Form_Prozesswaerme.btn_Help</code> || [[Programm Dokumentation/Prozesswärme|Prozesswärme]] | |||
|- | |||
| Dialog ''Strombedarf Verwaltung'' || <code>Form_Stromverbraucher.btn_Help</code> || [[Programm Dokumentation/Stromverbraucher|Stromverbraucher]] | |||
|- | |||
| Dialog ''Simulation Konfiguration'' || <code>Form_Simulation_Config.btn_Help</code> || [[Programm Dokumentation/Simulation|Simulation]] | |||
|- | |||
| Bereich ''Wirtschaftlichkeit'' (eigenes Fenster und Registerkarte ''Berichte & Kosten'') || <code>UcWirtschaftlichkeit.btn_Help</code> || [[Programm Dokumentation/Wirtschaftlichkeit|Wirtschaftlichkeit]] | |||
|- | |||
| Dialog ''Projektvarianten'' || <code>Form_Variantentest.btn_Help</code> || [[Programm Dokumentation/Varianten|Varianten]] | |||
|- | |||
| Dialog ''Projekt Speichern unter'' || <code>Form_ProjektSpeichernUnter.btn_Help</code> || [[Programm Dokumentation/Projektverwaltung|Projektverwaltung]] | |||
|- | |||
| Dialog ''Importkonflikte'' || <code>Form_ImportKonflikte.btn_Help</code> || [[Programm Dokumentation/Projektverwaltung|Projektverwaltung]] | |||
|- | |||
| Dialog ''Administration – Globale Anwendungseinstellungen'' || <code>Form_AdminSettings.btn_Help</code> || [[Programm Dokumentation/Einstellungen|Einstellungen]] | |||
|- | |||
| Chatfenster ''Hilfe-Assistent'' || <code>Form_KiChat.btn_Help</code> || [[Programm Dokumentation/Hilfe-Assistent|Hilfe-Assistent]] | |||
|} | |||
Die Inhalte der Unterseiten werden nach und nach ergänzt; das Gerüst jeder Seite – Zweck des Dialogs, Abschnitt ''Eingaben'', Abschnitt ''Siehe auch'' – muss aber stehen bleiben, damit der Hilfeaufruf aus dem Programm nicht ins Leere läuft. | |||
== Siehe auch == | == Siehe auch == | ||
Version vom 29. August 2026, 13:34 Uhr
Der Bereich Programm Dokumentation enthält die Hilfeseiten, die EPOS-Plan direkt aus dem Programm heraus aufruft – über die Kurzhinweise an den Eingabefeldern, den Menüpunkt und den Hilfe-Assistenten. Die Seiten sind wie die gesamte Dokumentation ohne Anmeldung lesbar, damit die Software sie jederzeit öffnen kann. Nur die Kachel auf der Hauptseite erscheint ausschließlich für angemeldete Benutzer, weil dieser Bereich in erster Linie der Pflege der Hilfetexte dient.
EPOS-Plan verlinkt auf Seitentitel und Sprungmarken dieses Bereichs. Wird eine Seite umbenannt oder eine Sprungmarke entfernt, läuft der Hilfeaufruf im Programm ins Leere. Ist eine Umbenennung unvermeidbar, bleibt der alte Titel als Weiterleitung bestehen; Sprungmarken werden mit Vorlage:Anker gesetzt und bei Bedarf um neue Namen ergänzt statt gelöscht.
Hilfeseiten
Die folgende Tabelle ist die Zuordnung, an die sich das Programm hält: 26 Aufrufstellen verweisen auf 23 Unterseiten dieses Bereichs. Wer eine Seite umbenennen möchte, sieht hier, welche Programmstellen daran hängen – die Spalte Formular / Schaltfläche entspricht der Zuordnungsdatei in der Anwendung.
| Programmstelle | Formular / Schaltfläche | Hilfeseite |
|---|---|---|
| Startmaske, Knopf Programmablauf | Form_Start.btn_Help |
Programmablauf |
| Startmaske, Registerkarte Projekt, Knopf Kurzanleitung | Form_Start.btn_Help_Kurzanleitung |
Kurzanleitung |
| Projektassistent (Neuanlage und Bearbeiten) | WizardParent.btn_Help |
Kurzanleitung |
| Startmaske, Registerkarte Wärmebedarf | Form_Start.btn_Help_Waermebedarf |
Wärmebedarf |
| Dialog Wärmebedarf Extern | Form_Waermebedarf.btn_Help |
Wärmebedarf |
| Startmaske, Registerkarte Strombedarf | Form_Start.btn_Help_Strombedarf |
Strombedarf |
| Dialog Klimadaten | Form_Klimadaten.btn_Help |
Klimadaten |
| Dialog Kosten | Form_Kosten.btn_Help |
Kosten |
| Dialog Datenbank Wärmepumpen | Form_WP.btn_Help |
Wärmepumpe |
| Dialog Verwaltung Heizkessel | Form_Heizkessel.btn_Help |
Heizkessel |
| Dialog BHKW Verwaltung | Form_BHKWEing.btn_Help |
BHKW |
| Dialog Eingabe der Solarkollektoren | Form_SolarKollektoren.btn_Help |
Solarthermie |
| Dialog Verwaltung Photovoltaik Module | Form_PV.btn_Help |
Photovoltaik |
| Dialog Verwaltung Pufferspeicher | Form_PufferSp.btn_Help |
Pufferspeicher |
| Dialog Stromspeicher | Form_Stromspeicher.btn_Help |
Stromspeicher |
| Dialog Eingabe der Gebäudedaten | Form_Gebaeude.btn_Help |
Gebäude |
| Dialog Brauchwasser Verwaltung | Form_Brauchwasser.btn_Help |
Brauchwasser |
| Dialog Prozesswärme Verwaltung | Form_Prozesswaerme.btn_Help |
Prozesswärme |
| Dialog Strombedarf Verwaltung | Form_Stromverbraucher.btn_Help |
Stromverbraucher |
| Dialog Simulation Konfiguration | Form_Simulation_Config.btn_Help |
Simulation |
| Bereich Wirtschaftlichkeit (eigenes Fenster und Registerkarte Berichte & Kosten) | UcWirtschaftlichkeit.btn_Help |
Wirtschaftlichkeit |
| Dialog Projektvarianten | Form_Variantentest.btn_Help |
Varianten |
| Dialog Projekt Speichern unter | Form_ProjektSpeichernUnter.btn_Help |
Projektverwaltung |
| Dialog Importkonflikte | Form_ImportKonflikte.btn_Help |
Projektverwaltung |
| Dialog Administration – Globale Anwendungseinstellungen | Form_AdminSettings.btn_Help |
Einstellungen |
| Chatfenster Hilfe-Assistent | Form_KiChat.btn_Help |
Hilfe-Assistent |
Die Inhalte der Unterseiten werden nach und nach ergänzt; das Gerüst jeder Seite – Zweck des Dialogs, Abschnitt Eingaben, Abschnitt Siehe auch – muss aber stehen bleiben, damit der Hilfeaufruf aus dem Programm nicht ins Leere läuft.
Siehe auch
- Programmfunktionen – jeder Dialog und jede Eingabe im Einzelnen erklärt
- Einstellungen, Hilfe und Sprache – das dreistufige Hilfesystem von EPOS-Plan
- Hilfe-Assistent – Fragen zur Bedienung direkt im Programm