SpliceIt! Documentation 0.1 ALPHA

Disclaimer: You are one of the very first people to read this ALPHA version of the documentation. So be aware of the fact that this version is likely to contain inaccuracies and other errors like horrible spelling and grammar ; ). We appriciate any error report you might send! Thanks for beeing interested in our little project.

Welcome

We're glad to see someone interested in learning about the SpliceIt! project. This documentation right now is a mix between the current features of SpliceIt! and the features we plan to implement. The reason for documenting non-existing stuff is simply that this gives us the chance to get peer-reviews for them before we mess up, and it helps staying on-top of documenting everything as well! If you have any questions about the project feel free to ask one of our devlopers either in the IRC channel: #spliceit @ freenode.net or with a short mail:

Project Manager / Programmer:Felix Geisendörfer aka the_undefined FelixGe@web.de[Germany]
Programmer:Franz Heinzmann aka frando frando@xcite-online.de[Germany]
Programmer:Kiyoshi Murata aka nemontemi kbmurata@gmail.com[Brazil]

For the People that read too fast: Parts of this documentation are for things we plan to implement. We will highlight them so you know what is done, and what isn't with a little Todo. If you want to know more about our Documentation approach check out our section about Documentation Driven Development.

Content

  1. About SpliceIt!
    1. Project Guidelines
    2. Documentation Driven Development
  2. SpliceIt! Plugins
    1. Controllers
    2. Models
    3. Views
    4. Apis
    5. Plugin-Hacks
  3. SpliceIt! Core Apis
    1. User
    2. Rights
    3. i18n
    4. Theming
    5. Url Aliasing
    6. + Admin (generates an Admin interface for all plugins)

Appendix

  1. Todo List (Contains all things we highlighted with a little Todo)

Doc-Generator Tests

  1. Textile Markup test
  2. Geshi-PHP Markup test