_pkgdown.yml

url: https://davidgohel.github.io/officer/

title: officer

development:
  mode: auto

template:
  bootstrap: 5
  theme: breeze-light
  bootswatch: simplex
  bslib:
    pkgdown-nav-height: 100px
    base_font:
      google: "Open Sans"

home:
  links:
  - text: 'Read the officeverse book'
    href: https://ardata-fr.github.io/officeverse/
  - text: 'Visit <img alt="ardata" src="https://www.ardata.fr/img/ardata-logo.svg" width="70"> website'
    href: https://www.ardata.fr
footer:
  structure:
    left: legal
  components:
    legal: proudly brought to you by <a href="https://www.ardata.fr"><img alt="ardata" src="https://www.ardata.fr/img/ardata-logo.svg" width="70"></a>
authors:
  David Gohel:
    href: https://www.ardata.fr

reference:
  - title: Working with Word documents
    contents:
    - read_docx
    - set_doc_properties
    - docx_set_paragraph_style
    - docx_set_character_style
    - change_styles
  - title: Word documents information
    contents:
    - docx_summary
    - docx_comments
    - styles_info
    - doc_properties
    - docx_dim
    - docx_show_chunk
    - length.rdocx
  - title: Navigate into Word documents
    contents:
    - starts_with("cursor_")
    - docx_bookmarks
  - title: Add content to Word documents
    contents:
    - body_add_blocks
    - body_add_caption
    - body_add_img
    - body_add_par
    - body_add_table
    - body_add_blocks
    - body_add_fpar
    - body_add_toc
    - body_add_break
    - body_add_docx
    - body_bookmark
    - body_add_gg
    - body_add_caption
    - body_add_plot
    - body_end_block_section
    - body_set_default_section
    - starts_with("body_end_section")
    - body_comment
  - title: Word sections
    contents:
    - prop_section
    - page_mar
    - page_size
    - section_columns
  - title: Word simple tables
    contents:
    - prop_table
    - starts_with("table_")
  - title: Replace content in Word documents
    contents:
    - ends_with("at_bkm")
    - ends_with("all_text")
  - title: Remove content from Word documents
    contents:
    - body_remove
  - title: Reading/writing PowerPoint documents
    contents:
    - read_pptx
    - print.rpptx
  - title: Manipulate slides
    contents:
    - add_slide
    - on_slide
    - move_slide
    - remove_slide
  - title: Slide content
    contents:
    - ph_with
    - starts_with("ph_location")
    - ph_slidelink
    - ph_hyperlink
    - ph_remove
    - set_notes
    - notes_location_label
    - notes_location_type
  - title: Read PowerPoint information
    contents:
    - pptx_summary
    - slide_size
    - length.rpptx
    - annotate_base
    - layout_summary
    - layout_properties
    - plot_layout_properties
    - layout_dedupe_ph_labels
    - layout_rename_ph_labels
    - slide_summary
    - color_scheme
    - media_extract
    - as.matrix.rpptx
  - title: Content formatting
    desc: Define formatted paragraphs or parts of paragraphs, such as text, calculated Word fields, sets of paragraphs, etc.
    contents:
    - fpar
    - starts_with("block_")
    - unordered_list
    - plot_instr
    - ftext
    - starts_with("run_")
    - set_autonum_bookmark
    - external_img
    - hyperlink_ftext
    - empty_content
    - sp_line
    - sp_lineend
  - title: Formatting properties
    contents:
    - fp_text_lite
    - fp_text
    - fp_par
    - fp_border
    - fp_cell
    - fp_tabs
    - fp_tab
  - title: RTF
    contents:
    - rtf_doc
    - rtf_add
    - print.rtf
  - title: Excel
    contents:
    - read_xlsx
    - add_sheet
    - sheet_select
  - title: Misc
    contents:
    - officer
    - read_xlsx
    - add_sheet
    - sheet_select
    - shortcuts
    - sanitize_images
    - officer-defunct
    - starts_with("slip_in")
navbar:
  title: officer
  type: default
  left:
  - text: Function reference
    href: reference/index.html
  - text: User Documentation
    href: https://ardata-fr.github.io/officeverse/