Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve relative / ordinal diagram in the docs (#1277)
## Checklist - [x] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [x] I have not broken the cheatsheet - [x] I have tested building the docs Replace the hand-written diagram of relative / ordinal modifiers with one generated by LaTeX / tikz. If it is necessary in the future to change this image, you can reuse and modify the below latex code to regenerate it. ``` \documentclass[tikz]{standalone} \usepackage{tikz} \usetikzlibrary{decorations.pathreplacing,calligraphy} % to convert pdf -> png: % convert -density 300 relative-ordinal.pdf -quality 100 -background white -alpha remove relative_ordinal.png \begin{document} \def\spacing{1.4cm} \newcommand{\ibrace}[4]{ \draw [decorate, decoration = {brace, amplitude=5pt}] (#2*\spacing, #1*0.8cm + 0.5cm) -- (#3*\spacing, #1*0.8cm + 0.5cm) node[above=5pt, pos=0.5, scale=0.8] {\texttt{"#4"}}; } \newcommand{\bbrace}[4]{ \draw [decorate, decoration = {brace, amplitude=5pt}] (#2*\spacing, #1*0.8cm + 0.5cm) -- (#3*\spacing, #1*0.8cm + 0.5cm) node[above=-20pt, pos=0.5, scale=0.8] {#4}; } \newcommand{\funk}[3]{ \draw[fill=black] (#1*\spacing,0) circle (0.1cm) node[below=#2, text width=1cm,align=left,scale=0.7] (F#1) {\texttt{"#3"}}; } \begin{tikzpicture}[ultra thick] \funk{0}{0pt}{first funk} \funk{1}{0pt}{second funk} \funk{2}{0pt}{third previous funk} \funk{3}{0pt}{second previous funk} \funk{4}{0pt}{previous funk} \funk{5}{0pt}{funk} \funk{6}{0pt}{next funk} \funk{7}{0pt}{second next funk} \funk{8}{0pt}{third next funk} \funk{9}{0pt}{second last funk} \funk{10}{0pt}{last funk} \draw[latex-] (F5) -- +(0,-0.8cm) node[below=2pt,scale=0.8] {input target}; \ibrace{0}{6}{8}{next three funks}; \ibrace{0}{2}{4}{previous three funks}; \ibrace{1}{5}{7}{three funks}; \ibrace{2}{3}{5}{three funks backward}; \ibrace{0}{0}{1}{first two funks}; \ibrace{0}{9}{10}{last two funks}; \bbrace{-3}{10}{0}{iteration scope}; \end{tikzpicture} \end{document} ``` --------- Co-authored-by: Martin Rykfors <martin.rykfors@evolabel.com>
- Loading branch information