Skip to content

Commit

Permalink
update <front/>, delete Preparation
Browse files Browse the repository at this point in the history 
this commit updated the <front> text with some simplifications of sentences. Preparation chapter is deleted, because of two reasons. first, it is totally outdated and describes how to install the software from a DVD. Second, how to setup an Edirom locally is described in the docs-directory of the software-repository, the USER help is not an appropriate place for this.

refs #471
  • Loading branch information
@krHERO @daniel-jettka
krHERO authored and daniel-jettka committed Dec 11, 2024
1 parent 41531d9 commit c0dc848
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 66 deletions.
38 changes: 3 additions & 35 deletions add/help/help_de.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,47 +40,15 @@
<titlePage>
<titlePart>Hilfe (Bedienungsanleitung) </titlePart>
<argument>
<p>Dieses Dokument enthält eine allgemeine Einführung in die Benutzung von <term type="ediromGui" key="global_appName"/> und beschreibt die grundlegenden Funktionen der Software. Möglicherweise sind nicht alle Optionen, die im Folgenden beschrieben werden in jeder Edition verfügbar.
Dies ist unter anderem der Tatsache geschuldet, dass Inhalte projektspezifisch angelegt werden und jede Edition, die <term type="ediromGui" key="global_appName"/> benutzt, den individuellen Editionsrichtlinien und - konzepten unterliegt.
Des Weiteren kann es aus editions-spezifischen Gründen sein, dass manche Versionen mehrere Optionen und Erweiterungen enthalten, die nicht in diesem Dokument aufgeführt und erklärt sind.</p>
<p>Dieses Dokument enthält eine allgemeine Einführung in die Benutzung von <term type="ediromGui" key="global_appName"/>. Es beschreibt die grundlegenden Funktionen der Software. Möglicherweise sind nicht alle Optionen, die im Folgenden beschrieben werden in jeder Edition verfügbar,
da Inhalte projektspezifisch angelegt werden und jede Editionihren individuellen Editionsrichtlinien unterliegt.
Des Weiteren ist es aus editions-spezifischen Gründen möglich, dass manche Versionen Erweiterungen enthalten, die nicht in diesem Dokument aufgeführt und erklärt sind.</p>
</argument>
</titlePage>
<pb/>
<divGen type="toc"/>
</front>
<body>
<!--<div>
<divGen type="toc"/>
</div>-->

<!-- PREPARATION =============================================== -->
<div type="div1" xml:id="preparation">
<head>Vorbereitung</head>
<div type="div2" xml:id="installation">
<head>Installation </head>
<p><term type="ediromGui" key="global_appName"/> wurde als eine Web-Anwendung entwickelt und muss deshalb auf einem Server aufgesetzt werden.
Sollten Fragen auftauchen, wie <term type="ediromGui" key="global_appName"/> auf einem Server aufgesetzt werden muss, kann das Edirom Projekt (<ref target="http://www.edirom.de">http://www.edirom.de</ref>) kontaktiert werden.</p>
<p>Nichtsdestotrotz kann eine auf <term type="ediromGui" key="global_appName"/> basierende Edition aber auch auf anderen Datenträger gespeichert und verbreitet werden.
Dies erfordert jedoch die lokale Installation auf einem Computer. Sollte die vorliegende Version der <term type="ediromGui" key="global_appName"/> eine solch verbreitete
Ausgabe sein, kann der entsprechende Autor oder Verlag kontaktiert werden, um weitere Informationen rund um die Installation auf dem Computer zu erhalten.</p>
<!-- <note type="editorial">Projektspezifische Informationen zur Installationsroutine sollten nachfolgend als XML-Kommentare eingeschoben werden.</note>-->
<!--<div type="div2">
<head>Windows </head>
<p>If <hi rend="italic">AutoRun</hi> is activated in Windows, the Edirom installation program will open automatically when the DVD is inserted. Otherwise, start the program by running the <hi rend="italic">setup.exe</hi> file on the DVD. Follow the instructions provided in the installation program. Once installation is complete, you'll see the application listed in the <hi rend="italic">Start menu</hi> under <hi rend="italic">All Programs</hi> as '<hi rend="italic">Edirom</hi>' or a different name, depending on the edition.</p>
</div>-->
<!--<div type="div2">
<head>Mac OS X </head>
<p>If you're an Apple user, simply copy the Edirom application from the DVD to any directory on the hard drive (e.g., Applications). From there, double-click the application to start it.</p>
</div>-->
</div>
<div type="div2" xml:id="starting">
<head>Start der Anwendung </head>
<p><term type="ediromGui" key="global_appName"/> wurde als eine Web-Anwendung entwickelt. Die einzige Systemvorgabe, um <term type="ediromGui" key="global_appName"/> vernünftig ausführen zu können, ist die Installation eines Javascript-fähigen Browsers.</p>
<p>Sollte die aktuelle Version von <term type="ediromGui" key="global_appName"/> installiert werden müssen, kann rund um Fragen, die die Installation auf dem persönlichen Rechner betreffen, der entsprechende Autor oder Verlag kontaktiert werden.</p>
<!--<note type="editorial">Projektspezifische Informationen zum Start der Anwendung sollten entweder darüber, also den vorhergehenden Paragraphen ersetzend, oder nachfolgend eingeschoben werden.</note>-->
</div>
</div>

<!-- USER INTERFACE ========================================================= -->
<div type="div1" xml:id="gui">
<head>Benutzeroberfläche</head>
Expand Down
32 changes: 1 addition & 31 deletions add/help/help_en.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,44 +56,14 @@
<titlePart>Help (User Manual)</titlePart>
<argument>
<p>This document provides a general introduction to using <term type="ediromGui" key="global_appName"/>. It describes the basic functions of the software. Please note that not all of the
options described here are necessarily available in every edition using <term type="ediromGui" key="global_appName"/>. This is due to the fact that contents have to be prepared
accordingly and projects using <term type="ediromGui" key="global_appName"/> have their own edition guidelines and concepts. Furthermore, some versions may contain more options than
options described here are necessarily available in every edition using <term type="ediromGui" key="global_appName"/>. This is due to the fact that projects have their own edition guidelines and concepts. Furthermore, some versions may contain more options than
mentioned in this document due to edition-specific enhancements.</p>
</argument>
</titlePage>
<pb/>
<divGen type="toc"/>
</front>
<body>
<!--<div>
<divGen type="toc"/>
</div>-->
<!-- PREPARATION =============================================== -->
<div type="div1" xml:id="preparation">
<head>Preparation</head>
<div type="div2" xml:id="installation">
<head>Installation </head>
<p>
<term type="ediromGui" key="global_appName"/> is designed as web application and thus has to be set up on a server. For questions about setting up <term type="ediromGui" key="global_appName"/> on a server please contact the Edirom Project (<ref target="http://www.edirom.de">http://www.edirom.de</ref>).</p>
<p>Nevertheless an <term type="ediromGui" key="global_appName"/> based edition can be distributed on a discrete data storage device, and require/permit installation on your personal computer. If your current version of <term type="ediromGui" key="global_appName"/> is such a distributed version, please contact the corresponding author or publisher for further details concerning installation on your personal computer.</p>
<!--<note type="editorial">Project specific information on installation routines to be inserted below as in following xml comments.</note>-->
<!--<div type="div2">
<head>Windows </head>
<p>If <hi rend="italic">AutoRun</hi> is activated in Windows, the Edirom installation program will open automatically when the DVD is inserted. Otherwise, start the program by running the <hi rend="italic">setup.exe</hi> file on the DVD. Follow the instructions provided in the installation program. Once installation is complete, you'll see the application listed in the <hi rend="italic">Start menu</hi> under <hi rend="italic">All Programs</hi> as '<hi rend="italic">Edirom</hi>' or a different name, depending on the edition.</p>
</div>-->
<!--<div type="div2">
<head>Mac OS X </head>
<p>If you're an Apple user, simply copy the Edirom application from the DVD to any directory on the hard drive (e.g., Applications). From there, double-click the application to start it.</p>
</div>-->
</div>
<div type="div2" xml:id="starting">
<head>Application startup </head>
<p>
<term type="ediromGui" key="global_appName"/> is designed as a web application. The only system requirement is a javascript enabled web browser.</p>
<p>If your current version of <term type="ediromGui" key="global_appName"/> has to be installed please contact the corresponding author or publisher for further details concerning installation on your personal computer.</p>
<!--<note type="editorial">Project specific information on Application Startup to be inserted, either above, replacing the above paragraph, or below.</note>-->
</div>
</div>
<!-- USER INTERFACE ========================================================= -->
<div type="div1" xml:id="gui">
<head>User interface</head>
Expand Down

0 comments on commit c0dc848

Please sign in to comment.