search

SchweizerischeBundesbahnen / ch.sbb.polarion.extension.pdf-exporter

Polarion extension for customised PDF exports
13 stars 0 forks source link

Warning message when exporting the current, non-final version of a live document #64

Open ukrishne opened 1 month ago

ukrishne commented 1 month ago

Description

Show a warning message when exporting the current, non-final version of a live document.

Motivation

This warning helps users understand that the document is still being edited. Exporting it now might result in inconsistencies if the document changes later.

Proposed Solution (optional)

image

grigoriev commented 1 month ago

@ralfsmolarek3 what do you thing about such functionality?

ralfsmolarek3 commented 1 month ago

@ukrishne thanks a lot for the enhancement request!

I believe such warnings should be done on an organizational level. In many cases this could annoy people more than it help. As a workaround the PDF-export could be triggered through a script which does those checks/warnings.

However this feature could be part of a more generic enhancement we have already thought about: making the style-packages depending on logic

Inside the administration we define certain dependencies e.g.:

If all dependencies are fulfilled a style-package will be used: so every dependency-set is one style-package assinged. The configurations are similar defined like the custom-sets in Polarion (having an order and are checked in that order. First "hit" will be used). One configuration has to be defined as the fallback (will be used if no other will match).

What do you think?

ukrishne commented 1 month ago

@ralfsmolarek3 : many thanks Ralf for your detailed comment. agreed, workaround you have suggested can be done at organisation level but as you are already considering as part of generic enhancements i am ok with it. could be a small note can be added about non baselined version export.

ralfsmolarek3 commented 1 month ago

@ukrishne not sure about the "non baselined version" as we always export a specific revision (even if it is head). So the only point is if someone hasn't created a baseline in advance. However this can be done any time later. You know the variable we have for header/footer?!

image

ukrishne commented 1 month ago

Hi Ralf, thanks for your reply. We would need to give info that user is exporting current version which is live and can undergo modification and pdf become out of sync. This info has to given only during current version export. Not applicable for baselines.

On Wed, 17 Jul, 2024, 1:27 pm Ralf Smolarek, @.***> wrote:

@ukrishne https://github.com/ukrishne not sure about the "non baselined version" as we always export a specific revision (even if it is head). So the only point is if someone hasn't created a baseline in advance. However this can be done any time later. You know the variable we have for header/footer?!

image.png (view on web) https://github.com/user-attachments/assets/aac03358-97e2-453d-a7b6-80f00faeac5f

— Reply to this email directly, view it on GitHub https://github.com/SchweizerischeBundesbahnen/ch.sbb.polarion.extension.pdf-exporter/issues/64#issuecomment-2232672547, or unsubscribe https://github.com/notifications/unsubscribe-auth/AK4I7FCVXVSBK5AFDCV7S6DZMYPVLAVCNFSM6AAAAABKP7O2RGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMZSGY3TENJUG4 . You are receiving this because you were mentioned.Message ID: <SchweizerischeBundesbahnen/ch.sbb.polarion.extension. @.***>

kschmiechen commented 1 month ago

I think rendering a warning in the exported PDF could already be done using Velocity scripts in the cover sheet and header footer definition. Based on the document status or whether there is a baseline for the current revision, you can include a warning that this is a not baselined version.

ukrishne commented 1 month ago

@kschmiechen : thanks for your comment. Yes agreed, but my request was not show the warning in the exported pdf but just to show information to user that you are trying to export current version.