Module: Plansheet::LaTeXMixins

Included in:
DailyLaTeXSheet, LaTeXSheet, MonthlyLaTeXSheet, WeeklyLaTeXSheet
Defined in:
lib/plansheet/sheet/latex_utils.rb

Constant Summary collapse

HARD_NL = 
" \\\\\n"
SQUARE = 
"$\\square$"

Instance Method Summary collapse

Instance Method Details

#checkbox_item(str, line: nil) ⇒ Object 



17
18
19
 
# File 'lib/plansheet/sheet/latex_utils.rb', line 17

def checkbox_item(str, line: nil)
  "#{SQUARE} #{str}#{" #{writein_line(line)}" if line}"
end

#config_file_sanity_check(options = {}) ⇒ Object 



104
105
106
107
108
109
110
 
# File 'lib/plansheet/sheet/latex_utils.rb', line 104

def config_file_sanity_check(options = {})
  options.each do |opt, type|
    unless @config[opt].is_a?(type) && !@config[opt]&.empty?
      abort "Need to specify #{opt} #{type.to_s.downcase} in your ~/.plansheet.yml config"
    end
  end
end

#itemize_tightlist ⇒ Object 



35
36
37
38
39
40
41
42
 
# File 'lib/plansheet/sheet/latex_utils.rb', line 35

def itemize_tightlist
  "    \\\\begin{itemize}\n    \\\\tightlist\n    \#{yield}\n    \\\\end{itemize}\n  DOCUMENT\nend\n"

#itemline(item, opt: nil) ⇒ Object 



44
45
46
 
# File 'lib/plansheet/sheet/latex_utils.rb', line 44

def itemline(item, opt: nil)
  "\\item#{opt ? "[#{opt}]" : ""} #{item}\n"
end

#minipage(size) ⇒ Object 



48
49
50
51
52
53
54
 
# File 'lib/plansheet/sheet/latex_utils.rb', line 48

def minipage(size)
  "    \\\\begin{minipage}{\#{size}}\n    \#{yield}\n    \\\\end{minipage}\n  MINIPAGE\nend\n"

#sanitize_string(str) ⇒ Object 



56
57
58
 
# File 'lib/plansheet/sheet/latex_utils.rb', line 56

def sanitize_string(str)
  str.gsub("_", '\_')
end

#sheet_header ⇒ Object 



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
 
# File 'lib/plansheet/sheet/latex_utils.rb', line 60

def sheet_header
  # LaTeX used to be generated by pandoc
  "    \\\\PassOptionsToPackage{unicode}{hyperref}\n    \\\\PassOptionsToPackage{hyphens}{url}\n    \\\\documentclass[]{article}\n    \\\\author{}\n    \\\\date{\#{Date.today}}\n    \\\\usepackage{amsmath,amssymb}\n    \\\\usepackage{lmodern}\n    \\\\usepackage{iftex}\n    \\\\usepackage[T1]{fontenc}\n    \\\\usepackage[utf8]{inputenc}\n    \\\\usepackage{textcomp}\n    \\\\IfFileExists{upquote.sty}{\\\\usepackage{upquote}}{}\n    \\\\IfFileExists{microtype.sty}{\n      \\\\usepackage[]{microtype}\n      \\\\UseMicrotypeSet[protrusion]{basicmath}\n    }{}\n    \\\\makeatletter\n    \\\\@ifundefined{KOMAClassName}{\n      \\\\IfFileExists{parskip.sty}{\n        \\\\usepackage{parskip}\n      }{\n        \\\\setlength{\\\\parindent}{0pt}\n        \\\\setlength{\\\\parskip}{6pt plus 2pt minus 1pt}}\n    }{\n      \\\\KOMAoptions{parskip=half}}\n    \\\\makeatother\n    \\\\usepackage{xcolor}\n    \\\\IfFileExists{xurl.sty}{\\\\usepackage{xurl}}{}\n    \\\\IfFileExists{bookmark.sty}{\\\\usepackage{bookmark}}{\\\\usepackage{hyperref}}\n    \\\\hypersetup{\n      hidelinks,\n      pdfcreator={LaTeX via plansheet}}\n    \\\\urlstyle{same}\n    \\\\usepackage[margin=1.5cm]{geometry}\n    \\\\setlength{\\\\emergencystretch}{3em}\n    \\\\providecommand{\\\\tightlist}{\n      \\\\setlength{\\\\itemsep}{0pt}\\\\setlength{\\\\parskip}{0pt}}\n    \\\\setcounter{secnumdepth}{-\\\\maxdimen}\n  FRONTMATTER\nend\n"

#vbox ⇒ Object 



21
22
23
 
# File 'lib/plansheet/sheet/latex_utils.rb', line 21

def vbox
  "\\vbox{\n#{yield}\n}\n"
end

#vspace(space) ⇒ Object 



9
10
11
 
# File 'lib/plansheet/sheet/latex_utils.rb', line 9

def vspace(space)
  "\\vspace{#{space}}\n"
end

#writein_line(space) ⇒ Object 



13
14
15
 
# File 'lib/plansheet/sheet/latex_utils.rb', line 13

def writein_line(space)
  "$\\underline{\\hspace{#{space}}}$"
end