structure changes

This commit is contained in:
Bernhard Posselt
2013-03-13 17:13:35 +01:00
parent cbe3f633ad
commit a5761ca8d0
38 changed files with 131 additions and 84 deletions

View File

@@ -1,6 +1,6 @@
===========================================
App Developement Using the ownCloud App API
===========================================
===================================
App Developement (ownCloud App API)
===================================
.. toctree::
:maxdepth: 1
@@ -16,3 +16,4 @@ App Developement Using the ownCloud App API
filesystem
hooks
data-migration
api/index

View File

@@ -0,0 +1,85 @@
================
AppFramework API
================
.. toctree::
:maxdepth: 1
:hidden:
app
controller_controller
core_api
db_doesnotexistexception
db_multipleobjectsreturnedexception
db_mapper
dependencyinjection_dicontainer
http_response
http_downloadresponse
http_jsonresponse
http_redirectresponse
http_templateresponse
http_textresponse
http_textdownloadresponse
http_twigresponse
http_request
middleware_middleware
middleware_middlewaredispatcher
middleware_security_securitymiddleware
middleware_security_securityexception
middleware_twig_twigmiddleware
utility_controllertestutility
utility_methodannotationreader
Main
----
* :doc:`app`
* :doc:`dependencyinjection_dicontainer`
API Layer
---------
* :doc:`core_api`
Request
-------
* :doc:`http_request`
Controllers
-----------
* :doc:`controller_controller`
Database
--------
* :doc:`db_doesnotexistexception`
* :doc:`db_multipleobjectsreturnedexception`
* :doc:`db_mapper`
Responses
---------
* :doc:`http_response`
* :doc:`http_downloadresponse`
* :doc:`http_jsonresponse`
* :doc:`http_redirectresponse`
* :doc:`http_templateresponse`
* :doc:`http_textresponse`
* :doc:`http_textdownloadresponse`
Middleware
----------
* :doc:`middleware_middleware`
* :doc:`middleware_middlewaredispatcher`
Security & Authentication
^^^^^^^^^^^^^^^^^^^^^^^^^
* :doc:`middleware_security_securitymiddleware`
* :doc:`utility_methodannotationreader`
* :doc:`middleware_security_securityexception`
Twig Templates
^^^^^^^^^^^^^^
* :doc:`middleware_twig_twigmiddleware`
* :doc:`http_twigresponse`
Testing
-------
* :doc:`utility_controllertestutility`

View File

@@ -1,6 +1,6 @@
========================================
App Developement Using the App Framework
========================================
================================
App Developement (App Framework)
================================
.. toctree::
:maxdepth: 1
@@ -24,3 +24,4 @@ App Developement Using the App Framework
../app/filesystem
../app/hooks
../app/data-migration
api/index

View File

@@ -186,7 +186,7 @@ The App Framework comes with additional template functions for Twig to better in
ownCloud Templates
------------------
In every template file you can easily access the template functions listed in :doc:`../classes/core/templates`. To access the assigned variables in the template, use the **$_[]** array. The variable will be availabe under the key that you defined (e.g. $_['key']).
In every template file you can easily access the template functions listed in :doc:`../app/api/templates`. To access the assigned variables in the template, use the **$_[]** array. The variable will be availabe under the key that you defined (e.g. $_['key']).
:file:`templates/main.php`
@@ -222,4 +222,4 @@ The parent variables will also be available in the included templates, but shoul
<?php print_unescaped($this->inc('other_template', array('variable' => 'value'))); ?>
**For more info, see** :doc:`../classes/core/templates`
**For more info, see** :doc:`../app/api/templates`

View File

@@ -1,5 +1,5 @@
App Tutorial (App Framework)
============================
App Tutorial
============
.. sectionauthor:: Bernhard Posselt <nukeawhale@gmail.com>

View File

@@ -1,31 +0,0 @@
================
AppFramework API
================
.. toctree::
:maxdepth: 1
app
controller_controller
core_api
db_doesnotexistexception
db_multipleobjectsreturnedexception
db_mapper
dependencyinjection_dicontainer
http_response
http_downloadresponse
http_jsonresponse
http_redirectresponse
http_templateresponse
http_textresponse
http_textdownloadresponse
http_twigresponse
http_request
middleware_middleware
middleware_middlewaredispatcher
middleware_security_securitymiddleware
middleware_security_securityexception
middleware_twig_twigmiddleware
utility_controllertestutility
utility_methodannotationreader

View File

@@ -1,9 +0,0 @@
=================
API Documentation
=================
.. toctree::
:maxdepth: 1
appframework/index
core/index

View File

@@ -5,10 +5,8 @@ General
.. toctree::
:maxdepth: 1
debugging
security
codereviews
codingguidelines
kanban
debugging
angular
dependencyinjection

View File

@@ -12,48 +12,46 @@ App Developement
intro/index
app/index
appframework/index
classes/index
.. _Junior Jobs: http://owncloud.org/dev/junior-jobs/
.. _git crash course: http://git-scm.com/course/svn.html
.. _Twig Templates: http://twig.sensiolabs.org/
.. _Symfony Routing: http://symfony.com/doc/current/components/routing/introduction.html
.. _Pimple: http://pimple.sensiolabs.org/
.. _PHPUnit: http://www.phpunit.de/manual/current/en/
* Take a job from our `Junior Jobs`_
Intro
-----
Before starting to write an app please read the security and coding guidelines:
* :doc:`general/security`
* :doc:`general/codingguidelines`
* :doc:`general/codereviews`
* :doc:`general/debugging`
* :doc:`general/kanban`
* :doc:`general/angular` | `AngularJS Documentation <http://angularjs.org/>`_
* :doc:`general/dependencyinjection` | `Pimple`_
App Developement
================
After this you can start to write your app:
* :doc:`intro/gettingstarted`
* :doc:`intro/createapp`
Tutorial
--------
You can choose between the traditional and MVC style (App Framework) approach.
App Development using ownCloud App API
--------------------------------------
You can choose between the traditional and MVC style (App Framework) approach. This approach uses the basic ownCloud libraries and provides no classes to use for MVC development and testing.
* :doc:`app/tutorial`
API Documentation
~~~~~~~~~~~~~~~~~
* `ownCloud App API <http://api.owncloud.org/namespaces/OCP.html>`_
App Development using the App Framework App
-------------------------------------------
Develop an app using an MVC Framework. The App Framework provides enhanced Security, MVC classes and testing tools but you need to read more until you can produce the first output.
* :doc:`appframework/tutorial`
App Framework
-------------
API Documentation
=================
* :doc:`classes/appframework/index`
* :doc:`classes/core/index`
~~~~~~~~~~~~~~~~~
* :doc:`appframework/api/index`
* `ownCloud App API <http://api.owncloud.org/namespaces/OCP.html>`_
Further Information
-------------------
General useful information
* `git crash course <http://git-scm.com/course/svn.html>`_
* :doc:`general/debugging`
* :doc:`general/angular` | `AngularJS Documentation <http://angularjs.org/>`_
* :doc:`general/dependencyinjection` | `Pimple <http://pimple.sensiolabs.org/>`_

View File

@@ -4,5 +4,9 @@ Bugtracker
.. toctree::
:maxdepth: 1
:hidden:
codereviews
kanban
.. _Bugtracker: https://github.com/owncloud/core/issues

View File

@@ -13,7 +13,7 @@ Kanban Board = github issues + huboard
We are using http://huboard.com to visualize ownCloud github issues as a `kanban
board`_ (see: `core`_, `apps`_, `mirall`_):
.. figure:: ../../images/kanbanexample.png
.. figure:: ../images/kanbanexample.png
:scale: 70
As you may have noticed, the columns of the kanban board represent the