From c85a7f3351a54550b9661ba6ec8e093cf7ba27fe Mon Sep 17 00:00:00 2001 From: Allison Beemer <66966224+anbeemer@users.noreply.github.com> Date: Wed, 17 Jul 2024 12:08:54 -0500 Subject: [PATCH] Added example to uploading_files.rst --- docs/tutorials/uploading_files.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/tutorials/uploading_files.rst b/docs/tutorials/uploading_files.rst index f547ff3..d6a82c6 100644 --- a/docs/tutorials/uploading_files.rst +++ b/docs/tutorials/uploading_files.rst @@ -19,5 +19,24 @@ The `destination` key specifies where in the file structure you would like the f Example ======= +If the `meta.json` folder looks like: + +.. code-block:: + + { + "type":"file", + "title":"Syllabus", + "filename":"F24_Math100_syllabus.pdf", + "modules":["Course Information", "Week 1"], + "destination": "course_info/syllabus_schedule" + } + +then the file `F24_Math100_syllabus.pdf` will be put into two modules: `Course Information` and `Week 1`. +Within these two modules, its title will appear to students as `Syllabus`. The file will be located in `course_info/syllabus_schedule`, +which will be created if it did not already exist. + +Note that while a file cannot be simultaneously placed in multiple file structure locations using `meta.json`, if `meta.json` is updated, +the file will not automatically be deleted from any previous location unless that instance is specifically deleted. +