Main Page: Difference between revisions
Importing NeoWiki demo data |
Importing NeoWiki demo data |
||
| Line 2: | Line 2: | ||
Welcome to the NeoWiki demo wiki! |
Welcome to the NeoWiki demo wiki! |
||
NeoWiki turns your wiki into a collaborative graph database by letting you store and query structured information |
NeoWiki turns your wiki into a collaborative graph database by letting you store and query structured information. |
||
Information is stored in versioned document form inside of wiki pages. The latest version is also stored in |
|||
graph databases via which it can be queried. |
|||
NeoWiki is in the experimental proof of concept phase. It is not production ready, public interfaces will change, |
|||
NeoWiki is still alpha software. Various features are incomplete or missing. This demo wiki exists so you can see the current state of NeoWiki and imagine what you could do with a further developed version of the software. |
|||
big structural changes will happen, and key functionality is still missing. |
|||
This demo exists to gather feedback to inform further development. ([https://professional.wiki/en/contact Contact Professional Wiki]) |
|||
You can find [https://github.com/ProfessionalWiki/NeoWiki/tree/master/docs technical documentation] in the |
|||
[https://github.com/ProfessionalWiki/NeoWiki NeoWiki git repository]. |
|||
</div> |
</div> |
||
== Discover NeoWiki Step by Step == |
|||
Terminology is explained in [https://github.com/ProfessionalWiki/NeoWiki/blob/master/docs/Glossary.md the glossary]. |
|||
'''As a reader:''' |
|||
* View a Subject: [[Professional Wiki]] |
|||
* View a Schema: [[Schema:Company]] |
|||
'''As an editor:''' |
|||
* Edit a Subject: [[Professional Wiki]] (login required) |
|||
* Edit a Schema: either via a Subject using it, i.e. [[Professional Wiki]], or directly on the Schema page, i.e. [[Schema:Company]] |
|||
* Create a Subject: TODO |
|||
'''As a developer:''' |
|||
* View Subject JSON: [[Special:NeoJson/ACME_Inc]] (developer UI, normal users will not see JSON. [https://github.com/ProfessionalWiki/NeoWiki/blob/master/docs/SubjectFormat.md View docs]) |
|||
* [[#REST_API_endpoints|Explore the REST API]] |
|||
== Demo pages == |
== Demo pages == |
||
| Line 11: | Line 39: | ||
* Simple page with automatic infobox and edit form: [[NeoWiki]], [[ProWiki]] |
* Simple page with automatic infobox and edit form: [[NeoWiki]], [[ProWiki]] |
||
* Subject with relations: [[Professional Wiki]] |
* Subject with relations: [[Professional Wiki]] |
||
* Multiple subjects per page: |
* Multiple subjects per page: [[ACME Inc]] |
||
* Wikibase Statement emulation: [[Berlin]] |
* Wikibase Statement emulation: [[Berlin]] |
||
* Displaying data from other pages: [[Company Infoboxes]] |
* Displaying data from other pages: [[Company Infoboxes]] |
||
* [[Reactive UI example]] |
* [[Reactive UI example]] |
||
* [[Cypher query examples]] |
|||
* [[Lua examples]] |
|||
| ⚫ | |||
=== Schemas === |
|||
| ⚫ | |||
compensation in EUR with a value between 0 and 1000000. |
compensation in EUR with a value between 0 and 1000000. |
||
A finished version of NeoWiki would contain a dedicated editor for creating and modifying schemas. For now, you have |
|||
to edit the JSON directly. |
|||
You can create a new employee by doing to its schema page and clicking "create new employee" at the top. A finished |
|||
version of NeoWiki would allow you to create new subjects directly from the Visual Editor when editing a page. |
|||
* [[Schema:Company]] |
* [[Schema:Company]] |
||
| Line 35: | Line 53: | ||
* [{{fullurl:Special:AllPages|from=&to=&namespace=7474}} View all schemas] |
* [{{fullurl:Special:AllPages|from=&to=&namespace=7474}} View all schemas] |
||
== |
== REST API endpoints == |
||
* '''Create a new Schema''': Create a new page with the prefix "Schema:" and the name of your schema. For instance, "Schema:MyExample". Creating and editing schemas requires elevated permissions. We can turn this off. |
|||
Technical |
|||
We will have OpenAPI docs later. For now, you can find a complete and up-to-date list by looking at the |
|||
* '''View or edit Subject JSON directly''': NeoWiki can be used without understanding what JSON is, and the JSON is not normally shown. However, as a technical person, you can access it via the REST API or the "View or edit JSON" link at the bottom of pages with Subjects. The latter is a development utility that would not be available on production wikis. |
|||
[https://github.com/ProfessionalWiki/NeoWiki/blob/master/extension.json MediaWiki API route definitions]. |
|||
* '''View the data in Neo4j''': Head over to https://neo.professional.wiki:7474/ |
|||
Search for "RestRoutes". |
|||
== REST API endpoints == |
|||
Example URL: https:// |
Example URL: https://neowiki.dev/w/rest.php/neowiki/v0/subject/s1demo4sssssss1 |
||
=== Read endpoints === |
=== Read endpoints === |
||
Revision as of 10:58, 27 January 2026
Welcome to the NeoWiki demo wiki!
NeoWiki turns your wiki into a collaborative graph database by letting you store and query structured information. Information is stored in versioned document form inside of wiki pages. The latest version is also stored in graph databases via which it can be queried.
NeoWiki is in the experimental proof of concept phase. It is not production ready, public interfaces will change, big structural changes will happen, and key functionality is still missing.
This demo exists to gather feedback to inform further development. (Contact Professional Wiki)
You can find technical documentation in the NeoWiki git repository.
Discover NeoWiki Step by Step
Terminology is explained in the glossary.
As a reader:
- View a Subject: Professional Wiki
- View a Schema: Schema:Company
As an editor:
- Edit a Subject: Professional Wiki (login required)
- Edit a Schema: either via a Subject using it, i.e. Professional Wiki, or directly on the Schema page, i.e. Schema:Company
- Create a Subject: TODO
As a developer:
- View Subject JSON: Special:NeoJson/ACME_Inc (developer UI, normal users will not see JSON. View docs)
- Explore the REST API
Demo pages
- Simple page with automatic infobox and edit form: NeoWiki, ProWiki
- Subject with relations: Professional Wiki
- Multiple subjects per page: ACME Inc
- Wikibase Statement emulation: Berlin
- Displaying data from other pages: Company Infoboxes
- Reactive UI example
Schemas allow you to define the structure of your data. For instance, you can define that a Employee has a compensation in EUR with a value between 0 and 1000000.
REST API endpoints
We will have OpenAPI docs later. For now, you can find a complete and up-to-date list by looking at the MediaWiki API route definitions. Search for "RestRoutes".
Example URL: https://neowiki.dev/w/rest.php/neowiki/v0/subject/s1demo4sssssss1
Read endpoints
GET /neowiki/v0/subject/{subjectId}Gets the JSON definition of a subjectGET /neowiki/v0/schema/{schemaName}Gets the JSON definition of a schema
Write endpoints
These require a CSRF token, first obtained via api.php?action=query&format=json&meta=tokens&type=csrf
POST /neowiki/v0/page/{pageId}/mainSubjectCreates a new main subjectPOST /neowiki/v0/page/{pageId}/childSubjectsCreates a new child subjectPATCH /neowiki/v0/subject/{subjectId}Updates a subjectDELETE /neowiki/v0/subject/{subjectId}Deletes a subject
These endpoints are designed for the NeoWiki frontend. They are not a complete general purpose API yet.