diff --git a/README.md b/README.md index 7224d43..f210887 100644 --- a/README.md +++ b/README.md @@ -23,9 +23,9 @@ To generate the majority of the code, run **NOTE THAT** currently this relies on development versions of the ADL framework; in order to work for you locally, this requires that you check out the development branches of each of -1. [adl-support](https://github.com/simon-brooke/adl-support/); -2. [adl](https://github.com/simon-brooke/adl); and -3. [lein-adl](https://github.com/simon-brooke/lein-adl) +1. [adl-support](https://git.journeyman.cc/simon/adl-support/); +2. [adl](https://git.journeyman.cc/simon/adl); and +3. [lein-adl](https://git.journeyman.cc/simon/lein-adl) And, in each repository in the order listed above, run diff --git a/pastoralist.adl.xml b/pastoralist.adl.xml index 8f87077..1112bf7 100644 --- a/pastoralist.adl.xml +++ b/pastoralist.adl.xml @@ -1,13 +1,23 @@ - - + A web-app intended to be used by pastoralists in managing - pastures, grazing, and animals. + pastures, grazing, and animals. + + TODO: If this is intended to share data between systems -- as it must, if + for example, it is tracking the movement of animals between holdings -- + then + + 1. Keys must include a unique identifier of the instance on which they + were created, as serial identifiers will not be unique across machines; + 2. It had better implement [ActivityPub](https://www.w3.org/TR/activitypub/). + All holdings used to the system @@ -28,7 +38,7 @@ version="0.0.1"> - + A user is a person authorised to see data on a holding. Some users (e.g. vets, farm secretaries) may be authorised to see data on many holdings. @@ -71,7 +81,7 @@ version="0.0.1"> Records are not normally deleted from this system because - of historical data integrity; we may want to trace the history of an + of historical data integrity; we may want to trace the history of a pasture even after pasture boundaries have been changed. Indeed, if we treat subdivisions as pastures (which would be quite sensible), @@ -110,6 +120,7 @@ version="0.0.1"> + @@ -119,20 +130,41 @@ version="0.0.1"> - + + + Not confident of this. It might be better to store a single character (or even + boolean), because for i18n reasons storing a natural language token is going + to make data from different systems non-comparable. + + - + + + Store scientific/latin name for species. TODO: 32 characters may not be enough. + + - + + + + + + Is there a canonical name for a breed? Is a Texan 'Galloway' the same breed + as a Galloway 'Galloway'? What even is a breed? Should we store details of + a breed society or other body which adjudicates membership of the breed? + + + @@ -144,7 +176,7 @@ version="0.0.1"> - + The user who recorded this event. @@ -165,7 +197,7 @@ version="0.0.1"> - + @@ -191,7 +223,7 @@ version="0.0.1"> - + @@ -201,19 +233,13 @@ version="0.0.1"> - An image of the canvasser, so that other members of their - team can recognise them. - - Information the canvasser supplies about themselves; an introduction. + Information the user supplies about themselves; an introduction. - Does a canvasser record need a phone field? There is a phone - field on the elector record. I suppose, for under-16 canvassers, there may - be no elector record.