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 | 164 |
1 files changed, 77 insertions, 87 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 5f96164e92b..83e4144b7e8 100644 --- a/Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex +++ b/Master/texmf-dist/source/latex/tudscr/doc/tudscr-installation.tex @@ -1,5 +1,5 @@ \chapter{Weiterführende Installationshinweise} -\label{sec:install:ext} +\tudhyperdef*{sec:install:ext}% % \noindent\Attention{% Im Folgenden werden unterschiedliche Varianten erläutert, wie die jeweils @@ -12,7 +12,7 @@ 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 + über CTAN eingespielt werden können. In \autoref{sec:install} wird der Installationsprozess der PostScript"=Schriften beschrieben. } @@ -28,18 +28,17 @@ Fehlerkorrektur respektive eine Aktualisierung von \TUDScript nötig, kann diese schnell und unkompliziert über das \GitHubRepo bereitgestellt und durch den Anwender sofort genutzt werden. -Dies hat allerdings für Anwender, welche das Forum relativ wenig oder gar -nicht besuchen, den großen Nachteil, dass diese nicht von Aktualisierungen, +Dies hat allerdings für alle Anwender, welche das Forum relativ wenig oder gar +nicht besuchen, den großen Nachteil, dass Sie nicht von Aktualisierungen, Verbesserungen und Fehlerkorrekturen neuer Versionen profitieren können. Auch -sämtliche nachfolgenden Bugfixes und Aktualisierungen des \TUDScript-Bundles -müssen durch den Anwender manuell durchgeführt werden. Daher wird in Zukunft -die Verbreitung via \hrfn{http://www.ctan.org/pkg/tudscr}{CTAN} präferiert, so -dass \TUDScript stets in der aktuellen Version verfügbar ist~-- eine durch den -Anwender aktuell gehaltene \hologo{LaTeX}"=Distribution vorausgesetzt. Der -einzige Nachteil bei diesem Ansatz ist, dass die Verbreitung eines Bugfixes -über das \hrfn{http://www.ctan.org/}{Comprehensive TeX Archive Network (CTAN)} -und die anschließende Bereitstellung durch die verwendete Distribution für -gewöhnlich mehrere Tage dauert. +alle nachfolgenden Bugfixes und Aktualisierungen des \TUDScript-Bundles müssen +durch den Anwender manuell durchgeführt werden. Daher wird die Verbreitung via +\CTAN[pkg/tudscr] präferiert, sodass \TUDScript stets in der gerade aktuellen +Version verfügbar ist~-- eine durch den Anwender aktuell gehaltene +\hologo{LaTeX}"=Distribution vorausgesetzt. Der einzige Nachteil bei diesem +Ansatz ist, dass die Verbreitung eines Bugfixes und die anschließende +Bereitstellung durch die verwendete Distribution für gewöhnlich bis zu zwei +Tagen dauert. Die gängigen \hologo{LaTeX}"=Distributionen durchsuchen im Regelfall zuerst das lokale \Path{texmf}"=Nutzerverzeichnis nach Klassen und Paketen und erst daran @@ -49,7 +48,7 @@ liegt. Sobald im Nutzerverzeichnis die gesuchte Datei gefunden wurde, wird die Suche beendet. \Attention{% In der Konsequenz bedeutet dies, dass sämtliche Aktualisierungen über CTAN - nicht zum Tragen kommen, falls \TUDScript als lokale Nutzerversion + nicht zum Tragen kommen, falls \TUDScript als lokale Nutzerversion installiert wurde. } @@ -68,15 +67,15 @@ selbst verantwortlich ist. \section{Lokale Deinstallation des \TUDScript-Bundles} -\label{sec:local:uninstall} -\index{Deinstallation} +\tudhyperdef*{sec:local:uninstall}% +\index{Deinstallation}% % Um die lokale Nutzerinstallation zu entfernen, kann für Windows -\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr\_uninstall.bat}% -{\File{tudscr\_uninstall.bat}} sowie für unixartige Betriebssysteme -\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr\_uninstall.sh}% -{\File{tudscr\_uninstall.sh}} verwendet werden. Nach der Ausführung des -jeweiligen Skriptes kann in der Konsole beziehungsweise im Terminal mit +\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr\_uninstall.bat}{\File{tudscr\_uninstall.bat}} +sowie für unixartige Betriebssysteme +\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr\_uninstall.sh}{\File{tudscr\_uninstall.sh}} +verwendet werden. Nach der Ausführung des jeweiligen Skriptes kann in der +Konsole beziehungsweise im Terminal mit % \begin{quoting} \Path{kpsewhich --all tudscrbase.sty} @@ -119,22 +118,22 @@ gefundene~-- zum Ordner der Distribution \emph{zusätzliche}~-- Pfad hat die folgende Struktur: % \begin{quoting} -\Path{\emph{<Installationspfad>}/tex/latex/tudscr/tudscrbase.sty} +\Path{\PName{Installationspfad}/tex/latex/tudscr/tudscrbase.sty} \end{quoting} % Um die Nutzerinstallation vollständig zu entfernen, muss als erstes zu -\Path{\emph{<Installationspfad>}} navigiert werden. Anschließend ist in diesem +\Path{\PName{Installationspfad}} navigiert werden. Anschließend ist in diesem Pfad Folgendes durchzuführen: % \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/}]\File*{.cls}- und \File*{.sty}"~Dateien löschen \item[\Path{tex/latex/tudscr/}]Ordner \Path{logo} vollständig löschen \item[\Path{doc/latex/}] Ordner \Path{tudscr} vollständig löschen \item[\Path{source/latex/}] Ordner \Path{tudscr} vollständig löschen \end{description} % -Das Verzeichnis \Path{\emph{<Installationspfad>}/tex/latex/tudscr/fonts} +Das Verzeichnis \Path{\PName{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 @@ -145,8 +144,8 @@ Distribution bereitgestellt wird. \section{Lokale Installation des \TUDScript-Bundles} -\label{sec:local:install} -\index{Installation!Nutzerinstallation}\index{Nutzerinstallation (lokal)} +\tudhyperdef*{sec:local:install}% +\index{Installation!Nutzerinstallation|(}% % Für die lokale Nutzerinstallation von \TUDScript inklusive der Schriften des \CDs werden für Windows sowie unixartige Betriebssysteme die passenden Skripte @@ -155,15 +154,13 @@ 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 Nutzerinstallation des \TUDScript-Bundles und der dazugehörigen Schriften für die Distributionen \Distribution{\hologo{TeX}~Live} oder \Distribution{\hologo{MiKTeX}} werden neben den Schriftarchiven die Dateien aus -\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Windows\_full.zip}% -{\File*{TUD-KOMA-Script\_\vTUDScript\_Windows\_full.zip}} benötigt. Vor der -Verwendung des Skripts \File{tudscr\_\vTUDScript\_install.bat} sollte -sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im selben -Verzeichnis befinden: +\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Windows\_full.zip}{\File*{TUD-KOMA-Script\_\vTUDScript\_Windows\_full.zip}} +benötigt. Vor der Nutzung 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}}% \begin{description}[labelwidth=\tempdim,labelsep=1em] @@ -171,7 +168,7 @@ Verzeichnis befinden: \item[\File{tudscr\_\vTUDScript\_install.bat}]Installationsskript \item[\File{Univers\_PS.zip}]Archiv mit Schriftdateien für \Univers \item[\File{DIN\_Bd\_PS.zip}]Archiv mit Schriftdateien für \DIN - \item[\File{tudscrfonts.zip}]Archiv mit Metriken für die + \item[\File{tudscr\_fonts\_install.zip}]Archiv mit Metriken für die Schriftinstallation via \Package{fontinst} \end{description} % @@ -189,15 +186,13 @@ Schriftinstallation sei auf \autoref{sec:install:win} verwiesen. \subsection{Lokale Installation von \TUDScript unter Linux und OS~X} -\index{Installation!Nutzerinstallation}\index{Nutzerinstallation (lokal)} Für eine lokale Nutzerinstallation des \TUDScript-Bundles und der dazugehörigen Schriften für die Distributionen \Distribution{\hologo{TeX}~Live} oder \Distribution{Mac\hologo{TeX}} werden neben den Schriftarchiven die Dateien aus -\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Unix\_full.zip}% -{\File*{TUD-KOMA-Script\_\vTUDScript\_Unix\_full.zip}} benötigt. Vor der -Verwendung des Skripts \File{tudscr\_\vTUDScript\_install.sh} sollte -sichergestellt werden, dass sich \emph{alle} der folgenden Dateien im selben -Verzeichnis befinden: +\hrfn{https://github.com/tud-cd/tudscr/releases/download/\vTUDScript/TUD-KOMA-Script\_\vTUDScript\_Unix\_full.zip}{\File*{TUD-KOMA-Script\_\vTUDScript\_Unix\_full.zip}} +benötigt. Vor der Verwendung des Skripts \File{tudscr\_\vTUDScript\_install.sh} +sollte 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}}% @@ -206,7 +201,7 @@ Verzeichnis befinden: (Terminal: \Path{bash tudscr\_\vTUDScript\_install.sh}) \item[\File{Univers\_PS.zip}]Archiv mit Schriftdateien für \Univers \item[\File{DIN\_Bd\_PS.zip}]Archiv mit Schriftdateien für \DIN - \item[\File{tudscrfonts.zip}]Archiv mit Metriken für die + \item[\File{tudscr\_fonts\_install.zip}]Archiv mit Metriken für die Schriftinstallation via \Package{fontinst} \end{description} % @@ -218,18 +213,15 @@ verwiesen. \section{Lokales Update des \TUDScript-Bundles} -\label{sec:local:update} -\index{Update!Nutzerinstallation}\index{Nutzerinstallation (lokal)} - - - +\tudhyperdef*{sec:local:update}% +\index{Update|!}% +% \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 +\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 @@ -244,11 +236,11 @@ angeboten. Die Aktualisierung kann durch den Anwender entweder~-- wie in \autoref{sec:local:install} erläutert~-- mit einer skriptbasierten oder mit 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}) sehr -empfohlen. +\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}) sehr empfohlen. +\index{Installation!Nutzerinstallation|)}% \subsection{Update des \TUDScript-Bundles von Version \NoCaseChange{v}1.0} @@ -259,7 +251,7 @@ empfohlen. Ist \TUDScript in der veralteten Version~v1.0 installiert, so wird dringend zu einer Deinstallation geraten. Andernfalls wird es zu Problemen kommen. Dafür werden die Skripte -\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr\_uninstall.bat}{\File{tudscr\_uninstall.bat}} +\hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr_uninstall.bat}{\File{tudscr\_uninstall.bat}} respektive \hrfn{https://github.com/tud-cd/tudscr/releases/download/uninstall/tudscr_uninstall.sh}{\File{tudscr\_uninstall.sh}} bereitgestellt. Die aktuelle Version~\vTUDScript{} kann nach der Deinstallation @@ -268,25 +260,24 @@ wie in \autoref{sec:install} beschrieben installiert werden. 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 steht 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}} bereit, welches sowohl die genannten -Skripte zur Deinstallation als auch die zur neuerlichen Installation der -veralteten Klassen benötigten \File{tudscr\_v1.0old\_install.bat} oder -\File{tudscr\_v1.0old\_install.sh} enthält. Nach Abschluss des Vorgangs sind -die alten Klassen der Version~v1.0 mit \Class{tudscrbookold}, -\Class{tudscrreprtold} und \Class{tudscrartclold} parallel zur aktuellen -Version~\vTUDScript{} verwendbar. +\hrfn{https://github.com/tud-cd/tudscrold/releases/download/v1.0/TUD-KOMA-Script_v1.0old.zip}{\File*{TUD-KOMA-Script\_v1.0old.zip}} +bereit, welches sowohl die genannten Skripte zur Deinstallation als auch die +zur neuerlichen Installation der veralteten Klassen benötigten +\File{tudscr\_v1.0old\_install.bat} oder \File{tudscr\_v1.0old\_install.sh} +enthält. Nach Abschluss des Vorgangs sind die alten Klassen der Version~v1.0 +mit \Class{tudscrbookold}, \Class{tudscrreprtold} und \Class{tudscrartclold} +parallel zur aktuellen Version~\vTUDScript{} verwendbar. Im Vergleich zur Version~v1.0 hat sich an der Benutzerschnittstelle nicht sehr 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'(tudscr) sehen, welches eine Schnittstelle zur -Nutzung alter und ursprünglich nicht mehr vorgesehener Befehle sowie Optionen -bereitstellt. Allerdings werden einige von diesen auch durch das Paket -\Package{tudscrcomp}(tudscr) nicht mehr bereitgestellt. Aufgeführt sind diese -in \autoref{sec:obsolete}. Sollten trotz aller Hinweise 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. +Probleme auf, sollte der Anwender als erstes die Beschreibung des Paketes +\Package{tudscrcomp}'full' lesen, welches eine Schnittstelle zur Nutzung alter +und ursprünglich nicht mehr vorgesehener Befehle sowie Optionen bereitstellt. +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 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*} \end{Declaration*} \end{Declaration*} @@ -294,21 +285,20 @@ Meldung im \Forum die beste Möglichkeit, um Hilfe zu erhalten. \section{Installationshinweise für portable Installationen} -\label{sec:install:portable} - +\tudhyperdef*{sec:install:portable}% +% Prinzipiell ist die Installation der PostScript-Schriften bei der Nutzung von \Distribution{\hologo{TeX}~Live~Portable}|?| beziehungsweise \Distribution{\hologo{MiKTeX}~Portable}|?| äquivalent zur nicht-portablen Variante, welche in \autoref{sec:install} beschrieben wird. Alle dort gegebenen -Hinweise sollten sorgfältig berücksichtigt werden. Darüberhinaus ist bei +Hinweise sollten sorgfältig berücksichtigt werden. Darüber hinaus ist bei \Distribution{\hologo{MiKTeX}~Portable} darauf zu achten, den Installationspfad nicht unbedingt auf der obersten Verzeichnisebene des externen Speichermediums zu wählen. Zur Installation der Schriften des \CDs wird das Archiv -\hrfn{https://github.com/tud-cd/tudscr/releases/download/fonts/TUD-KOMA-Script_fonts_Windows.zip}% -{\File*{TUD-KOMA-Script\_fonts\_Windows.zip}} benötigt. Dieses kann entweder -auf der lokalen Festplatte oder auf dem externen Speichermedium entpackt -werden. Danach wird folgendes Vorgehen empfohlen: +\hrfn{https://github.com/tud-cd/tudscr/releases/download/fonts/TUD-KOMA-Script_fonts_Windows.zip}{\File*{TUD-KOMA-Script\_fonts\_Windows.zip}} +benötigt. Dieses kann entweder auf der lokalen Festplatte oder auf dem externen +Speichermedium entpackt werden. Danach wird folgendes Vorgehen empfohlen: \minisec{\NoCaseChange{\hologo{TeX}}~Live~Portable} Das folgende Vorgehen wurde mit Windows getestet. Empfehlungen für die portable @@ -317,8 +307,8 @@ gesendet werden. \begin{enumerate} \item Installation von \Distribution{\hologo{TeX}~Live~Portable} in den Pfad \Path{\PName{Laufwerk}:\textbackslash texlive} -\item Die Datei \File{tl-tray-menu.exe} im Installationspfad öffnen -\item Im Infobereich der Taskleiste mit einem Rechtsklick auf das Symbol von +\item Die Datei \File*{tl-tray-menu.exe} im Installationspfad öffnen +\item Im Infobereich der Taskleiste mit einem Rechtsklick auf das Symbol von \Distribution{\hologo{TeX}~Live~Portable} das Kontextmenü öffnen und ein Update entweder über die grafische Oberfläche (\emph{Package Manager}) oder die Kommandozeile (\emph{Command Prompt}) durchführen @@ -338,7 +328,7 @@ gesendet werden. \item Installation von \Distribution{\hologo{MiKTeX}~Portable} in den Pfad \Path{\PName{Laufwerk}:\textbackslash LaTeX\textbackslash MiKTeXportable} \item Die Datei \File{miktex-portable.cmd} im Installationspfad öffnen -\item Im Infobereich der Taskleiste mit einem Rechtsklick auf das Symbol von +\item Im Infobereich der Taskleiste mit einem Rechtsklick auf das Symbol von \Distribution{\hologo{MiKTeX}~Portable} das Kontextmenü öffnen und ein Update durchführen \item Über das Kontextmenü die Kommandozeile starten und über diese das @@ -352,10 +342,10 @@ gesendet werden. Ein Ausführen ohne die über \Distribution{\hologo{MiKTeX}~Portable} geöffnete Kommandozeile führt zu Fehlern. }% -\item Bei der erstmaligen Verwendung einer der \TUDScript-Dokumentklassen - werden die Pakete \Package{tudscr}, \Package{koma-script}, - \Package{etoolbox}, \Package{textcase}, \Package{environ}, - \Package{trimspaces}, \Package{xcolor}, \Package{mptopdf}() durch +\item Bei der erstmaligen Verwendung einer der \TUDScript-Klassen werden die + Pakete \Package*{tudscr}, \Package{koma-script}, \Package{etoolbox}, + \Package{textcase}, \Package{environ}, \Package{trimspaces}, + \Package{xcolor} sowie \Package{mptopdf}<> durch \Distribution{\hologo{MiKTeX}~Portable} nachinstalliert, falls diese nicht schon vorhanden sind und die automatische Nachinstallation von Paketen aktiviert ist. |