Table Merger Macro

...

Document Properties Marker

override	false

Short Description

Merges tables (and lists) into one table (or list).

Doctype

macro

hide

Name

Table Merger Macro

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
names	Author
property	Audience

Type

Name List

doctype	macro-type
render-no-hits-as-blank	true
property	Type

Subject

Name List

doctype	subject
property	Subject

Tags

Tag List

property	Tags

Flags

page-size-limit-detection

hide

Iteration


value	production

hide

Since

2.1

Deprecated

hide

Removed

hide

Sort Key

hide

...

Section

index	true
show-title	false
title	Description

The macro allows to merge tables from different sources into one table.

Example sources may be the Transclusion Macro transcluding a table or the Display Table Macro.

Note Box
The current version of the macro only processes tables where the heading is found in the first table row (either inside an HTML `thead` element or not).

The Table Merger Macro does only merge rows of two tables and allows a row mapping. In case cells of two tables should be merged into one row, use the

Static Document Link

document	Table Set Macro

. For details on this use case, refer to

projectdoc-static-document-link-macro

anchor	Merging Table Columns into Rows
document	Table Set Macro
label	Merging Table Columns into Rows

projectdoc-section

title	Properties

Section

title	Column Names

List of column names to render.

If blank the columns from the tables are used.

Section

title	Discard

Allows to discard list items or rows.

`empty`	Discard empty list items or table rows without cell content.
`no-links`	Discard list items or table rows if there is not at least one link.
`no-items`	Discard list items or table rows if link has class projectdoc-no-docs.
`full`	Discard list items or table rows if fully set (all cells have content).
`partial`	Discard table rows if there is at least one empty cell.
`is-checked`	Discard list items or table rows if a task list with at least one checked checkbox is found.
`is-not-checked`	Discard list items or table rows if a task list with at least one checkbox is found that is not checked.
`strikethrough`	Discard list items or table rows if at least some text is tagged with strikethrough.

Content Marker

id	discard-use-cases

The values empty, no-links, no-items, and no-links + no-items are typically used for definition, numbered, and bullet lists.

The values empty, full, and partial are typically used for tables. The value partial only has meaning for tables.

The value can be controlled by the space property

Static Document Link

document	Table Merger Macro Param Discard

. The space property

Static Document Link

document	Table Merger override empty Items

overrides the macro configuration.

Example Box

title	Filter Examples with Discard

For examples please refer to the tip Filter on Table Rows.

projectdoc-box-version

since	2.5

The parameter is available since version 2.5.

projectdoc-content-marker

id	discard-since-4-5

Version Box

title	New Values
since	4.5

The values full and partial are supported since version 4.5.

The values is-checked and is-not-checked are supported since version 4.6.

Version Box

since	5.0

The value strikethrough is available since version 5.0.4.

Section

title	Header Translations

Comma-separated list of key list-value pairs to map columns from tables. This allows to rename columns to match.

Format: k1=v1|v2, k2=v3.

In case the column header should be renamed, simply specify the new column name with the Column Names parameter and map the columns of the merged tables here.

projectdoc-box-example

If the column on both tables to be merged is "A" but it should be named "X" and the second column "Short Description" should be not renamed, then:

Column Names: X, Short Description
Header Translations: X=A

In case the column to be named "X" is merged from columns named "A" and "B" then:

Column Names: X, Short Description
Header Translations: X=A|B

Section

title	Sort By

Specify the column names for a sort order. The suffix "-" will invert the sort order (descending).

Example Box

title	Table Sort Orders

Name-
Bonus Points, Name

Any string will turn on sort on list items.

Version Box

until	6.0.3

Up to version 6.0.3 the sort column for tables is limited to one column and the order is always ascending.

Note that sorting is executed on table rows. If the rows reference documents, the properties used for sorting must be rendered in the tables.

projectdoc-section

title	CSS Class

Set to the table or definition list.

...

Section

title	Macro Body

Tables or lists (dl, ul, ol) found in the body of the macro are merged.

Only tables or lists of the same kind are merged. If a collection of one kind is found, collection of other types are not merged. For instance you cannot merge tables with definition lists. If at least one table is found, lists of any kind are not merged.

Section

title	Details

Some details on using this macro.

Section

title	Nested Lists

Since lists may be nested, it is important to only use list roots when merging lists. Therefore lists are required to be siblings to be merged successfully. If lists are nested within other containers, the root containers can be marked with

Display Property

add-link	true
document	projectdoc-table-merger-root
property-name	Identifier

to select the contained list.

This is especially useful when the

Static Document Link

document	Content Marker Macro

is used to make parts of lists only available for users with specified permissions or being members of specified groups.

Version Box

since	4.9

This feature is available since version 4.9.

Section

title	Merging Text Lists

Text lists rendered with the

Static Document Link

document	Display Document Property As List Macro

may be merged by this macro.

Version Box

since	4.11

This feature is available since version 4.11 of the projectdoc Toolbox.

Section

title	Page Size Warnings

This macro supports macros that render a table. If such a macro runs into the limits set by the page size configuration and renders a warning, then this macro will render an error.

Section

index	true
title	Related Macros

Tour

render-as-definition-list	true
replace-title-with-name	true

Title	Short Description
Table Set Macro
Display Table Macro

...

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Versions Compared

Old Version 25

New Version Current

Key

About

Keep up-to-date!

Powered by