Changeset 34149 for main

Timestamp:

2020-06-11T13:16:20+12:00 (4 years ago)

Author:

ak19

Message:

Adding note to stress the importance of ensuring the div containing the apply-templates on /page in any custom main.xsl is given the id=gs_content. Otherwise a lot of GS3 could break, the way Remote GS Server's download-collection-configurations broke (the call to authentication-ping by ServletRealmCheck requesting excerptid=gs_content broke, because no user groups were returned for a user because there was no gs_content in the custom interface file main.xsl for Opotiki.

File:

• main/trunk/greenstone3/web/interfaces/default/transform/layouts/main.xsl (modified) (1 diff)

main/trunk/greenstone3/web/interfaces/default/transform/layouts/main.xsl

@@ -68 +68 @@
                         <xsl:call-template name="formatmanagerpre"/>
                     </xsl:if>
-    
+
+                    <!-- IMPORTANT: when copying this file to base your own custom interface's main.xsl on this one,
+                         or when writing a main.xsl for your custom interface from scratch,
+                         it is absolutely crucial to ensure the div element containing the xsl:apply-templates for /page
+                         is given the id="gs_content".
+                         Without this, many parts of GS3 will fail as they make use of gs_content whenever they make
+                         calls to the GS server that include 'excerptid=gs_content' in the URL params.
+                         For instance, connecting a client-GLI to a remote GS3 server and attempting to view
+                         collections will fail as the user groups for a user will return null without this.
+                         ADDITIONAL NOTE: it has not been investigated whether adding addition html elements inside the
+                         div with id="gs_content" is wise. I've not checked whether such elements will be parsed out
+                         properly and just the expected portions retrieved successfully by callers that requested
+                         excerptid=gs_content.
+                    -->
                     <div id="gs_content" class="ui-widget-content">
                         <!--