| 1 |
.\" Man page generated from reStructuredText. |
| 2 |
. |
| 3 |
.TH WEBQUIZ: A LATEX PACKAGE FOR WRITING ONLINE QUIZZES "" "" "" |
| 4 |
.SH NAME |
| 5 |
WebQuiz: a LaTeX package for writing online quizzes \- |
| 6 |
. |
| 7 |
.nr rst2man-indent-level 0 |
| 8 |
. |
| 9 |
.de1 rstReportMargin |
| 10 |
\\$1 \\n[an-margin] |
| 11 |
level \\n[rst2man-indent-level] |
| 12 |
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| 13 |
- |
| 14 |
\\n[rst2man-indent0] |
| 15 |
\\n[rst2man-indent1] |
| 16 |
\\n[rst2man-indent2] |
| 17 |
.. |
| 18 |
.de1 INDENT |
| 19 |
.\" .rstReportMargin pre: |
| 20 |
. RS \\$1 |
| 21 |
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] |
| 22 |
. nr rst2man-indent-level +1 |
| 23 |
.\" .rstReportMargin post: |
| 24 |
.. |
| 25 |
.de UNINDENT |
| 26 |
. RE |
| 27 |
.\" indent \\n[an-margin] |
| 28 |
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| 29 |
.nr rst2man-indent-level -1 |
| 30 |
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] |
| 31 |
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u |
| 32 |
.. |
| 33 |
.sp |
| 34 |
\fI\%WebQuiz\fP makes it possible to use \fI\%LaTeX\fP to write interactive online quizzes. |
| 35 |
The quizzes are first written in \fI\%LaTeX\fP and then converted into HTML using |
| 36 |
\fI\%WebQuiz\fP, which is written in python. The conversion from \fI\%LaTeX\fP to HTML is |
| 37 |
done behind the scenes using \fI\%TeX4ht\fP\&. The idea is that you should be able to |
| 38 |
produce nice online quizzes using \fI\%WebQuiz\fP and basic knowledge of \fI\%LaTeX\fP\&. |
| 39 |
.sp |
| 40 |
\fI\%WebQuiz\fP is designed to be used from the command\-line. For example, if |
| 41 |
\fIquiz1.tex\fP is a LaTeX file for a quiz then: |
| 42 |
.INDENT 0.0 |
| 43 |
.TP |
| 44 |
.B \fIlatex quiz1\fP |
| 45 |
produces a "readable" DVI file for the quiz |
| 46 |
.TP |
| 47 |
.B \fIpdflatex quiz1\fP |
| 48 |
produces a "readable" PDF file for the quiz |
| 49 |
.TP |
| 50 |
.B \fIwebquiz quiz1\fP |
| 51 |
creates the web page \fIquiz1.html\fP |
| 52 |
.UNINDENT |
| 53 |
.sp |
| 54 |
If you prefer to use \fI\%LaTeX\fP from a GUI for \fI\%LaTeX\fP then it should be possible to |
| 55 |
configure it to use \fI\%WebQuiz\fP directly. As an example, the manual provides some |
| 56 |
details about how to do this for TeXShop. |
| 57 |
.SH USAGE |
| 58 |
.INDENT 0.0 |
| 59 |
.TP |
| 60 |
.B usage: webquiz [\-h] [\-q] [\-d] [\-s] [\-\-latex | \-l | \-x] [\-r RCFILE] |
| 61 |
[\-i | \-e | \-\-settings [SETTINGS]] |
| 62 |
[quiz_file [quiz_file ...]] |
| 63 |
.UNINDENT |
| 64 |
.sp |
| 65 |
A LaTeX package for writing online quizzes |
| 66 |
.INDENT 0.0 |
| 67 |
.TP |
| 68 |
.B positional arguments: |
| 69 |
quiz_file latex quiz files |
| 70 |
.TP |
| 71 |
.B optional arguments: |
| 72 |
.INDENT 7.0 |
| 73 |
.TP |
| 74 |
.B \-h\fP,\fB \-\-help |
| 75 |
show this help message and exit |
| 76 |
.TP |
| 77 |
.B \-q\fP,\fB \-\-quiet |
| 78 |
Suppress tex4ht messages (also \-qq etc) |
| 79 |
.TP |
| 80 |
.B \-d\fP,\fB \-\-draft |
| 81 |
Use make4ht draft mode |
| 82 |
.TP |
| 83 |
.B \-s\fP,\fB \-\-shell\-escape |
| 84 |
Shell escape for tex4ht/make4ht |
| 85 |
.TP |
| 86 |
.B \-\-latex |
| 87 |
Use latex to compile document with make4ht (default) |
| 88 |
.TP |
| 89 |
.B \-l\fP,\fB \-\-lua |
| 90 |
Use lualatex to compile the quiz |
| 91 |
.TP |
| 92 |
.B \-x\fP,\fB \-\-xelatex |
| 93 |
Use xelatex to compile the quiz |
| 94 |
.TP |
| 95 |
.BI \-r \ RCFILE\fP,\fB \ \-\-rcfile \ RCFILE |
| 96 |
Specify location of the webquiz rc\-file |
| 97 |
.TP |
| 98 |
.B \-i\fP,\fB \-\-initialise\fP,\fB \-\-initialize |
| 99 |
Install web components of webquiz |
| 100 |
.TP |
| 101 |
.B \-e\fP,\fB \-\-edit\-settings |
| 102 |
Edit default settings for webquiz |
| 103 |
.TP |
| 104 |
.BI \-\-settings \ <SETTINGS> |
| 105 |
List default settings for webquiz |
| 106 |
.UNINDENT |
| 107 |
.UNINDENT |
| 108 |
.SH INSTALLATION |
| 109 |
.sp |
| 110 |
To use \fI\%WebQuiz\fP you need to have a standard \fI\%LaTeX\fP distribution installed, such as \fI\%TeXLive\fP, that includes \fI\%TeX4ht\fP\&. In addition, you need to have \fI\%Python3\fP installed. As \fI\%WebQuiz\fP uses scalable vector graphics (SVG) you should check that all of the dependencies of \fI\%dvisvgm\fP are installed on your system, especially if you plan on using graphics or images. |
| 111 |
.sp |
| 112 |
Once the TeX components of \fI\%WebQuiz\fP package have been installed you can install the web components of \fI\%WebQuiz\fP using the following command, which needs to be run from the command line: |
| 113 |
.sp |
| 114 |
> webquiz \-\-initialise |
| 115 |
.sp |
| 116 |
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. |
| 117 |
.sp |
| 118 |
Please see the manual for more details about initialising and using \fI\%WebQuiz\fP\&. |
| 119 |
.SH INSTALLATION FROM THE CTAN ZIPFILE |
| 120 |
.sp |
| 121 |
On both unix\-like systems (including macosx), and windows systems (using |
| 122 |
either TeXLive or MiKTeX), you can install WebQuiz by downloading the |
| 123 |
WebQuiz zip file from: |
| 124 |
.INDENT 0.0 |
| 125 |
.INDENT 3.5 |
| 126 |
\fI\%http://mirrors.ctan.org/macros/latex/contrib/webquiz.zip\fP |
| 127 |
.UNINDENT |
| 128 |
.UNINDENT |
| 129 |
.sp |
| 130 |
To install the package, unzip this file and change directory to the |
| 131 |
webquiz/scripts subdirectory run: |
| 132 |
.sp |
| 133 |
> webquiz \-\-tex\-install |
| 134 |
.sp |
| 135 |
(or webquiz.bat \-\-text\-install on windows). This commands unpacks the webquiz |
| 136 |
files into their standard locations in the TeX install tree to it should be |
| 137 |
run from an administrators account, or using sudo on a unix\-like system. |
| 138 |
Roughly what this command does is the following: |
| 139 |
.INDENT 0.0 |
| 140 |
.IP \(bu 2 |
| 141 |
It creates a symbolic link, or equivalent, to the main WebQuiz executable, |
| 142 |
which is the file webquiz.py in the scripts directory |
| 143 |
.IP \(bu 2 |
| 144 |
Copies the latex directory to somewhere in the TeX search path and then |
| 145 |
runs \fImktexlsr\fP so that LaTeX and WebQuiz can find these files. |
| 146 |
.IP \(bu 2 |
| 147 |
Copies the python code into the TeX scripts subdirectory |
| 148 |
.IP \(bu 2 |
| 149 |
Copies the WebQuiz doc subdirectory into the TeX doc/latex subdirectory. |
| 150 |
.UNINDENT |
| 151 |
.sp |
| 152 |
If you are using MiKTeX you may need to open the MiKTeX console, go to |
| 153 |
the Tasks menu and then rebuild the TeX filename database. |
| 154 |
.sp |
| 155 |
Once the files above are in place initialise WebQuiz by following the |
| 156 |
installation instructions above. |
| 157 |
.sp |
| 158 |
Mainly for development purposes, there is another undocumented |
| 159 |
command\-line option for removing these files from TEXMFMAIN: |
| 160 |
.sp |
| 161 |
> sudo webquiz/scripts/webquiz \-\-tex\-uninstall |
| 162 |
.SH SYSTEM REQUIREMENTS |
| 163 |
.sp |
| 164 |
In order to work WebQuiz needs the following programs to be installed on your |
| 165 |
system: |
| 166 |
.INDENT 0.0 |
| 167 |
.IP \(bu 2 |
| 168 |
An up\-to\-date \fI\%LaTeX\fP distribution, such as that provided by \fI\%TeXLive\fP\&. In |
| 169 |
particular, you need to have \fI\%TeX4ht\fP and \fI\%make4ht\fP installed. |
| 170 |
Unfortunately, since TeXLive 2018 was released there have been a significat |
| 171 |
bunber of updates to a number of packahges that \fI\%WebQuiz\fP uses, including |
| 172 |
updates to \fI\%TeX4ht\fP, \fI\%make4ht\fP, \fI\%tikz\fP and \fI\%pstricks\fP\&. For this reason, \fIit is |
| 173 |
strongly recommended that you all packages from ctan_ before using WebQuiz_\fP\&. |
| 174 |
.IP \(bu 2 |
| 175 |
\fI\%python3\fP As of writing python 3.7.2 is available. |
| 176 |
.IP \(bu 2 |
| 177 |
\fI\%Javascript\fP |
| 178 |
.IP \(bu 2 |
| 179 |
If you plan to use \fI\%pstricks\fP with \fI\%WebQuiz\fP, or if you want to |
| 180 |
compile the online manual for WebQuiz, then you need to ensure that |
| 181 |
\fI\%ghostscript\fP and \fI\%dvisvgm\fP are installed and properly configured on your |
| 182 |
system. See the \fI\%WebQuiz\fP manual and the \fI\%dvisvgm\fP documentation for more |
| 183 |
details |
| 184 |
.IP \(bu 2 |
| 185 |
A web server. To view online quizzes you of course need a web server. As |
| 186 |
described in the \fBInstallation\fP section you will also need to copy of the |
| 187 |
\fI\%WebQuiz\fP components onto your web server using the command: |
| 188 |
.sp |
| 189 |
> webquiz \-\-initialise |
| 190 |
.UNINDENT |
| 191 |
.SH AUTHORS |
| 192 |
.sp |
| 193 |
The LaTeX component of \fI\%WebQuiz\fP was written by Andrew Mathas and the python, |
| 194 |
css and javascript code was written by Andrew Mathas (and Don Taylor), based on |
| 195 |
an initial protype of Don Taylor\(aqs from 2001. Since 2004 the program has been |
| 196 |
maintained and developed by Andrew Mathas. Although the program has changed |
| 197 |
substantially since 2004 Don\(aqs idea of using \fI\%TeX4ht\fP, and some of his code, is |
| 198 |
still very much in use. |
| 199 |
.sp |
| 200 |
Copyright (C) 2004\-2019 |
| 201 |
.SH LICENSE |
| 202 |
.sp |
| 203 |
GNU General Public License, Version 3, 29 June 2007 |
| 204 |
.sp |
| 205 |
This program is free software: you can redistribute it and/or modify it |
| 206 |
under the terms of the GNU_General Public License |
| 207 |
(\fI\%GPL\fP) as published by |
| 208 |
the Free Software Foundation, either version 3 of the License, or (at |
| 209 |
your option) any later version. |
| 210 |
.sp |
| 211 |
This program is distributed in the hope that it will be useful, but |
| 212 |
WITHOUT ANY WARRANTY; without even the implied warranty of |
| 213 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General |
| 214 |
Public License for more details. |
| 215 |
.\" Generated by docutils manpage writer. |
| 216 |
. |