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
|
\documentclass[load-preamble+]{cnltx-doc}
\usepackage{setspace,hologo,enumitem,dashrulex,tikz}
\usepackage[noto]{newtxmath}
\setcnltx
{
package = dashrulex,
title = dashrulex,
version = v1.01a,
date = 2024/07/18,
authors = Qu Yi,
info = Draw dashed rules,
email = toquyi@163.com,
url = https://github.com/texno3/dashrulex,
abstract =
{
The \pkg*{dashrulex} package provides a flexible solution for drawing dashed rules in the body, and currently provides two commands \cs{hdashrule} and \cs{hanyrule}. It's written in \hologo{LaTeX3} and can be used as an alternative to the \pkg*{dashrule} package.
},
color-scheme = blue,
listings-options = {numbers = none,gobble = 2,lineskip = 1pt},
pre-output = {\parindent = 0em\setstretch{1.3}},
before-skip = \smallskipamount,
after-skip = \smallskipamount
}
\makeatletter
\newcommand{\splitmeta}[3][\code{,}]{\meta{#2}#1\meta{#3}}
\newcommand{\newsplitarg}[4][\splitmeta]
{
\newcommand{#2}[2]
{\code{\textcolor{argument}{#3\textnormal{#1{##1}{##2}}#4}}}
}
\newcommand{\kvsplit}[3]
{
\item\code{\option{#1}\cnltx@isvalue\splitmarg{#2}{#3}}
\cnltx@checkdefault{\hfill\newline}
}
\newsplitarg{\splitoarg}{[}{]}
\newsplitarg{\splitmarg}{\{}{\}}
\newsplitarg{\splitdarg}{(}{)}
\newnote{\newtag}[1]{\textcolor{red}{#1}}
\renewcommand{\emph}[1]{\textcolor{red}{#1}}
\renewcommand{\cnltx@write@lastname}{}
\setlist{nosep,topsep = \smallskipamount}
\setlist[description,1]{leftmargin = \parindent}
\setlist[itemize,1]{leftmargin = *}
\makeatother
\begin{document}
\section{Preface}
Sometimes it is necessary to draw dashed rules when writing documents, such as guides in the table of contents and indexes, horizontal lines in headers and footers, and even adding horizontal lines after headings. Macro packages such as \pkg*{dashrule} and \pkg*{nccrules} are available to accomplish this. Considering that \pkg*{dashrule} has not been updated for a long time, \pkg*{dashrulex} rewrites it using \hologo{LaTeX3} syntax and enhances it a bit.
\section{User commands}
\begin{commands}
\command{hdashrule}[\oarg{raise}\oarg{leader}\marg{width}\marg{thickness list}\marg{dash rules}]
The command to draw horizontal dashed rules, based on the \cs{rule} command, and the same as the \cs{rule} command when the \meta{dash rules} are empty. \meta{raise} is the vertical offset of the rule. \meta{leader} is the alignment of the dashed line fill, which can be empty, \code{c}, or \code{x} (the \textcolor{red}{default}), corresponding to the \cs{leaders}, \cs{cleaders}, and \cs{xleaders} commands, respectively. \meta{width} is the length of the dashed line, which can be set to \cs{fill} when used to fill the remaining part of the current text line. \meta{thickness list} is a rule for the height of \textcolor{red}{vertical} lines, separated by \textcolor{red}{commas} and written as \splitmeta{height 1}{height a}\code{,...}, where \meta{height 1} denotes the height of a solid line and \meta{height a} denotes the height of a blank space. \meta{dash rules} stands for \textcolor{red}{horizontal} dashed line rules, which expressed as \splitmeta[\code{|}]{length 1}{length a}\code{,}\splitmeta[\code{|}]{length 2}{length b}\code{,...}, where \meta{length 1} represents the length of the solid line and \meta{length a} represents the length of the blank space, such as \code{5pt|2pt,3pt}, if the blank space is empty, then it is equal to the solid line length.
\begin{example}
1X\rule{2cm}{1pt}x \\
2X\hdashrule{2cm}{1pt}{}x \\
3X\hdashrule{2cm}{1pt}{1pt}x \\
4X\hdashrule{4cm}{1pt}{1pt}x \\
5X\hdashrule[0.5ex]{4cm}{1pt}{1pt}x \\
6X\hdashrule[0.5ex]{4cm}{1pt}{3mm}x \\
7X\hdashrule[0.5ex]{4cm}{1mm}{3mm}x \\
8X\hdashrule[0.5ex]{4cm-3mm}{1mm}{3mm}\vrulemod[0.5ex]{3mm}{1mm}x \\
9X\hdashrule[0.5ex]{4cm}{1mm}{3mm|3pt}x \\
10X\hdashrule[0.5ex]{4cm}{1mm}{3mm|3pt,1mm|2pt}x \\
11X\hdashrule[0.5ex]{4cm}{2pt,1pt,1pt}{3mm|3pt,1mm|2pt}x
\end{example}
\command{vrulemod}[\oarg{raise}\oarg{height}\oarg{depth}\marg{width}\marg{thickness list}]
The vertical model used to fill the dashed line. \meta{thickness list} is consistent with the \cs{hdashrule} command, \meta{width} represents the length of the component, and the three optional parameters are consistent with those of the \cs{raisebox} command.
\command{hanyrule}[\oarg{leader}\marg{width}\marg{symbol list}]
This command sets the length of the dotted rule and fills it with arbitrary symbols. \meta{symbol list} can be more than one symbol and they are separated by \textcolor{red}{commas}. Symbols are best packed in boxes of a certain length, as spacing between symbols is not provided.
\begin{example}
\newcommand{\dblblock}
{%
\tikz[color=teal]
{
\draw[line width=0.8mm](0mm,1.1mm)--(3mm,1.1mm);
\draw[line width=0.3mm](0mm,0mm)--(3mm,0mm);
}%
}
1X\hanyrule[]{5cm}{\makebox[8pt]{$\cdot$}}x \\
2X\hanyrule[c]{5cm}{\makebox[8pt]{$\cdot$}}x \\
3X\hanyrule[x]{5cm}{\makebox[8pt]{$\cdot$}}x \\
4X\hanyrule[x]{5cm}{\makebox[8pt][l]{$\cdot$}}x \\
5X\hanyrule[x]{5cm}{\makebox[8pt][r]{$\cdot$}}x \\
6X\hanyrule[x]{5cm}{\makebox[8pt]{$\cdot$},\makebox[8pt]{$\circ$}}x \\
7X\hanyrule[x]{5cm}{\makebox[5mm]{\vrulemod{3mm}{2pt,1pt,1pt}}}x \\
8X\hanyrule[x]{5cm}{\makebox[5mm]{\dblblock}}x
\end{example}
\end{commands}
\section{Known issues}
Currently only horizontal dashed line drawing is supported, with future plans to support vertical dashed lines, and even box dashed borders and so on.
\appendix
\nocite{*}
\end{document}
|
