diff options
Diffstat (limited to 'macros/latex/contrib/homework/README.md')
-rw-r--r-- | macros/latex/contrib/homework/README.md | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/macros/latex/contrib/homework/README.md b/macros/latex/contrib/homework/README.md index 0374b4030f..c580a03fa8 100644 --- a/macros/latex/contrib/homework/README.md +++ b/macros/latex/contrib/homework/README.md @@ -6,7 +6,7 @@ The current document class is for writing homework. It has the following features. - Simple and clear interface. -- Built-in support for many theorem-like environments, already configured and ready to use (in the mean time also very customizable, via `\SetTheorem`). +- Built-in support for many theorem-type environments, already configured and ready to use (in the mean time also very customizable, via `\SetTheorem`), with clever referencing supported. - Multilingual support: currently supporting Chinese (both simplified and traditional), English, French, German, Italian, Japanese, Portuguese (European and Brazilian), Russian and Spanish. - Page numbers are of the form `Page [current] of [total]`, which can help you ensure that there are no missing pages when you print your homework for submission. - Support writing problem statements and solutions (or proofs) in different colors. @@ -20,14 +20,14 @@ A typical homework document looks like this: ```latex \documentclass[11pt, - logo = {image-file-of-your-university-logo}, - % logo height = 1cm, + logo = {image-file-of-your-university-logo}, % Remove this line if you don't want logo presented. + % logo height = 1cm, % In case you are not satisfied with the default logo size. title in boldface, title in sffamily, theorem in new line, ]{homework} -\UseLanguage{...} % If you wish to write your homework in languages other than English +\UseLanguage{...} % If you wish to write your homework in languages other than English. \title{The Subject, Week 1} @@ -47,11 +47,11 @@ A typical homework document looks like this: % If you wish to state the problem and then write your answer... -\begin{problem} +\begin{problem}[You can add some brief problem description here] You may also state the problem here... \end{problem} -\begin{solution} +\begin{solution}% You may also use the "answer" environment, they are essentially the same. ... and write the solution here... \end{solution} @@ -60,7 +60,7 @@ A typical homework document looks like this: \begin{solution}[Proof] ... or a proof like this one... - % You may write lemmas or propositions inside your solution. + % You may write claims, lemmas, propositions, etc. inside your solution. \begin{lemma}\label{lem} Some auxiliary result. \end{lemma} @@ -68,7 +68,7 @@ A typical homework document looks like this: The proof of \cref{lem}, where we use the following formula: \[ \infty = \infty + 1. - \qedhere % To place the QED symbol in the right place + \qedhere % For placing the QED symbol in the right place. \] \end{proof} ... and the rest steps... @@ -84,8 +84,10 @@ A few remarks: 1) The logo image can be included via the class option `logo = {⟨image file name⟩}`, and if you are not satisfied with its default size, then you may manually specify the size via the option `logo height = {⟨height⟩}`. If you do not want to show any logo in the title bar, you may simply remove the option `logo = {⟨image file name⟩}`. 1) The options `title in boldface`, `title in sffamily` or even `title in scshape` are for configuring the text effect of the title line, the sectional titles and theorem names. 1) The option `theorem in new line` is for showing the problem / theorem name, numbering and description in a separate line, for the sake of clarity. -1) `\title`, `author` and `\date` should be placed before `\begin{document}`. -1) Since the problem, solution and other theorem-type environments have a QED symbol at the end, if your text ends with displayed formula or lists, then you may need to place a `\qedhere` so that the QED symbol is placed in the right place. +1) `\title`, `\author` and `\date` should be placed before `\begin{document}`. +1) Since the problem, solution and other theorem-type environments have a QED symbol at the end, if your text ends with a displayed equation or a `itemize`/`enumerate`/`description` list, then you would need to add a `\qedhere` so that the QED symbol is placed in the right place. +1) Every theorem-type environment has a starred unnumbered version, for instance, `claim*` for unnumbered `claim`, `lemma*` for unnumbered `lemma`, etc. +1) It is recommended to use clever reference, such as `\cref`. For languages such as French and German, to ensure that the generated referencing text is grammatically correct, you may write the definite article and/or declension as optional argument for the referencing commands, for instance, `\cref[à]{⟨label⟩}` or `\cref[de]{⟨label⟩}` for French, `\cref[nom.]{⟨label⟩}` or `\cref[von,dat.]{⟨label⟩}` for German, etc. ## TeXnical details |