diff --git a/EK-VAXAA-4P-001.pdf b/EK-VAXAA-4P-001.pdf index 7f2dc68..a570885 100644 Binary files a/EK-VAXAA-4P-001.pdf and b/EK-VAXAA-4P-001.pdf differ diff --git a/EK-VAXAA-4P-001.tex b/EK-VAXAA-4P-001.tex index fff219a..766a3ae 100644 --- a/EK-VAXAA-4P-001.tex +++ b/EK-VAXAA-4P-001.tex @@ -34,23 +34,23 @@ Read the VAXstation 2000 hardware and operating system Software documentation in \begin{enumerate} \item Hardware Installation Information \begin{enumerate} - \item VAXstation 2000 Hardware Installation Guide (Order No. EK-VAXAC-IN-003.) - \item To install a monochrome monitor, see this guide, the VAXstation 2000 Hardware Option Guide for the 4-Plane Graphics Coprocessor (Order No. EK-VAXAA-4P-001.) - \item Workstations and MicroVAX 2000 Network Guide (Order No EK-NETAB-UG) + \item VAXstation 2000 Hardware Installation Guide (Order No. \pdf{EK-VAXAC-IN-003}.) + \item To install a monochrome monitor, see this guide, the VAXstation 2000 Hardware Option Guide for the 4-Plane Graphics Coprocessor (Order No. \pdf{EK-VAXAA-4P-001}.) + \item Workstations and MicroVAX 2000 Network Guide (Order No \pdf{EK-NETAB-UG}) \end{enumerate} \item Operating System Information \begin{enumerate} - \item VAXstation 2000 Owner's Manual, Chapter 1 (Operating the VAXstation 2000) (Order No. EK-VAXAC-OM-003) - \item MicroVMS VAXstation 2000/MicroVAX 2000 Installation Guide (Order No. AA-JR84A-TN) + \item VAXstation 2000 Owner's Manual, Chapter 1 (Operating the VAXstation 2000) (Order No. \pdf{EK-VAXAC-OM-003}) + \item MicroVMS VAXstation 2000/MicroVAX 2000 Installation Guide (Order No. \pdf{AA-JR84A-TN}) or - ULTRIX-32W Basic Installation Guide for the VAXstation 2000 (Order No. AA-KU45A-TE) + ULTRIX-32W Basic Installation Guide for the VAXstation 2000 (Order No. \pdf{AA-KU45A-TE}) \end{enumerate} \item Reference Information \begin{enumerate} - \item VAXstation 2000 Owner's Manual (Order No. EK-VAXAC-OM-003) - \item MicroVMS VAXstation 2000/MicroVAX 2000 Operations Guide (Order No. AA-JR83A-TN) + \item VAXstation 2000 Owner's Manual (Order No. \pdf{EK-VAXAC-OM-003}) + \item MicroVMS VAXstation 2000/MicroVAX 2000 Operations Guide (Order No. \pdf{AA-JR83A-TN}) \end{enumerate} \end{enumerate} @@ -59,7 +59,7 @@ The following notices appear throughout this guide: \begin{itemize} \item Notes - Contain general or supplemental information about a topic. - \item Cautions - COntain information to prevent damage to equipment. + \item Cautions - Contain information to prevent damage to equipment. \end{itemize} \subsection*{Conventions Used in This Guide} diff --git a/EK-VSTAA-MG-001-preamble.tex b/EK-VSTAA-MG-001-preamble.tex index 00888b3..eee5414 100644 --- a/EK-VSTAA-MG-001-preamble.tex +++ b/EK-VSTAA-MG-001-preamble.tex @@ -44,16 +44,16 @@ Notes, cautions, and warnings appear throughout this book. \hline \textbf{Manual} & \textbf{Order Number} \\ \hline -VAXstation 2000 Hardware Installation Guide & EK-VAXAA-IN \\ -VAXstation 2000 Owner's Manual & EK-VAXAA-OM \\ -VAXstation 2000/MicroVAX 2000 Technical Manual & EK-VTTAA-TM \\ -MicroVAX 2000 Hardware Installation Guide & EK-MVXAA-IN \\ -MicroVAX 2000 Owner's Manual & EK-MVXAA-OM \\ -VR290 Service Guide & EK-VR290-SM \\ -VAXstation 2000, MicroVAX 2000, VAXmate Network Guide & EK-NETAA-UG \\ -RD53 Technical Description Manual & EK-RD53A-TD \\ -RX33 Technical Description Manual & EK-RX33T-TM \\ -TZK50/SCSI Controller Technical Manual & EK-TZK50-TM \\ +VAXstation 2000 Hardware Installation Guide & \pdf{EK-VAXAA-IN} \\ +VAXstation 2000 Owner's Manual & \pdf{EK-VAXAA-OM} \\ +VAXstation 2000/MicroVAX 2000 Technical Manual & \pdf{EK-VTTAA-TM} \\ +MicroVAX 2000 Hardware Installation Guide & \pdf{EK-MVXAA-IN} \\ +MicroVAX 2000 Owner's Manual & \pdf{EK-MVXAA-OM} \\ +VR290 Service Guide & \pdf{EK-VR290-SM} \\ +VAXstation 2000, MicroVAX 2000, VAXmate Network Guide & \pdf{EK-NETAA-UG} \\ +RD53 Technical Description Manual & \pdf{EK-RD53A-TD} \\ +RX33 Technical Description Manual & \pdf{EK-RX33T-TM} \\ +TZK50/SCSI Controller Technical Manual & \pdf{EK-TZK50-TM} \\ \hline \end{tabularx} diff --git a/EK-VSTAA-MG-001.pdf b/EK-VSTAA-MG-001.pdf index 3258aaf..ef64a2c 100644 Binary files a/EK-VSTAA-MG-001.pdf and b/EK-VSTAA-MG-001.pdf differ diff --git a/Makefile b/Makefile index 8c7db36..427d1d5 100644 --- a/Makefile +++ b/Makefile @@ -1,13 +1,21 @@ -all: EK-VAXAA-4P-001.pdf EK-VSTAA-MG-001.pdf +SOURCEs=README EK-VAXAA-4P-001.tex EK-VSTAA-MG-001.tex -EK-VAXAA-4P-001.pdf: EK-VAXAA-4P-001.tex dec.cls - pdflatex EK-VAXAA-4P-001 < /dev/null - pdflatex EK-VAXAA-4P-001 < /dev/null -EK-VSTAA-MG-001.pdf: EK-VSTAA-MG-001.tex EK-VSTAA-MG-001-preamble.tex EK-VSTAA-MG-001-ch1.tex EK-VSTAA-MG-001-ch2.tex dec.cls decsectional.cls - pdflatex EK-VSTAA-MG-001 < /dev/null - pdflatex EK-VSTAA-MG-001 < /dev/null + + +PDFS=$(patsubst %.tex,%.pdf,$(SOURCES)) + +all: ${PDFS} README.md + + +%.pdf: %.tex $(wildcard %-*.tex) dec.cls decsectional.cls + pdflatex ${basename $@ .pdf} < /dev/null + pdflatex ${basename $@ .pdf} < /dev/null watch: ls *.tex *.cls | entr -c -s 'make' + + +README.md: README.tex + pandoc -s README.tex -o README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..46ddd61 --- /dev/null +++ b/README.md @@ -0,0 +1,96 @@ +--- +address: GitHub +author: +- The DEC Documentation Rebuild Project +title: ReadMe +--- + +Welcome to the DEC Documentation Rebuild project. This project, driven +by the community, aims to recreate as much of the documentation for +vintage Digital Equipment Corporation (DEC) computer equipment and +software as possible. + +The reason for this is twofold: + +1. Much of the documentation is in a poor state. It can be hard to make + out some parts of it due to bad scanning, or generally poor source + material. + +2. The existing documentation can be very hard to work with. Scanned + PDFs, even with advanced OCR, are hard to search and navigate. + Rebuilding the documentation gives us the chance to correct that + with embedded hyperlinks, clean text, and a generally more usable + experience. + +# How we are doing it + +It is highly likely (backed up by some evidence from the documentation +itself[^1] is written in LaTeX. In order to try and maintain as much of +the original layout and pagination as closely as possible to the +original LaTeX has again been chosen as the method to re-create the +documentation. This also lets us separate out the style from the content +making it much faster, once suitable document classes have been created, +to recreate documents with the minimum of effort. + +# Contributing + +You'd like to contribute? Fantastic! We are always looking for more +volunteers to help recreate more documents. Just fork this repository +and get writing. Most of the groundwork has been done for you in the +form of some handy document classes (dec.cls and decsectional.cls) that +implement reasonably accurately[^2]. By all means take a look at one of +the existing LaTeX files for an idea of how to go about implementing the +document. + +We only have a few stipulations when it comes to style, both of content +and general working: + +- The hyperref package is automatically included in the base dec.cls + file. Please use hyperlinks and hyperrefs within the document to + link to sections, figures and tables where they are mentioned in the + text. Also please use the \ + `pdf{...} ` command to wrap any references to other DEC documents. + This just creates a href to a PDF document in the same directory at + the moment though that may be subject to change in the future. + +- Your document should be named by the order number of the document + (for example EK-VAXAC-OM-003.tex) with any sub-parts being named the + same but with a hyphenated suffix (for example + EK-VAXAC-OM-003-ch1.tex). + +- In DEC documentation all figures have a reference number associated + with them which denotes the author, their image sequence number, and + the year of production. When you cut out an image from the original + scanned PDF please include this reference number. Name the image + file with this reference number and place it in the **fig** folder, + then use the \ + `fig{ref}{caption} ` command to reference it within your document. + +- Title page images should be stored in the **titles** folder and + named after the order number of the document. + +When transcribing you should attempt to match the layout and pagination +of the original document as possible. This is chiefly so that someone +who is referencing the original scanned PDF and someone who is +referencing the rebuilt PDF both get the same page numbers for the same +information and can collaborate more seamlessly. Some bleed of +paragraphs from page to page is fine, but tables, figures, and sections +should be on the same pages as the original where possible. + +# License + +These documents are provided with no warranty as regards their accuracy +whatsoever. The document class files are provided under the CC-BY 4.0 +license for you to use and adapt for your own purposes as you see fit. +We hope you find them useful. The document content and images remain +©Digital Equipment Corporation or the current owner of their trademarks +and copyrights (either HPE or VSI at the moment) and are provided and +used as an educational resource for archival and learning purposes. + +[^1]: For example using a space separated console prompt such as `> > >` + to combat LaTeX conversion of \>\> into \>\> + +[^2]: Apart from the fonts which we have tried to find reasonable + matches for in the standard LaTeX font library, but has proved + almost impossibe - and we don't want to have to use third party + fonts to complicate matters. diff --git a/README.pdf b/README.pdf new file mode 100644 index 0000000..0f3a194 Binary files /dev/null and b/README.pdf differ diff --git a/README.tex b/README.tex new file mode 100644 index 0000000..b03c2ed --- /dev/null +++ b/README.tex @@ -0,0 +1,78 @@ +\documentclass{dec} +\product{DEC Documentation} +\title{ReadMe} +\pubmonth{March} +\pubyear{2025} +\author{The DEC Documentation Rebuild Project} +\address{GitHub} + +\begin{document} + +\pagestyle{main} + +Welcome to the DEC Documentation Rebuild project. This project, driven by the community, aims to +recreate as much of the documentation for vintage Digital Equipment Corporation (DEC) computer +equipment and software as possible. + +The reason for this is twofold: + +\begin{enumerate} + +\item Much of the documentation is in a poor state. It can be hard to make out some parts of it due to bad scanning, + or generally poor source material. + +\item The existing documentation can be very hard to work with. Scanned PDFs, even with advanced OCR, are hard to + search and navigate. Rebuilding the documentation gives us the chance to correct that with embedded hyperlinks, + clean text, and a generally more usable experience. + +\end{enumerate} + +\section{How we are doing it} + +It is highly likely (backed up by some evidence from the documentation itself\footnote{For example using a space separated console prompt such as {\tt > > >} +to combat \LaTeX\ conversion of {>}{>} into >> } is written in \LaTeX. In order to try and maintain as much of the original layout and pagination as closely +as possible to the original \LaTeX\ has again been chosen as the method to re-create the documentation. This also lets us separate out the style from the content +making it much faster, once suitable document classes have been created, to recreate documents with the minimum of effort. + +\section{Contributing} + +You'd like to contribute? Fantastic! We are always looking for more volunteers to help recreate more documents. Just fork this repository and get +writing. Most of the groundwork has been done for you in the form of some handy document classes (dec.cls and decsectional.cls) that implement +reasonably accurately\footnote{Apart from the fonts which we have tried to find reasonable matches for in the standard \LaTeX\ font library, but +has proved almost impossibe - and we don't want to have to use third party fonts to complicate matters.}. By all means take a look at one of the +existing \LaTeX\ files for an idea of how to go about implementing the document. + +We only have a few stipulations when it comes to style, both of content and general working: + +\begin{itemize} + +\item The hyperref package is automatically included in the base dec.cls file. Please use hyperlinks and hyperrefs within the document + to link to sections, figures and tables where they are mentioned in the text. Also please use the {\tt \\pdf\{...\}\ } command to + wrap any references to other DEC documents. This just creates a href to a PDF document in the same directory at the moment though + that may be subject to change in the future. + +\item Your document should be named by the order number of the document (for example EK-VAXAC-OM-003.tex) with any sub-parts being named the same but + with a hyphenated suffix (for example EK-VAXAC-OM-003-ch1.tex). + +\item In DEC documentation all figures have a reference number associated with them which denotes the author, their image sequence number, and the + year of production. When you cut out an image from the original scanned PDF please include this reference number. Name the image file with + this reference number and place it in the \textbf{fig} folder, then use the {\tt \\fig\{ref\}\{caption\}\ } command to reference it within + your document. + +\item Title page images should be stored in the \textbf{titles} folder and named after the order number of the document. + +\end{itemize} + +When transcribing you should attempt to match the layout and pagination of the original document as possible. This is chiefly so that someone +who is referencing the original scanned PDF and someone who is referencing the rebuilt PDF both get the same page numbers for the same information and +can collaborate more seamlessly. Some bleed of paragraphs from page to page is fine, but tables, figures, and sections should be on the same pages +as the original where possible. + +\section{License} + +These documents are provided with no warranty as regards their accuracy whatsoever. The document class files are provided under the CC-BY 4.0 license +for you to use and adapt for your own purposes as you see fit. We hope you find them useful. The document content and images remain \copyright Digital +Equipment Corporation or the current owner of their trademarks and copyrights (either HPE or VSI at the moment) and are provided and used as an educational +resource for archival and learning purposes. + +\end{document} diff --git a/dec.cls b/dec.cls index 71ce4c4..fd37190 100644 --- a/dec.cls +++ b/dec.cls @@ -17,10 +17,10 @@ \usepackage{hyperref} \hypersetup{ colorlinks, - citecolor=black, - filecolor=black, + citecolor=blue, + filecolor=blue, linkcolor=blue, - urlcolor=black + urlcolor=blue } \raggedbottom @@ -95,7 +95,7 @@ -\def\@titlepicture{} +\def\@titlepicture{titles/blank} \newcommand{\titlepicture}[1]{ \def\@titlepicture{#1}} @@ -274,3 +274,5 @@ required to take measures to correct the interference. \newcommand{\console}{{\tt {>}{>}{>}}\ } + +\newcommand{\pdf}[1]{\href{#1.pdf}{#1}} diff --git a/titles/blank.png b/titles/blank.png new file mode 100644 index 0000000..1cf21b2 Binary files /dev/null and b/titles/blank.png differ