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

POC: Click on Template file -> Create Document (Web, Backend, mobile, desktop) #9785

Closed
13 tasks
tbsbdr opened this issue Aug 12, 2024 · 4 comments · Fixed by #10276
Closed
13 tasks

POC: Click on Template file -> Create Document (Web, Backend, mobile, desktop) #9785

tbsbdr opened this issue Aug 12, 2024 · 4 comments · Fixed by #10276
Assignees
Labels

Comments

@tbsbdr
Copy link
Contributor

tbsbdr commented Aug 12, 2024

Description

User Stories

  • As a user I want to create a document by clicking on a template file so that I can use the templates from a shared folder.

Acceptance Criteria

  • click on a template file eg. letter.ott creates a new writable document letter.odt, new document gets opened
  • Supported file formats:
    • Must:
      • DOTX
      • OTT
    • Nice to have:
      • XLTX
      • POTX
      • OTS
      • OTP
  • the document gets implicity saved to the users personal space: letter.odt; [Name of template].[corresponding ext]
  • filename collisions are implicitly solved: letter (1).odt
  • provide the location of letter (1).odt so that clients can show a notification where the file got stored (in personal)

also see ONLYOFFICE/DocumentServer#2839

Definition of ready

  • Everybody needs to understand the value written in the user story
  • Acceptance criteria have to be defined
  • All dependencies of the user story need to be identified
  • Feature should be seen from an end user perspective
  • Story has to be estimated
  • Story points need to be less than 20

Definition of done

  • Functional requirements
    • Functionality described in the user story works
    • Acceptance criteria are fulfilled
  • Quality
    • Code review happened
    • CI is green (that includes new and existing automated tests)
    • Critical code received unit tests by the developer
  • Non-functional requirements
    • No sonar cloud issues
  • Configuration changes
    • The next branch of the ocis charts is compatible
@tbsbdr tbsbdr added the Type:Story User Story label Aug 12, 2024
@tbsbdr tbsbdr changed the title Click on Template file -> Create Document POC: Click on Template file -> Create Document Sep 5, 2024
@tbsbdr tbsbdr changed the title POC: Click on Template file -> Create Document POC Web, Backend, mobile, desktop: Click on Template file -> Create Document Sep 5, 2024
@tbsbdr tbsbdr changed the title POC Web, Backend, mobile, desktop: Click on Template file -> Create Document POC: Click on Template file -> Create Document (Web, Backend, mobile, desktop) Sep 5, 2024
@butonic
Copy link
Member

butonic commented Sep 10, 2024

hm, how do other solutions like collabora and ms solve this?

@micbar
Copy link
Contributor

micbar commented Oct 9, 2024

Needed Changes in Web and oCIS

app/list/

  • We will add a field target_ext=<extension> to indicate which extension should be used by the new file

app/open

  • We will add the template_id to provide a way to tell the OfficeApp which template to process. The template_id will only be used if the file is empty.

Background: It is important that the template is processed by the Web App to execute the field functions and other stuff.

Web Client

  • Web Client reads the target_ext field from the app/list response.
  • Files with that flag will trigger a new default action, which is "open a new file from this template" (new web extension inside of external-app)
  • The existing file action "Open this File in ..." will stay and can be used via right click.

New default action "open a new file from this template"

  • It asks the user about the new file name in the personal space root (collision handling included, no personal space means "feature not available")
  • It will create a new file via app/new using the suggested file extension
  • It uses the new file to switch the current context
  • It will open the new file via app/open and send the template_id

@micbar
Copy link
Contributor

micbar commented Oct 17, 2024

@kulmann backend has been merged.

@kulmann
Copy link
Member

kulmann commented Oct 17, 2024

@kulmann backend has been merged.

nice! ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Needs Tests
Development

Successfully merging a pull request may close this issue.

4 participants