check_footnote_typography: Check footnote typography

Description Usage Arguments Details Value Examples

View source: R/check_footnote_typography.R

Description

Check footnote typography

Usage

1
2
3
4
5
6
check_footnote_typography(
  filename,
  ignore.lines = NULL,
  .report_error,
  rstudio = FALSE
)

Arguments

filename

A LaTeX file.

ignore.lines

Lines to ignore (for example, those using the word 'footnote').

.report_error

A function to provide context to any errors.

rstudio

(logical, default: FALSE) Should the RStudio API be used?

Details

See https://github.com/grattan/grattex/blob/master/doc/grattexDocumentation.pdf for full set of error conditions.

Value

Called for its side-effect.

Examples

1
2
3
4
5
6
## Not run: 
  tex_file <- tempfile(fileext = ".tex")
  cat("Footnote not ending with full stop.\\footnote{No sentence}", file = tex_file)
  check_footnote_typography(tex_file)

## End(Not run)

TeXCheckR documentation built on Nov. 17, 2020, 9:08 a.m.