slachiewicz opened a new pull request, #418:
URL: https://github.com/apache/maven-help-plugin/pull/418

   > **This PR is provisional and overlaps #413.** #413 (fixes #404) proposes 
deleting `src/site/fml/faq.fml` and its `site.xml` entry outright. If the 
project prefers that, **close this PR** — no argument from me about the content 
being thin. This is offered as the alternative for the case where the project 
would rather keep the two URLs alive: deleting the page retires `faq.html` 
along with `#What_is_a_Mojo` and 
`#Why_mvn_help.3Aactive-profiles_won.27t_show_the_active_profiles_under_Maven_2.1`,
 which have been served for years. Whichever way it goes, one of the two PRs 
should be closed rather than both left open.
   
   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
   
   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. Neither id here is a valid XML name. The second one is worth a look:
   
   ```
   
#Why_mvn_help.3Aactive-profiles_won.27t_show_the_active_profiles_under_Maven_2.1
   ```
   
   `:` became `.3A`, `'` became `.27`, and it ends at `2.1` with **no** `.3F` — 
the `id` never carried the question mark the question does. The `<a name>` 
written here reproduces that rendered form, not the raw attribute.
   
   ### Verification
   
   Built the site with `mvn site` before and after and compared the set of 
anchors the generated `faq.html` actually serves. Every anchor served before is 
still served after; `<head>` byte-identical, so title and metadata are 
unchanged. `site.xml` needs no edit — FML and Markdown both render to 
`faq.html`, so the menu entry keeps 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