Merged kdfdocs/master

docs/contents/.agignore

@@ -0,0 +1 @@
+.git

docs/contents/.gitignore

@@ -0,0 +1 @@
+_kdf

docs/contents/CONTRIBUTORS.md

@@ -0,0 +1,4 @@
+
+# Contributors
+
+- Your name here!

docs/contents/README.md

@@ -0,0 +1,65 @@
+
+# Koding Framework Documentation: Source
+
+Welcome to the source for the [Koding][0] Framework Documentation. This is the
+*source* for the Koding Framework Documentation. This is generally only
+interesting for contributors.
+
+If you're looking for the documentation, it is available in the
+[https://koding.com/APPNAME][1] App.
+
+## Contributing
+
+Contributing to the documentation is encouraged! We do ask that you adhere to
+the following guidelines so that everything works properly when loaded into
+APPNAME.
+
+## Formatting
+
+The formatting of the documentation is subject to change since the viewing
+application is not done yet, however the basic points are as follows.
+
+### Directory Index
+
+All directories should come with an index page, which effectively serves as the
+`index.html` page.
+
+### Local URLs
+
+Because these markdown files will be loaded into a Koding Application and viewed
+from Koding, your URLs to documents within this document should not include a
+full path to this repository. Below are two examples.
+
+#### Bad
+
+```markdown
+... the
+[KDObject](https://github.com/koding/kdfdocs/blob/master/api/core/object.coffee)
+object is the base ...
+```
+
+In this example, if a user clicked the *KDObject* link they would be sent from
+Koding, to Github. This navigation away from Koding is undesired in the UX.
+
+#### Good
+
+```markdown
+... the [KDObject](./api/core/object.coffee) object is the base ...
+```
+
+In this example we got rid of all the http junk, so the link is local to
+Koding. Now if a user clicks it, they'll go to the item that they wanted to,
+rather than going to the raw source for the document. Huzzah!
+
+### Static Resources
+
+Because Koding uses HTTPS for all users, if you link to plain HTTP images on
+Koding they will fail to load and throw warnings about unsafe content.
+
+So, for now, link all embedded images to their absolute paths on Github,
+**with HTTPS**. This ensures that the image is secure, and everything is happy.
+
+
+
+[0]: https://koding.com
+[1]: https://koding.com/APPNAME

docs/contents/api/README.md

@@ -0,0 +1 @@
+index.md

docs/contents/api/core/README.md

@@ -0,0 +1 @@
+index.md

docs/contents/api/core/index.md

@@ -0,0 +1,5 @@
+
+# Core KD Framework Components
+
+- KDEventEmitter
+- [KDObject](./kdobject.md)

docs/contents/api/core/kdobject.md

@@ -0,0 +1,55 @@
+
+# KDObject
+
+
+## Extends
+
+[KDEventEmitter](./kdeventemitter.md)
+
+## Methods
+
+### constructor:(options = {}, data) ->
+
+### bound: (method) ->
+
+### lazyBound: (method, rest...) ->
+
+### forwardEvent: (target, eventName, prefix="") ->
+
+### forwardEvents: (target, eventNames, prefix="") ->
+
+### ready:(listener) ->
+
+### registerSingleton:KD.registerSingleton
+
+### getSingleton:KD.getSingleton
+
+### getInstance:(instanceId)->
+
+### registerKDObjectInstance: -> KD.registerInstance @
+
+### setData:(@data)->
+
+### getData:-> @data
+
+### setOptions:(@options = {})->
+
+### setOption:(option, value)-> @options[option] = value
+
+### unsetOption:(option)-> delete @options[option] if @options[option]
+
+### getOptions:-> @options
+
+### getOption:(key)-> @options[key] ? null
+
+### changeId:(id)->
+
+### cgetId:->@id
+
+### csetDelegate:(@delegate)->
+
+### cgetDelegate:->@delegate
+
+### cdestroy:->
+
+### cchainNames:(options)->

docs/contents/api/index.md

@@ -0,0 +1,13 @@
+
+# KDFramework API
+
+
+- [Core Components][1]
+- [View Components][2]
+
+
+
+
+[0]: https://koding.com
+[1]: ./core/index.md
+[2]: ./views/index.md

docs/contents/api/views/README.md

@@ -0,0 +1 @@
+index.md

docs/contents/api/views/index.md

@@ -0,0 +1,23 @@
+
+# KDFramework Views
+
+- [KDView](./kdview.md)
+- [JView](./jview.md)
+- [KDHeaderView](./kdheaderview.md)
+- [KDButtonView](./kdbuttonview.md)
+- [KDButtonGroupView](./kdbuttongroupview.md)
+- [KDButtonViewWithMenu](./kdbuttonviewwithmenu.md)
+- [KDHitEnterInputView](./kdhitenterinputview.md)
+- [KDInputView](./kdinputview.md)
+- [KDListView](./kdlistviewitem.md)
+- [KDListItemView](./kdlistview.md)
+- [KDListViewController](./kdlistviewcontroller.md)
+- [KDLoaderView](./kdloaderview.md)
+- [KDNotificationView](./kdnotificationview.md)
+- [KDToggleButton](./kdtogglebutton.md)
+
+
+
+
+
+[0]: https://koding.com

docs/contents/api/views/jview.md

@@ -0,0 +1,94 @@
+
+# JView
+
+JView implements a basic [KDView](./kdview.md) with [Pistachio][0] as the 
+default template language.
+
+## Usage
+
+If you're creating your own class and extending JView, you'll want to define a 
+`pistachio` method.
+
+```coffee
+class Example extends JView
+  pistachio: ->
+    """
+    <p>
+      This is a JView!
+    </p>
+    """
+
+example = new Example()
+appView.addSubView example
+```
+
+If you're looking to create a pistachio view *without* inheriting it, you can 
+define a `pistachio` property on the JView option.
+
+```coffee
+view = new JView
+  pistachio: """
+  <p>
+    This is a JView!
+  </p>
+  """
+
+appView.addSubView view
+```
+
+These two are approximately the same. The differences lie in your 
+implementation needs.
+
+## API Index
+
+> class JView extends [KDView][kdview]
+> - [constructor](#constructor): (options={}, data) ->
+> - [pistachio](#pistachio): -> "some pistachio"
+
+## [Class](https://github.com/koding/kd/blob/master/src/core/jview.coffee#L3)
+
+JView extends [KDView](./kdview.md). Please see that for inherited methods.
+
+### [Constructor](https://github.com/koding/kd/blob/master/src/core/jview.coffee#L3)
+> [constructor](#constructor): (options={}, data) ->
+
+Source for JView constructor is inherited entirely from [KDView][kdview].  The 
+only difference is the `pistachio` option.
+
+#### Args
+
+1. **options**:
+  - Type: object
+  - Default: `{}`
+
+    The following keys are supported.
+
+  - **options.pistachio**: A pistachio string. This is an alternative to the 
+    `@pistachio` method, and is checked **first** when pistachio is rendered.
+    - Type: string
+    - Default: `undefined`
+
+### [pistachio](https://github.com/koding/kd/blob/master/src/core/jview.coffee#L14)
+> [pistachio](#pistachio): -> "some pistachio"
+
+The `@pistachio` method is intended for you to implement in your class which is 
+extending JView. It's sole purpose is to return a string is pistachio 
+templating. 
+
+#### Returns
+
+A string is [Pistachio][0].
+
+Example:
+
+```pistachio
+<p>
+  This is being returned by your class, which inherited JView!
+</p>
+```
+
+
+
+
+[0]: https://github.com/phidelta/pistachio
+[kdview]: ./kdview.md

docs/contents/api/views/kdbuttongroupview.md

@@ -0,0 +1,64 @@
+
+# KDButtonGroupView
+
+A view that creates buttons in a group.
+
+## Usage
+
+```coffee
+view = new KDButtonGroupView
+  buttons:
+    "Button One!":
+      cssClass: "clean-red"
+      callback: ->
+        new KDNotificationView
+          content: "You clicked the red button, we're doomed!"
+    "Button Two!"
+      cssClass: "cupid-green"
+      callback: ->
+        new KDNotificationView
+          content: "You clicked the green button, we're saved!"
+
+appView.addSubView view
+```
+
+In this example we create a `KDButtonGroupView` and pass in a options object.  
+This buttons object has a key `"buttons"`, with the value of an object also.
+
+Each key in the buttons object is a button title, and the value for that key is 
+the settings for that button. So, in the above example `"Button One!"` is the 
+title of a button, and the object within are settings passed directly to the 
+button being created.
+
+`KDButtonGroupView` will take these button objects, and create instances of 
+[KDButtonView][kdbuttonview] for each one.
+
+## API Index
+
+> class KDButtonGroupView extends [KDView][kdview]
+> - [constructor](#constructor): (options={}, data) ->
+
+## [Class](https://github.com/koding/kd/blob/master/src/components/buttons/buttongroupview.coffee#L3)
+
+KDbuttonView inherits from [KDView][kdview]. Please see that for inherited 
+methods.
+
+### [Constructor](https://github.com/koding/kd/blob/master/src/components/buttons/buttongroupview.coffee#L5)
+
+1. **options**:
+  - Type: object
+  - Default: `{}`
+
+  The following keys are supported.
+
+  - **options.buttons**: An object containing settings for the 
+    [KDButtonViews][kdbuttonview] that KDButtonGroupView will create. Each key 
+is the title of a button to be created, and the value is yet another object 
+that will be given as options to the [KDButtonView][kdbuttonview].
+    - Type: object
+
+
+
+
+[kdview]: ./kdview.md
+[kdbuttonview]: ./kdbuttonview.md