README

   1 This file documents the contents of this module
   2
   3 See devel/ for more devel-oriented doc.
   4
   5 ==================== 1st level subdirs
   6 * myslice:
   7   this is the sjango project', where to look for
   8   . settings
   9   . urls
  10   . common static files
  11
  12 * insert_above:
  13   a third-party django app for adding on-the-fly mentions to css or js files that need to go in the header
  14   much like our past drupal_set_html_head()
  15
  16 * auth:
  17   a django 'app' that deals with authentication; see especially
  18   auth.backend.MyCustomBackend
  19   for how to use a separate authentication system,
  20   as well as settings.py for how to enable it
  21
  22 * slice:
  23   a django app for dealing with slice views
  24
  25 * templates/
  26 * static/
  27   initially I had started to keep:
  28    * templates (html templates with embedded python-like django chunks)
  29    * static files (css, js, images..)
  30   locally in the app were they belong
  31   but I ended up with having the need to move up and down the tree endlessly
  32   so for the beginning at least, I have moved everything in a unique place
  33   this convention is subject to change
  34
  35 ---
  36 * devel:
  37   no code in there, only various notes and other scripts useful for developers
  38
  39 * all-static: (generated, no need to source-control)
  40   this is where 'manage.py collectstatic' will gather all your static contents if you run a local server
  41   make has convenience targets to refresh this area
  42   $ make clean-static
  43   $ make static
  44
  45 ==================== initial conventions for templates and static
  46
  47 * templates:
  48   we store this under templates/ within the corresponding app, e.g.
  49   auth/templates/login.html
  50   for now this is only about html, but the engine can be used for rendering anything including json or whatever..
  51
  52 * static files:
  53   we chose to have all static files (images, but also javascript and stylesheets) in the various
  54   proj or app where they belong, under a static/ subdir that has this structure:
  55   where-it-belongs/
  56     static/
  57       img/
  58       css/
  59       js/
  60   the stuff I have so far is in myslice/ because it looks common to all apps..
  61
  62
  63