Skip to content

Commit

Permalink
Update changelog to note new logo setting, and add some documentation…
Browse files Browse the repository at this point in the history
… for Opal settings.
  • Loading branch information
davidmiller committed Mar 19, 2017
1 parent 228ab5f commit a7deb6d
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 2 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Expand Up @@ -19,6 +19,12 @@ Adds a utility method to the `Episode` service that returns a human readable pat

Enhances the API available for plugins to include javascript and css by adding methods on `opal.core.plugins.OpalPlugin`

#### OPAL_LOGO_PATH

This new setting allows applications to set the path at which the app logo is served.
If `OPAL_LOGO_PATH` is set, the value is passed to the `{% static %}` templatetag to set the `src` atribute
of an image in the default application header and login screen.

### 0.8.1 (Minor Release)

#### Cookies for the future
Expand Down
2 changes: 1 addition & 1 deletion doc/docs/opaldocs.css
Expand Up @@ -20,7 +20,7 @@ h1 {
margin-bottom: 24px;
}
h2 {
font-size: 36px;
font-size: 30px;
}
h3 {
font-size: 24px;
Expand Down
3 changes: 2 additions & 1 deletion doc/docs/reference/reference_guides.md
Expand Up @@ -53,7 +53,8 @@ The following reference guides are available:

|
-|-
[Settings](settings.md) | Opal settings
[Changelog](changelog.md) | Opal Changelog
[Upgrading](upgrading.md) | Upgrading between Opal> versions
[Upgrading](upgrading.md) | Upgrading between Opal versions
[Javascript dependencies](javascript/javascript_dependencies.md)| External javascript libraries available |
[Testing](testing.md) | Testing
24 changes: 24 additions & 0 deletions doc/docs/reference/settings.md
@@ -0,0 +1,24 @@
# Opal Settings

Opal applications provide a number of settings in the `settings.py` of your application.

## OPAL_BRAND_NAME

The human readable form of your application name.
Displayed in the header by default.
Scaffolded applications start with whatever is passed in to `opal startproject`.

## OPAL_LOG_OUT_DURATION

Opal will log users out if they have been inactive for greater than this value.
Scaffolded applications set this to 15 minutes by default. Unit is milliseconds.

## OPAL_LOGO_PATH

If `OPAL_LOGO_PATH` is set, the value is passed to the `{% static %}` templatetag to set the
`src` atribute of an image in the default application header and login screen.

## VERSION_NUMBER

The version number of your application. Displayed in the header by default.
Scaffolded applications start at `<0.0.1`.
1 change: 1 addition & 0 deletions doc/mkdocs.yml
Expand Up @@ -68,6 +68,7 @@ pages:
- Detail Views: reference/detail_views.md
- Patient Lists: reference/patient_list.md
# Misc
- Settings: reference/settings.md
- Changelog: reference/changelog.md
- Testing: reference/testing.md
- Upgrading: reference/upgrading.md
Expand Down

0 comments on commit a7deb6d

Please sign in to comment.