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
  18
  19 * slice:
  20   a django app for dealing with slice views
  21
  22 * templates/
  23 * static/
  24   initially I had started to keep:
  25    * templates (html templates with embedded python-like django chunks)
  26    * static files (css, js, images..)
  27   locally in the app were they belong
  28   but I ended up with having the need to move up and down the tree endlessly
  29   so for the beginning at least, I have moved everything in a unique place
  30   this convention is subject to change
  31
  32 ---
  33 * devel:
  34   no code in there, only various notes and other scripts useful for developers
  35
  36 * all-static: (generated, no need to source-control)
  37   this is where 'manage.py collectstatic' will gather all your static contents if you run a local server
  38   make has convenience targets to refresh this area
  39   $ make clean-static
  40   $ make static
  41
  42 ==================== initial conventions for templates and static
  43
  44 * templates:
  45   we store this under templates/ within the corresponding app, e.g.
  46   auth/templates/login.html
  47   for now this is only about html, but the engine can be used for rendering anything including json or whatever..
  48
  49 * static files:
  50   we chose to have all static files (images, but also javascript and stylesheets) in the various
  51   proj or app where they belong, under a static/ subdir that has this structure:
  52   where-it-belongs/
  53     static/
  54       img/
  55       css/
  56       js/
  57   the stuff I have so far is in myslice/ because it looks common to all apps..
  58
  59
  60