summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/webquiz/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/webquiz/README.rst')
-rw-r--r--Master/texmf-dist/doc/latex/webquiz/README.rst71
1 files changed, 35 insertions, 36 deletions
diff --git a/Master/texmf-dist/doc/latex/webquiz/README.rst b/Master/texmf-dist/doc/latex/webquiz/README.rst
index 60d0f52181f..dd8efda77e7 100644
--- a/Master/texmf-dist/doc/latex/webquiz/README.rst
+++ b/Master/texmf-dist/doc/latex/webquiz/README.rst
@@ -44,7 +44,8 @@ optional arguments:
-x, --xelatex Use xelatex to compile the quiz
-r RCFILE, --rcfile RCFILE
Specify location of the webquiz rc-file
- -i, --initialise Install web components of webquiz
+ -i, --initialise, --initialize
+ Install web components of webquiz
-e, --edit-settings Edit default settings for webquiz
--settings <SETTINGS>
List default settings for webquiz
@@ -61,40 +62,33 @@ If you want to install the web components of WebQuiz_ into a system directory th
Please see the manual for more details about initialising and using WebQuiz_.
-Installation from ctan
-----------------------
-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:
-
-- Create a symbolic link, or equivalent, to the main WebQuiz executable, which
- is the file webquiz.py in the scripts directory
-- Copy the latex directory to somewhere in TeX search path, or set your
- TEXINPUTS environment variable appropriately, and then run `mktexlsr` or
- equivalent so that LaTeX and WebQuiz can find these files.
-- Ideally the doc subdirectory should be copied into the doc/layetx subdirecory
- of the main TeX distribution.
-
-If you are using a unix system, or macosx, there is an (undocumented)
-command-line option `--tex-install` that installs the three different
-components of WebQuiz_ into the standard locations in the TeXLive
-tree:
-
-- $TEXMFMAIN/tex/latex/webquiz all LaTeX files
-- $TEXMFMAIN/scripts/webquiz the python programs
-- $TEXMFMAIN/doc/latex/webquiz the documentation and web components
-- A symbolic link is made from the TeX bin directory to the main
- WebQuiz executable $TEXMFMAIN/scripts/webquiz/webquiz.py
-
-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:
-
-> sudo webquiz/scripts/webquiz --tex-install
-
-In principle, this command may also work on a windows computer,
-provided that the command `kpsewhich` is available, but this is
-untested.
+Installation from the ctan zipfile
+----------------------------------
+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:
+
+ http://mirrors.ctan.org/macros/latex/contrib/webquiz.zip
+
+To install the package, unzip this file and change directory to the
+webquiz/scripts subdirectory run:
+
+> webquiz --tex-install
+
+(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:
+
+- It creates a symbolic link, or equivalent, to the main WebQuiz executable,
+ which is the file webquiz.py in the scripts directory
+- Copies the latex directory to somewhere in the TeX search path and then
+ runs `mktexlsr` so that LaTeX and WebQuiz can find these files.
+- Copies the python code into the TeX scripts subdirectory
+- Copies the WebQuiz doc subdirectory into the TeX doc/latex subdirectory.
+
+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.
Once the files above are in place initialise WebQuiz by following the
installation instructions above.
@@ -135,7 +129,12 @@ system:
Authors
-------
-The LaTeX component of WebQuiz_ 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's from 2001. Since 2004 the program has been maintained and developed by Andrew Mathas. Although the program has changed substantially since 2004 Don's idea of using TeX 4ht, and some of his code, is still very much in use.
+The LaTeX component of WebQuiz_ 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's from 2001. Since 2004 the program has been
+maintained and developed by Andrew Mathas. Although the program has changed
+substantially since 2004 Don's idea of using TeX4ht_, and some of his code, is
+still very much in use.
Copyright (C) 2004-2019