kettek/pages/QWiki.ktx

42 lines
1.7 KiB
Plaintext

,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
QWiki
````````````````````````
//Latest Version:// [[git]].href(http://kettek.net/gitphp/?p=QWiki.git)
QWiki is a simple wiki design implemented in Node.js with no database requirements. It is intended to be simple, quick, and customizable (from a programmer's standpint).
It is currently lacking in important features such as user-based access and archiving/diffing.
,,,,,,,,,,,,,,,,,,,,,,,,
Installation
````````````````````````
* npm install
* node index.js [--port=7331]
,,,,,,,,,,,,,,,,,,,,,,,,
Impetus
````````````````````````
1. straight-forward and small wiki
2. no database requirements
3. easy to deploy
,,,,,,,,,,,,,,,,,,,,,,,,
Designs
````````````````````````
1. filesystem database
2. actions based on request paths ("my_page/edit", "my_page/delete", etc.) rather than queries
3. HTML customization via "style.css" in wiki root and "index.html" template in QWiki root.
4. extendable wiki page formats such as markdown, html, or others
,,,,,,,,,,,,,,,,,,,,,,,,
Components
````````````````````````
* QCore
- limited HTTP server that handles POST data, mimetypes, page templating, etc.
- handles templating rules and page actions
* QParse
- object that holds data related to generating a page from page templating
* QWiki
- inherits from QCore
- handles page saving, cache generation, formatting, and similar