PabloLeon / model-driven-journalism

0 stars 0 forks source link

Document dummy specification #15

Closed PabloLeon closed 7 years ago

PabloLeon commented 7 years ago

To get a better idea what the requirements of the article engine should be we need an example dummy file that would generate the NHS waiting times article.

PabloLeon commented 7 years ago

Json spec for the article:

Markdown spec for the scenes

Components are specified with [ ], as in idyll-lang.

Components: [UKmap selectedRegion zoom] [ TODO items as choices both checkbox and text input or range] [ Suggestions ] [ Prediction Card ] [ PredictionSummary ]

All actions simply add to the inventory and all conditional renderings/interaction (for example which items are displayed in the prediction card) are conditional on the inventory items. So the inventory contains items for the geolocation (the relevant NUTS region and coordinates), the choices for the targets and success criteria and all predictors chosen).

PabloLeon commented 7 years ago

see #14 , JSON contains inventory array and a dictionary of id: actiontype, actionparameter specifcations that correspond to actions in the package.