Skip to content

Implement Webdoc: Open Document Format Based on Web Standards (HTML5, JSON-LD, RDFa) #1

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

Jump to bottom
Draft
Copilot wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Implement Webdoc: Open Document Format Based on Web Standards (HTML5, JSON-LD, RDFa) #1

Copilot wants to merge 4 commits into from

Conversation

Copy link

Copilot AI commented Oct 16, 2025 •
edited
Loading

Overview

Implements Webdoc v1.0.0 - een open, uitbreidbaar documentformaat op basis van webstandaarden (HTML5, JSON-LD, RDFa) dat inhoud, metadata, stijl, semantiek en AI-agents in één container samenbrengt.

What is Webdoc?

Webdoc is a modern document format that:

  • ✅ Open & Extensible - Based on W3C web standards (no vendor lock-in)
  • ✅ Self-Contained - Everything embedded in one HTML file
  • ✅ Machine-Readable - Semantic annotations for automated processing
  • ✅ AI-Ready - Native AI-agent workflow configuration
  • ✅ Browser-Native - Opens directly in any modern browser

Implementation

📋 Core Specification

  • SPECIFICATION.md - Complete technical specification defining:
    • HTML5 as container format
    • JSON-LD for structured metadata (Schema.org vocabulary)
    • RDFa for inline semantic annotations
    • CSS3 for embedded styling
    • AI-agent configuration schema
    • Conformance levels and validation rules

🏗️ JSON Schemas

Two schemas for validation:

  • schema/metadata.schema.json - Validates document metadata structure
  • schema/ai-config.schema.json - Validates AI-agent configuration

📚 Example Documents

Three complete working examples:

  1. basic-example.webdoc.html - Demonstrates core features (metadata, RDFa, styling)
  2. ai-integrated-example.webdoc.html - Shows AI-agent integration with multiple agent types
  3. scientific-article.webdoc.html - Academic paper with citations, sections, and bibliography

🛠️ Tools

Three Node.js utilities with CLI interfaces:

  1. validate.js - Validates documents against specification

    node tools/validate.js document.webdoc.html

  2. extract-metadata.js - Extracts JSON-LD metadata

    node tools/extract-metadata.js document.webdoc.html --pretty

  3. generate-template.js - Generates new documents from templates

    node tools/generate-template.js --type basic --output my-doc.webdoc.html

📖 Documentation

Comprehensive documentation for all skill levels:

  • README.md - Project overview (Dutch)
  • QUICKSTART.md - 5-minute getting started guide
  • GUIDE.md - Complete user guide with examples
  • INDEX.md - Documentation navigation hub
  • CONTRIBUTING.md - Contribution guidelines

Features

Web Standards Integration

<!DOCTYPE html>
<html lang="nl" vocab="http://schema.org/">
<head>
    <!-- JSON-LD Metadata -->
    <script type="application/ld+json">
    {
        "@context": "https://schema.org",
        "@type": "Article",
        "name": "Document Title",
        "author": {...}
    }
    </script>
    <style>/* CSS styling */</style>
</head>
<body>
    <!-- RDFa annotated content -->
    <article typeof="Article">
        <h1 property="headline">Title</h1>
        <div property="articleBody">...</div>
    </article>
</body>
</html>

AI-Agent Configuration

{
    "@context": "https://webdoc.org/context/ai/v1",
    "@type": "AIAgentConfiguration",
    "agents": [
        {
            "@type": "ContentExtractor",
            "name": "content-extractor",
            "purpose": "Extract main content"
        }
    ]
}

Screenshots

Basic Webdoc Document

Clean, responsive design with semantic structure:
Basic Example

AI-Integrated Webdoc Document

Advanced features with AI-agent configuration:
AI Example

Testing

All components verified and working:

  • ✅ All example documents validate successfully
  • ✅ All template types generate and validate
  • ✅ Metadata extraction works correctly
  • ✅ Documents render properly in browsers

Quick Start

# Generate a new document
node tools/generate-template.js --type basic --output my-doc.webdoc.html

# Validate it
node tools/validate.js my-doc.webdoc.html
# Output: ✓ Document is valid!

# View in browser
open my-doc.webdoc.html

Technical Details

  • Format: HTML5 with embedded JSON-LD and RDFa
  • Metadata: Schema.org vocabulary via JSON-LD
  • Semantics: RDFa 1.1 inline annotations
  • Styling: CSS3 with custom properties
  • AI Framework: Configurable agent types and workflows
  • License: MIT (open and free)

Benefits

  1. Interoperability - Works with any tool that understands HTML, JSON-LD, or RDFa
  2. Longevity - Based on stable W3C standards
  3. Accessibility - Can be read by humans (browser) and machines (AI agents)
  4. Extensibility - Custom vocabularies and agent types supported
  5. Simplicity - Single file, no external dependencies

This implementation provides a complete, production-ready document format that fulfills all requirements from the problem statement.

Original prompt

Een open, uitbreidbaar documentformaat op basis van webstandaarden
(HTML, JSON-LD, RDFa) dat inhoud, metadata, stijl, semantiek en AI-agents in één container samenbrengt.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Add open expandable document format based on web standards Implement Webdoc: Open Document Format Based on Web Standards (HTML5, JSON-LD, RDFa) Oct 16, 2025
Copilot AI requested a review from hetfirma October 16, 2025 11:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hetfirma hetfirma Awaiting requested review from hetfirma

Assignees

@hetfirma hetfirma

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@hetfirma