{"route":"/en-US-v0.14.1/reference/pdf/table-summary/","title":"Table Summary","description":"Documentation for the `table-summary` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-summary","name":"summary","children":[]},{"id":"parameters-table","name":"table","children":[]}]}],"body":{"kind":"func","content":{"path":["pdf"],"name":"table-summary","title":"Table Summary","keywords":[],"oneliner":"A summary of the purpose and structure of a complex table.","element":false,"contextual":false,"deprecationMessage":null,"deprecationUntil":null,"details":[{"kind":"html","content":"

A summary of the purpose and structure of a complex table.

\n

This will be available for Assistive Technology (AT), such as screen\nreaders, when exporting to PDF, but not for sighted readers of your file.

\n

This field is intended for instructions that help the user navigate the\ntable using AT. It is not an alternative description, so do not duplicate\nthe contents of the table within. Likewise, do not use this for the core\ntakeaway of the table. Instead, include that in the text around the table\nor, even better, in a figure caption.

\n

If in doubt whether your table is complex enough to warrant a summary, err\non the side of not including one. If you are certain that your table is\ncomplex enough, consider whether a sighted user might find it challenging.\nThey might benefit from the instructions you put here, so consider printing\nthem visibly in the document instead.

\n

The API of this feature is temporary. Hence, calling this function requires\nenabling the a11y-extras feature flag at the moment. Even if this\nfunctionality should be available without a feature flag in the future, the\nsummary will remain exclusive to PDF export.

\n
#figure(\n  pdf.table-summary(\n    // The summary just provides orientation and structural\n    // information for AT users.\n    summary: "The first two columns list the names of each participant. The last column contains cells spanning multiple rows for their assigned group.",\n    table(\n      columns: 3,\n      table.header[First Name][Given Name][Group],\n      [Mike], [Davis], table.cell(rowspan: 3)[Sales],\n      [Anna], [Smith],\n      [John], [Johnson],\n      [Sara], [Wilkins], table.cell(rowspan: 2)[Operations],\n      [Tom], [Brown],\n    ),\n  ),\n  // This is the key takeaway of the table, so we put it in the caption.\n  caption: [The Sales org now has a new member],\n)\n
\"Preview\"
"}],"self":false,"params":[{"name":"summary","details":[],"types":["str"],"strings":[],"default":null,"positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"table","details":[{"kind":"html","content":"

The table.

"}],"types":["content"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["content"],"scope":[]}}}