You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@freemarker.apache.org by "T X (JIRA)" <ji...@apache.org> on 2018/07/16 17:41:00 UTC

[jira] [Comment Edited] (FREEMARKER-97) Header capitalization using standard styles

    [ https://issues.apache.org/jira/browse/FREEMARKER-97?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16545520#comment-16545520 ] 

T X edited comment on FREEMARKER-97 at 7/16/18 5:40 PM:
--------------------------------------------------------

Great question, [~ddekany]. The phrase _because of_, is commonly thought of as a preposition; by itself, _because_ is also considered by some to be a subordinating conjunction. The _Chicago Manual of Style_ doesn't capitalize any prepositions, as you pointed out, excepting at the start of a sentence. Additionally, conjunctions are not capitalized.

[http://www.businesswritingblog.com/business_writing/2010/02/words-to-capitalize-in-titles-and-headings.html]

This is a bit of a rabbit hole, though:

[http://www.slate.com/blogs/lexicon_valley/2014/01/16/because_why_the_word_is_not_a_conjunction_as_dictionaries_have_it_but_instead.html]

I'd suggest leaving both mid-line occurrences lowercase, which also simplifies the code. (Note that the other online converters always capitalize _because_, regardless of _of_.)

I've asked a few folks who have studied English grammar, specifically the CMS.


was (Author: thangalin):
Great question, [~ddekany]. The phrase _because of_, is commonly thought of as a preposition; by itself, _because_ is also considered by some to be a subordinating conjunction. The _Chicago Manual of Style_ doesn't capitalize any prepositions, as you pointed out, excepting at the start of a sentence. Additionally, conjunctions are not capitalized.

[http://www.businesswritingblog.com/business_writing/2010/02/words-to-capitalize-in-titles-and-headings.html]

This is a bit of a rabbit hole, though:

[http://www.slate.com/blogs/lexicon_valley/2014/01/16/because_why_the_word_is_not_a_conjunction_as_dictionaries_have_it_but_instead.html]

I'd suggest leaving both mid-line occurrences lowercase, which also simplifies the code. (Note that the other online converters always capitalize _because_, regardless of _of_.)

> Header capitalization using standard styles
> -------------------------------------------
>
>                 Key: FREEMARKER-97
>                 URL: https://issues.apache.org/jira/browse/FREEMARKER-97
>             Project: Apache Freemarker
>          Issue Type: Wish
>          Components: engine
>    Affects Versions: 2.3.28
>            Reporter: T X
>            Priority: Minor
>
> 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_cap_first]
>  * [https://freemarker.apache.org/docs/ref_builtins_string.html#ref_builtin_capitalizet|https://freemarker.apache.org/docs/ref_builtins_string.html#ref_builtin_cap_first]
> Neither of these capitalize the text in ways that adhere to various standard styles:
>  * [Chicago Manual of Style|https://en.wikipedia.org/wiki/The_Chicago_Manual_of_Style]
>  * [Associated Press|https://en.wikipedia.org/wiki/AP_Stylebook]
>  * [MLA Style Manual|https://en.wikipedia.org/wiki/MLA_Style_Manual]
>  * [APA Style|https://en.wikipedia.org/wiki/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|https://github.com/gouch/to-title-case/blob/master/to-title-case.js]
> * [Perl|https://gist.github.com/gruber/9f9e8650d68b13ce4d78]
> * [PHP|https://gist.github.com/HipsterJazzbo/2532c93a18db7451b0cec529c95b53c4]
> 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
>  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)