User Keywords

Last modified: 10/20/2025

User Keywords

This page defines the user-extensible vocabulary for flexible content tagging and organization. User keywords are configuration-driven and defined in config/app-default-config.json under ngdpbase.userKeywords.

User Keywords is part of Page Metadata Documentation

"ngdpbase.maximum.user-keywords": 5

User Keywords (enabled=true)
User-defined keywords for content tagging and organization
Label Description Category Enabled Restrict Editing Allowed Roles
anthropology Human culture and society content subject Yes No -
default Default keyword with no special restrictions general Yes No -
draft Work in progress content status Yes No -
economics Economic and financial content subject Yes No -
geology Geological and earth science content subject Yes No -
medicine Medical and healthcare-related content subject Yes No -
meteorology Weather and atmospheric science content subject Yes No -
oceanography Ocean and marine science content subject Yes No -
political-science Political science and governance content subject Yes No -
psychology Psychological and behavioral science content subject Yes No -
published Finalized and approved content status Yes No -
review Content under review status Yes No -
sociology Social science and society-related content subject Yes No -
Total Keywords: 13 | By Category: subject: 9, general: 1, status: 3

"ngdpbase.maximum.user-keywords": 5

Configuration Structure

Showing Current User Keywords

User Keywords
User-defined keywords for content tagging and organization
Label Description Category Enabled Restrict Editing Allowed Roles
anthropology Human culture and society content subject Yes No -
default Default keyword with no special restrictions general Yes No -
draft Work in progress content status Yes No -
economics Economic and financial content subject Yes No -
geology Geological and earth science content subject Yes No -
medicine Medical and healthcare-related content subject Yes No -
meteorology Weather and atmospheric science content subject Yes No -
oceanography Ocean and marine science content subject Yes No -
political-science Political science and governance content subject Yes No -
psychology Psychological and behavioral science content subject Yes No -
published Finalized and approved content status Yes No -
review Content under review status Yes No -
sociology Social science and society-related content subject Yes No -
Total Keywords: 13 | By Category: subject: 9, general: 1, status: 3

Configuration Properties

Each user keyword has the following properties:

PropertyTypeDescription
labelstringThe keyword value used in metadata user-keywords array
descriptionstringHuman-readable description of the keyword's purpose
categorystringGrouping category (e.g., "general", "access", "status", "subject")
enabledbooleanWhether the keyword is active and available for use
restrictEditingbooleanIf true, restricts who can edit pages with this keyword
allowedRolesarrayRoles allowed to edit (only used if restrictEditing is true)
schemaOrgstringOptional schema.org type mapping for semantic web

Usage in Page Metadata

User keywords are used in the user-keywords frontmatter field as an array:

---
title: Example Medical Research Page
system-category: documentation
user-keywords:
  - medicine
  - research
  - published
slug: medical-research-example
---

Metadata Rules

User Keywords vs System Categories

AspectSystem CategoriesUser Keywords
**Field**system-categoryuser-keywords
**Format**Single value (string)Multiple values (array)
**Purpose**Storage location controlContent tagging & classification
**Effect**Determines /pages/ or /required-pages/No storage effect for most keywords — exception: private moves the page to a private location
**Configuration**ngdpbase.systemCategoriesngdpbase.userKeywords
**Maximum**1 requiredUp to 5 optional
**Extensibility**Admin-controlledUser-extensible (Editor+ can propose)

Example Usage

---
title: Introduction to Oceanography
system-category: documentation  # ← Single category (WHERE to store)
user-keywords:                   # ← Multiple keywords (WHAT it's about)
  - oceanography
  - geology
  - published
slug: intro-oceanography
---

Backend Integration

UI Population

The backend reads ngdpbase.userKeywords configuration to:

Keyword Validation

The ValidationManager can validate user keywords:

Proposing New Keywords

Users with Editor role or higher can propose new keywords:

  1. Identify Need: Determine if existing keywords don't fit
  2. Check Documentation: Review this page for existing keywords
  3. Create Proposal: Document the keyword purpose and usage
  4. Submit Request: Contact admin or create a ticket
  5. Admin Reviews: Admin adds to custom config if approved

Proposal Template

Future Enhancement

**Keyword**: astronomy
**Category**: subject
**Description**: Astronomy and space science content
**Reason**: We have 15 pages about astronomy with no appropriate keyword
**Schema.org Mapping**: (optional) AstronomicalObject

Keyword Usage Statistics

>

Note: Statistics tracking not yet implemented - Future Enhancement

Migration Notes

From Old System

If migrating from a different keyword system:

  1. Map Old → New: Create mapping of old keywords to new keywords
  2. Update Metadata: Batch update all pages with new keywords
  3. Add Custom Config: Add frequently-used old keywords to custom config
  4. Document Changes: Update this page with migration details