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

CV Export - Table of contents not correct #406

Open
Robin481 opened this issue Feb 19, 2021 · 2 comments
Open

CV Export - Table of contents not correct #406

Robin481 opened this issue Feb 19, 2021 · 2 comments
Assignees
Labels
bug Something isn't working plan needs to be planned

Comments

@Robin481
Copy link
Member

Robin481 commented Feb 19, 2021

When exporting anyone's CV the Table of contents can be wrong/not updated. (Especially when there is a lot of data)
E.g. After an export the ToC (Table of Contents) says the language_skills are on page 3 even though they are on page 5. Right-clicking the ToC and updating fixes the issue but is tedious and can be easily forgotten.

DoD:

  • The ToC is always Up-To-Date when exporting a CV
  • There exists a test for this use case
@Robin481 Robin481 added bug Something isn't working plan needs to be planned PSE labels Feb 19, 2021
@Robin481 Robin481 added java-devs and removed PSE labels Mar 9, 2021
@rbotteon rbotteon assigned rbotteon and unassigned rbotteon Mar 10, 2021
@rbotteon
Copy link

rbotteon commented Mar 15, 2021

In the actual state is not possible to implement this feature/bug fix.

Why?

The actual gem used to produce odt reports based on a template is odf-report.
It doesn't offer the possibility to refresh/interact with the table of contents TOC.
I opened an issue/feature request and i didn't receive any answer.
I looked up for alternatives but apparently there isn't a gem that offer what we need out of the box.

Here the gems I found:

  1. odf-report (in use today)
  • Create odt from templates
  • Not possible to create/interact TOC
  • Last commit 8 months ago
  • Issue opened -> no answer received
  1. odf
  • Create odt from scratch
  • Does not allow the use of templates
  • Not possible to create/interact TOC
  • Last commit 4 years ago
  1. serenity
  • Create odt from templates
  • Not possible to create/interact TOC
  • Last commit 5 years ago
  1. odf-core
  • Full set of "Open Document Format" elements translated into Ruby classes.
  • Ideal as a foundation to develop a gem
  • Not usable out of the box
  • Last commit 5 years ago
  • As a table of content element
  • Implementation details of ODF must be known to be used

I found other gems but these are the only interesting for ours needs.

Possible solutions:

  1. Add the TOC feature to the actual used gem odf-report

    • we have to learn some of the implementation details of ODF
    • probably the "shortest" solution == not the longest
  2. Implement a whole new gem

    • Based on odf-core
    • Can be developed as OS intern project @puzzle
    • We have to learn a lot of the implementation details of ODF
    • The longest solution
  3. Via jruby use an existing java library

    • I don't think that the elders of ruby will accept it
    • No idea about the time needed

All of the solutions are expensive (development of multiple days).

@Robin481
Copy link
Member Author

Robin481 commented Mar 15, 2021

@rbotteon
Thanks a lot for the extensive Feedback!

I think the Issue itself doesn't warrant any of the proposed approaches. Time spent vs severity of the issue is not at all reasonable.
Opening an issue on the gem's GitHub was in my opinion the only reasonable thing to do. Thanks for doing that! Issue here

What do you think about adding a little note when exporting a cv? Along the lines of:
Wenn ein CV exportiert wird welches grösser als 4 Seiten ist kann es zu Inkonsistenten im Inhaltsverzeichnis kommen. Denke doch daran dieses jeweils im Dokument selber zu refreshen.

@Robin481 Robin481 removed the java-devs label Mar 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working plan needs to be planned
Projects
None yet
Development

No branches or pull requests

2 participants