diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CHANGES.md | 16 | ||||
| -rw-r--r-- | doc/INSTALL.md | 29 | ||||
| -rw-r--r-- | doc/THEMES.md | 33 |
3 files changed, 60 insertions, 18 deletions
diff --git a/doc/CHANGES.md b/doc/CHANGES.md index d4b8ca379..753560873 100644 --- a/doc/CHANGES.md +++ b/doc/CHANGES.md @@ -1,3 +1,16 @@ +# Version 0.5 + +## Highlighted features +* It should now be possible to develop the software on OSX +* Base design refactored: CSS simplified and reduced, base design colours removed, now provided in example Alaveteli theme override + +## Upgrade notes +* Themes created for 0.4 and below should be changed to match the new format (although the old way should continue to work): + * You should create a resources folder at `<yourtheme>/public/` and symlink to it from the main rails app. See the `install.rb` in `alaveteli-theme` example theme for details. + * Your styles should be moved from `general/custom_css.rhtml` to a standalone stylesheet in `<yourtheme>/public/stylesheets/` + * The partial at `general/_before_head_end.rhtml` should be changed in the theme to include this stylesheet + + # Version 0.4 ## Highlighted features @@ -16,6 +29,9 @@ * TRACK_SENDER_EMAIL * TRACK_SENDER_NAME * HTML_TO_PDF_COMMAND + * NEW_RESPONSE_REMINDER_AFTER_DAYS + * FORCE_REGISTRATION_ON_NEW_REQUEST +* The config variable `FRONTPAGE_SEARCH_EXAMPLES` is no longer used, so you should remove it to avoid confusion. * Execute `script/rebuild-xapian-index` to create new xapian index terms used in latest version of search (can take a long time) * Install wkhtmltopdf to enable PDFs in downloadable zipfiles. A diff --git a/doc/INSTALL.md b/doc/INSTALL.md index bb8c7de21..a891339e6 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -82,6 +82,18 @@ The following command will set up a user 'foi' with password 'foi': ALTER DATABASE foi_development OWNER TO foi; ALTER DATABASE foi_test OWNER TO foi;" | psql +# Configure email + +You will need to set up an email server (MTA) to send and receive +emails. Full configuration for an MTA is beyond the scope of this +document. However, just to get the tests to pass, you will at a +minimum need to allow sending emails via a `sendmail` command (a +requirement met, for example, with `sudo apt-get install exim4`). + +To receive email in a production setup, you will also need to +configure your MTA to forward incoming emails to Alaveteli. An +example configuration is described in `INSTALL-exim4.md`. + # Set up configs For overall application settings, copy `config/general.yml-example` to @@ -278,4 +290,21 @@ is supplied in `../conf/varnish-alaveteli.vcl`. to `/etc/elinks/elinks.conf`: set document.codepage.assume = "utf-8" + + You should also check that your locale is set up wrongly. See + [https://github.com/sebbacon/alaveteli/issues/128#issuecomment-1814845](this issue followup) + for further discussion. +* **I'm getting lots of `SourceIndex.new(hash) is deprecated` errors when running the tests** + + The latest versions of rubygems contain a large number of noisy + deprecation warnings that you can't turn off individually. Rails + 2.x isn't under active development so isn't going to get fixed (in + the sense of using a non-deprecated API). So the only vaguely + sensible way to avoid this noisy output is to downgrade rubygems. + + For example, you might do this by uninstalling your + system-packaged rubygems, and then installing the latest rubygems + from source, and finally executing `sudo gem update --system + 1.6.2`. + diff --git a/doc/THEMES.md b/doc/THEMES.md index a4793a6fd..c2381b61f 100644 --- a/doc/THEMES.md +++ b/doc/THEMES.md @@ -50,24 +50,21 @@ These means that a file at `vendor/plugins/alavetelitheme/lib/help/about.rhml` will appear in place of the core "about us" file. -There's a special file at -`vendor/plugins/alavetelitheme/lib/views/general/custom_css.rhtml`. -Its contents are automatically included as the last CSS file in the -header of the site. In theory, it should be possible to do quite a -lot of layout customisation by only changing this file. - -Your CSS is likely to reference various images such as a logo, -background images, etc. We don't have a nice way of supporting these -at the moment. The current practice is to place them in -`vendor/plugins/alavetelitheme/public/images/` and then symlink this -directory to somewhere within the `public/` folder in the main -Alaveteli Rails app, e.g.: - - ln -s $ALAVETELI_SITE/vendor/plugins/alavetelitheme/public/images/ public/images/my_images - -...and then refer to these in your custom_css.rhtml like so: - - background-image: url("../my_images/navimg/my-logo.png"); +Rails expects all its stylesheets to live at `<railshome>/public`, +which presents a problem for plugins. Here's how we solve it: the +stylesheet and associated resources for your theme live (by +convention) in at `alavatelitheme/public/`. This is symlinked from +the main Rails app -- see `alavetelitheme/install.rb` to see how this +happens. + +The partial at +`alavetelitheme/lib/views/general/_before_head_end.rhtml` includes the +custom CSS in your theme's stylesheet folder (by convention, in +`alavetelitheme/public/stylesheets/`), with: + + <%= stylesheet_link_tag "/alavetelitheme/stylesheets/custom" %> + +...which will, of course, need changing for your theme. # Customising the request states |