devel:django_introduction
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
devel:django_introduction [2008/09/24 09:25] jodal It is now recommended to keep the nav.django.urls.* modules in the various subsystems instead of in lib-python. |
devel:django_introduction [2009/06/17 08:46] jorabra Add missing word |
||
|---|---|---|---|
| Line 8: | Line 8: | ||
| ===== nav.django package ===== | ===== nav.django package ===== | ||
| - | As NAV has not used Django from the very beginning, NAV does not strictly follow the Django convention of multiple apps with their own models, views, etc. To plug NAV into the Django framework some glue is needed. This glue and other common Django-related code is located in the ''nav.django'' Python package, which is located in ''subsystem/lib-python/src/nav/django''. | + | As NAV has not used Django from the very beginning, NAV does not strictly follow the Django convention of multiple apps with their own models, views, etc. To plug NAV into the Django framework some glue is needed. This glue and other common Django-related code is located in the ''nav.django'' Python package, which is located in ''subsystem/lib-python/nav/django''. |
| ==== Settings ==== | ==== Settings ==== | ||
| Line 18: | Line 18: | ||
| ==== URL configuration ==== | ==== URL configuration ==== | ||
| - | In ''nav.django.urls'' the root URL configuration for all things Django in NAV is located. ''nav.django.urls'' is not only a module, but also a package. The ''%%__init__.py%%'' file in the package imports all submodules it can find in the file system, calls ''get_urlpatterns()'' on all the submodules, and combines the results into one ''urlpatterns'' list, as all Django URL configurations does. | + | The root URL configuration for all Django-related applications in NAV is located in ''nav.django.urls''. It is not only a module, but also a package. The ''%%__init__.py%%'' file in the package imports all submodules it can find in the directory, calls ''get_urlpatterns()'' on all the submodules, and combines the results into one ''urlpatterns'' list, as all Django URL configurations does. |
| When creating a new Django app, create a new submodule for your app in the ''subsystem/your_app/nav/django/urls/'' folder, run ''make install'' in your app to install the module into the ''nav.django.urls'' package, and the NAV installation will find your app. If somebody else installs URLconf glue into ''nav.django.urls'' they will not affect the URL configuration for your app, unless they use exactly the same name for the submodule as you did. For details, check out the ''ipdevinfo'' subsystem and its ''Makefile.in''. | When creating a new Django app, create a new submodule for your app in the ''subsystem/your_app/nav/django/urls/'' folder, run ''make install'' in your app to install the module into the ''nav.django.urls'' package, and the NAV installation will find your app. If somebody else installs URLconf glue into ''nav.django.urls'' they will not affect the URL configuration for your app, unless they use exactly the same name for the submodule as you did. For details, check out the ''ipdevinfo'' subsystem and its ''Makefile.in''. | ||
| Line 87: | Line 87: | ||
| Finally, the folder ''media/'' contains all static media which is needed by the app. Typically, this should be ''media/style/'' for CSS-files, ''media/js/'' for JavaScript, and ''media/images/'' for images. Files should typically be named after the app to avoid name collisions with other apps when installed, i.e. ''media/style/ipdevinfo.css'' and subfolders like ''media/images/ipdevinfo/''. | Finally, the folder ''media/'' contains all static media which is needed by the app. Typically, this should be ''media/style/'' for CSS-files, ''media/js/'' for JavaScript, and ''media/images/'' for images. Files should typically be named after the app to avoid name collisions with other apps when installed, i.e. ''media/style/ipdevinfo.css'' and subfolders like ''media/images/ipdevinfo/''. | ||
| + | |||
| + | Configuration files should be in the ''config/'' folder in the source tree, and installed into ''$NAVHOME/etc/appname/''. | ||
| How to install everything mentioned here is defined in ''Makefile.in''. | How to install everything mentioned here is defined in ''Makefile.in''. | ||
devel/django_introduction.txt ยท Last modified: 2010/01/13 11:30 by eide
Page Tools
