From c168bdeadb2fb2500c952e73c262ba3210d09b8b Mon Sep 17 00:00:00 2001 From: Rosetta <135234996+gisellerosetta@users.noreply.github.com> Date: Tue, 11 Nov 2025 09:07:44 +0000 Subject: [PATCH 1/2] add glossary --- docs/reference/glossary.md | 14 +++++++++++++- mkdocs.yml | 2 +- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index c4771257..ed096920 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -1,7 +1,19 @@ # Glossary of Terms ## Cover +A cover sheet of a spreadsheet. Contains information about the dataset(s) in the Excel workbook, +such as publication dates and methodology notes. Handled by the [`Cover`](../api/classes/cover.md) class. -## gptables +## Element +A [part of a table](../getting_started/elements.md), such as a title or subtitle. Relevant when defining values of elements in a `GPTable`. + +## GPTable +A [`Good Practice Table object`](../api/classes/gptable.md), which has data and elements such as title, subtitles, and column units +associated with it. + +## Placeholder +A [note](../getting_started/tutorial.md#adding-notes) reference denoted by double dollar notation, e.g. `$$placeholder_text$$`. These are +replaced by numbers when the workbook is written to file. ## Theme +A [.yaml file](../how_to/custom_theme.md) describing pre-set formatting options. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 19c0b560..9ef86e08 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -29,7 +29,7 @@ nav: - Reference: - Accessibility checklist: reference/checklist.md - Examples: reference/examples.md - #- Glossary: reference/glossary.md + - Glossary: reference/glossary.md - About GPTables: - Contributing guidance: info/contributing.md - Changelog: info/changelog.md From bb19305019e95184f4b9e2c40f9702414969d635 Mon Sep 17 00:00:00 2001 From: Rosetta <135234996+gisellerosetta@users.noreply.github.com> Date: Tue, 11 Nov 2025 09:10:32 +0000 Subject: [PATCH 2/2] hooks --- docs/reference/glossary.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index ed096920..b3816415 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -12,8 +12,8 @@ A [`Good Practice Table object`](../api/classes/gptable.md), which has data and associated with it. ## Placeholder -A [note](../getting_started/tutorial.md#adding-notes) reference denoted by double dollar notation, e.g. `$$placeholder_text$$`. These are +A [note](../getting_started/tutorial.md#adding-notes) reference denoted by double dollar notation, e.g. `$$placeholder_text$$`. These are replaced by numbers when the workbook is written to file. ## Theme -A [.yaml file](../how_to/custom_theme.md) describing pre-set formatting options. \ No newline at end of file +A [.yaml file](../how_to/custom_theme.md) describing pre-set formatting options.