diff --git a/CHANGELOG.md b/CHANGELOG.md index 1bca2b2..e1467e8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,3 +11,64 @@ ### Miscellaneous Chores * release 5.1.0 ([#7](https://github.com/SchweizerischeBundesbahnen/ch.sbb.polarion.extension.pdf-exporter/issues/7)) ([0b0260a](https://github.com/SchweizerischeBundesbahnen/ch.sbb.polarion.extension.pdf-exporter/commit/0b0260a0dc1014073e81067e12eaf57c7e827bca)) + + +# Changelog before migration to conventional commits + +| Version | Changes | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| v5.0.2 | Added CSS configuration to hide non-printing elements | +| v5.0.1 | Added defaults for size and page parameters: A4 and Portrait | +| v5.0.0 | * Attribute "Fit images and tables to page width" is modified to be "Fit images and tables to page" and at the same time logic is modified to try and fit images not only to page width but also to page height (it's a breaking change, see "Upgrading instructions" section for further instructions).
* Exclude report parameters area from being exporting to pdf for live reports | +| v4.5.2 | Help colorized | +| v4.5.1 | Help updated | +| v4.5.0 | PDF/A variants now supported both for weasyprint CLI and weasyprint service | +| v4.4.0 | Polarion 2404 is supported | +| v4.3.1 | Fixed bugs in about page | +| v4.3.0 | * Support of WeasyPrint as a Service has been added
* Fixed export to PDF from default space | +| v4.2.0 | * Added BASELINE_NAME and REVISION_AND_BASELINE_NAME placeholders
* StringIndexOutOfBoundsException on LiveDoc rendering fix
* Hide hint for unsupported SVG 1.1 features | +| v4.1.1 | * HtmlUtils class moved to generic application.
* Styling fix.
* Fixed base URL prefix.
* Debug information for raw HTMl export | +| v4.1.0 | * Current configuration status to About page added.
* Expanded fields for document filename template
* Icon for LiveReport button changed | +| v4.0.0 | * Using enums for DocumentType
* Added endpoint for raw html to pdf export | +| v3.12.0 | User-friendly message about deactivated configuration properties on the Swagger UI page. | +| v3.11.1 | Temporary fix for starting of clearing job | +| v3.11.0 | About page supports configuration help and icon | +| v3.10.1 | delivery-external maven profile does not include EuroSpec cover page | +| v3.10.0 | * Fixed wiki page rendering
* Updated GUI to use asynchronous PDF export API
* Added cleanup async jobs | +| v3.9.0 | Default font for PDF export is Arial
Wiki pages now rendered using internal renderer directly | +| v3.8.1 | Fix for saving of default settings in read only transaction | +| v3.8.0 | * Added support Velocity variables and placeholders for document filename
* Enabled PDF generation for live reports on global level
* Added Asynchronous PDF generation API | +| v3.7.0 | * Fix for export of Wiki Page
* removed wikiFolder and wikiName from ExportParams | +| v3.6.0 | Evaluation of Velocity expression is extended with $page variable for LiveReports | +| v3.5.0 | Paper size is added as style package option.
* Fixed the logic for searching executor in windows with WSL | +| v3.4.0 | Support exporting Live Reports to PDF | +| v3.3.0 | * Evaluate Velocity expressions in Cover Page and Header/Footer templates
* DOCUMENT_ID placeholder has been added | +| v3.2.3 | Fix images which width is bigger than the page width but their width is not explicitly specified in any of attributes and factual value is used | +| v3.2.1 | Page break styling fix | +| v3.2.0 | * Added support of HTML Presentational Hints.
* Added possibility to re-define resulted file name.
* Marking referenced WorkItems extracted as a configurable property | +| v3.1.1 | Configuration properties in about page | +| v3.1.0 | Added possibility to open PDF exporter view in popup (via toolbar button) implemented with help of JS-injection approach provided by Polarion | +| v3.0.0 | * Cover page endpoint renamed to correspond menu item name.
* Fix named configurations issue when extension is installed from the scratch | +| v2.4.0 | New feature: on fly converting of cover page images located in SVN and referenced in CSS into base64 representation and embedding them into CSS directly | +| v2.3.0 | * Multiple predefined templates for cover page.
* Extended description in quick help sections of cover page and header/footer configurations to clarify format of special variables and document's custom fields.
* If no value was obtained/calculated for special variable or document's custom fields then blank string will be inserted instead of special variable or custom field ID.
* All ' ' occurrences are now removed from source HTML before converting into PDF. This is done to exclude situations when they are a reason of certain strings be too wide going outside of page boundaries. As a side effect in some cases WorkItems ID and title can be rendered on different lines of document. | +| v2.2.0 | * Cover page generation added together with cover page configuration.
* Custom styling of referenced Work Items.
* Cut local URLs + filtering Workitem roles working together fix.
* Added variables injection into CSS of document and cover page.
* Named settings moved to generic application | +| v2.1.1 | * Custom dropdowns are used to visually mark project's scope configurations inherited from global scope.
* Adjust REST endpoints and use Polarion services via PolarionService aggregator/proxy. | +| v2.1.0 | * New feature: added DOCUMENT_STATUS variable to header/footer settings.
* "Fit to page width" checkbox is renamed to "Fit images and tables to page width" to reduce confusion with real implementation.
* Fixed an issue when exporter form is initialized in case when no style packages ever configured on admin site.
* Added tests running real WeasyPrint instance to test if document elements didn't go out of page boundaries. | +| v2.0.0 | Added named settings and ability to combine them into style packages. Breaking change modifying the way settings are stored! | +| v1.2.14 | Fix too wide lines generated in PDF caused by unnecessary   characters in source HTML | +| v1.2.13 | Document's last revision is displayed instead of "HEAD" literal in case if no revision was specified | +| v1.2.12 | Added processing IDs of document's custom fields as placeholders in header/footer. Added an option to run WeasyPrint from docker image. | +| v1.2.11 | Displaying Polarion's HEAD revision logic fixed | +| v1.2.10 | Getting document's title logic fixed | +| v1.2.9 | Fix for Table of Figures - arbitrary caption's label | +| v1.2.8 | HTML logging added | +| v1.2.7 | Items of ToF & ToT as hyperlinks, fix for comments inside captions to figures and tables | +| v1.2.6 | Fix for "page-break-inside: avoid" | +| v1.2.5 | Table of content issues fixed | +| v1.2.4 | Non-default icons rendering fix | +| v1.2.3 | Table of figures/tables fix | +| v1.2.2 | Table of figures/tables generation added | +| v1.2.1 | Numbered lists processing fix | +| v1.2.0 | Fixing API to call from python | +| v1.1.0 | Different refactorings | +| v1.0.0 | Initial release | diff --git a/README.md b/README.md index 3edb6e7..05a33df 100644 --- a/README.md +++ b/README.md @@ -210,63 +210,3 @@ after installation of this version you will have to go to configuration again an Another change is default CSS which was modified to reflect different possible paper sizes as well as additional styling for images to jump into next page if they can't be fully displayed on current one. Thus please either reset your saved CSS into last version if you didn't have your own CSS definitions or merge your saved version with new default version. - -## Changelog - -| Version | Changes | -|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| v5.0.2 | Added CSS configuration to hide non-printing elements | -| v5.0.1 | Added defaults for size and page parameters: A4 and Portrait | -| v5.0.0 | * Attribute "Fit images and tables to page width" is modified to be "Fit images and tables to page" and at the same time logic is modified to try and fit images not only to page width but also to page height (it's a breaking change, see "Upgrading instructions" section for further instructions).
* Exclude report parameters area from being exporting to pdf for live reports | -| v4.5.2 | Help colorized | -| v4.5.1 | Help updated | -| v4.5.0 | PDF/A variants now supported both for weasyprint CLI and weasyprint service | -| v4.4.0 | Polarion 2404 is supported | -| v4.3.1 | Fixed bugs in about page | -| v4.3.0 | * Support of WeasyPrint as a Service has been added
* Fixed export to PDF from default space | -| v4.2.0 | * Added BASELINE_NAME and REVISION_AND_BASELINE_NAME placeholders
* StringIndexOutOfBoundsException on LiveDoc rendering fix
* Hide hint for unsupported SVG 1.1 features | -| v4.1.1 | * HtmlUtils class moved to generic application.
* Styling fix.
* Fixed base URL prefix.
* Debug information for raw HTMl export | -| v4.1.0 | * Current configuration status to About page added.
* Expanded fields for document filename template
* Icon for LiveReport button changed | -| v4.0.0 | * Using enums for DocumentType
* Added endpoint for raw html to pdf export | -| v3.12.0 | User-friendly message about deactivated configuration properties on the Swagger UI page. | -| v3.11.1 | Temporary fix for starting of clearing job | -| v3.11.0 | About page supports configuration help and icon | -| v3.10.1 | delivery-external maven profile does not include EuroSpec cover page | -| v3.10.0 | * Fixed wiki page rendering
* Updated GUI to use asynchronous PDF export API
* Added cleanup async jobs | -| v3.9.0 | Default font for PDF export is Arial
Wiki pages now rendered using internal renderer directly | -| v3.8.1 | Fix for saving of default settings in read only transaction | -| v3.8.0 | * Added support Velocity variables and placeholders for document filename
* Enabled PDF generation for live reports on global level
* Added Asynchronous PDF generation API | -| v3.7.0 | * Fix for export of Wiki Page
* removed wikiFolder and wikiName from ExportParams | -| v3.6.0 | Evaluation of Velocity expression is extended with $page variable for LiveReports | -| v3.5.0 | Paper size is added as style package option.
* Fixed the logic for searching executor in windows with WSL | -| v3.4.0 | Support exporting Live Reports to PDF | -| v3.3.0 | * Evaluate Velocity expressions in Cover Page and Header/Footer templates
* DOCUMENT_ID placeholder has been added | -| v3.2.3 | Fix images which width is bigger than the page width but their width is not explicitly specified in any of attributes and factual value is used | -| v3.2.1 | Page break styling fix | -| v3.2.0 | * Added support of HTML Presentational Hints.
* Added possibility to re-define resulted file name.
* Marking referenced WorkItems extracted as a configurable property | -| v3.1.1 | Configuration properties in about page | -| v3.1.0 | Added possibility to open PDF exporter view in popup (via toolbar button) implemented with help of JS-injection approach provided by Polarion | -| v3.0.0 | * Cover page endpoint renamed to correspond menu item name.
* Fix named configurations issue when extension is installed from the scratch | -| v2.4.0 | New feature: on fly converting of cover page images located in SVN and referenced in CSS into base64 representation and embedding them into CSS directly | -| v2.3.0 | * Multiple predefined templates for cover page.
* Extended description in quick help sections of cover page and header/footer configurations to clarify format of special variables and document's custom fields.
* If no value was obtained/calculated for special variable or document's custom fields then blank string will be inserted instead of special variable or custom field ID.
* All ' ' occurrences are now removed from source HTML before converting into PDF. This is done to exclude situations when they are a reason of certain strings be too wide going outside of page boundaries. As a side effect in some cases WorkItems ID and title can be rendered on different lines of document. | -| v2.2.0 | * Cover page generation added together with cover page configuration.
* Custom styling of referenced Work Items.
* Cut local URLs + filtering Workitem roles working together fix.
* Added variables injection into CSS of document and cover page.
* Named settings moved to generic application | -| v2.1.1 | * Custom dropdowns are used to visually mark project's scope configurations inherited from global scope.
* Adjust REST endpoints and use Polarion services via PolarionService aggregator/proxy. | -| v2.1.0 | * New feature: added DOCUMENT_STATUS variable to header/footer settings.
* "Fit to page width" checkbox is renamed to "Fit images and tables to page width" to reduce confusion with real implementation.
* Fixed an issue when exporter form is initialized in case when no style packages ever configured on admin site.
* Added tests running real WeasyPrint instance to test if document elements didn't go out of page boundaries. | -| v2.0.0 | Added named settings and ability to combine them into style packages. Breaking change modifying the way settings are stored! | -| v1.2.14 | Fix too wide lines generated in PDF caused by unnecessary   characters in source HTML | -| v1.2.13 | Document's last revision is displayed instead of "HEAD" literal in case if no revision was specified | -| v1.2.12 | Added processing IDs of document's custom fields as placeholders in header/footer. Added an option to run WeasyPrint from docker image. | -| v1.2.11 | Displaying Polarion's HEAD revision logic fixed | -| v1.2.10 | Getting document's title logic fixed | -| v1.2.9 | Fix for Table of Figures - arbitrary caption's label | -| v1.2.8 | HTML logging added | -| v1.2.7 | Items of ToF & ToT as hyperlinks, fix for comments inside captions to figures and tables | -| v1.2.6 | Fix for "page-break-inside: avoid" | -| v1.2.5 | Table of content issues fixed | -| v1.2.4 | Non-default icons rendering fix | -| v1.2.3 | Table of figures/tables fix | -| v1.2.2 | Table of figures/tables generation added | -| v1.2.1 | Numbered lists processing fix | -| v1.2.0 | Fixing API to call from python | -| v1.1.0 | Different refactorings | -| v1.0.0 | Initial release |