Skip to content

Format PDF/HTML table rules/lines with booktabs #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 1, 2023
Merged

Format PDF/HTML table rules/lines with booktabs #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
de2e14f
Format PDF/HTML table rules/lines with booktabs
hansemro Sep 30, 2023
f3ebcc4
Use consistent table rule/line format
hansemro Sep 30, 2023
241d91a
Add texlive-extra-utils ubuntu dependency
hansemro Sep 30, 2023
0c5d3ad
Update table formatting in RF Gen. section
hansemro Sep 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions ngscopeclient-manual.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
\usepackage{gensymb}
\usepackage{verbatim}
\usepackage[libertine,cmbraces]{newtxmath}
\usepackage{booktabs}

\setlength{\parskip}{2mm}

Expand Down Expand Up @@ -57,8 +58,10 @@
\definecolor{protostatus}{HTML}{000080}

% table lines
\newcommand{\thinhline}{\Xhline{1\arrayrulewidth}}
\newcommand{\thickhline}{\Xhline{2.5\arrayrulewidth}}
\setlength{\heavyrulewidth}{0.12em}
\setlength{\lightrulewidth}{0.04em}
\newcommand{\thickhline}{\toprule[\heavyrulewidth]}
\newcommand{\thinhline}{\midrule[\lightrulewidth]}

% fonts for formatting commands
\newcommand{\menustyle}[1]{\texttt{#1}}
Expand Down
130 changes: 65 additions & 65 deletions section-decodes.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,19 +45,19 @@ \subsection{Conventions}
\textbf{Color name} & \textbf{Use case} & \textbf{Default Color} \\
\thickhline
Address & Memory addresses & \cellcolor{address}\textcolor{black}{\#ffff00} \\
\thickhline
\thinhline
Checksum Bad & Incorrect CRC/checksum & \cellcolor{checksumbad}\textcolor{white}{\#ff0000} \\
\thickhline
\thinhline
Checksum OK & Valid CRC/checksum & \cellcolor{checksumok}\textcolor{black}{\#00ff00} \\
\thickhline
\thinhline
Control & Miscellaneous control data & \cellcolor{control}\textcolor{white}{\#c000a0} \\
\thickhline
\thinhline
Data & User data & \cellcolor{data}\textcolor{white}{\#336699} \\
\thickhline
\thinhline
Error & Malformed/unreadable data & \cellcolor{error}\textcolor{white}{\#ff0000} \\
\thickhline
\thinhline
Idle & Inter-frame gaps & \cellcolor{idle}\textcolor{white}{\#404040} \\
\thickhline
\thinhline
Preamble & Preamble/sync words & \cellcolor{preamble}\textcolor{white}{\#808080} \\
\thickhline
\end{tabularx}
Expand Down Expand Up @@ -95,7 +95,7 @@ \subsection{Inputs}
\textbf{Signal name} & \textbf{Type} & \textbf{Description} \\
\thickhline
data & 1-bit digital & Serial 128b/130b data line \\
\thickhline
\thinhline
clk & 1-bit digital & DDR bit clock, typically generated by use of the \hyperref[filter:cdrpll]{Clock Recovery
(PLL)} filter on the input data.\\
\thickhline
Expand All @@ -115,9 +115,9 @@ \subsection{Output Signal}
\textbf{Type} & \textbf{Description} & \textbf{Color} & \textbf{Format} \\
\thickhline
Ordered set & Block with type 2'b10 & \cellcolor{control}\textcolor{white}{Control} & \%032x \\
\thickhline
\thinhline
Data & Block with type 2'b01 & \cellcolor{data}\textcolor{white}{Data} & \%032x \\
\thickhline
\thinhline
Error & Block with type 2'b00 or 2'b11 & \cellcolor{error}\textcolor{white}{Error} & \%032x \\
\thickhline
\end{tabularx}
Expand Down Expand Up @@ -153,7 +153,7 @@ \subsection{Inputs}
\textbf{Signal name} & \textbf{Type} & \textbf{Description} \\
\thickhline
data & 1-bit digital & Serial 64b/66b data line \\
\thickhline
\thinhline
clk & 1-bit digital & DDR bit clock, typically generated by use of the \hyperref[filter:cdrpll]{Clock Recovery
(PLL)} filter on the input data.\\
\thickhline
Expand All @@ -173,9 +173,9 @@ \subsection{Output Signal}
\textbf{Type} & \textbf{Description} & \textbf{Color} & \textbf{Format} \\
\thickhline
Control & Block with type 2'b10 & \cellcolor{control}\textcolor{white}{Control} & \%016x \\
\thickhline
\thinhline
Data & Block with type 2'b01 & \cellcolor{data}\textcolor{white}{Data} & \%016x \\
\thickhline
\thinhline
Error & Block with type 2'b00 or 2'b11 & \cellcolor{error}\textcolor{white}{Error} & \%016x \\
\thickhline
\end{tabularx}
Expand Down Expand Up @@ -213,7 +213,7 @@ \subsection{Inputs}
\textbf{Signal name} & \textbf{Type} & \textbf{Description} \\
\thickhline
data & 1-bit digital & Serial 8b/10b data line \\
\thickhline
\thinhline
clk & 1-bit digital & DDR bit clock, typically generated by use of the \hyperref[filter:cdrpll]{Clock Recovery
(PLL)} filter on the input data.\\
\thickhline
Expand All @@ -224,7 +224,7 @@ \subsection{Parameters}
\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Parameter name} & \textbf{Type} & \textbf{Description} \\
\thickhline
\thinhline
Display Format & Enum &
\textbf{Dotted (K28.5 D21.5)}: displays the 3b4b and 5b6b code blocks separately, with K or D prefix. \newline
\textbf{Hex (K.bc b5)}: displays data as hex byte values and control codes with a K prefix. \\
Expand All @@ -241,9 +241,9 @@ \subsection{Output Signal}
\textbf{Type} & \textbf{Description} & \textbf{Color} & \textbf{Format} \\
\thickhline
Control & Control codes & \cellcolor{control}\textcolor{white}{Control} & K\%d.\%d+ or K\%02x\\
\thickhline
\thinhline
Data & Upper layer protocol data & \cellcolor{data}\textcolor{white}{Data} & D\%d.\%d+ or \%02x\\
\thickhline
\thinhline
Error & Malformed data & \cellcolor{error}\textcolor{white}{Error} & ERROR \\
\thickhline
\end{tabularx}
Expand Down Expand Up @@ -275,7 +275,7 @@ \subsection{Inputs}
\textbf{Signal name} & \textbf{Type} & \textbf{Description} \\
\thickhline
data & 1-bit digital & Serial TMDS data line \\
\thickhline
\thinhline
clk & 1-bit digital & DDR \emph{bit} clock, typically generated by use of the \hyperref[filter:cdrpll]{Clock Recovery
(PLL)} filter on the input data. Note that this is 5x the rate of the pixel clock signal. \\
\thickhline
Expand All @@ -286,7 +286,7 @@ \subsection{Parameters}
\begin{tabularx}{16cm}{llX}
\thickhline
\textbf{Parameter name} & \textbf{Type} & \textbf{Description} \\
\thickhline
\thinhline
Lane Number & Integer & Lane number within the link (0-3)\\
\thickhline
\end{tabularx}
Expand All @@ -303,11 +303,11 @@ \subsection{Output Signal}
\textbf{Type} & \textbf{Description} & \textbf{Color} & \textbf{Format} \\
\thickhline
Control & Control codes (H/V sync) & \cellcolor{control}\textcolor{white}{Control} & CTL\%d \\
\thickhline
\thinhline
Data & Pixel/island data & \cellcolor{data}\textcolor{white}{Data} & \%02x \\
\thickhline
\thinhline
Error & Malformed data & \cellcolor{error}\textcolor{white}{Error} & ERROR \\
\thickhline
\thinhline
Guard band & HDMI data/video guard band & \cellcolor{preamble}\textcolor{white}{Preamble} & GB \\
\thickhline
\end{tabularx}
Expand Down Expand Up @@ -480,7 +480,7 @@ \subsection{Parameters}
Measurement Type & Enum &
\textbf{Full Record}: Measure the area of entire waveform \newline
\textbf{Per Cycle}: Measure the area of each cycle in the waveform\\
\thickhline
\thinhline
Area Type & Enum &
\textbf{True Area}: Consider area below ground as negative\newline
\textbf{Absolute Area}: Consider area below ground as positive\\
Expand Down Expand Up @@ -797,31 +797,31 @@ \subsection{Output Signal}
\textbf{Type} & \textbf{Description} & \textbf{Color} & \textbf{Format} \\
\thickhline
Control & Start of frame & \cellcolor{preamble}\textcolor{white}{Preamble} & SOF \\
\thickhline
\thinhline
ID & CAN ID & \cellcolor{address}\textcolor{black}{Address} & ID \%x \\
\thickhline
\thinhline
RTR & Remote Transmission Request & \cellcolor{control}\textcolor{white}{Control} & DATA | REQ \\
\thickhline
\thinhline
FD mode & CAN-FD mode & \cellcolor{control}\textcolor{white}{Control} & FD | STD\\
\thickhline
\thinhline
R0 & Reserved bits & \cellcolor{preamble}\textcolor{white}{Preamble} & RSVD \\
\thickhline
\thinhline
DLC & Data Length Code & \cellcolor{control}\textcolor{white}{Control} & Len 3 \\
\thickhline
\thinhline
Data & Payload data & \cellcolor{data}\textcolor{white}{Data} & \%02x \\
\thickhline
\thinhline
Valid CRC & Good checksum & \cellcolor{checksumok}\textcolor{black}{Checksum OK} & CRC: \%04x \\
\thickhline
\thinhline
Invalid CRC & Bad checksum & \cellcolor{checksumbad}\textcolor{white}{Checksum Bad} & CRC: \%04x \\
\thickhline
\thinhline
CRC delimiter & Bus turnaround & \cellcolor{preamble}\textcolor{white}{Preamble} & CRC DELIM \\
\thickhline
\thinhline
ACK & Acknowledgement & \cellcolor{checksumok}\textcolor{black}{Checksum OK} & ACK \\
\thickhline
\thinhline
NAK & Missing acknowledgement & \cellcolor{checksumbad}\textcolor{white}{Checksum Bad} & NAK \\
\thickhline
\thinhline
ACK delimiter & Bus turnaround & \cellcolor{preamble}\textcolor{white}{Preamble} & ACK DELIM \\
\thickhline
\thinhline
EOF & End of frame & \cellcolor{preamble}\textcolor{white}{Preamble} & EOF \\

\thickhline
Expand Down Expand Up @@ -1521,21 +1521,21 @@ \subsection{Output Signal}
\textbf{Type} & \textbf{Description} & \textbf{Color} & \textbf{Format} \\
\thickhline
Preamble & Preamble & \cellcolor{preamble}\textcolor{white}{Preamble} & PREAMBLE \\
\thickhline
\thinhline
Preamble & Start of frame delimiter & \cellcolor{preamble}\textcolor{white}{Preamble} & SFD \\
\thickhline
\thinhline
Address & Src/dest MAC & \cellcolor{address}\textcolor{black}{Address} & From 02:00:11:22:33:44 \\
\thickhline
\thinhline
Control & Ethertype & \cellcolor{control}\textcolor{white}{Control} & Type: IPv4 \newline Type: 0xbeef \\
\thickhline
\thinhline
Control & VLAN tag & \cellcolor{control}\textcolor{white}{Control} & VLAN 10, PCP 0 \\
\thickhline
\thinhline
Data & Frame data & \cellcolor{data}\textcolor{white}{Data} & a5 \\
\thickhline
\thinhline
Checksum OK & Valid FCS & \cellcolor{checksumok}\textcolor{black}{Checksum OK} & CRC: 0xdeadbeef \\
\thickhline
\thinhline
Checksum Bad & Invalid FCS & \cellcolor{checksumbad}\textcolor{white}{Checksum Bad} & CRC: 0xbaadc0de \\
\thickhline
\thinhline
Error & Malformed data & \cellcolor{error}\textcolor{white}{Error} & ERROR \\
\thickhline
\end{tabularx}
Expand Down Expand Up @@ -2261,7 +2261,7 @@ \subsection{Parameters}
\textbf{Parameter name} & \textbf{Type} & \textbf{Description} \\
\thickhline
Ref Freq Low & Float & Lower reference frequency\\
\thickhline
\thinhline
Ref Freq High & Float & Upper reference frequency\\
\thickhline
\end{tabularx}
Expand Down Expand Up @@ -2446,7 +2446,7 @@ \subsection{Inputs}
\textbf{Signal name} & \textbf{Type} & \textbf{Description} \\
\thickhline
IN+ & Analog & Positive input waveform \\
\thickhline
\thinhline
IN- & Analog & Negative input waveform \\
\thickhline
\end{tabularx}
Expand Down Expand Up @@ -2506,39 +2506,39 @@ \subsection{Output Signal}
\textbf{Type} & \textbf{Description} & \textbf{Color} & \textbf{Format} \\
\thickhline
Line Control & Line Reset & \cellcolor{preamble}\textcolor{white}{Preamble} & LINE RESET \\
\thickhline
\thinhline
Line Mode & Line Mode Change to SWD & \cellcolor{control}\textcolor{white}{Control} & JTAG TO SWD \\
\thickhline
\thinhline
Line Mode & Line Mode Change to JTAG & \cellcolor{control}\textcolor{white}{Control} & SWD TO JTAG \\
\thickhline
\thinhline
Line Mode & Line Mode Change to Dormant & \cellcolor{control}\textcolor{white}{Control} & SWD TO DORMANT \\
\thickhline
\thinhline
Line Mode & Leave Dormant Mode & \cellcolor{control}\textcolor{white}{Control} & LEAVE DORMANT \\
\thickhline
\thinhline
Start & Start of frame & \cellcolor{preamble}\textcolor{white}{Preamble} & START \\
\thickhline
\thinhline
APnDP & Selection between AP and DP & \cellcolor{control}\textcolor{white}{Control} & AP|DP \\
\thickhline
\thinhline
RnW & Read or Write mode & \cellcolor{control}\textcolor{white}{Control} & R|W \\
\thickhline
\thinhline
ADDR & AP or DP Address & \cellcolor{address}\textcolor{black}{Address} & Reg \%02x \\
\thickhline
\thinhline
Parity & Good Header Parity & \cellcolor{green}\textcolor{black}{Control} & OK \\
\thickhline
\thinhline
Parity & Bad Header Parity & \cellcolor{red}\textcolor{white}{Control} & BAD \\
\thickhline
\thinhline
Stop & End of Header & \cellcolor{preamble}\textcolor{white}{Preamble} & STOP \\
\thickhline
\thinhline
Park & Line Release & \cellcolor{preamble}\textcolor{white}{Preamble} & PARK \\
\thickhline
\thinhline
Turnaround & Line Direction Change & \cellcolor{preamble}\textcolor{white}{Preamble} & TURN \\
\thickhline
\thinhline
Acknowledge & Good Response from target to request & \cellcolor{control}\textcolor{white}{Control} & ACK|WAIT \\
\thickhline
\thinhline
Acknowledge & Bad Response from target to request & \cellcolor{control}\textcolor{white}{Control} & FAULT|ERROR \\
\thickhline
\thinhline
Data & Payload to/From Target & \cellcolor{data}\textcolor{white}{Data} & \%08x \\
\thickhline
\thinhline

\thickhline
\end{tabularx}
Expand Down Expand Up @@ -2623,9 +2623,9 @@ \subsection{Parameters}
\textbf{Parameter name} & \textbf{Type} & \textbf{Description} \\
\thickhline
High Level & Float & High level reference voltage\\
\thickhline
\thinhline
Low Level & Float & Low level reference voltage\\
\thickhline
\thinhline
Measurement Type & Enum &
\textbf{High Level}: Measure the total time the signal is above high level reference voltage \newline
\textbf{Low Level}: Measure the total time the signal is below low level reference voltage \newline
Expand Down
4 changes: 2 additions & 2 deletions section-ng-gettingstarted.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ \subsection{Linux}
\begin{lstlisting}[language=sh, numbers=none]
sudo apt install build-essential cmake pkg-config libglm-dev \
libgtkmm-3.0-dev libsigc++-2.0-dev libyaml-cpp-dev \
liblxi-dev texlive texlive-fonts-extra libglew-dev \
catch2 libvulkan-dev glslang-dev libglfw3-dev
liblxi-dev texlive texlive-fonts-extra texlive-extra-utils \
libglew-dev catch2 libvulkan-dev glslang-dev libglfw3-dev
\end{lstlisting}

On Fedora:
Expand Down
10 changes: 5 additions & 5 deletions section-protoanalyzer.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ \section{Packet Coloring}
\textbf{Color name} & \textbf{Use case} & \textbf{Default Color} \\
\thickhline
Command & Executing commands & \cellcolor{protocmd}\textcolor{white}{\#600050} \\
\thickhline
\thinhline
Control & Changing configuration & \cellcolor{protoctl}\textcolor{white}{\#808000} \\
\thickhline
\thinhline
Data read & Reading data & \cellcolor{protoread}\textcolor{white}{\#336699} \\
\thickhline
\thinhline
Data write & Writing data & \cellcolor{protowrite}\textcolor{white}{\#339966} \\
\thickhline
\thinhline
Error & Malformed, bad checksum & \cellcolor{protoerror}\textcolor{white}{\#ff0000} \\
\thickhline
\thinhline
Status & Status updates, flow control & \cellcolor{protostatus}\textcolor{white}{\#000080} \\
\thickhline
\end{tabularx}
Expand Down
2 changes: 2 additions & 0 deletions section-rfgen-drivers.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ \section{Siglent}
\textbf{Device Family} & \textbf{Driver} & \textbf{Transport} & \textbf{Notes} \\
\thickhline
SSG3000X & Unknown & Unknown & May be compatible with the siglent\_ssg driver, but not tested\\
\thinhline
SSG5000A & Unknown & Unknown & May be compatible with the siglent\_ssg driver, but not tested\\
\thinhline
SSG5000X & siglent\_ssg & lan & Only tested via lan transport, but USBTMC and serial are available too\\
\thickhline
\end{tabularx}
Expand Down
Loading