[ 
https://issues.apache.org/jira/browse/WW-5728?focusedWorklogId=1041094&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-1041094
 ]

ASF GitHub Bot logged work on WW-5728:
--------------------------------------

                Author: ASF GitHub Bot
            Created on: 12/Sep/26 09:13
            Start Date: 12/Sep/26 09:13
    Worklog Time Spent: 10m 
      Work Description: lukaszlenart opened a new pull request, #331:
URL: https://github.com/apache/struts-site/pull/331

   Closes [WW-5728](https://issues.apache.org/jira/browse/WW-5728).
   
   ## What
   
   - New `source/plugins/jasperreports7/index.md` for 
`struts2-jasperreports7-plugin` (since 7.1.0, WW-5455), mirroring the structure 
of the existing JasperReports page: description, usage with the result 
parameters, examples, filling from report parameters (WW-3245, applies to both 
plugins), `JasperReport7Aware` hooks, custom exporters, settings, installation, 
and a migration list from the 6.x plugin.
   - Plugins index: new `JasperReports 7 Plugin | 7.1.0+` row next to the 
existing one, both annotated with the JasperReports major they target.
   - Existing JasperReports page: one line pointing JasperReports 7 users to 
the new page.
   
   ## Where the page deliberately deviates from the Javadoc
   
   - **Format values are lower-case.** `JasperReport7Result` looks the exporter 
up as `getInstance(JasperReport7ExporterProvider.class, format)` with no case 
folding, and the beans are registered as `pdf`, `csv`, `html`, `xlsx`, `xml`, 
`rtf`. The Javadoc's own `<param name="format">CSV</param>` example would fail 
with `No exporter found for format: CSV`. The page uses `csv` and says the 
lookup is case-sensitive. The Javadoc itself should be fixed in `apache/struts`.
   - **`jasperreports-pdf` must be added by the application.** It is 
`<optional>` in the plugin POM while `pdf` is the default format, so the 
Installation section shows it alongside the plugin dependency.
   - **Custom exporters are documented as *new* format names only.** 
Redeclaring a bundled bean name (`<bean name="pdf" ...>`) in `struts.xml` 
throws `ConfigurationException` (`throwExceptionOnDuplicateBeans` defaults to 
`true` in `XmlDocConfigurationProvider`), so "override the PDF exporter" is not 
a supported path; the page says to use a different name or subclass 
`JasperReport7Result.exportReport`.
   - `timeZone` is documented although the Javadoc omits it - the setter exists 
in both plugins and is applied as `REPORT_TIME_ZONE`.
   
   ## Verified
   
   `bundle exec jekyll build` succeeds; the new page renders with all ToC 
anchors resolving, the `../jasperreports` / `../jasperreports7` cross-links and 
the index row point at existing pages, and the settings table renders.
   
   Docs-only diff, so no security review.
   
   ## Noticed along the way (not in this PR, `apache/struts`)
   
   `JasperReport7CsvExporterProvider` sets 
`config.setRecordDelimiter(reportDelimiter)` to the same value as the field 
delimiter, so every record is joined by `,` instead of a newline - looks like a 
copy-paste slip.
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)
   




Issue Time Tracking
-------------------

            Worklog Id:     (was: 1041094)
    Remaining Estimate: 0h
            Time Spent: 10m

> Add a struts-site page for the JasperReports 7 plugin
> -----------------------------------------------------
>
>                 Key: WW-5728
>                 URL: https://issues.apache.org/jira/browse/WW-5728
>             Project: Struts 2
>          Issue Type: Task
>          Components: Documentation, Plugin - JasperReports
>            Reporter: Lukasz Lenart
>            Assignee: Lukasz Lenart
>            Priority: Major
>             Fix For: 7.4.0
>
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> The {{struts2-jasperreports7-plugin}} introduced by WW-5455 has no page on 
> the site. {{source/plugins/jasperreports/index.md}} in {{struts-site}} 
> documents only the original {{struts2-jasperreports-plugin}} (JasperReports 
> 6.x line), and the plugins index does not mention the 7 variant at all.
> A user picking a plugin today cannot tell from the site that the second 
> plugin exists, which JasperReports major each one targets, or how the result 
> type and its parameters differ ({{JasperReport7Result}}, 
> {{JasperReport7Aware}}, the exporter providers, 
> {{struts.jasperReport.csvDelimiter}} and friends in 
> {{JasperReport7Constants}}).
> Needed:
> * a {{source/plugins/jasperreports7/index.md}} page mirroring the structure 
> of the existing one (description, usage with the result parameters, examples, 
> settings, installation), sourced from the Javadoc of {{JasperReport7Result}} 
> and {{JasperReport7Constants}};
> * an entry in the plugins index next to the existing JasperReports plugin, 
> and a line on the existing page pointing to the new one for JasperReports 7 
> users;
> * once WW-3245 merges, the "Filling from report parameters" section applies 
> to both plugins and should appear on both pages.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to