Skip to content
Snippets Groups Projects
Commit a523c3a4 authored by David Paul's avatar David Paul
Browse files

Update documentation

parent aa63bf9a
No related branches found
No related tags found
No related merge requests found
......@@ -28,6 +28,10 @@ To set up, you should upload the PAIL files to a PHP server and modify ```settin
| ```$pail_generate_command``` | The command used to generate the personalised assessment for the user. It will be passed the directory in which to store any generated files as its last command line argument. There are no checks that this program does only store files in the specified directory, so you should ensure you trust that this command will do the right thing.
| ```$pail_contact``` | The contact email people should be directed to if there are any issues
| ```$pail_reset``` | If false (the default), files are only generated the first time the learner visits the LTI tool (and simply displayed on subsequent visits). If true, the files are generated each time the learner visits.
| ```$pail_generated_dir``` | The subdirectory where files will be generated (defaults to "generated")
| ```$pail_context_id``` | The key to use to get the context ID from the LTI context (defaults to "context_id", which should always be appropriate)
| ```$pail_user_id``` | The key to use to get the user ID from the LTI context (defaults to "user_id". To get student number at UNE, use "lis_person_sourcedid" instead)
| ```$pail_debug``` | Whether to output debug information with the page (defaults to false)
You can then set up an LTI tool in your LMS that points to the base URL where you have PAIL set up.
PAIL will then automatically generate and render the Markdown file specified by the ```display``` request parameter (or ```display.md``` if no such parameter exists) for each individual learner.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment