Go to file
kts of kettek (muzukashi) 879437b96e Renamed qwiki to QWiki wherever found. QCore now has a cwd property referred to when acquiring the working directory. The request object now has hash, pathname, path, and query properties parsed from req.url. req.area is now unescape()'d. Current act string is now a property of req as well. Queries are now parsed for 'QRULE', and if found, only that rule is sent to the client rather than the whole act. QWiki now calls initialize() method which will eventually populate the cwd with default files. 2016-02-17 23:36:16 -08:00
acts Renamed qwiki to QWiki wherever found. QCore now has a cwd property referred to when acquiring the working directory. The request object now has hash, pathname, path, and query properties parsed from req.url. req.area is now unescape()'d. Current act string is now a property of req as well. Queries are now parsed for 'QRULE', and if found, only that rule is sent to the client rather than the whole act. QWiki now calls initialize() method which will eventually populate the cwd with default files. 2016-02-17 23:36:16 -08:00
resources Modified CSS to have the content view have a minimum height if 70% -- this is a less than ideal alternative to making the content's height take up most of the screen save for the footer. Created the resources/ directory, containing base resources for the interface. At the moment, it just contains all the icons in the icons.svg file. 2016-01-25 14:46:38 -08:00
wiki Modified CSS to have the content view have a minimum height if 70% -- this is a less than ideal alternative to making the content's height take up most of the screen save for the footer. Created the resources/ directory, containing base resources for the interface. At the moment, it just contains all the icons in the icons.svg file. 2016-01-25 14:46:38 -08:00
.gitignore Initial commit of QWiki. Currently uses markdown as default (and cannot be changed outside of system code). Lacking some functionality. Needs to split into multiple component/module files, such as QCore and QWiki. 2015-10-11 15:09:43 -07:00
QCore.js Renamed qwiki to QWiki wherever found. QCore now has a cwd property referred to when acquiring the working directory. The request object now has hash, pathname, path, and query properties parsed from req.url. req.area is now unescape()'d. Current act string is now a property of req as well. Queries are now parsed for 'QRULE', and if found, only that rule is sent to the client rather than the whole act. QWiki now calls initialize() method which will eventually populate the cwd with default files. 2016-02-17 23:36:16 -08:00
README.md Initial commit of QWiki. Currently uses markdown as default (and cannot be changed outside of system code). Lacking some functionality. Needs to split into multiple component/module files, such as QCore and QWiki. 2015-10-11 15:09:43 -07:00
TODO.md Adjusted body background to be separate from the content background -- also added a shadow to the content. Updated TODO for future snazz. 2016-01-24 05:15:34 -08:00
index.html Renamed qwiki to QWiki wherever found. QCore now has a cwd property referred to when acquiring the working directory. The request object now has hash, pathname, path, and query properties parsed from req.url. req.area is now unescape()'d. Current act string is now a property of req as well. Queries are now parsed for 'QRULE', and if found, only that rule is sent to the client rather than the whole act. QWiki now calls initialize() method which will eventually populate the cwd with default files. 2016-02-17 23:36:16 -08:00
index.js Renamed qwiki to QWiki wherever found. QCore now has a cwd property referred to when acquiring the working directory. The request object now has hash, pathname, path, and query properties parsed from req.url. req.area is now unescape()'d. Current act string is now a property of req as well. Queries are now parsed for 'QRULE', and if found, only that rule is sent to the client rather than the whole act. QWiki now calls initialize() method which will eventually populate the cwd with default files. 2016-02-17 23:36:16 -08:00
package.json Renamed qwiki to QWiki wherever found. QCore now has a cwd property referred to when acquiring the working directory. The request object now has hash, pathname, path, and query properties parsed from req.url. req.area is now unescape()'d. Current act string is now a property of req as well. Queries are now parsed for 'QRULE', and if found, only that rule is sent to the client rather than the whole act. QWiki now calls initialize() method which will eventually populate the cwd with default files. 2016-02-17 23:36:16 -08:00

README.md

QWiki 2015-10-11 14:55:35

QWiki is a simple wiki design implemented in node.js.

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