User Documentation Summary

User Documentation is a list of User Documentation and System Pages for GeoHazardWatch

This page serves as the central hub for all documentation, tutorials, guides, examples, and test pages in the ngdpbase system.

📑 Documentation Categories

Main Documentation Hubs

• System Pages - All pages with system-category=system (core system functionality)
• Documentation for Developers - Technical documentation for developers (in docs/ directory)

📚 Core System Documentation

Authentication & Security

• Page Level Access Control Lists - Page-level access control using JSPWiki-style ACLs
• Password Management Guide - User account and password management system
• User Roles and Permissions - Complete documentation of user roles and permissions

Page Organization & Metadata

• Page Metadata Documentation - Comprehensive guide to frontmatter and metadata fields with Schema.org compliance
• Frontmatter - Understanding YAML frontmatter in ngdpbase pages
• Keywords and Categories - System for organizing and categorizing pages
• system-category - Storage-based categories that determine page location
• System Keywords - Controlled vocabulary for system-level keywords
• User Keywords - User-extensible vocabulary for flexible content tagging
• System Pages - Pages with system-category=system
• Page Storage Guide - Understanding where and how pages are stored

Plugins & Extensions

• System Pages - Documentation of system variables and their usage (see also WikiVariables)
• WikiVariables - JSPWiki term for platform variables
• Plugin - Overview of the plugin system
• ConfigAccessorPlugin - Access system configuration values on pages
• Using IndexPlugin - Display alphabetical index of all pages
• Using UndefinedPagesPlugin - List all RED-LINK pages (linked to but not yet created)
• Current Time Plugin - Display formatted date and time

Configuration & Management

• Configuration System - Interface for JSON configuration files
• ValidationManager - Central system for data integrity and consistency
• Backup - Backup operations and configuration

Search & Navigation

• Search Documentation - Complete guide to all search methods (UI, SearchPlugin, and API)
• PageIndex - Complete alphabetical listing of all pages
• Using IndexPlugin - Create alphabetical page indexes in your pages

System Information

• SystemInfo - System status, configuration, and diagnostic information

🎨 Table System Documentation

Table Functionality

• JSPWiki Table Functionality - Complete documentation of JSPWiki-style table features
• Table Examples - Comprehensive examples of different table formatting options

📝 Markdown Features

Syntax & Examples

• FootnoteExample - GitHub Flavored Markdown (GFM) footnote syntax demonstration

📝 Content Management

Metadata & Organization

see docs/page-metadata.md

Templates & Styling

• Footer - Footer configuration
• LeftMenu - Navigation menu configuration
• Welcome - Default welcome page content

💡 Quick Reference

User Documentation

[{Search system-category='documentation' format='titles'}]

Essential Syntax

# System Variables
[{$pagename}]       - Current page name
[{$totalpages}]     - Total pages count
[{$uptime}]         - Server uptime
[{$timestamp}]      - Current timestamp

# Page Links
[another page]   - ```[another page]```  Link to another page
[Link Text|Page Name] - ```[Link Text|Page Name]``` Link with custom text

# Plugins
[{ReferringPagesPlugin page="PageName"}] - Pages that reference given page
[{SessionsPlugin}]  - Active sessions count
[{TotalPagesPlugin}] - Total pages (plugin version)

# Table Styling
%%table-striped     - Striped table styling
%%                  - (table content)
/%                  - End table

[{Table style:'...' headerStyle:'...' evenRowStyle:'...'}]
|| Header ||        - Table header row
| Data |            - Table data row
|# |                - Auto-numbered row

Navigation Tips

• Browse by Category: Use Keywords and Categories to understand page organization
• System Pages: Visit System Pages for core system functionality pages
• Developer Docs: Check Documentation for Developers for technical documentation
• Search Everything: Use Search Documentation for advanced search features
• Find All Pages: Check PageIndex for complete page listing
• System Status: Visit SystemInfo for system diagnostics

📊 Statistics

• Total Pages: 133
• Documentation Pages: 50 comprehensive guides (all pages with system-category: documentation)