Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleDiscard Parameter Values

The Discard Parameter of the Table Merger Macro can have one of the following values.

  1. empty
  2. no-links
  3. no-items
  4. no-links+ no-items
  5. full
  6. partial
Section
titleempty

The value empty allows to discard empty lines. Suppose a table uses the Wiki Link Macro with the option to render a blank in case the referenced document does not exist, the static table would have an empty line. This would be discarded if a value of empty is selected.

Typically this option is used for definition, numbered, or bullet lists.


Section
titleno-links

The use case is similar to the one using empty. In case the Wiki Link Macro renders to text in case the referenced document does not exist, this is the option to not who the table row. So the table row would be discarded if there is not at least on link in any of the row's cells. Note that the column in which such a link is required cannot be specified.

Typically this option is used for numbered or bullet lists.

Note that in case of definition lists the check is applied to both, the term and the data.


Section
titleno-items

This is a special check that looks for the CSS class named projectdoc-no-docs. This class is set if the link points to a home page without document instances, but could be used for different use cases.

Typically this option is used for numbered, or bullet lists.

Note that in case of definition lists the check is applied to both, the term and the data.


Section
titleno-links + no-items

This is simply a check that there has to be a link and the link must not point to a home page without documents.

Typically this option is used for numbered or bullet lists.

Note that in case of definition lists the check is applied to both, the term and the data.


Section
titlefull

This option allows to discard table rows where every row cell has a non-empty value. This may also be applied to list items.

Why would you like to discard fully filled table rows? In case your team adds information incrementally, you may want to keep track on which documents already have the specified minimum information. To track the documents that still need to be worked on, you may want to discard all documents that are already finished according to the standard.

Simply use the Display Table Macro to select on the documents to track. Put this macro inside the Table Merger Macro with the Discard Parameter set to full.

Example Box

Suppose your team creates a glossary. Typically the Iteration property would track the state of each document. But to track the current state of each glossary item more precisely the team decides that every item requires – besides the mandatory name and short description – at least a description (document section), a list of translations (document section), and Linguistic Information (property).

The initial glossary (of four items) looks like this:

We add the progress tracker on a Space Index and may configure access restrictions so that this page is only visible to page authors.

So the following items will be shown as incomplete.

Adding the Linguistic Information (document property) does not remove any entry.

After adding translations (document sections) to the remaining three, only two items are rendered as incomplete.

And after adding a description section (document section) for the doctype item, there is only one item marked as incomplete.

Image RemovedImage Added



Section
titlepartial

This option allows to discard rows where at least on cell has an empty value. This may be convenient to show only references to documents where all required information is already set.

This value has no effect on lists. 


...