Changes between Version 1 and Version 2 of structure

Timestamp:

Jun 28, 2011, 12:55:30 PM (13 years ago)

Author:

dennisw

Comment:

--

structure

@@ -1 +1 @@
 = 4. Folder & Files explained =
+Some folders and files that you might need later are listed here with their description.
 
-'''django_gheat/''' Root
->'''external/'''
->>'''django-extensions/''' Extensions for Django. Run the setup.py to install.
->'''gheat/''' The main folder for the heatmap application
->>'''etc/'''
->>>'''color-schemes/'''
->>>[[BR]]'''dots/'''
->>'''management/'''
->>>'''commands/'''
->'''website/''' The main folder for the heatmap website
->>'''static/'''
->>>'''image/'''
->>>[[BR]]'''theme/'''
->>>>'''default/'''
->>'''templates/'''
+== gheat/ ==
+You can find all gheat files here, general settings, models, data import scripts etc.
+
+=== views.py ===
+Mainly responsible for serving heatmap tiles.
+
+=== models.py ===
+Database structure is defined here.
+
+=== management/commands/ ===
+Data import scripts are located here, scripts for importing Kismet, Droidstumbler, and general .csv files are available. Can be run with {{{./manage.py <script>}}}.
+Also, a prerender script is available which uses the gheat-way of rendering (not the tile.py).
+
+=== etc/ ===
+Dot sizes and colours for heatmap tiles are put here.
+
+== website/ ==
+=== filters.py ===
+The main script for heatmap rendering. Renders realtime.
+
+=== urls.py ===
+Redirects urls to their given destination.
+
+=== static/ ===
+Contains the static files for the website such as CSS, Javascripts and images.
+
+==== heatmap.js ====
+Has the init() for the map. Contains settings for the heatmap, basic layers are added here too.
+
+==== heatmap_extensions.js ====
+Most of the javascript extensions are here (except for the plugins like JQuery UI and the colorpicker, though their functions are used here).
+Filters, slider, layer switcher functions and other things are coded here.
+
+==== openstreetmap.js ====
+At the bottom, basic layers are set.
+
+=== templates/ ===
+The website's templates are saved here.