From 8efc599bc1c20bfd8172e96a7e27f196d08adf47 Mon Sep 17 00:00:00 2001
From: Thierry Parmentelat <thierry.parmentelat@inria.fr>
Date: Fri, 21 Dec 2012 17:57:16 +0100
Subject: [PATCH] mostly all the resources (templates/static) should be at
 their right location - see README for more on that one

---
 Makefile                                      |   4 +-
 README                                        |  43 ++++++++++++++++--
 .../static}/img/form_input_password.png       | Bin
 engine/plugin.py                              |   2 +-
 .../{plugin_setenv.js => plugin-setenv.js}    |   0
 5 files changed, 42 insertions(+), 7 deletions(-)
 rename {static => auth/static}/img/form_input_password.png (100%)
 rename engine/templates/{plugin_setenv.js => plugin-setenv.js} (100%)

diff --git a/Makefile b/Makefile
index 8206a484..4168c6b4 100644
--- a/Makefile
+++ b/Makefile
@@ -23,9 +23,11 @@ list-js: force
 	@find . -type f -name '*.js' | grep -v '/all-static/'
 list-css: force
 	@find . -type f -name '*.css' | grep -v '/all-static/'
-list-img:
+list-img: force
 	@find . -type f -name '*.png' | grep -v '/all-static/'
 
+list-all list-resources: list-html list-js list-css list-img
+
 #################### manage static contents (extract from all the modules into the single all-static location)
 static: force
 	./manage.py collectstatic --noinput 
diff --git a/README b/README
index 7aa08fcd..52c5e419 100644
--- a/README
+++ b/README
@@ -85,11 +85,13 @@ not much effort has been put into coming up with a nice layout and all, feel fre
   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
+
 * static/
-  some global stuff:
-   * templates (django templates, i.e. (essentially html) fragments that can be specializied)
-   * static files (css, js, images..)
-  see more about that below
+   * third party stuff (bootstrapfs, jquery, datatables)
+   * + some global static files (css, js, images..)
+     see more about that below too
 
 * devel:
   no code in there, only various notes and other scripts useful for developers
@@ -122,7 +124,38 @@ not much effort has been put into coming up with a nice layout and all, feel fre
       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
+
+  $ make list-html list-js list-css list-img
+  -- 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
+
+    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
diff --git a/static/img/form_input_password.png b/auth/static/img/form_input_password.png
similarity index 100%
rename from static/img/form_input_password.png
rename to auth/static/img/form_input_password.png
diff --git a/engine/plugin.py b/engine/plugin.py
index 4fb42119..e7dcfa9c 100644
--- a/engine/plugin.py
+++ b/engine/plugin.py
@@ -111,7 +111,7 @@ class Plugin:
         settings_json = json.dumps (js_env, separators=(',',':'))
         env ['settings_json' ] = settings_json
         # compute plugin-specific initialization
-        js_init = render_to_string ( 'plugin_setenv.js', env )
+        js_init = render_to_string ( 'plugin-setenv.js', env )
         print 'js_init',js_init
         self.add_js_chunks (request, js_init)
         
diff --git a/engine/templates/plugin_setenv.js b/engine/templates/plugin-setenv.js
similarity index 100%
rename from engine/templates/plugin_setenv.js
rename to engine/templates/plugin-setenv.js
-- 
2.43.0