johnRedden / TextbookProject

Textbook project start.
0 stars 0 forks source link

Exercises per Objective #17

Closed FelixVicis closed 8 years ago

FelixVicis commented 8 years ago

We're finally to this point.

Exercises

At the end of an objective, there should be a list of problems to work on. We will need to decide such things as how detailed we should get with each one, ect.

For now, we're going to hit minimum viable product. We need an html doc tied and retrievable per objective. Really, all we're doing is adding one more layer to structure at this point.

johnRedden commented 8 years ago

Yeah we need to sit down and break down and generalize what an exercise is...

Exercise: Instruction: HTML Question: HTML Answer: HTML Objective: Reference to corresponding objective.

We will need to standardize the list of possible instructions.

On Thu, May 5, 2016 at 8:23 PM, Allen Mills notifications@github.com wrote:

We're finally to this point. Exercises

At the end of an objective, there should be a list of problems to work on. We will need to decide such things as how detailed we should get with each one, ect.

For now, we're going to hit minimum viable product. We need an html doc tied and retrievable per objective. Really, all we're doing is adding one more layer to structure at this point.

— You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub https://github.com/johnRedden/TextbookProject/issues/17

FelixVicis commented 8 years ago

Update

New Module: Problems
Datastore Table: Exercises
type Exercise struct {
    ID          int64         `datastore:"-"` // Self.ID
    Parent      int64         ``              // Objective ID
    Instruction string        ``              // Instruction Kind. Will need list of exercise kinds.
    Question    template.HTML `datastore:"-"` // Question information, html.
    Solution    template.HTML `datastore:"-"` // Solution to above quesion.
}
FelixVicis commented 8 years ago

Update

FelixVicis commented 8 years ago

Completed

We now have Structures, Storage, API's, readers, and editors for exercises. Happy to close this issue.

All api's follow the same format and are documented in file. Wiki documentation will be coming soon.

/api/exercises.json  -- Collection exercise reader api
/api/exercise.xml -- singular exercise reader api
/api/makeExercise -- singular exercise writer api
/api/deleteExercise -- singular exercise deleter api

The reader is a very cut down version. It'll need to look better, of course, but for now it works. The editor follows the same format as the others, it too will need to look better in the future.

/read/exercise/:ID -- singular exercise reader html
/edit/Exercise/:ID -- singular exercise writer html