slachiewicz opened a new pull request, #651:
URL: https://github.com/apache/maven-project-info-reports-plugin/pull/651

   Part of an estate-wide move of the remaining FAQ pages from FML to Markdown.
   
   ### Two commits, deliberately
   
   1. **A pure rename**, `src/site/fml/faq.fml` -> `src/site/markdown/faq.md`, 
no content change.
   2. **The rewrite**, written by hand.
   
   Git records a rename plus a rewrite in a single commit as a delete and an 
add, which stops `git log --follow`. Splitting them keeps the history. **Please 
merge or rebase rather than squash.**
   
   ### Why by hand
   
   doxia-converter cannot target FML: the questions come out as link-reference 
syntax rather than headings, the `[top]` back-links become links to a 
nonexistent `top` page, and the contents links lose their `#` anchors.
   
   ### Anchors are preserved, and that is the point
   
   This page has been on maven.apache.org for years and is linked from outside. 
FML derives its anchor from the `<faq id=...>` attribute, and where that 
attribute is not a valid XML name `DoxiaUtils.encodeId` rewrites it at render 
time. The `<a name>` elements written here reproduce **the anchor the live site 
serves today**, not the raw attribute.
   
   All four anchors on this page are rewritten forms, and two of them do not 
match their own question text — worth checking carefully in review:
   
   | question | anchor served today |
   |---|---|
   | Is it possible to customize the labels of the Project Reports Menu? | 
`#Is_it_possible_to_customize_the_labels_of_the_Project_Reports_Menu` |
   | How to exclude SCM access info? | 
`#How_to_exclude_SCM_anonymous_access_info` |
   | How to use developer/contributor time zone? | 
`#How_to_use_developer.2Fcontributor_time_zone` |
   | Is it possible to customize the reports rendering? | 
`#Is_it_possible_to_customize_the_reports_rendering` |
   
   Note the missing `.3F` — the `id=` attributes never carried the question 
mark the questions do.
   
   ### Verification
   
   Built the site with `mvn site` before and after and compared the set of 
anchors the generated `faq.html` actually serves. All four plus `#top` are 
still served; `<head>` byte-identical, so title and metadata are unchanged; no 
link target on the page changed. `site.xml` needs no edit — FML and Markdown 
both render to `faq.html`, so the menu entry and the `./faq.html` link in 
`index.md` keep working.
   
   ### What is lost
   
   FML generates a `[top]` back-link after each answer. Those are dropped 
rather than hand-written. The question becomes an `h3` heading instead of a 
definition term. Nothing else changes.
   
   <sub>Drafted with Claude — please verify</sub>
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to