annotate_base: Placeholder parameters annotation

In officer: Manipulation of Microsoft Word and PowerPoint Documents

Placeholder parameters annotation

Description

generates a slide from each layout in the base document to identify the placeholder indexes, types, names, master names and layout names.

This is to be used when need to know what parameters should be used with ph_location* calls. The parameters are printed in their corresponding shapes.

Note that if there are duplicated ph_label, you should not use ph_location_label. Hint: You can dedupe labels using layout_dedupe_ph_labels.

Usage

annotate_base(path = NULL, output_file = "annotated_layout.pptx")

Arguments

path	path to the pptx file to use as base document or NULL to use the officer default
output_file	filename to store the annotated powerpoint file or NULL to suppress generation

Value

rpptx object of the annotated PowerPoint file

See Also

Other functions for reading presentation information: color_scheme(), doc_properties(), layout_properties(), layout_summary(), length.rpptx(), plot_layout_properties(), slide_size(), slide_summary()

Examples

# To generate an anotation of the default base document with officer:
annotate_base(output_file = tempfile(fileext = ".pptx"))

# To generate an annotation of the base document 'mydoc.pptx' and place the
# annotated output in 'mydoc_annotate.pptx'
# annotate_base(path = 'mydoc.pptx', output_file='mydoc_annotate.pptx')

officer documentation built on Oct. 10, 2024, 1:06 a.m.