diff options
Diffstat (limited to 'macros/latex/contrib/homework/README.md')
-rw-r--r-- | macros/latex/contrib/homework/README.md | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/macros/latex/contrib/homework/README.md b/macros/latex/contrib/homework/README.md index 57da7f2d66..e33fcf609d 100644 --- a/macros/latex/contrib/homework/README.md +++ b/macros/latex/contrib/homework/README.md @@ -4,7 +4,7 @@ ## Introduction -The current document class is for writing homework. It has the following features. +The current document class is for writing homework or assignment. It has the following features. - Simple and clear interface. - 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. @@ -36,16 +36,23 @@ These are necessary if you wish to write your document in Chinese (either simpli ## Usage +> It is recommended that you start by looking at one of the demo documents that suits your need and edit the code there to get your own template. + +> If you don't find what you were expecting, or if you would like some elements to be changed or improved, feel free to post a feature request via [the GitHub issue](https://github.com/Jinwen-XU/homework/issues). + A typical homework document looks like this: ```latex \documentclass[a4paper, 11pt, + % twoside, % Use this option if you wish to use double-sided printing logo = {image-of-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, - % twoside, % Use this option if you wish to use double-sided printing + % remove qed, % Remove the Q.E.D. symbol for problems/questions/lemmas/... + colored solution, % Show solution/answer with color, default is blue + % You may specify this as "colored solution = ⟨color⟩" % hide solution, % Use this option to hide the solutions/answers ]{homework} @@ -175,11 +182,13 @@ Alternatively, if you are making an exercise sheet and prefer a more formal titl > You may refer to the demo documents for more examples. Regarding some of the class options: -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⟩}` or `logo width = {width}`. If you do not want to show any logo in the title bar, you may simply remove the option `logo = {⟨image file name⟩}`. +1) As usual, the option `twoside` is for double-sided printing. +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⟩}` or `logo width = {⟨width⟩}`. 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) The option `twoside` is for double-sided printing. -1) The option `formal title` is for enabling the formal title style. +1) The option `remove qed` is for removing the Q.E.D. symbol for theorem-type environment. +1) The option `formal title` is for enabling the formal title style. There would be no logo and no separation lines, and the title would be centered. +1) The option `colored solution` or `colored solution = ⟨color⟩` is for setting the text color of the solution/answer. 1) The option `hide solution` (or `hide answer`) is for hiding the `solution` and `answer` environments. A few extra remarks: |