Debian Codegraph @

texmf-dist/doc/latex/dpcircling/DPcircling.tex

raw
1 %%
2 %% This is the documentation of DPcircling package.
3 %% (Last Update: 2020/04/15)
4 %% Maintained on GitHub:
5 %% https://github.com/domperor/DPcircling
6 %%
7 %% Copyright (c) 2020 Oura M. (domperor)
8 %% Released under the MIT license
9 %% https://opensource.org/licenses/mit-license.php
10 %%
11
12 \documentclass[10pt]{article}
13 \usepackage[dvipdfmx]{graphicx}
14 \usepackage{geometry}
15 \usepackage{url}
16 \geometry{a4paper,total={170mm,257mm},left=20mm,top=20mm}
17 \usepackage{DPcircling}
18 \title{DPcircling package v1.0}
19 \author{Oura M. (domperor)}
20 \date{\today}
21 \pagestyle{empty}
22 \begin{document}
23 \maketitle\thispagestyle{empty}
24
25 \section*{about this package}
26
27 This package provides 4 types of text decorations: \verb+\DPcircling+ \DPcircling{circle}, \verb+\DPrectangle+ \DPrectangle{rectangle}, \verb+\DPjagged+ \DPjagged{jagged rectangle}, and \verb+\DPfanshape+ \DPfanshape{fan-shape}. The baseline would be adjusted properly according to the surroundings\footnote{Unless you cram too tall things into a small decoration box. The box would be broken, and you would make a mess.}. You can use these decorations both in text mode and in math mode. You can specify \verb+line color+, \verb+line width+, \verb+width+, and \verb+height+ as option keys.
28
29 \
30
31 This package is maintained on GitHub: \url{https://github.com/domperor/DPcircling}
32
33 \subsection*{basic usage}
34
35 \begin{quote}
36 (in preamble): \verb+\usepackage[+\textit{\texttt{driver}}\verb+]{graphicx}\usepackage{DPcircling}+\footnote{The author personally uses dvipdfmx as the driver.}
37
38 (in your text): \verb+\DP*****[+\textit{\texttt{options}}\verb+]{+\textit{\texttt{content}}\verb+}+
39 \end{quote}
40
41 For instance, the code
42 \begin{quote}
43 \begin{verbatim}
44 It is a \DPjagged[line color=blue,line width=1.4pt]{\color{brown}great} opportunity.
45 \end{verbatim}
46 \end{quote}
47 \noindent gives the result:
48 \begin{quote}
49 It is a \DPjagged[line color=blue, line width= 1.4pt]{\color{brown}great} opportunity.
50 \end{quote}
51
52 \subsection*{required packages}
53
54 DPcircling requires the following packages: \verb+tikz+, \verb+keyval+, \verb+graphicx+, and the ones that these packages require.
55
56 \subsection*{aliases}
57
58 \verb+\DPcircle+ and \verb+\DPcirc+ are the aliases of \verb+\DPcircling+.
59 \verb+\DPrect+ is the alias of \verb+\DPrectangle+.
60
61 \subsection*{changing default values}
62
63 The default values of \verb+line color+, \verb+line width+, \verb+width+, and \verb+height+ are \verb+black+, \verb+1pt+, noted below(*), and \verb+2*(content height)+. You can modify these like this:
64 \begin{quote}
65 \begin{verbatim}
66 \DPcirclingDefault{line color=brown, line width=0.33pt, width=4em, height=5em}
67 \end{verbatim}
68 \end{quote}
69
70 \noindent (*) The default values of \verb+width+ are \verb+max{2*(content width), 2em}+ (circle) and
71 \verb:(content width)+2em: (else).
72
73 \section*{version history}
74
75 2020/04/15 v1.0
76
77 \end{document}