From b15ccb1b41ec28ae01c036bd7f7504f388ac83cd Mon Sep 17 00:00:00 2001
From: jensp <jensp@8810af33-2d31-482b-a856-94f89814c4df>
Date: Sat, 8 Jun 2019 09:18:45 +0000
Subject: [PATCH] Docuementation for the Freemarker functions provided by
 ccm-core

git-svn-id: https://svn.libreccm.org/ccm/trunk@6118 8810af33-2d31-482b-a856-94f89814c4df
---
 .../{ccm-core.md => ccm-core/user-banner.md}  | 22 +++++++++----------
 1 file changed, 10 insertions(+), 12 deletions(-)
 rename ccm-core/doc/freemarker/{ccm-core.md => ccm-core/user-banner.md} (68%)

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