Early developmentNot everything described here has shipped yet.

Skip to content

Getting started

Turn a wiki page into structured, queryable data in a few minutes. Try it on the public sandbox at neowiki.dev (create an account, then experiment freely: it is a sandbox and resets periodically) or on your own wiki.

1. Create a Schema

A Schema describes a kind of thing: a Person, a Building, a Painting. Go to Special:Schemas and create one, then use Add property definition for each fact you want to record, giving it a name and a Property Type: text, number, date, relation, and so on.

2. Create a Subject

A Subject is one thing described with a Schema. Pick Create subject in the sidebar, or the Create button on the Schema's own page (it names the Schema, so Create Person on Schema:Person), name the page the Subject will live on, fill in the values, and save. The new page's Main Subject renders automatically as an infobox, and the Data tab lets you view and edit all its Subjects. To attach a Subject to a page that already exists, open that page and pick Create subject here from the page tools.

3. Render a View in wikitext

Source edit any page and add:

{{#view:}}

With no id it renders the page's Main Subject. Parser Functions covers the rest, and Layouts control which properties a View shows (Glossary).

4. Query

Add a query to any page. This one lists the stored pages, whatever your data model:

{{#cypher_raw: MATCH (p:Page) RETURN p.name }}

This needs a Neo4j backend; the sandbox and the Docker install have one.

Where next

Tell us what this guide is missing: https://github.com/ProfessionalWiki/NeoWiki/issues/1336.