summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/litesolution/doc/litesolution.tex
blob: 821a84006b890996cd39ed52816487abe36db060 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
\documentclass[ans,mtpro2]{litesolution}

\usepackage[listings]{tcolorbox}

\cover{schrodinger}
\title{\sffamily The \pkg{LiteSolution} Class}
\subtitle{\sffamily\scshape Hangzhou Dianzi University}
\bioinfo{\scshape\sffamily Mingyu Hsia, \href{mailto:xiamyphys@gmail.com}{\ttfamily xiamyphys@gmail.com} | \today, Version 2.1a}
\coverdecoration{$\Psi=\displaystyle\int\e^{\frac i\hbar\int\ab(\frac{R}{16\pi G}-\frac14F^2+\overline\psi i\cancel D\psi-\lambda\varphi\overline\psi\psi+\abs{D\varphi}^2-V(\varphi))}$}

\begin{document}

\maketitle

\chapterimage{\UPFadingImage[trim={0 {.9\paperheight} 0 0},clip]{Beautiful-realities}}

\chapter{An Introduction to the \pkg{LiteSolution} Class}

\section{Introduction}

This is the document for \pkg{litesolution} template, which provides a lite design of the solution of test paper.

\subsection{The purpose of this template}

This template provides a fresh design for typesetting solutions of exams, textbooks or other exercises. Welcome to feedback bugs or ideas via email \href{mailto:xiamyphys@gmail.com}{\ttfamily xiamyphys@gmail.com} or \href{https://github.com/xiamyphys/litesolution}{GitHub}.

\subsection{Installing \pkg{Litesolution} and loading it}

Simply download \verb|litesolution.cls| file from \href{https://github.com/xiamyphys/LiteSolution}{GitHub} or \href{https://ctan.org/pkg/litesolution}{CTAN} and save it under your working directory. However, I strongly suggest to use terminal to install and update all packages to the latest version

\begin{verbatim}
    sudo tlmgr update --self --all
\end{verbatim}

To learn more, please refer to \href{https://tex.stackexchange.com/questions/55437/how-do-i-update-my-tex-distribution}{How do I update my \hologo{TeX} distribution?}

\subsection{Compatibility}
The test environments are macOS + Mac\hologo{TeX} 2024 / Overleaf and they all work fine for \hologo{pdfLaTeX} and \hologo{XeLaTeX} compilers. Windows, Linux and Unix platforms compatibility unknown.

\section{Global Options of \pkg{Litesolution}}

\begin{verbatim}
    \documentclass[<options>]{litesolution}
\end{verbatim}

\subsection{The \mode{answer} option}

This option has two modes, \mode{ans} and \mode{noans}, which can show or hide answers. After the \mode{noans} mode is enabled, the environment \cmd{solution} will be deactivated and contents in command \cmd{ans} will be hidden.

\subsection{The \mode{counter} option}

This option has two modes, \mode{separate} and \mode{continuous}, which can make the page number between chapters be reset or continuous.

\section{Cover Configurations}

\subsection{The cover page configurations}

\begin{verbatim}
    \cover{<image name>}  \title{<title>}  \subtitle{<vertical subtitle>}
    \bioinfo{<bioinfo on bottom>}          \coverdecoration{<above contents>}
\end{verbatim}

The same as the \pkg{book} class, the macro title could not be omitted, or it will return an error. The following is the cover configurations of this document

\begin{verbatim}
    \title{\sffamily The \pkg{litesolution} Class}
    \subtitle{\sffamily\scshape Hangzhou Dianzi University}
    \bioinfo{\scshape\sffamily Mingyu Hsia, \href{mailto:xiamyphys@gmail.com}
        {\ttfamily xiamyphys@gmail.com} | \today, Version 2.1a}
    \coverdecoration{$\Psi=\displaystyle\int\e^{\frac i\hbar
        \int\ab(\frac{R}{16\pi G}-\frac14F^2+\overline\psi i\cancel D\psi
        -\lambda\varphi\overline\psi\psi+\abs{D\varphi}^2-V(\varphi))}$}
    \cover{schrodinger}
\end{verbatim}

\subsection{The chapter head configurations}

\begin{verbatim}
    \chapterimage {<insert image macro>}
\end{verbatim}

This command can assign the format of the image at every chapters begin and you can adjust the format of the image with the \pkg{fadingimage} package.

\section{Preset Commands}

\subsection{The \cmd{ans} command}

\begin{verbatim}
    \ans {<contents>}
\end{verbatim}
 
This command can underline the answer, and if mode \mode{noans} is enabled, the answer will be hidden.

\subsection{The \cmd{solute} command}

\begin{verbatim}
    \solute {<number>}              \solute* {<contents>}
\end{verbatim}

This command can create a fixable answer box when the mode \mode{noans} is enabled.

\subsection{Other preset commands}

This template provides the same math commands as \S 1.5 of the template \pkg{LiteBook} described additionly.

\section{Preset \pkg{amsthm} Environments}

\subsection{The \cmd{problem} environment}

\begin{tcblisting}{sidebyside,colback=DarkGreen!5,colframe=DarkGreen!80}
\begin{problem}\leavevmode
\begin{tasks}(2)
  \task Choice A  \task[\true] Choice B
  \task Choice C  \task Choice D
\end{tasks}
\end{problem}
\end{tcblisting}

\subsection{The \cmd{solution} and \cmd{note} environment}

\begin{minipage}{.48\textwidth}
\begin{tcblisting}{sidebyside,colback=MidnightBlue!5,colframe=MidnightBlue!80}
\begin{solution}
  B is correct.
\end{solution}
\end{tcblisting}
\end{minipage}
\hfill
\begin{minipage}{.48\textwidth}
\begin{tcblisting}{sidebyside,colback=DarkRed!5,colframe=DarkRed!80}
\begin{note}
  We note that.
\end{note}
\end{tcblisting}    
\end{minipage}

\appendix
\def\thesection{Appendix \Alph{section}}

\section{An Introduction to The \pkg{notebeamer} Class}

This class provides an easy way to input Beamers on note papers and make notebook quickly. It's optimized for Goodnotes' default paper size and there won't have difference between papers.

In the future, this class will be redesigned to a package that optimized for the \pkg{litesolution} class.

\section{An Introduction to The \pkg{fadingimage} Package}

This package provides three commands for adding fading full width picture at the top or bottom of a page.

\end{document}