What it builds
With Developer Mode on, a document's options menu offers New World…. Give it a name, a genre and the date its chronicle begins. It then publishes these pages under that document:
page | binding | what you see |
|---|---|---|
the world root |
| a genre and an epoch date in Attributes, a card view of everything below |
|
| a type page: a schema tag, New Document and New Collection buttons, and an editable schema |
|
| a folder whose pages are typed by inheritance, with a live table of its children |
one starter page per type | inherited from its folder | required rows already filled: a date picker, title pills pointing at the other starters, and object fields ready to create |
The kit's schemas are the library's Character, Place, Faction and Event, republished with every target rewritten to point at your type pages. A Character's home targets hm://<you>/<world>/types/place instead of the library's Place. That document does not exist until the same publish creates it. This works because schemas reference each other by name, and a name can point at a page that has no content hash yet.
Editing the ontology
A type page is a document like any other, so you edit the ontology the way you edit documents. To add a field, open a type's schema. Choose Date for a date picker, or choose HM link or IPFS and fill in a target type to point at another type. Every page in the matching folder gains the field. To add a type, publish a new schema-definition page and point a folder's childAttributesSchema at it. You never need to delete anything: pages that carry a removed field show a warning until you tidy them. The graph of types is browsable. Each type page links to the types it references, and the explorer shows what depends on what.
What to try
Open the Wanderer. In Attributes, change born with the picker, pick a different home with the search pill, and press Create object on stats. The dialog is locked to Character stats and does not publish until strength, intellect and charisma are each from 1 to 10. Then press it on notes and publish anything at all.
Open the Characters folder and add a page. The required rows appear before you type a word, because the folder's childAttributesSchema types it.
Open the Character type, edit its schema, and add a title Date field. Go back to the Wanderer and the new field is there.
Open the world root's Attributes. genre is a dropdown and epoch is a date, because the root conforms to the World type.
The whole tree is ordinary Hypermedia. You can sync it, share it, comment on it, and query it from another space. Typed documents explains the model underneath.
See also
Typed documents: the three keys that bind a document to a type.
User stories: the same features, step by step in the app, the CLI and an agent.
References and naming: why a target can name a page that does not exist yet.
Schema language: the vocabulary the type pages are written in.
Metadata: the built-in keys, including attributesSchema and childAttributesSchema.
Examples: the library's example schemas, including the World kit.
Do you like what you are reading? Subscribe to receive updates.
Unsubscribe anytime