NeoWiki Documentation

Technical documentation for developers building on, integrating with, or running NeoWiki. New to NeoWiki? Try the live sandbox at neowiki.dev, or install it locally.

Learn the model

• Glossary — the concepts (Subject, Schema, Statement, View, Layout, Page Property) used across the UI, the code, and these docs. Start here.
• Qualifiers and References — how NeoWiki models qualifiers, references, and rank (for people coming from Wikibase)

Build on your wiki

Add and display structured data with wikitext and Lua.

• Parser Functions — {{#view}}, {{#neowiki_value}}, and {{#cypher_raw}}
• Lua API — the mw.neowiki Scribunto library, including nw.query() for Cypher

Integrate over HTTP

The REST and query APIs, and the JSON formats they exchange.

• REST API — the /neowiki/v0/* endpoints, plus the generated OpenAPI spec
• Schema Format — JSON format for Schema definitions
• Subject Format — JSON format for Subject data
• Validation Codes — stable code strings returned by backend validation
• Query API — read-only Cypher endpoint over the graph backend
• Graph Model — Neo4j node and relationship structure

Publish as RDF

Project Subjects to RDF, natively or mapped onto standard ontologies.

• RDF Export — native RDF projection: config, IRI scheme, endpoint, bulk dump
• Ontology Mapping — projecting into EDM, Dublin Core, … via Mapping pages
• Worked example: Person to EDM — end-to-end mapping walkthrough with findings

Extend NeoWiki

• Extending NeoWiki — add property types and view types, contribute graph and RDF data, and reuse NeoWiki's UI from another extension (with the RedHerb example extension as a starting point)

Run NeoWiki

• Installation — the Docker demo, or adding NeoWiki to an existing MediaWiki
• Maintenance — rebuilding the graph, upgrades, and current limitations

Understand the architecture

• Architecture Decision Records — numbered, dated architectural decisions
• Planning docs — work-in-progress exploration (not published to the website)

---

Where each kind of doc lives

For contributors adding to these docs:

• Cross-cutting, and every audience needs it (the Glossary, Qualifiers and References) → the docs root
• Wikitext or Lua authoring on the wiki → authoring/
• An HTTP API or a JSON data format → api/
• RDF projection or ontology mapping → rdf/
• Extending NeoWiki from another extension → extending/
• A worked, end-to-end example → examples/
• A sysadmin install, maintenance, or deployment guide → operations/
• A numbered, dated decision → adr/
• Work-in-progress exploration → planning/ (not published to the website)