X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=README;h=92724d1f1a1462857b8ca64aad893ef326c86600;hb=2d486f53c3e3acb881ddca8e3625f4dee7bc81f7;hp=a8a6bbc8a2974c39533076f2ce868adfd1bd821e;hpb=cf3e1a8d59fdcd6a0234ff79d9800022bbb0ed50;p=unfold.git diff --git a/README b/README index a8a6bbc8..92724d1f 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -This file documents the contents of this module +his file documents the contents of this module See the devel/ subdir for more devel-oriented doc. @@ -20,16 +20,30 @@ See the devel/ subdir for more devel-oriented doc. * init django $ manage.py syncdb -[[ at this point point it *might* be needed to run -$ make allst - but as far as running a local server is concerned you should be good without that - feedback on this is appreciated]] + +* gather static files +$ make static * run a local server: $ manage.py runserver 0.0.0.0:8000 +-- or -- my advice: +$ devel/server-loop.sh +when you just need to hit ^C yourself when your static files need to be refreshed - see below * use it from your browser +.......... NOTES on using the development server +. first off, running manage.py runserver is provided by django as a development convenience but SHOULD NOT be used in production +. second, when you do use it for developement purposes, please be aware that: +.. the recommended layout for the various files and pieces (py, html, js and css) qith django is really painful + we should use e.g. plugins/simplelist.py, plugins/templates/plugins.html, plugins/static/js/simplelist.js and plugins/static/css/simplelist.css +.. as that does not make sense IMHO, I've rewritten the tool for gathering these pieces in such a layout but from a completely flat codebase + I mean I want to be able to store all the files building a plugin in a single (git) directory + Of course it's a completely different matter once the service is packaged and installed, these files of course get properly separated. +.. as a result it is a little bit less convenient to use the development server + when you change the layout of your static and template files, you might need to re-run 'make static', so it is recommended to use + devel/server-loop.sh instead + ==================== Status @@ -108,11 +122,14 @@ I've tried to keep track of the version I picked and to have an easy upgrade pat * insert_above: a third-party django app for adding on-the-fly mentions to css or js files that need to go in the header -* templates/ - * some global templates (django templates, i.e. (essentially html) fragments that can be specializied) - more on this below +* trash/ + rough/preliminary views in here - as the name suggests this is temporary + +* views/ + will receive actual views over time + currently has some global html templates as well -* static/ +* third-party/ * third party stuff (bootstrapfs, jquery, datatables) * + some global static files (css, js, images..) see more about that below too @@ -123,34 +140,32 @@ I've tried to keep track of the version I picked and to have an easy upgrade pat ========== automatically generated * all-static: (generated, no need to source-control) - this is where 'manage.py collectstatic' will gather all your static contents if you run a local server + this is where 'make static' will gather all your static contents if you run a local server make has convenience targets to refresh this area - $ make clean-static $ make static + $ make clean-static * myslice.sqlite3 this is where django stores its own stuff, as per settings.py - -==================== conventions for templates and static +==================== conventions for templates * templates: we store this under templates/ within the corresponding app, e.g. auth/templates/login.html - for now this is mostly about html, but the engine can be used for rendering anything including js(on) or whatever.. + for now this is mostly about html, but the engine can be used for rendering anything + including js(on) or whatever.. + +==================== conventions for static files * static files: we chose to have all static files (images, but also javascript and stylesheets) in the various proj or app where they belong, under a static/ subdir that has this structure: where-it-belongs/ - static/ img/ css/ js/ -NOTE. in essence any of these files can be moved around (from e.g. one templates/ dir to another) -at any time without any change needed in the code - * filenames / locations you can run the following make targets to have a summary of where things are @@ -159,27 +174,13 @@ at any time without any change needed in the code -- or -- $ make list-all - as far as possible it's great to have things named the same after e.g. say a plugin name - like e.g. - plugins/quickfilter.py - plugins/templates/quickfilter.html - plugins/static/js/quickfilter.js - plugins/static/css/quickfilter.css - - it's sometimes not working though, so here are a few additional conventions - - the global layout (for now I needed only one) is named layout-myslice.html - it provides the global layout with one menu stuck on top and 2 divs 3/4 1/4 - the views that I currently have are all named in templates/view-<>.html - they all extend a layout - they should/could admittedly move where they belong (in auth/slice/engine) - so that they would go with their views.py code, but for now it's impler this way +* plugins + use a naming scheme as simple as possible + like e.g. + plugins/quickfilter/quickfilter.py + plugins/quickfilter/quickfilter.html + plugins/quickfilter/quickfilter.js + plugins/quickfilter/quickfilter.css - and there are 3 'widgets' (login, logout, and topmenu) - these could maybe be best implemented as a plugin now that I have the right model for that - however esp. for the login/logout I'm not quite sure this will remain over time - so for now it's good enough like this -So in summary there's still room for a lot of improvement on this particular topic.. -At the very least topmenu should be made a plugin, and maybe also login/logout