Differences

This shows you the differences between two versions of the page.

--- syntax:functions:proper [2018/01/17 08:38] – dmitry
+++ syntax:functions:proper [2021/08/02 03:27] – craigt
@@ Line 1: / Line 1: @@
-====Proper(text_value)====
+====== Proper(text) ======
+Category:  Text function
-Converts //text_value// to the proper case, i.e. first letter becomes uppercase, others become lowercase.
+\\
+=====Description=====
+This function converts //text// to the proper case (or "title case"), i.e. the first letter of each word becomes uppercase, the remaining letters become lowercase.
-Note that abbreviations always remain uppercase. To convert a text with abbreviations to the proper case, make it lowercase first.
+\\
+=====Arguments=====
+^Argument^Type^Description^
+|text|Text|The text value to convert to proper case.|
-^  Example  ^  Result  ^
+**Return value type:** Text
-| proper('hey Jude')  | Hey Jude  |
-| proper('back to the USSR')  | Back To The USSR  |
-| proper(lower('UPPER CASE TEXT'))  | Upper Case Text |
-=== See also ===
+\\
+=====Remarks=====
+This function has no effect on numbers, symbols, or non-printing characters.
-  * [[syntax:functions:upper]]
+Note that words that appear in all uppercase letters retain their case.  To convert these strings to proper case, first convert them to lowercase.  See examples below.
-  * [[syntax:functions:lower]]
+\\
+=====Examples=====
+  proper('hey Jude') = 'Hey Jude'
+  proper('back to the USSR') = 'Back To The USSR"  //All uppercase words remain uppercase
+  proper(lower('UPPER CASE TEXT')) = 'Upper Case Text'  //Convert uppercase words to lowercase first
+\\
+===== See also =====
+  * [[syntax:functions:lower|Lower(text)]]
+  * [[syntax:functions:upper|Upper(text)]]