summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/webquiz.1
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/webquiz.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/webquiz.165
1 files changed, 31 insertions, 34 deletions
diff --git a/Master/texmf-dist/doc/man/man1/webquiz.1 b/Master/texmf-dist/doc/man/man1/webquiz.1
index 076b3c70c1b..4bf1587e60e 100644
--- a/Master/texmf-dist/doc/man/man1/webquiz.1
+++ b/Master/texmf-dist/doc/man/man1/webquiz.1
@@ -95,7 +95,7 @@ Use xelatex to compile the quiz
.BI \-r \ RCFILE\fP,\fB \ \-\-rcfile \ RCFILE
Specify location of the webquiz rc\-file
.TP
-.B \-i\fP,\fB \-\-initialise
+.B \-i\fP,\fB \-\-initialise\fP,\fB \-\-initialize
Install web components of webquiz
.TP
.B \-e\fP,\fB \-\-edit\-settings
@@ -116,49 +116,41 @@ Once the TeX components of \fI\%WebQuiz\fP package have been installed you can i
If you want to install the web components of \fI\%WebQuiz\fP into a system directory then you need to run this command from an administrators account, so using \fIsudo\fP on a unix\-like system. For more details about the installation and configuration of \fI\%WebQuiz\fP please see Section 3.2 of the \fI\%WebQuiz\fP manual.
.sp
Please see the manual for more details about initialising and using \fI\%WebQuiz\fP\&.
-.SH INSTALLATION FROM CTAN
+.SH INSTALLATION FROM THE CTAN ZIPFILE
.sp
-If you are installing WebQuiz using the zip file from ctan, as opposed to
-installing the package from TeX distribution like TeXLive, then the following
-steps are recommended:
+On both unix\-like systems (including macosx), and windows systems (using
+either TeXLive or MiKTeX), you can install WebQuiz by downloading the
+WebQuiz zip file from:
.INDENT 0.0
-.IP \(bu 2
-Create a symbolic link, or equivalent, to the main WebQuiz executable, which
-is the file webquiz.py in the scripts directory
-.IP \(bu 2
-Copy the latex directory to somewhere in TeX search path, or set your
-TEXINPUTS environment variable appropriately, and then run \fImktexlsr\fP or
-equivalent so that LaTeX and WebQuiz can find these files.
-.IP \(bu 2
-Ideally the doc subdirectory should be copied into the doc/layetx subdirecory
-of the main TeX distribution.
+.INDENT 3.5
+\fI\%http://mirrors.ctan.org/macros/latex/contrib/webquiz.zip\fP
+.UNINDENT
.UNINDENT
.sp
-If you are using a unix system, or macosx, there is an (undocumented)
-command\-line option \fI\-\-tex\-install\fP that installs the three different
-components of \fI\%WebQuiz\fP into the standard locations in the TeXLive
-tree:
+To install the package, unzip this file and change directory to the
+webquiz/scripts subdirectory run:
+.sp
+> webquiz \-\-tex\-install
+.sp
+(or webquiz.bat \-\-text\-install on windows). This commands unpacks the webquiz
+files into their standard locations in the TeX install tree to it should be
+run from an administrators account, or using sudo on a unix\-like system.
+Roughly what this command does is the following:
.INDENT 0.0
.IP \(bu 2
-$TEXMFMAIN/tex/latex/webquiz all LaTeX files
+It creates a symbolic link, or equivalent, to the main WebQuiz executable,
+which is the file webquiz.py in the scripts directory
.IP \(bu 2
-$TEXMFMAIN/scripts/webquiz the python programs
+Copies the latex directory to somewhere in the TeX search path and then
+runs \fImktexlsr\fP so that LaTeX and WebQuiz can find these files.
.IP \(bu 2
-$TEXMFMAIN/doc/latex/webquiz the documentation and web components
+Copies the python code into the TeX scripts subdirectory
.IP \(bu 2
-A symbolic link is made from the TeX bin directory to the main
-WebQuiz executable $TEXMFMAIN/scripts/webquiz/webquiz.py
+Copies the WebQuiz doc subdirectory into the TeX doc/latex subdirectory.
.UNINDENT
.sp
-To install these files in TEXMFMAIN you will almost certainly need
-adminsistrator or root privledges, so on a unix\-like system you will
-need to use:
-.sp
-> sudo webquiz/scripts/webquiz \-\-tex\-install
-.sp
-In principle, this command may also work on a windows computer,
-provided that the command \fIkpsewhich\fP is available, but this is
-untested.
+If you are using MiKTeX you may need to open the MiKTeX console, go to
+the Tasks menu and then rebuild the TeX filename database.
.sp
Once the files above are in place initialise WebQuiz by following the
installation instructions above.
@@ -198,7 +190,12 @@ described in the \fBInstallation\fP section you will also need to copy of the
.UNINDENT
.SH AUTHORS
.sp
-The LaTeX component of \fI\%WebQuiz\fP was written by Andrew Mathas and the python, css and javascript code was written by Andrew Mathas (and Don Taylor), based on an initial protype of Don Taylor\(aqs from 2001. Since 2004 the program has been maintained and developed by Andrew Mathas. Although the program has changed substantially since 2004 Don\(aqs idea of using TeX 4ht, and some of his code, is still very much in use.
+The LaTeX component of \fI\%WebQuiz\fP was written by Andrew Mathas and the python,
+css and javascript code was written by Andrew Mathas (and Don Taylor), based on
+an initial protype of Don Taylor\(aqs from 2001. Since 2004 the program has been
+maintained and developed by Andrew Mathas. Although the program has changed
+substantially since 2004 Don\(aqs idea of using \fI\%TeX4ht\fP, and some of his code, is
+still very much in use.
.sp
Copyright (C) 2004\-2019
.SH LICENSE