summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/whatsnote/doc/whatsnote.tex
blob: 432e2c58bbd4f3ac1805b86f1d8a519c0a911ce3 (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
\documentclass[twoside]{whatsnote}
\usepackage[mono = false]{libertine}
\usepackage{verbatim,framed,hologo}
\providecommand\cls{\textsf}
\providecommand\pkg{\textsf}
\providecommand\url{\texttt}
\providecommand\env{\texttt}
\DeclareRobustCommand\cs[1]{\texttt{\char`\\#1}}
\usepackage[os = mac]{menukeys}

\coverset
  {
    title    = The \pkg{WhatsNote} Class,
    subtitle = Version 3.0A,
    bioinfo  = Mingyu Xia \url{<xiamyphys@gmail.com>},
    color    = MidnightBlue,
    head     = universe/3,
    logo     = cat/sixpointed stars,
  }

\begin{document}

\maketitle

\chapter { Introduction \& Demo }

\section{Cover configuration}

\begin{framed}
  \begin{verbatim}
  \coverset
    {
      title    = The \pkg{WhatsNote} Class,
      subtitle = Version 3.0A,
      bioinfo  = Mingyu Xia \url{<xiamyphys@gmail.com>},
      color    = MidnightBlue,
      head     = universe/3,
      logo     = cat/sixpointed stars,
    }
  \end{verbatim}
\end{framed}

\section{Global Options}

\subsection{Font}

You can set \keys{\cmdmac~math-font}, \keys{\cmdmac~main-font},
\keys{\cmdmac~sans-font} and \keys{\cmdmac~mono-font}.
The \keys{\cmdmac~CJK-font} can be set via \hologo{XeLaTeX} compiler.

\begin{verbatim}
  math-font    = STIX Two Math,
  main-font    = { {Libertinus Serif} },
  sans-font    = { {Libertinus Sans} },
  mono-font    = { {Libertinus Mono} },
  CJKmain-font =
    { {Zhuque Fangsong (technical preview)} [AutoFakeBold, AutoFakeSlant] },
  CJKsans-font = { {LXGW WenKai} [BoldFont = *-Medium, AutoFakeSlant] },
  CJKmono-font = { {LXGW WenKai Mono} [BoldFont = *-Medium, AutoFakeSlant] },
\end{verbatim}

\scratch
\begin{solution}
  \lipsum [ 2 ]
  \result {This is the answer}.
\end{solution}

\subsection{Hideanswer}

The default Boolean value of the key \keys{\cmdmac~hideanswer} is true,
environment \env{solution} and content in the macro \cs{result}
will be hidden when enable this.

\section{Left Text \& Right Figure}

\begin{framed}
  \begin{verbatim}
    \begin{textfig}[ key values ]
      <Left Content>
      \textfigsplit
      <Right Content>
    \end{textfig}
  \end{verbatim}
\end{framed}

The keys in the environment \env{textfig} accepts the following values:
\begin{tasks}[ label = \ensuremath\bullet ](2)
  \task \keys{\cmdmac~lefthand ratio} accepts float point number.
  \task \keys{\cmdmac~righthand ratio} accepts float point number.
  \task \keys{\cmdmac~lefthand width} accepts diameter.
  \task \keys{\cmdmac~righthand width} accepts diameter.
\end{tasks}

\begin{textfig}[ lefthand ratio = .72 ]
  \begin{problem}[ text-fig layout]
    \lipsum [ 1 ]
    \begin{tasks}(4)
      \task A
      \task B
      \task C
      \task D
    \end{tasks}
  \end{problem}
  \textfigsplit
  \centering
  \includegraphics[ width = .9\linewidth ]{example-image}
\end{textfig}

\begin{remark}
  This is an amsthm environment surrounded by a mdframed box.
  \lipsum [ 2 ]
\end{remark}

\section{Other Preset amsthm environments}

\env{theorem}, \env{lemma}, \env{corollary}, \env{proposition}, 
\env{conjecture}, \env{criterion}, \env{assertion}, \env{definition}, 
\env{condition}, \env{example}, \env{exercise}, \env{algorithm},
\env{question}, \env{axiom}, \env{property}, \env{assumption},
\env{hypothesis}, \env{note}, \env{notation}, \env{claim}, \env{summary}, 
\env{acknowledgment}, \env{case}, \env{conclusion}.

\end{document}