From 6f0fd2bd38de3f64630f5af3b6249768abd3c83c Mon Sep 17 00:00:00 2001 From: hneemann Date: Sat, 25 Mar 2017 22:26:49 +0100 Subject: [PATCH] updated documentation --- src/test/resources/docu/static_de.xml | 25 +++++++++---------------- src/test/resources/docu/static_en.xml | 19 ++++++------------- 2 files changed, 15 insertions(+), 29 deletions(-) diff --git a/src/test/resources/docu/static_de.xml b/src/test/resources/docu/static_de.xml index 66e7628be..ca2369500 100644 --- a/src/test/resources/docu/static_de.xml +++ b/src/test/resources/docu/static_de.xml @@ -64,32 +64,25 @@ - Um eine Schaltung in mehrere Teile zu zerlegen, die auch unabhängig z.B. in einem VCS abgelegt und verfolgt - werden können, wird jede eingebundenen Schaltung in einer eigenen Datei gespeichert. Das hat zu Folge, dass in einer - Schaltung nur die Dateinamen der Teilschaltungen gespeichert sind, und diese Dateien zur Laufzeit im Dateisystem - gefunden werden müssen. Um die verschiedenen Arbeitsweisen der Nutzer bestmöglich zu unterstützen und dennoch + Um eine Schaltung in mehrere Teile zu zerlegen, die auch unabhängig z.B. in einem Versionskontrollsystem + abgelegt und verfolgt werden können, wird jede eingebundenen Schaltung in einer eigenen Datei gespeichert. + Dabei werden in einer Schaltung nur die Dateinamen der Teilschaltungen gespeichert, und die entsprechenden + Dateien zur Laufzeit im Dateisystem gefunden werden müssen. + Um die verschiedenen Arbeitsweisen der Nutzer bestmöglich zu unterstützen und dennoch auf eine komplexe Verwaltung von Importpfaden usw. zu verzichten, ist eine etwas ungewöhnliche Import-Strategie implementiert. - In einer Schaltung sind die absoluten Pfade der eingebetteten Schaltungen gespeichert. Wenn diese Datei eingelesen - werden soll, wird jedoch zunächst geprüft, ob sich eine Datei des gleichen Namens im Ordner der einbindenden Datei befindet. - Ist das der Fall, wird diese Datei verwendet. - - - Ist das nicht der Fall, werden alle Unterordner nach einer Datei des entsprechenden Namens durchsucht. Wird + In einer Schaltung sind nur die Dateinamen der eingebetteten Schaltungen gespeichert. Soll die Datei geöffnet werden, + werden alle Unterordner nach einer Datei des entsprechenden Namens durchsucht. Wird eine passende Datei gefunden, wird diese importiert. Dabei kommt es nur auf den Dateinamen der einzulesenden Datei an, nicht auf dessen Pfad. Entsprechend wird eine Fehlermeldung erzeugt, wenn sich in verschiedenen Unterordneren mehrere Dateien gleichen Namens befinden, da dann Mehrdeutigkeiten entstehen. - - Erst wenn bisher keine Datei gefunden wurde, wird der komplette absolute Pfad verwendet und es wird versucht, - diese Datei zu importieren. Gelingt auch das nicht, wird eine Fehlermeldung erzeugt. - Eine geeignete Projektstruktur sieht daher wie folgt aus: In einem eigenen Ordner befindet sich die Wurzelschaltung. - Alle importierten Schaltungen sollte sin im selben Ordner oder in Unterordnern befinden. Alle Schaltungen sollten - unterschiedliche Namen haben, es sollte also nicht vorkommen, dass sich in verschiedenen Ordnern Schaltungen + Alle importierten Schaltungen müssen sich im selben Ordner oder in Unterordnern befinden. Alle Schaltungen müssen + unterschiedliche Namen haben, es darf also nicht vorkommen, dass sich in verschiedenen Ordnern Schaltungen gleichen Namens befinden. diff --git a/src/test/resources/docu/static_en.xml b/src/test/resources/docu/static_en.xml index 813fa7142..b47b429b1 100644 --- a/src/test/resources/docu/static_en.xml +++ b/src/test/resources/docu/static_en.xml @@ -64,30 +64,23 @@ In order to decompose a circuit into several parts which are independent, e.g. can be stored and tracked in - a VCS, each embedded circuit is stored in its own file. The result is that in a circuit only the file names + a version control system, each embedded circuit is stored in its own file. + The result is that in a circuit only the file names of the subcircuits are stored, and these files must be found in the file system at runtime. In order to support the various work methods of the users as best as possible and still to avoid a complex administration of import paths, etc., a somewhat unusual import strategy is implemented. - The absolute paths of the embedded circuits are stored in a circuits file. If a file is to be imported, - however, it is first checked whether a file with the same name is located in the folder of the including - file. If this is the case, this file is used. - - - If this is not the case, all subfolders are searched for a file of the corresponding name. + Only the file names of the embedded circuits are stored in a circuits file. + If a file needs to be opened, all subfolders are searched for a file of the corresponding name. If a suitable file is found, it is imported. This process only depends on the file name of the file to be read, not on its path. Correspondingly, an error message is generated if there are several files of the same name in different subfolders, since ambiguities then arise. - - Only if no file has been found yet, the complete absolute path is used and an attempt is made to import - this file. If this is not successful, an error message is generated. - A suitable project structure therefore looks as follows: The root circuit is located in a separate folder. - All imported circuits should be in the same folder or subfolders. All circuits should have different names, - so it should not happen that there are circuits of the same name in different folders. + All imported circuits must be in the same folder or subfolders. All circuits must have different names, + so it must not happen that there are circuits of the same name in different folders.