ufs (version 0.3.2)

setFigCapNumbering: Set caption numbering

Description

Set caption numbering

Usage

setFigCapNumbering(
  captionName = "fig.cap",
  prefix = "Figure %s: ",
  suffix = "",
  optionName = paste0("setCaptionNumbering_", captionName),
  resetCounterTo = 1
)

Arguments

captionName

THe name of the caption; normally fig.cap or tab.cap.

prefix, suffix

The prefix and suffix; any occurrences of \%s will be replaced by the number.

optionName

THe name to use for the option that keeps track of the numbering.

resetCounterTo

Whether to reset the counter (as stored in the options), and if so, to what value (set to FALSE to prevent resetting).

Value

NULL, invisibly.

Examples

# NOT RUN {
setFigCapNumbering();

### For table captions
setFigCapNumbering("tab.cap", "Table %s: ");
# }