We need to implement the lessons app

[timlinux]

This is the specification for a new lessons app in projecta. The idea is that each project can create one or more lessons that teach people how to use their app. The lessons follow the same layout and approach as our work here:

https://github.com/kartoza/QGISTrainingWorkshop

The app should implement the following models / schema:

We will add word / character count limits to the various sections to constrain the content to around 2 pages. The outcome should be:

1. everything should be multilingual supported so that you can add translations for all parts of the lesson and render it in different languages
2. a form where you can CRUD lessons
3. a subform where you can CRUD lesson questions
4. a subform where you can CRUD the answers for questions
5. a subform where you can CRUD specifications for the exercise part
6. a form where you can CRUD sections
7. a form where you can drag and drop to order sections
8. a form where you can drag and drop to order specifications (or do in the same step as creation would be better)
9. a form where you can drag and drop to order questions (od do in the same place as creation would be better)
10. form where you can drag and drop the lesson order within a section
11. an index page that lists all lessons, grouped by section for a project
12. a view where the lesson is rendered similar to the example below:

On the view we should add logic (@ann26 has previously done similar) to render the view as a PDF.

In a future ticket we will extend the lessons index page with a form which lets you tick a collection of lessons and generate a PDF containing only those lessons.

There should be an additional option to set a stylesheet on a per-project basis that will inform the look and feel of the worksheets. Maybe more simply we can just do this by letting the user provider two or three accent colours that are used for the margin icons, underlines etc. The project logo can appear at the start of every page.

[timlinux]

CC for your interest @charlotte-morgan

[Charlotte-Morgan]

@timlinux - thanks for tagging me here. I hope CRUD docs are not the same as CRAP maps :)

[timlinux]

@Charlotte-Morgan :-)

CRUD - Create, Read, Update, Delete

[ismailsunni]

More task:

• [ ] new project role here for lessons_manager...and make it editable by staff, lessons manager or project owner...
• [ ] a subform where you can CRUD specifications for the further reading

[ismailsunni]

Tasks: https://docs.google.com/spreadsheets/u/1/d/1hpCL1ZreIDWBreaF_nWuqwrQROV4bRmAS3tcvaCefyk/edit?usp=drive_web

[ismailsunni]

Hi @timlinux

new project role here for lessons_manager...and make it editable by staff, lessons manager or project owner...

Can we just use group permission for this? And check the permission for CRUD-ing lesson?

[timlinux]

Can we just use group permission for this? And check the permission for CRUD-ing lesson?

I think it is better model it as I described @ismailsunni - the permissions are specific to a particular project or organisation - IIRC the groups in django will be global across all projects which wont work.

@Gustry @ismailsunni @myarjunar Sorry I didnt make it clear but we should copy the interactions from changelogs: Show the section / lesson list in the side box, clicking on the box will take you to a menu of all sections / lessons, clicking on a specific lesson will take you to a read only render of that lesson

At the top right corner of the read only lesson render (which should look just like the worksheet example above) should show three icons:

1. print icon (print to pdf using js pdf generator)
2. edit pencil icon (available to lesson managers, project admins and staff only) - takes you to the lesson form to tweak it
3. remove icon (available to lesson managers, project admins and staff only) - lets you remove the lesson

[timlinux]

Here are the mappings of the worksheet fields to the content on the rendered worksheet:

1-introduction-to-inasafe copy.pdf

[Gustry]

Notes from @timlinux on Gitter: :point_up: January 24, 2018 8:07 AM

• [ ] Make the table headers in the report use the project accent colour for the background (or a lightened version of it)
• [x] Get the references / further reading part working
• [x] Remove the check makes next to the answers (it removes the challenge somewhat) make some behaviour to show the answer ticks on mouse over of the words ‘show answers’ which you need to add at the bottom of the questions
• [x] [HALF] find a better monochrome icon for further reading (use bootstrap icon if possible)
• [ ] I think we do need to add moderator behaviour for the worksheets - can you implement the same patterns as we have done for changelog but only at the worksheet and section models (the dependent models like qnswers will anyway be hidden or shown based on their parent)
• [x] leader text needs to be in italics
• [x] [HALF] The first image in the worksheet should span the page width and the text above or under it - the form should prompt the user to give an image in a letterbox aspect ration for best results - maybe even recommend a size)
• [x] The second image in teh worksheet - can you copy the behaviour from changelog that lets you get a popped out full size view of the image when you click it (without any etext below saying click for larger image so it does not mess up our print layout)
• [ ] Look and see if you can add js2pdf support to the rendered page so we can make a PDF from it
• [ ] Start thinking of another view like the contents page view but with checkboxes for which modules you want to see that then makes a long page with each lesson rendered read only one after the other and with js2pdf support
• [ ] Second highest priority is adding moderation support as there are some worksheets in our collection that are quite low quality and I want to hold them back from general viewing until they have been tidied up
• [x] For the check box next to answers I still think it is better to have the behaviour on mouse over of the question or similar because if I am lecturing using the materialis on screen I have to log out typically I want to be logged in so I can make quick fixes to the content as I encounter things students are not clear about
• [x] another todo: For inputs that support markdown we should indicate that in the help text

[timlinux]

• [x] For the table on the rendered lesson: The table should not be rendered if it is empty (we should still have the hover over star to add a specification). Once the first spec. is added the table can be rendered.

[Gustry]

For the table on the rendered lesson: The table should not be rendered if it is empty (we should still have the hover over star to add a specification). Once the first spec. is added the table can be rendered.

This one looks weird for me. We have no idea that there is hidden table and a hidden button to add a requirement It's quite hard to find the add new requirement button. Maybe we should still add a text if there is no table?

[timlinux]

This one looks weird for me. We have no idea that there is hidden table and a hidden button to add a requirement It's quite hard to find the add new requirement button. Maybe we should still add a text if there is no table?

It also looks wierd having an empty table. As we discussed on zoom though, just make the whole div of the exercise section a hover target.

[timlinux]

More niggles:

• [x] When you submit a new lesson there is no way afterwards to attach files or set the youtube or author details

[Gustry]

I thought the table is compulsory. If it's compulsory, when it's empty, it reminds you to fill it. You said we don't want a placeholder.

[christodewit]

• [x] InaSafe worksheets section: Displaying the Title instead of the Module name

[Gustry]

When you submit a new lesson there is no way afterwards to attach files or set the youtube or author details

I can't replicate this one. I can add new/edit youtube link or author.

[christodewit]

• [x] When I try to remove an answer the following happens:

• [x] When I create the second question the following happens:

[christodewit]

• [x] Creating a table using Markdown: This is not displaying correctly in Projecta

Markdown in GitHub:

Display in GitHub:

Display in Projecta:

[Gustry]

@christodewit I moved the table with markdown to a separate issue: #723

I fixed your first problem when you remove an answer. But I can't replicate your bug about adding a second question.