Skip to content

Commit

Permalink
some typo fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
fredkingham committed Mar 27, 2018
1 parent df5fbab commit 771103f
Showing 1 changed file with 15 additions and 18 deletions.
33 changes: 15 additions & 18 deletions doc/docs/reference/patient_list.md
@@ -1,10 +1,9 @@
# `opal.core.patient_lists`
## opal.core.patient_lists

The `patient_lists` module defines a number of classes for working with lists of patients.

## `class PatientList`

### Properties and Class Methods
### class opal.core.patient_lists.PatientList

#### PatientList.allow_add_patient
Whether we should show the add patient button. Defaults to `True`.
Expand All @@ -17,7 +16,7 @@ A custom comparator service to set sort order within a list. Defaults to None.
Further information on Comparators can be found in the [Opal Guides](../guides/list_views.md#customising-sort-order-of-episodes) section.

#### PatientList.direct_add
Further information is available in the [Guides section](../guides/list_views.md#direct-add)
Further information is available in the [Guides section](../guides/list_views.md#direct-add).

#### PatientList.display_name
How we want to refer to this list on screen to users.
Expand All @@ -26,13 +25,13 @@ How we want to refer to this list on screen to users.
Passing an integer to `PatientList.order` will allow you to control the order of display of Patient Lists in dropdowns and other views. Further information is available in the [Guides section](../guides/list_views.md#ordering-lists).

#### PatientList.queryset
Further information is available in the [Guides section](../guides/list_views.md#querysets)
Further information is available in the [Guides section](../guides/list_views.md#querysets).

#### PatientList.schema
Further information is available in the [Guides section](../guides/list_views.md#schemas)
Further information is available in the [Guides section](../guides/list_views.md#schemas).

#### PatientList.slug
Further information is available in the [Guides section](../guides/list_views.md#slug)
Further information is available in the [Guides section](../guides/list_views.md#slug).

#### PatientList.template_name
If you want to over-ride the default Patient List template `opal/templates/patient_list/spreadsheet.html` with a custom template, or set the Card or Table PatientList templates, you can specify the path of the custom template (relative to `/myapp/templates/`) in this property.
Expand All @@ -44,46 +43,44 @@ class MyPatientList(PatientList):
template_name = 'my_layout.html'
```

will look for a template at `/myapp/templates/my_layout.html`
Will look for a template at `/myapp/templates/my_layout.html`.

#### PatientList.visible_to
Further information is available in the [Guides section](../guides/list_views.md#access-control)
Further information is available in the [Guides section](../guides/list_views.md#access-control).



## `class TaggedPatientList`
### class TaggedPatientList
Tagged Patient Lists inherit from Patient Lists - as such they have all of the same methods and properties of Patient Lists.

### Properties

#### TaggedPatientList.tag
The main, or parent tag for this list. Should be lowercase, with no numbers or dashes. Underscores are OK. Further information is available in the [Guides section](../guides/list_views.md#tagged-patient-lists)
The main, or parent tag for this list. Should be lowercase, with no numbers or dashes. Underscores are OK. Further information is available in the [Guides section](../guides/list_views.md#tagged-patient-lists).

#### TaggedPatientList.subtag
The child tag for this list. Should be lowercase, with no numbers or dashes. Underscores are OK.



## `class TabbedPatientListGroup`
### class TabbedPatientListGroup
Groups Patient Lists together, to display as tabs at the top of any list in the group.
![patientlist-tabbed-view](../img/patientlist-tabbed-view.png)

### Properties and Class Methods
![patientlist-tabbed-view](../img/patientlist-tabbed-view.png).

#### TabbedPatientListGroup.for_list
Returns the group for a given PatientList. Raises ValueError if not passed a PatientList
Returns the group for a given PatientList. Raises ValueError if not passed a PatientList.

#### TabbedPatientListGroup.get_member_lists
A hook for dynamically customising the members of this list group. Returns an iterable of PatientLists. Defaults to the `.member_lists` property.

#### TabbedPatientListGroup.get_member_lists_for_user
Returns an iterable of the visible member lists for a given USER
Returns an iterable of the visible member lists for a given user.

#### TabbedPatientListGroup.member_lists
A list containing the `PatientList` subclasses in this group.

#### TabbedPatientListGroup.visible_to
Predicate function to determine whether this list is meaningfully visible to this USER
Predicate function to determine whether this list is meaningfully visible to this user.



Expand Down

0 comments on commit 771103f

Please sign in to comment.