diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex')
-rw-r--r-- | Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex | 109 |
1 files changed, 56 insertions, 53 deletions
diff --git a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex index 36de3d01b56..e98a23877d4 100644 --- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex +++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex @@ -4,16 +4,16 @@ \noindent\Attention{% Im Folgenden werden unterschiedliche Varianten erläutert, wie die jeweils aktuelle Version von \TUDScript genutzt werden kann, falls bereits eine - frühere Variante \textbf{lokal} installiert ist. Unabhängig davon, für welche - Möglichkeit Sie sich entscheiden, ist eine abermalige Installation der - PostScript"=Schriften für eine fehlerfreie Verwendung von \TUDScript zwingend - notwendig, wenn Sie bisher \TUDScript vor der Version~v2.02 verwendet haben. - Das liegt daran, dass der Installationsprozess der Schriften des \CDs für die - Version~v2.02 nochmals angepasst werden musste. Dieser Schritt ließ sich - leider nicht vermeiden. Für zukünftige Versionen kann darauf hoffentlich - verzichtet werden, sodass Aktualisierungen ausschließlich über CTAN - eingespielt werden können. Die Installation der PostScript"=Schriften ist in - \autoref{sec:install} beschrieben. + frühere Variante als \textbf{lokale Nutzerinstallation} verwendet wird. + Unabhängig davon, für welche Möglichkeit Sie sich entscheiden, ist eine + abermalige Installation der PostScript"=Schriften für eine fehlerfreie + Verwendung von \TUDScript zwingend notwendig, wenn Sie bisher \TUDScript vor + der Version~v2.02 verwendet haben, da der Installationsprozess der Schriften + des \CDs für die Version~v2.02 nochmals angepasst werden musste. Dieser + Schritt ließ sich leider nicht vermeiden. Für zukünftige Versionen kann + darauf hoffentlich verzichtet werden, sodass Aktualisierungen ausschließlich + über CTAN eingespielt werden können. In \autoref{sec:install} wird der + Installationsprozess der PostScript"=Schriften beschrieben. } \bigskip\noindent @@ -92,16 +92,17 @@ werden (\autoref{sec:install}). Wird \emph{nur} das lokale Nutzerverzeichnis oder gar kein Verzeichnis gefunden, so wird höchstwahrscheinlich eine veraltete Distribution -verwendet. In diesem Fall \emph{muss} \TUDScript lokal aktualisiert -(\autoref{sec:local:update}) beziehungsweise bei der erstmaligen Verwendung -lokal installiert (\autoref{sec:local:install}) werden. Sollte neben dem -Pfad der Distribution immer noch mindestens ein weiterer Pfad angezeigt werden, -so ist weiterhin eine lokale Nutzerversion installiert. In diesem Fall hat der -Anwender zwei Möglichkeiten: +verwendet. In diesem Fall wird eine Aktualisierung dieser \emph{unbedingt} +empfohlen. Sollte dies nicht möglich sein, \emph{muss} \TUDScript als lokale +Nutzerversion aktualisiert (\autoref{sec:local:update}) beziehungsweise bei der +erstmaligen Verwendung installiert (\autoref{sec:local:install}) werden. Sollte +neben dem Pfad der Distribution immer noch mindestens ein weiterer Pfad +angezeigt werden, so ist weiterhin eine lokale Nutzerversion installiert. In +diesem Fall hat der Anwender zwei Möglichkeiten: % \begin{enumerate} \item Entfernen der lokalen Nutzerinstallation (manuell) -\item Update der lokalen Nutzerversion +\item Aktualisierung der lokalen Nutzerversion \end{enumerate} % Die erste Variante wird nachfolgend erläutert, die zweite Möglichkeit wird in @@ -125,7 +126,7 @@ Um die Nutzerinstallation vollständig zu entfernen, muss als erstes zu \Path{\emph{<Installationspfad>}} navigiert werden. Anschließend ist in diesem Pfad Folgendes durchzuführen: % -\settowidth{\tempdim}{\Path{tex/latex/tudscr/}}% +\settowidth\tempdim{\Path{tex/latex/tudscr/}}% \begin{description}[labelwidth=\tempdim,labelsep=1em] \item[\Path{tex/latex/tudscr/}]alle .cls- und .sty-Dateien löschen \item[\Path{tex/latex/tudscr/}]Ordner \Path{logo} vollständig löschen @@ -137,8 +138,8 @@ Das Verzeichnis \Path{\emph{<Installationspfad>}/tex/latex/tudscr/fonts} \textbf{sollte erhalten bleiben}. Andernfalls müssen die Schriften des \CDs abermals wie unter \autoref{sec:install} beschrieben installiert werden. Zum Abschluss ist in der Kommandozeile beziehungsweise im Terminal der Befehl -\Path{texhash} aufzurufen. Damit wurde die lokale Version entfernt und es wird -von nun an die Version von \TUDScript genutzt, welche durch die verwendete +\Path{texhash} aufzurufen. Damit wurde die lokale Nutzerversion entfernt und es +wird von nun an die Version von \TUDScript genutzt, welche durch die verwendete Distribution bereitgestellt wird. @@ -147,15 +148,15 @@ Distribution bereitgestellt wird. \label{sec:local:install} \index{Installation!Nutzerinstallation}\index{Nutzerinstallation (lokal)} % -Für die lokale Installation von \TUDScript inklusive der Schriften des \CDs -werden für Windows sowie unixartige Betriebssysteme die passenden Skripte +Für die lokale Nutzerinstallation von \TUDScript inklusive der Schriften des +\CDs werden für Windows sowie unixartige Betriebssysteme die passenden Skripte angeboten. Eine lokale Installation sollte nur von Anwender ausgeführt werden, die genau wissen, aus welchen Gründen dies geschehen soll. \subsection{Lokale Installation von \TUDScript unter Windows} \index{Installation!Nutzerinstallation}\index{Nutzerinstallation (lokal)} -Für eine lokale Installation sowohl des \TUDScript-Bundles als auch der +Für eine lokale Nutzerinstallation sowohl des \TUDScript-Bundles als auch der dazugehörigen Schriften für die Distributionen \Distribution{\hologo{TeX}~Live} oder \Distribution{\hologo{MiKTeX}} werden neben Schriftarchiven die Dateien aus \hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Windows\_full.zip}% @@ -164,7 +165,7 @@ Verwendung des Skripts \File{tudscr\_\vTUDScript\_install.bat} sollte sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im selben Verzeichnis befinden: % -\settowidth{\tempdim}{\File{tudscr\_\vTUDScript\_install.bat}}% +\settowidth\tempdim{\File{tudscr\_\vTUDScript\_install.bat}}% \begin{description}[labelwidth=\tempdim,labelsep=1em] \item[\File{tudscr\_\vTUDScript.zip}]Archiv mit Klassen- und Paketdateien \item[\File{tudscr\_\vTUDScript\_install.bat}]Installationsskript @@ -188,7 +189,7 @@ Schriftinstallation sei auf \autoref{sec:install:fonts:win} verwiesen. \subsection{Lokale Installation von \TUDScript unter Linux und OS~X} \index{Installation!Nutzerinstallation}\index{Nutzerinstallation (lokal)} -Für eine lokale Installation sowohl des \TUDScript-Bundles als auch der +Für eine lokale Nutzerinstallation sowohl des \TUDScript-Bundles als auch der dazugehörigen Schriften für die Distributionen \Distribution{\hologo{TeX}~Live} oder \Distribution{Mac\hologo{TeX}} werden neben Schriftarchiven die Dateien aus \hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Unix\_full.zip}% @@ -198,7 +199,7 @@ sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im selben Verzeichnis befinden: % \begin{description}[labelwidth=\tempdim,labelsep=1em] -\settowidth{\tempdim}{\File{tudscr\_\vTUDScript\_install.sh}}% +\settowidth\tempdim{\File{tudscr\_\vTUDScript\_install.sh}}% \item[\File{tudscr\_\vTUDScript.zip}]Archiv mit Klassen- und Paketdateien \item[\File{tudscr\_\vTUDScript\_install.sh}]Installationsskript (Terminal: \Path{bash tudscr\_\vTUDScript\_install.sh}) @@ -218,31 +219,34 @@ verwiesen. \section{Lokales Update des \TUDScript-Bundles} \label{sec:local:update} \index{Update!Nutzerinstallation}\index{Nutzerinstallation (lokal)} -% -%\subsection{Update des \TUDScript-Bundles ab Version~\NoCaseChange{v}2.02} -%Für eine lokale Aktualisierung von \TUDScript auf \vTUDScript{} muss das Archiv -%\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Windows\_update.zip}% -%{TUD-KOMA-Script\_\vTUDScript\_Windows\_update.zip} respektive -%\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Unix\_update.zip}% -%{TUD-KOMA-Script\_\vTUDScript\_Unix\_update.zip} entpackt und anschließend -%\File{tudscr\_\vTUDScript\_update.bat} oder -%\File{tudscr\_\vTUDScript\_update.sh} ausgeführt werden. -%\Attention{% -% Das lokale Update funktioniert nur, wenn bereits mindestens Version~v2.02 -% entweder lokal oder über die Distribution installiert ist.% -%} + + + +\subsection{Update des \TUDScript-Bundles ab Version~\NoCaseChange{v}2.02} +Für eine lokale Aktualisierung von \TUDScript auf \vTUDScript{} muss das Archiv +\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Windows\_update.zip}% +{TUD-KOMA-Script\_\vTUDScript\_Windows\_update.zip} respektive +\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Unix\_update.zip}% +{TUD-KOMA-Script\_\vTUDScript\_Unix\_update.zip} entpackt und anschließend +\File{tudscr\_\vTUDScript\_update.bat} oder +\File{tudscr\_\vTUDScript\_update.sh} ausgeführt werden. +\Attention{% + Die lokale Aktualisierung funktioniert nur, wenn \TUDScript bereits + mindestens in der Version~v2.02 entweder als lokale Nutzerversion oder über + die Distribution sowie die PostScript"=Schriften installiert sind.% +} \subsection{Update des \TUDScript-Bundles ab Version~\NoCaseChange{v}2.00} Mit der Version~v2.02 gab es einige tiefgreifende Änderungen. Deshalb wird für vorausgehende Versionen~-- sprich v2.00 und v2.01~-- kein dediziertes Update angeboten. Die Aktualisierung kann durch den Anwender entweder~-- wie in \autoref{sec:local:install} erläutert~-- mit einer skriptbasierten oder mit -einer manuellen Neuinstallation lokal erfolgen. Für die zweite Variante muss +einer manuellen Neuinstallation erfolgen. Für die zweite Variante muss der Inhalt des Archivs \hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/tudscr\_\vTUDScript.zip}% {\File{tudscr\_\vTUDScript.zip}} in das lokale \Path{texmf}"=Nutzerverzeichnis kopiert werden. Des Weiteren wurde die Installation der Schriften überarbeitet. -Deshalb wird auch für diese eine Neuinstallation (\autoref{sec:install}) +Deshalb wird auch für diese eine Neuinstallation (\autoref{sec:install}) sehr empfohlen. @@ -263,9 +267,9 @@ bereitgestellt. Andernfalls wird es zu Problemen kommen. Die aktuelle Version~\vTUDScript{} kann nach der Deinstallation der Version~v1.0 wie unter \autoref{sec:install} beschrieben installiert werden. -Sollen die obsoleten \TUDScript-Klassen in der Version~v1.0 nach einer -Aktualisierung weiterhin genutzt werden, so müssen diese erst wie zuvor -beschrieben de"~~und anschließend neu installiert werden. Dafür kann das Archiv +Möchten Sie die obsoleten \TUDScript-Klassen in der Version~v1.0 nach einer +Aktualisierung weiterhin nutzen, so müssen diese nach der Deinstallation neu +installiert werden. Dafür kann das Archiv \hrfn{https://github.com/tud-cd/tudscrold/releases/download/v1.0/TUD-KOMA-Script_v1.0old.zip}% {\File*{TUD-KOMA-Script\_v1.0old.zip}} verwendet werden, welches sowohl die genannten Skripte zur Deinstallation als auch die zur neuerlichen Installation @@ -276,15 +280,14 @@ die alten Klassen der Version~v1.0 mit \Class{tudscrbookold}, parallel zur aktuellen Version~\vTUDScript{} genutzt werden. Im Vergleich zur Version~v1.0 hat sich an der Benutzerschnittstelle nicht sehr -viel verändert. Treten nach dem Umstieg von der Version~v1.0 auf die -Version~\vTUDScript{} dennoch Probleme auf, sollte der Anwender als erstes in -die Beschreibung des Paketes \Package{tudscrcomp}'full' sehen. Diese Paket -stellt eine Schnittstelle bereit, mit der es möglich ist, alte und ursprünglich -nicht mehr vorgesehene Befehle und Optionen dennoch zu nutzen. Allerdings -werden einige von diesen auch durch das Paket \Package{tudscrcomp} nicht mehr -bereitgestellt, weil diese schlichtweg verworfen wurden. Diese sind in -\autoref{sec:obsolete} aufgeführt und es werden im alten Dokument notwendige -Anpassungen beschrieben. Sollten dennoch Fehler oder Probleme beim Umstieg auf +viel verändert. Treten nach dem Umstieg auf die Version~\vTUDScript{} dennoch +Probleme auf, sollte der Anwender als erstes in die Beschreibung des Paketes +\Package{tudscrcomp}'full' sehen,welches eine Schnittstelle bereitstellt, mit +der es möglich ist, alte und ursprünglich nicht mehr vorgesehene Befehle sowie +Optionen dennoch zu nutzen. Allerdings werden einige von diesen auch durch das +Paket \Package{tudscrcomp} nicht mehr bereitgestellt. Aufgeführt sind diese in +\autoref{sec:obsolete}. Sollten trotz aller Hinweise in besagtem +\autorefname[sec:obsolete] dennoch Fehler oder Probleme beim Umstieg auf die neue \TUDScript-Version auftreten, ist eine Meldung im Forum die beste Möglichkeit, um Hilfe zu erhalten. \end{Declaration*} |