[FREEMARKER-97] Header capitalization using standard styles

• Type: Wish
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: 2.3.28
• Component/s: engine
• Assignee: Unassigned
• Reporter: T X
• Created: 29/May/18 17:53
• Updated: 25/Jul/18 21:36

Description

FreeMarker offers a couple of simple algorithms for changing the case of titles:

• https://freemarker.apache.org/docs/ref_builtins_string.html#ref_builtin_cap_firs
• https://freemarker.apache.org/docs/ref_builtins_string.html#ref_builtin_capitalizet

Neither of these capitalize the text in ways that adhere to various standard styles:

• Chicago Manual of Style
• Associated Press
• MLA Style Manual
• APA Style

Consider the following texts:

• On iPhone the Transcript Extends Outside of Screen Frame
• PEAR And GNA Report Performance
• BCMailPlusFTPClient Sends Document without Document ID
• JWebUnit: Non-PEN Orders main.xhtml Meta Refresh Tag Issue

These are correct as written and must not be adjusted by an algorithm that changes the text title. There are a couple of web sites that produce the expected titles (note that the second site capitalizes the word "without," which implies the algorithm does not use Chicago conventions):

• https://titlecaseconverter.com/
• http://individed.com/code/to-title-case/

There are a variety of implementations that perform such a feat:

• JavaScript
• Perl
• PHP

These implementations do not require a whitelist. (So "iPhone" and "ClassName" will remain as given.) Apache Commons' WordUtils class does not implement Chicago Style, and I suspect it is also a fairly simple algorithm.

Since ?capitalize and ?cap_first are taken, I propose ?title_case with an optional parameter (default is Chicago):

• chicago
• ap
• apa
• mla