Requirements

This page will detail the requirements of the GUI.

Essential

will be a docpad plugin that creates it's own docpad server that runs off the port 9779
- refer to the example admin plugin for how to do this
will load in the actual site inside an iframe, with our admin interface ontop of the page
- this allows us to have control of the website navigation, while not injecting anything into it
backbone models will be given to the client via a rest interface
the client will use query-engine to search the models
will allow viewing, and editing of everything inside website's directory
- perhaps initially, only things inside src is needed
- viewing files
  - will show their filename
  - will search by their path
    - src/ will be the default search
- editing files
  - will show their filename
  - ability to rename the file
  - ability to delete the file
  - ability to edit the files source
will allow creating new text files
will allow uploading binary files
will allow deleting files
file meta data, content, and GetText data will be editable via contenteditable using semantic attributes
authentication plugin
- checks their github authentication against the package.json maintainers list
rest plugin
- provides getting and saving of models

auto save
live preview
- live preview allows your changes to be reflected in the background page
- will need docpad to provide a rest interface for rendering content
will allow changing of the website's docpad.cson file
- be it via the editing files interface, or a special interface
will allow changing website theme visually
will allow browsing the docpad wiki
will have an exchange store for discovering and installing new plugins and themes
will allow you to turn on and off plugins
will offer git comitting and syncing
will offer deployment