Documentation for the Freemarker functions provided by ccm-core

git-svn-id: https://svn.libreccm.org/ccm/trunk@6103 8810af33-2d31-482b-a856-94f89814c4df

ccm-core/doc/ccm-core-freemarker.md

@@ -0,0 +1,43 @@
+# Freemarker functions provided by ccm-themedirector
+
+## User Banner
+
+Import Path
+: `/ccm-core/user-banner.ftl`
+
+### `String getGreeting()`
+
+Retrieves to the greeting value provided by the _UserBanner_ component.
+
+### `boolean isLoggedIn()`
+
+Return `true` if the current user is logged and `false` otherwise. 
+
+### `boolean isNotLoggedIn()`
+
+Return `true` if the current user is *not* logged and `false` otherwise. 
+
+### `String getChangePasswordUrl()`
+
+Returns the URL where a authenticated user can change his or her password.
+
+### `String getLoginLink()`
+
+Returns the URL of the login page.
+
+### `String getLogoutLink()`
+
+Returns the URL for logging out.
+
+### `String getScreenName()`
+
+Returns the username of the current user. If the user is not authenticated the will return an empty string.
+
+### `String getUserGivenName()`
+
+Returns the given of the current user, if availabe. If the user is not authenticated the will return an empty string.
+
+### `String getUserFamilyName()`
+
+Returns the given of the current user, if availabe. If the user is not authenticated the will return an empty string.
+

ccm-themedirector/doc/ccm-themedirector-freemarker.md

@@ -1,4 +1,4 @@
-# Freemarker functions provided by ccm-themedirectory
+# Freemarker functions provided by ccm-themedirector
 
 ## Language utilities