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

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

Export to HTML button in document properties #116

Closed ewuerger closed 1 month ago

ewuerger commented 1 month ago

Description

Mandatory

An additional button below Export to PDF with an HTML icon (just like PDF icon but with HTML text) in the Document Properties navigation bar, that downloads the produced HTML page that is passed to Weasyprint.

Optional

Extend the REST API with an endpoint for just HTML processing.

Motivation

Hello dear Polarion PDF Exporter plugin devs,

first of all great work with the plugin!

When we want to work on the style package of the plugin (CSS style-sheet, cover page,...) it is sometimes hard to figure out what the correct CSS rules are, and if we need !important because there are already inline styles on the HTML elements. The HTML structure is very important to be known in order to come up with correct CSS styling rules. Also this helps the user to understand some processing that the plugin does, e.g. work item tables. When a user doesn't have access to the server where Polarion runs, she can't access the produced HTML that is passed to Weasyprint.

It would help very much to be able to receive this HTML from the frontend and I think this shouldn't mean too much implementation work.

This would help us immensely to style the produced PDFs via CSS rules.

Cheers

Proposed Solution (optional)

No response

ralfsmolarek3 commented 1 month ago

Hello @ewuerger , thanks for the request. Adding this to the REST API makes sense to me. Let me check. Adding a button I personally do not really like but I understand where you are coming from!

grigoriev commented 1 month ago

Hi @ewuerger,

after some discussions we decided that such a button on the UI would be a bit redundant for such purposes. So we simply added a REST API endpoint:

image

It's similar to /api/convertendpoint, but returns desired HTML instead of producing PDF.

Please let us know if it's not sufficient or in case of any findings/bugs.

ewuerger commented 1 month ago

I will test this next week. Thank you very much! @grigoriev @ralfsmolarek3