Skip to content

Docs/COMMS-895: Document single-line/multi-line layout argument for attribute value macros #24264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
akabiru wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

Docs/COMMS-895: Document single-line/multi-line layout argument for attribute value macros #24264

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/user-guide/wysiwyg/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,20 @@ Example:

**Linking to the current project's status**: `projectValue:status`

### Controlling the layout of multi-value attributes

Attributes that hold multiple values (for example target versions or multi-select custom fields) render one value per line in the application and comma-separated in PDF exports. Append a layout argument to the macro to choose a layout explicitly:

- `workPackageValue:1234:targetVersions:multiline` renders one value per line
- `workPackageValue:1234:targetVersions:singleline` renders all values on a single line, comma-separated

The layout argument also works with custom fields (`workPackageValue:1234:"My custom field":singleline`), with project attributes (`projectValue:...`) and with relative references (`workPackageValue:targetVersions:singleline`).

Only attributes that hold multiple values are affected. On single-value attributes such as `subject`, the layout argument is accepted but does not change the rendering.

> [!NOTE]
> The deprecated `version` attribute renders the work package's target versions on a single line by default.

### Embedding attribute help texts

You can also embed attribute values and [their help texts](../../system-admin-guide/attribute-help-texts/) by using `workPackageLabel` or `projectLabel`.
Expand Down Expand Up @@ -255,7 +269,8 @@ where `1234` stands for the [work package ID](../work-packages).
| Start date | `workPackageValue:1234:startDate` |
| Status | `workPackageValue:1234:status` |
| Subject / Title | `workPackageValue:1234:subject` |
| Version | `workPackageValue:1234:version` |
| Target versions | `workPackageValue:1234:targetVersions` |
| Version _(deprecated)_ | `workPackageValue:1234:version` |
| Work | `workPackageValue:8415:estimatedTime` |
| Work package type | `workPackageValue:1234:type` |

Expand Down
Loading