Permalink
Browse files

Some text tweaks to the notes docs, updating customisation with new d…

…efaults.
  • Loading branch information...
1 parent 8d9d08d commit a885d6d5498c73b17235ac5a0216efdf81981a5a @dracos dracos committed Jul 26, 2012
Showing with 60 additions and 57 deletions.
  1. +2 −2 notes/cobranding.txt
  2. +27 −6 notes/code_structure.txt
  3. +31 −21 notes/customisation.pod
  4. +0 −5 notes/glossary.txt
  5. +0 −23 notes/location_related_flow.txt
View
@@ -1,5 +1,5 @@
-Notes on adding a co brand
---------------------------
+Notes on adding a cobrand
+-------------------------
Basic steps
View
@@ -1,11 +1,32 @@
The code is broken down into the following sections:
-website: code to display the website and handle user submissions
+* Website: code to display the website and handle user submissions
-backend: send alerts to the councils, work out who should get the alert, various
-confirmation emails
+* Backend: send reports to the councils, work out who should get alerts,
+ send questionnaires, and so on
-mobile apps: currently for iPhone and Android - two separate apps
+* Mobile apps: currently for iPhone and Android - two separate apps, with
+ a PhoneGap app being worked on.
+
+* Utility scripts: odds and ends
+
+Main top level directories
+--------------------------
+
+android Native Android phone app source code
+bin Scripts, ranging from the ones that send reports to councils to
+ one-offs to fix data import errors
+commonlib Shared mySociety functions
+conf Configuration file, needed Debian packages, example Apache config,
+ and example crontab
+db Schema for PostgreSQL database
+iphone Native iPhone phone app source code
+local Local store of Perl modules
+locale Translation files
+perllib Source code of the FixMyStreet project
+phonegap PhoneGap mobile app, in progress
+script Catalyst management commands
+t Test suite
+templates Email and web templates
+web Front end static files; CSS, JS, images
-utility scripts: odds and ends - eg importing photos from Flickr tagged
-'fixmystreet'
View
@@ -35,36 +35,46 @@ The full set of templates is stored in the default Cobrand and if no
equivalent template is found in a Cobrand directory FixMyStreet will
use the default template.
+By default, the Default cobrand uses the templates in
+C<templates/web/fixmystreet> that are used for the www.fixmystreet.com website.
+If you want to base your design off this, you can inherit from those templates,
+rather than the "bare bones" default ones.
+
At a bare minimum you will probably want to copy the header and footer
-web templates found in C<templates/web/default/header.html> and
-C<templates/web/default/footer.html> into your Cobrand and make appropriate
+web templates found in C<templates/web/fixmystreet/header.html> and
+C<templates/web/fixmystreet/footer.html> into your Cobrand and make appropriate
changes.
The other template you should make your own version of is the FAQ which
-is in C<templates/web/default/faq-en-gb.html>
+is in C<templates/web/fixmystreet/faq/faq-en-gb.html>
=head1 CSS
-The CSS is stored in web/css/ under which there are directories for Cobrands
-but this is only by custom. The loading of the css is controled by the header
-templates. Note that FixMyStreet uses sccs files to generate our CSS so by there
-are no CSS files until C<bin/make_css> has been run.
+The CSS is stored in web/cobrands/ under which there are directories for Cobrands.
+The loading of the CSS is controlled by the header templates. Note that
+FixMyStreet uses SCSS and Compass to generate our CSS so there are no CSS files
+until C<bin/make_css> has been run.
-The CSS provided with FixMyStreet uses CSS3 media queries in order to adapt
-the layout to work on different devices.
+The CSS provided with FixMyStreet uses CSS3 media queries in a mobile first
+format order to adapt the layout to work on different devices.
-The CSS is structured into two main files:
+The CSS is structured into main files:
=over
-=item core.css
+=item base.css
+
+This contains all the styling for the content of the pages in a mobile sized browser.
+
+=item layout.css
-This contains all the styling for the content of the pages. This should not
-need changed unless you are significantly changing the layout of the site.
+This contains all the styling for the content of the pages in a desktop sized browser.
-=item main.css
+=item _colours.css
-This contains the CSS for the header and footer as well as the colour scheme.
+This contains basic colour information, so you can easily make a site that
+looks different simply by copying these files to your own cobrand CSS
+directory, and changing the colours.
=back
@@ -174,23 +184,23 @@ Return 0 to disable the display of uploaded photos.
=item area_types
-If you are using MaPit alongside FixMyStreet this should return a
+If you are using MapIt alongside FixMyStreet this should return a
list of the area type codes that the site will handle. This is used
-to filter the data returned from MaPit so that only appropriate areas are
+to filter the data returned from MapIt so that only appropriate areas are
displayed.
=item remove_redundant_councils
-This is used to filter out any overlapping jurisdictions from MaPit results
+This is used to filter out any overlapping jurisdictions from MapIt results
where only one of the authorities actually has reponsability for the events
-reported by the site. An example would be be a report in a city where MaPit
+reported by the site. An example would be be a report in a city where MapIt
has an id for the city council and the state council but problems are only
-reported to the state. In this case you would remove the id for the the city
+reported to the state. In this case you would remove the id for the city
council from the results.
=item short_name
-This is used to turn the full authority name returned by MaPit into a short
+This is used to turn the full authority name returned by MapIt into a short
name.
=back
View
@@ -1,5 +0,0 @@
-Unfamiliar terms that you may come across in the code:
-
-MaPit: The mySociety database and web service that maps postcodes and points to
-current or past administrative area information and polygons for all the United
-Kingdom. http://mapit.mysociety.org/
@@ -1,23 +0,0 @@
---- '/' ---
-
- Homepage has a search form that submits to /around. There is no location
- processing done on the home page. Any queries sent to the homepage are
- redirected to /around.
-
---- '/around' ---
-
- SEARCH: allows user to search for a location using postcode or other text.
- If nothing matched error shown. If multiple match show alternatives.
-
- LIST: If a search could be resolved to a lat/lon, or a lot/lon was in query
- show matches near that location.
-
- PARTIAL: If there is a partial token show a message when searching. When a
- match is found redirect to '/report/new' for the partial to be completed.
-
---- '/report/new' ---
-
- Requires a lat/lng, or a tile click, or a partial report with a location
- stored. If no location can be deteremined redirects back to '/around'. All
- form information is lost but the partial token is preserved.
-

0 comments on commit a885d6d

Please sign in to comment.