Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Instructor Interface with PDF Editing Functionality #8768

Open
eceeeren opened this issue Jun 9, 2024 · 0 comments · Fixed by #8987
Open

Updated Instructor Interface with PDF Editing Functionality #8768

eceeeren opened this issue Jun 9, 2024 · 0 comments · Fixed by #8987
Assignees
Labels
feature-proposal This issue is a feature proposal

Comments

@eceeeren
Copy link
Contributor

eceeeren commented Jun 9, 2024

Feature Proposal

Spec Version 0.2.0

Context

Problem

Currently, when instructors attach a PDF file to a lecture, any changes to the document require removing the original file and uploading a new version. This method is inefficient and time-consuming, particularly for minor updates, and depends heavily on external software.

Motivation

This issue needs to be addressed to streamline the process of updating lecture materials. Allowing instructors to make changes directly within the platform will significantly reduce the process time and reliance on external applications.

Requirements Engineering

Existing (Problematic) Solution / System

Instructors currently lack the ability to edit PDF files directly within the educational platform. They must use external software to modify documents, then re-upload them to the platform, disrupting the workflow and consuming additional time. Also once the lecture units are defined by the system, the process is not dynamic and flexible enough to arrange them properly.

Proposed System

The proposed enhancement will allow instructors to manipulate PDF attachments directly in the browser. This includes functionalities such as adding, removing, reordering pages, merging PDF files and visualise lecture units division if that option is selected. A thumbnail grid will provide a visual representation of the PDF, and interactive tools will facilitate direct manipulation of the content.

Requirements

Functional Requirements

  1. FR: Thumbnail Preview Generation: The user should be able to view PDF pages on a separate thumbnail grid on the screen, each page number is notated.
  2. FR: Arranging Lecture Units on Thumbnail Grid: The user should be able to edit lecture units on Thumbnail grid.
  3. FR: Adding New Pages to the PDF File: The user should be able to add new pages by merging another PDF file to the previous one.
  4. FR: Removing Pages from the PDF File: The user should be able to select all pages or individually and remove them from the file.
  5. FR: Hiding Pages from the PDF File: The user should be able to select multiple pages and hide them until a further notice.
  6. FR: Reordering Pages of the PDF File: The user should be able to reorder pages via dragging and dropping them.

Non-Functional Requirements

  1. NFR: Performance: Load Time: The Instructor Interface should create the thumbnail grid with the added PDF within 2 seconds.
  2. NFR: Usability: Intuitive Design on Reordering Pages: The thumbnail grid should be created in a way that, for a user to change pages, only 1 dragging functionality would be enough.
  3. NFR: Usability: Intuitive Design on Merging Pages: Merging pages and adding a new page should be done with 2 clicks (clicking upload & selecting file/page).
  4. NFR: Usability: Intuitive Design on Removing Pages: Removing page should be done either in 2 clicks individually (select & delete the page) or the clicks should be equal to the page size for multiple pages and then 1 deleting function.
  5. NFR: Usability: Intuitive Design on Hiding/Exposing Pages: Hiding and exposing an individual page should be done in 1 click via a toggle button.
  6. NFR: Responsiveness: The added functionality should work seamlessly with different screen sizes or different devices like laptops, tables and mobile phones.
  7. NFR: Reliability: Multiple Users Support: The process should not be interrupted once an Instructor is changing a file.

Analysis

Analysis Object Model

What are the involved Analysis Objects?

PDFEditing-AnalysisObjectModel

Dynamic Behavior

Include dynamic models (Activity Diagram, State Chart Diagram, Communication Diagram) here to outline the dynamic nature of the PROBLEM

Activity Diagram of the new Attachments page

Screenshot 2024-07-02 at 23 38 33

UI/UX Design

Screenshots of the final UI mockups (mandatory): Please include screenshots to provide a clear and persistent visual reference of the design.

A basic representation of the solution (can be extended)

Frame 1 - Main Frame

Link to the design mockup (optional):

https://www.figma.com/design/xYgczdrOHjvo7zHasIRIGu/Aybike-Ece-Eren---Master's-Thesis?node-id=8-11206&m=dev

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-proposal This issue is a feature proposal
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants