From a5761ca8d060028f886eaba05960ecd7b8062d0b Mon Sep 17 00:00:00 2001 From: Bernhard Posselt Date: Wed, 13 Mar 2013 17:13:35 +0100 Subject: [PATCH] structure changes --- .../app/{classes/core => app/api}/index.rst | 0 .../{classes/core => app/api}/templates.rst | 0 .../app/{classes/core => app/api}/view.rst | 0 developer_manual/app/app/index.rst | 7 +- .../appframework => appframework/api}/app.rst | 0 .../api}/controller_controller.rst | 0 .../api}/core_api.rst | 0 .../api}/db_doesnotexistexception.rst | 0 .../api}/db_mapper.rst | 0 .../db_multipleobjectsreturnedexception.rst | 0 .../api}/dependencyinjection_dicontainer.rst | 0 .../api}/http_downloadresponse.rst | 0 .../api}/http_jsonresponse.rst | 0 .../api}/http_redirectresponse.rst | 0 .../api}/http_request.rst | 0 .../api}/http_response.rst | 0 .../api}/http_templateresponse.rst | 0 .../api}/http_textdownloadresponse.rst | 0 .../api}/http_textresponse.rst | 0 .../api}/http_twigresponse.rst | 0 .../app/appframework/api/index.rst | 85 +++++++++++++++++++ .../api}/middleware_middleware.rst | 0 .../api}/middleware_middlewaredispatcher.rst | 0 .../middleware_security_securityexception.rst | 0 ...middleware_security_securitymiddleware.rst | 0 .../api}/middleware_twig_twigmiddleware.rst | 0 .../api}/utility_controllertestutility.rst | 0 .../api}/utility_methodannotationreader.rst | 0 developer_manual/app/appframework/index.rst | 7 +- .../app/appframework/templates.rst | 4 +- .../app/appframework/tutorial.rst | 4 +- .../app/classes/appframework/index.rst | 31 ------- developer_manual/app/classes/index.rst | 9 -- developer_manual/app/general/index.rst | 4 +- developer_manual/app/index.rst | 58 ++++++------- .../general => bugtracker}/codereviews.rst | 0 developer_manual/bugtracker/index.rst | 4 + .../{app/general => bugtracker}/kanban.rst | 2 +- 38 files changed, 131 insertions(+), 84 deletions(-) rename developer_manual/app/{classes/core => app/api}/index.rst (100%) rename developer_manual/app/{classes/core => app/api}/templates.rst (100%) rename developer_manual/app/{classes/core => app/api}/view.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/app.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/controller_controller.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/core_api.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/db_doesnotexistexception.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/db_mapper.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/db_multipleobjectsreturnedexception.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/dependencyinjection_dicontainer.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/http_downloadresponse.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/http_jsonresponse.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/http_redirectresponse.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/http_request.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/http_response.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/http_templateresponse.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/http_textdownloadresponse.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/http_textresponse.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/http_twigresponse.rst (100%) create mode 100644 developer_manual/app/appframework/api/index.rst rename developer_manual/app/{classes/appframework => appframework/api}/middleware_middleware.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/middleware_middlewaredispatcher.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/middleware_security_securityexception.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/middleware_security_securitymiddleware.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/middleware_twig_twigmiddleware.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/utility_controllertestutility.rst (100%) rename developer_manual/app/{classes/appframework => appframework/api}/utility_methodannotationreader.rst (100%) delete mode 100644 developer_manual/app/classes/appframework/index.rst delete mode 100644 developer_manual/app/classes/index.rst rename developer_manual/{app/general => bugtracker}/codereviews.rst (100%) rename developer_manual/{app/general => bugtracker}/kanban.rst (99%) diff --git a/developer_manual/app/classes/core/index.rst b/developer_manual/app/app/api/index.rst similarity index 100% rename from developer_manual/app/classes/core/index.rst rename to developer_manual/app/app/api/index.rst diff --git a/developer_manual/app/classes/core/templates.rst b/developer_manual/app/app/api/templates.rst similarity index 100% rename from developer_manual/app/classes/core/templates.rst rename to developer_manual/app/app/api/templates.rst diff --git a/developer_manual/app/classes/core/view.rst b/developer_manual/app/app/api/view.rst similarity index 100% rename from developer_manual/app/classes/core/view.rst rename to developer_manual/app/app/api/view.rst diff --git a/developer_manual/app/app/index.rst b/developer_manual/app/app/index.rst index b93ab31f4..70e171268 100644 --- a/developer_manual/app/app/index.rst +++ b/developer_manual/app/app/index.rst @@ -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 diff --git a/developer_manual/app/classes/appframework/app.rst b/developer_manual/app/appframework/api/app.rst similarity index 100% rename from developer_manual/app/classes/appframework/app.rst rename to developer_manual/app/appframework/api/app.rst diff --git a/developer_manual/app/classes/appframework/controller_controller.rst b/developer_manual/app/appframework/api/controller_controller.rst similarity index 100% rename from developer_manual/app/classes/appframework/controller_controller.rst rename to developer_manual/app/appframework/api/controller_controller.rst diff --git a/developer_manual/app/classes/appframework/core_api.rst b/developer_manual/app/appframework/api/core_api.rst similarity index 100% rename from developer_manual/app/classes/appframework/core_api.rst rename to developer_manual/app/appframework/api/core_api.rst diff --git a/developer_manual/app/classes/appframework/db_doesnotexistexception.rst b/developer_manual/app/appframework/api/db_doesnotexistexception.rst similarity index 100% rename from developer_manual/app/classes/appframework/db_doesnotexistexception.rst rename to developer_manual/app/appframework/api/db_doesnotexistexception.rst diff --git a/developer_manual/app/classes/appframework/db_mapper.rst b/developer_manual/app/appframework/api/db_mapper.rst similarity index 100% rename from developer_manual/app/classes/appframework/db_mapper.rst rename to developer_manual/app/appframework/api/db_mapper.rst diff --git a/developer_manual/app/classes/appframework/db_multipleobjectsreturnedexception.rst b/developer_manual/app/appframework/api/db_multipleobjectsreturnedexception.rst similarity index 100% rename from developer_manual/app/classes/appframework/db_multipleobjectsreturnedexception.rst rename to developer_manual/app/appframework/api/db_multipleobjectsreturnedexception.rst diff --git a/developer_manual/app/classes/appframework/dependencyinjection_dicontainer.rst b/developer_manual/app/appframework/api/dependencyinjection_dicontainer.rst similarity index 100% rename from developer_manual/app/classes/appframework/dependencyinjection_dicontainer.rst rename to developer_manual/app/appframework/api/dependencyinjection_dicontainer.rst diff --git a/developer_manual/app/classes/appframework/http_downloadresponse.rst b/developer_manual/app/appframework/api/http_downloadresponse.rst similarity index 100% rename from developer_manual/app/classes/appframework/http_downloadresponse.rst rename to developer_manual/app/appframework/api/http_downloadresponse.rst diff --git a/developer_manual/app/classes/appframework/http_jsonresponse.rst b/developer_manual/app/appframework/api/http_jsonresponse.rst similarity index 100% rename from developer_manual/app/classes/appframework/http_jsonresponse.rst rename to developer_manual/app/appframework/api/http_jsonresponse.rst diff --git a/developer_manual/app/classes/appframework/http_redirectresponse.rst b/developer_manual/app/appframework/api/http_redirectresponse.rst similarity index 100% rename from developer_manual/app/classes/appframework/http_redirectresponse.rst rename to developer_manual/app/appframework/api/http_redirectresponse.rst diff --git a/developer_manual/app/classes/appframework/http_request.rst b/developer_manual/app/appframework/api/http_request.rst similarity index 100% rename from developer_manual/app/classes/appframework/http_request.rst rename to developer_manual/app/appframework/api/http_request.rst diff --git a/developer_manual/app/classes/appframework/http_response.rst b/developer_manual/app/appframework/api/http_response.rst similarity index 100% rename from developer_manual/app/classes/appframework/http_response.rst rename to developer_manual/app/appframework/api/http_response.rst diff --git a/developer_manual/app/classes/appframework/http_templateresponse.rst b/developer_manual/app/appframework/api/http_templateresponse.rst similarity index 100% rename from developer_manual/app/classes/appframework/http_templateresponse.rst rename to developer_manual/app/appframework/api/http_templateresponse.rst diff --git a/developer_manual/app/classes/appframework/http_textdownloadresponse.rst b/developer_manual/app/appframework/api/http_textdownloadresponse.rst similarity index 100% rename from developer_manual/app/classes/appframework/http_textdownloadresponse.rst rename to developer_manual/app/appframework/api/http_textdownloadresponse.rst diff --git a/developer_manual/app/classes/appframework/http_textresponse.rst b/developer_manual/app/appframework/api/http_textresponse.rst similarity index 100% rename from developer_manual/app/classes/appframework/http_textresponse.rst rename to developer_manual/app/appframework/api/http_textresponse.rst diff --git a/developer_manual/app/classes/appframework/http_twigresponse.rst b/developer_manual/app/appframework/api/http_twigresponse.rst similarity index 100% rename from developer_manual/app/classes/appframework/http_twigresponse.rst rename to developer_manual/app/appframework/api/http_twigresponse.rst diff --git a/developer_manual/app/appframework/api/index.rst b/developer_manual/app/appframework/api/index.rst new file mode 100644 index 000000000..acf4d7c29 --- /dev/null +++ b/developer_manual/app/appframework/api/index.rst @@ -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` \ No newline at end of file diff --git a/developer_manual/app/classes/appframework/middleware_middleware.rst b/developer_manual/app/appframework/api/middleware_middleware.rst similarity index 100% rename from developer_manual/app/classes/appframework/middleware_middleware.rst rename to developer_manual/app/appframework/api/middleware_middleware.rst diff --git a/developer_manual/app/classes/appframework/middleware_middlewaredispatcher.rst b/developer_manual/app/appframework/api/middleware_middlewaredispatcher.rst similarity index 100% rename from developer_manual/app/classes/appframework/middleware_middlewaredispatcher.rst rename to developer_manual/app/appframework/api/middleware_middlewaredispatcher.rst diff --git a/developer_manual/app/classes/appframework/middleware_security_securityexception.rst b/developer_manual/app/appframework/api/middleware_security_securityexception.rst similarity index 100% rename from developer_manual/app/classes/appframework/middleware_security_securityexception.rst rename to developer_manual/app/appframework/api/middleware_security_securityexception.rst diff --git a/developer_manual/app/classes/appframework/middleware_security_securitymiddleware.rst b/developer_manual/app/appframework/api/middleware_security_securitymiddleware.rst similarity index 100% rename from developer_manual/app/classes/appframework/middleware_security_securitymiddleware.rst rename to developer_manual/app/appframework/api/middleware_security_securitymiddleware.rst diff --git a/developer_manual/app/classes/appframework/middleware_twig_twigmiddleware.rst b/developer_manual/app/appframework/api/middleware_twig_twigmiddleware.rst similarity index 100% rename from developer_manual/app/classes/appframework/middleware_twig_twigmiddleware.rst rename to developer_manual/app/appframework/api/middleware_twig_twigmiddleware.rst diff --git a/developer_manual/app/classes/appframework/utility_controllertestutility.rst b/developer_manual/app/appframework/api/utility_controllertestutility.rst similarity index 100% rename from developer_manual/app/classes/appframework/utility_controllertestutility.rst rename to developer_manual/app/appframework/api/utility_controllertestutility.rst diff --git a/developer_manual/app/classes/appframework/utility_methodannotationreader.rst b/developer_manual/app/appframework/api/utility_methodannotationreader.rst similarity index 100% rename from developer_manual/app/classes/appframework/utility_methodannotationreader.rst rename to developer_manual/app/appframework/api/utility_methodannotationreader.rst diff --git a/developer_manual/app/appframework/index.rst b/developer_manual/app/appframework/index.rst index 1d4ba29ae..b7f60ace0 100644 --- a/developer_manual/app/appframework/index.rst +++ b/developer_manual/app/appframework/index.rst @@ -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 diff --git a/developer_manual/app/appframework/templates.rst b/developer_manual/app/appframework/templates.rst index 5197f4b98..7e4699406 100644 --- a/developer_manual/app/appframework/templates.rst +++ b/developer_manual/app/appframework/templates.rst @@ -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 inc('other_template', array('variable' => 'value'))); ?> -**For more info, see** :doc:`../classes/core/templates` \ No newline at end of file +**For more info, see** :doc:`../app/api/templates` \ No newline at end of file diff --git a/developer_manual/app/appframework/tutorial.rst b/developer_manual/app/appframework/tutorial.rst index b077c7296..fdc14c6ab 100644 --- a/developer_manual/app/appframework/tutorial.rst +++ b/developer_manual/app/appframework/tutorial.rst @@ -1,5 +1,5 @@ -App Tutorial (App Framework) -============================ +App Tutorial +============ .. sectionauthor:: Bernhard Posselt diff --git a/developer_manual/app/classes/appframework/index.rst b/developer_manual/app/classes/appframework/index.rst deleted file mode 100644 index af5b0fbd5..000000000 --- a/developer_manual/app/classes/appframework/index.rst +++ /dev/null @@ -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 - diff --git a/developer_manual/app/classes/index.rst b/developer_manual/app/classes/index.rst deleted file mode 100644 index d3f669a71..000000000 --- a/developer_manual/app/classes/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -================= -API Documentation -================= - -.. toctree:: - :maxdepth: 1 - - appframework/index - core/index diff --git a/developer_manual/app/general/index.rst b/developer_manual/app/general/index.rst index d9b14b81d..1fd5ff68a 100644 --- a/developer_manual/app/general/index.rst +++ b/developer_manual/app/general/index.rst @@ -5,10 +5,8 @@ General .. toctree:: :maxdepth: 1 - debugging security - codereviews codingguidelines - kanban + debugging angular dependencyinjection diff --git a/developer_manual/app/index.rst b/developer_manual/app/index.rst index 845356708..7bd0c6b54 100644 --- a/developer_manual/app/index.rst +++ b/developer_manual/app/index.rst @@ -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 `_ -* :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 `_ + +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 `_ + +Further Information +------------------- +General useful information + +* `git crash course `_ +* :doc:`general/debugging` +* :doc:`general/angular` | `AngularJS Documentation `_ +* :doc:`general/dependencyinjection` | `Pimple `_ + diff --git a/developer_manual/app/general/codereviews.rst b/developer_manual/bugtracker/codereviews.rst similarity index 100% rename from developer_manual/app/general/codereviews.rst rename to developer_manual/bugtracker/codereviews.rst diff --git a/developer_manual/bugtracker/index.rst b/developer_manual/bugtracker/index.rst index 01e5cc11a..34a91a135 100644 --- a/developer_manual/bugtracker/index.rst +++ b/developer_manual/bugtracker/index.rst @@ -4,5 +4,9 @@ Bugtracker .. toctree:: :maxdepth: 1 + :hidden: + + codereviews + kanban .. _Bugtracker: https://github.com/owncloud/core/issues \ No newline at end of file diff --git a/developer_manual/app/general/kanban.rst b/developer_manual/bugtracker/kanban.rst similarity index 99% rename from developer_manual/app/general/kanban.rst rename to developer_manual/bugtracker/kanban.rst index aa7ace67f..893298988 100644 --- a/developer_manual/app/general/kanban.rst +++ b/developer_manual/bugtracker/kanban.rst @@ -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