Skip to content

Commit 1284cf4

Browse files
Add WIP documentation, needs to be finished when API part is done
1 parent b25d63c commit 1284cf4

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/PxWeb2/documentation/customization.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ You can:
1515
- Limit table sizes.
1616
- Control how and where languages appear in URLs.
1717
- Hide variables from the variable filter.
18+
- Customize Definitions panel content. WIP
1819
- Customize start page text and footer links (examples included below).
1920
- Define characters used for missing values.
2021

@@ -463,6 +464,15 @@ Edit these CSS variables in `theme/variables.css`:
463464
Do not alter `--px-border-radius-none` or `--px-border-radius-full` unless you
464465
know the side effects (they are used for logical extremes).
465466

467+
### Customize Definitions panel content WIP
468+
469+
The Definitions panel in the right sidebar on the table page, can be
470+
customized by changing translation strings in the "presentation_page.main_content.about_table.definitions" section of the relevant `locales/<lang>/translation.json` file.
471+
472+
If the strings inside the "about_statistics" and "metadata" sections are empty, the Definitions panel will only show the primary links from the API. The keys inside the "about_statistics" will add a header and text description to the primary links section.
473+
474+
If the API also returns variable definitions, the keys inside the "metadata" section will add a header and text description to the variable definitions section.
475+
466476
### Change the text and related links on the startpage, table page and in the footer
467477

468478
The `content.json` file defines customizable text and links that appear in

0 commit comments

Comments
 (0)