From 92c98d6d3b2935417abc820b580140d3786f1c4d Mon Sep 17 00:00:00 2001
From: pb <pb@8810af33-2d31-482b-a856-94f89814c4df>
Date: Tue, 3 Sep 2019 05:42:55 +0000
Subject: [PATCH] Added doku to Navigation default templates (Backport r6192
 from release24x)

git-svn-id: https://svn.libreccm.org/ccm/trunk@6193 8810af33-2d31-482b-a856-94f89814c4df
---
 .../templates/ccm-navigation/navigation/def-atoz.jsp |  9 +++++++++
 .../ccm-navigation/navigation/def-events.jsp         |  6 +++---
 .../ccm-navigation/navigation/def-portal-welcome.jsp | 12 ++++++------
 .../ccm-navigation/navigation/def-recent.jsp         |  8 ++++++++
 .../ccm-navigation/navigation/def-welcome.jsp        |  6 ++----
 5 files changed, 28 insertions(+), 13 deletions(-)

diff --git a/ccm-navigation/web/templates/ccm-navigation/navigation/def-atoz.jsp b/ccm-navigation/web/templates/ccm-navigation/navigation/def-atoz.jsp
index 407f1ff14..a658e08e9 100644
--- a/ccm-navigation/web/templates/ccm-navigation/navigation/def-atoz.jsp
+++ b/ccm-navigation/web/templates/ccm-navigation/navigation/def-atoz.jsp
@@ -1,3 +1,12 @@
+<!--
+   Content item page (index page) provided by ccm-navigation package,
+   ordering the object list in a A to Z list and adding a A to Z 
+   paginator
+
+   ##Title: Default A-Z Items List 
+   ##Descr: List of items ordered by title and paginated as A-Z
+   ##Path : /templates/ccm-navigation/navigation/def-atoz.jsp
+-->
 <jsp:root 
   xmlns:jsp="http://java.sun.com/JSP/Page" 
   xmlns:define="/WEB-INF/bebop-define.tld"
diff --git a/ccm-navigation/web/templates/ccm-navigation/navigation/def-events.jsp b/ccm-navigation/web/templates/ccm-navigation/navigation/def-events.jsp
index 28af8f77b..192e2725d 100644
--- a/ccm-navigation/web/templates/ccm-navigation/navigation/def-events.jsp
+++ b/ccm-navigation/web/templates/ccm-navigation/navigation/def-events.jsp
@@ -1,11 +1,11 @@
 <!--
-   Template to generate a list of events
+   Template to generate a list of events, starting with the next event and orderd
+   by ascending start date
 
    ##Title: Events Page
-   ##Descr: Generates an event list ordering items in ??? order.
+   ##Descr: Generates an event list ordering items by start date from current date.
    ##Path : /templates/ccm-navigation/navigation/def-events.jsp
 -->
-
 <jsp:root 
   xmlns:jsp="http://java.sun.com/JSP/Page" 
   xmlns:define="/WEB-INF/bebop-define.tld"
diff --git a/ccm-navigation/web/templates/ccm-navigation/navigation/def-portal-welcome.jsp b/ccm-navigation/web/templates/ccm-navigation/navigation/def-portal-welcome.jsp
index b1ea0bbf5..37f5adbb9 100644
--- a/ccm-navigation/web/templates/ccm-navigation/navigation/def-portal-welcome.jsp
+++ b/ccm-navigation/web/templates/ccm-navigation/navigation/def-portal-welcome.jsp
@@ -1,16 +1,16 @@
-<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page" 
-          xmlns:define="/WEB-INF/bebop-define.tld"
-          xmlns:show="/WEB-INF/bebop-show.tld"
-          version="1.2">
-
 <!-- JSP template to use a portal page as index page in navigation  
      Currently the same as def-portal.jsp, may change in future to
      support special features of a site's start page (home page)      
  
     ##Title: A Portal Page including navigation bar
-    ##Descr: Portal Page meant as an alternative site welcome page in navigation. Portlets must be added separately.
+    ##Descr: Meant as an alternative site welcome page in navigation. Portlets must be added separately.
     ##Path : /templates/ccm-navigation/navigation/def-portal-welcome.jsp
 -->
+<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page" 
+          xmlns:define="/WEB-INF/bebop-define.tld"
+          xmlns:show="/WEB-INF/bebop-show.tld"
+          version="1.2">
+
 
     <jsp:directive.page import="com.arsdigita.dispatcher.DispatcherHelper"/>
     <jsp:directive.page import="com.arsdigita.navigation.Navigation"/>
diff --git a/ccm-navigation/web/templates/ccm-navigation/navigation/def-recent.jsp b/ccm-navigation/web/templates/ccm-navigation/navigation/def-recent.jsp
index bcf080440..7d7072824 100644
--- a/ccm-navigation/web/templates/ccm-navigation/navigation/def-recent.jsp
+++ b/ccm-navigation/web/templates/ccm-navigation/navigation/def-recent.jsp
@@ -1,3 +1,11 @@
+<!--
+   A variation of the default item page ordering the object list decending by
+   publication date
+
+   ##Title: Default Rrecent Item Page
+   ##Descr: Index Page ordered with most recent items first
+   ##Path : /templates/ccm-navigation/navigation/def-recent.jsp
+-->
 <jsp:root 
   xmlns:jsp="http://java.sun.com/JSP/Page" 
   xmlns:define="/WEB-INF/bebop-define.tld"
diff --git a/ccm-navigation/web/templates/ccm-navigation/navigation/def-welcome.jsp b/ccm-navigation/web/templates/ccm-navigation/navigation/def-welcome.jsp
index 64e89a1b8..46f9ad2b5 100644
--- a/ccm-navigation/web/templates/ccm-navigation/navigation/def-welcome.jsp
+++ b/ccm-navigation/web/templates/ccm-navigation/navigation/def-welcome.jsp
@@ -1,10 +1,8 @@
 <!-- 
-   The JSP template for the welcome / start page using navigation 
+   Default JSP template for the welcome / start page using navigation 
 
    ##Title: Default Content Items Page 
-   ##Descr: Site start (landing) page created by navigationNavigation ordering 
-            items in ascending order, manually adjustable and adding News and 
-            Events lists
+   ##Descr: Adds to a standard item list (ascending order, manually adjustable) a news and an events list          
    ##Path : /templates/ccm-navigation/navigation/def-welcome.jsp
 -->
 <jsp:root