[bugfix] Correct the parameters for the 'Edit this page' button

Author: adamretter

.github/workflows/pages.yml

@@ -31,7 +31,7 @@ jobs:
       - name: Generate website (XSLT)
         id: generate
         # Override Maven properties for the Petal button url
-        run: mvn -B -Dpetal.api-url=https://petal.evolvedbinary.com -Dpetal.github-org-name=evolvedbinary -Dpetal.github-repo-name=cityehr-documentation -Dpetal.github-branch=develop -Dpetal.referrer-base-url=https://evolvedbinary.github.io/cityehr-documentation package -Dcityehr-documentation-website=true
+        run: mvn -B -Dpetal.api-url=https://petal.evolvedbinary.com -Dpetal.github-org-name=cityehr -Dpetal.github-repo-name=cityehr-documentation -Dpetal.github-branch=main -Dpetal.referrer-base-url=https://cityehr.github.io/cityehr-documentation package -Dcityehr-documentation-website=true
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - name: Upload pages artifact

cityehr-documentation-common/src/main/xslt/create-topic-html.xslt

@@ -24,11 +24,12 @@
   <!-- PARAMETER - the revision date and time of the generated document -->
   <xsl:param name="revision" required="no" as="xs:dateTime" select="current-dateTime()"/>
 
-  <xsl:param name="petal-api-url"           as="xs:string" required="yes"/>
-  <xsl:param name="petal-github-org-name"   as="xs:string" required="yes"/>
-  <xsl:param name="petal-github-repo-name"  as="xs:string" required="yes"/>
-  <xsl:param name="petal-github-branch"     as="xs:string" required="yes"/>
-  <xsl:param name="petal-referrer-base-url" as="xs:string" required="yes"/>
+  <xsl:param name="petal-api-url"             as="xs:string"  required="yes"/>
+  <xsl:param name="petal-github-org-name"     as="xs:string"  required="yes"/>
+  <xsl:param name="petal-github-repo-name"    as="xs:string"  required="yes"/>
+  <xsl:param name="petal-github-branch"       as="xs:string"  required="yes"/>
+  <xsl:param name="petal-referrer-base-url"   as="xs:string"  required="yes"/>
+  <xsl:param name="petal-referrer-sub-folder" as="xs:string?" required="no"/>
 
   <xsl:variable name="authors" as="xs:string+" select="('John Chelsom', 'Stephanie Cabrera', 'Catriona Hopper', 'Jennifer Ramirez')"/>
 
@@ -50,7 +51,7 @@
 
         <!-- Petal Edit Button -->
         <div id="petal-edit-page-button">
-          <a href="{htop:petal-edit-url(com:document-uri(.), $petal-api-url, $petal-github-org-name, $petal-github-repo-name, $petal-github-branch, $petal-referrer-base-url)}">
+          <a href="{htop:petal-edit-url(com:document-uri(.), $petal-api-url, $petal-github-org-name, $petal-github-repo-name, $petal-github-branch, $petal-referrer-base-url, $petal-referrer-sub-folder)}">
             <input type="button" value="Edit this page"/>
           </a>
         </div>
@@ -172,17 +173,18 @@
     Generates an Edit button URL for Petal
   -->
   <xsl:function name="htop:petal-edit-url" as="xs:string">
-    <xsl:param name="petal-source-file-uri"   as="xs:string" required="yes"/>
-    <xsl:param name="petal-api-url"           as="xs:string" required="yes"/>
-    <xsl:param name="petal-github-org-name"   as="xs:string" required="yes"/>
-    <xsl:param name="petal-github-repo-name"  as="xs:string" required="yes"/>
-    <xsl:param name="petal-github-branch"     as="xs:string" required="yes"/>
-    <xsl:param name="petal-referrer-base-url" as="xs:string" required="yes"/>
+    <xsl:param name="petal-source-file-uri"     as="xs:string" required="yes"/>
+    <xsl:param name="petal-api-url"             as="xs:string" required="yes"/>
+    <xsl:param name="petal-github-org-name"     as="xs:string" required="yes"/>
+    <xsl:param name="petal-github-repo-name"    as="xs:string" required="yes"/>
+    <xsl:param name="petal-github-branch"       as="xs:string" required="yes"/>
+    <xsl:param name="petal-referrer-base-url"   as="xs:string" required="yes"/>
+    <xsl:param name="petal-referrer-sub-folder" as="xs:string?"/>
 
     <xsl:variable name="petal-source-file-uri-tokens" select="tokenize($petal-source-file-uri, concat($petal-github-repo-name, '/'))" />
     <xsl:variable name="petal-source-file" select="$petal-source-file-uri-tokens[last()]" />
     <xsl:variable name="petal-webpage-filename" select="hcom:dita-filename-to-html(com:filename($petal-source-file-uri))" />
-    <xsl:sequence select="concat($petal-api-url, '?ghrepo=', $petal-github-org-name, '/', $petal-github-repo-name, '&amp;source=', $petal-source-file, '&amp;branch=', $petal-github-branch, '&amp;referer=', $petal-referrer-base-url, '/', $petal-webpage-filename)" />
+    <xsl:sequence select="concat($petal-api-url, '?ghrepo=', $petal-github-org-name, '/', $petal-github-repo-name, '&amp;source=', $petal-source-file, '&amp;branch=', $petal-github-branch, '&amp;referer=', string-join(($petal-referrer-base-url, $petal-referrer-sub-folder, $petal-webpage-filename), '/'))" />
   </xsl:function>
 
-</xsl:stylesheet>
+</xsl:stylesheet>

cityehr-documentation-common/src/test/xspec/create-topic-html.xspec

@@ -5,12 +5,13 @@
   xmlns:htop="http://cityehr/html/topic"
   stylesheet="../../main/xslt/create-topic-html.xslt">
 
-  <x:param name="version"                 as="xs:string">xspec-test-version</x:param>
-  <x:param name="petal-api-url"           as="xs:string">https://petal.evolvedbinary.com</x:param>
-  <x:param name="petal-github-org-name"   as="xs:string">evolvedbinary</x:param>
-  <x:param name="petal-github-repo-name"  as="xs:string">cityehr-documentation</x:param>
-  <x:param name="petal-github-branch"     as="xs:string">develop</x:param>
-  <x:param name="petal-referrer-base-url" as="xs:string">https://evolvedbinary.github.io/cityehr-documentation</x:param>
+  <x:param name="version"                   as="xs:string">xspec-test-version</x:param>
+  <x:param name="petal-api-url"             as="xs:string">https://petal.evolvedbinary.com</x:param>
+  <x:param name="petal-github-org-name"     as="xs:string">evolvedbinary</x:param>
+  <x:param name="petal-github-repo-name"    as="xs:string">cityehr-documentation</x:param>
+  <x:param name="petal-github-branch"       as="xs:string">develop</x:param>
+  <x:param name="petal-referrer-base-url"   as="xs:string">https://evolvedbinary.github.io/cityehr-documentation</x:param>
+  <x:param name="petal-referrer-sub-folder" as="xs:string">quick-start-guide</x:param>
 
   <x:scenario label="Scenario for testing the petal-edit-url function with source file from local filesytem">
     <x:call function="htop:petal-edit-url">
@@ -20,8 +21,9 @@
       <x:param name="petal-github-repo-name"  as="xs:string">cityehr-documentation</x:param>
       <x:param name="petal-github-branch"     as="xs:string">develop</x:param>
       <x:param name="petal-referrer-base-url" as="xs:string">https://evolvedbinary.github.io/cityehr-documentation</x:param>
+      <x:param name="petal-referrer-sub-folder" as="xs:string">quick-start-guide</x:param>
     </x:call>
-    <x:expect label="Correct Petal Edit URL" select="'https://petal.evolvedbinary.com?ghrepo=evolvedbinary/cityehr-documentation&amp;source=cityehr-quick-start-guide/src/main/lwdita/quick-start-guide/verify-install.dita&amp;branch=develop&amp;referer=https://evolvedbinary.github.io/cityehr-documentation/verify-install.html'"/>
+    <x:expect label="Correct Petal Edit URL" select="'https://petal.evolvedbinary.com?ghrepo=evolvedbinary/cityehr-documentation&amp;source=cityehr-quick-start-guide/src/main/lwdita/quick-start-guide/verify-install.dita&amp;branch=develop&amp;referer=https://evolvedbinary.github.io/cityehr-documentation/quick-start-guide/verify-install.html'"/>
   </x:scenario>
 
   <x:scenario label="Scenario for testing the petal-edit-url function with source file in GitHub Action container">
@@ -32,8 +34,9 @@
       <x:param name="petal-github-repo-name"  as="xs:string">cityehr-documentation</x:param>
       <x:param name="petal-github-branch"     as="xs:string">develop</x:param>
       <x:param name="petal-referrer-base-url" as="xs:string">https://evolvedbinary.github.io/cityehr-documentation</x:param>
+      <x:param name="petal-referrer-sub-folder" as="xs:string">quick-start-guide</x:param>
     </x:call>
-    <x:expect label="Correct Petal Edit URL" select="'https://petal.evolvedbinary.com?ghrepo=evolvedbinary/cityehr-documentation&amp;source=cityehr-quick-start-guide/src/main/lwdita/quick-start-guide/verify-install.dita&amp;branch=develop&amp;referer=https://evolvedbinary.github.io/cityehr-documentation/verify-install.html'"/>
+    <x:expect label="Correct Petal Edit URL" select="'https://petal.evolvedbinary.com?ghrepo=evolvedbinary/cityehr-documentation&amp;source=cityehr-quick-start-guide/src/main/lwdita/quick-start-guide/verify-install.dita&amp;branch=develop&amp;referer=https://evolvedbinary.github.io/cityehr-documentation/quick-start-guide/verify-install.html'"/>
   </x:scenario>
 
 </x:description>

cityehr-modelling-guide/pom.xml

@@ -28,10 +28,11 @@
         <website.output.folder>${project.build.directory}/website</website.output.folder>
 
         <petal.api-url>https://petal.evolvedbinary.com</petal.api-url>
-        <petal.github-org-name>evolvedbinary</petal.github-org-name>
+        <petal.github-org-name>cityehr</petal.github-org-name>
         <petal.github-repo-name>cityehr-documentation</petal.github-repo-name>
-        <petal.github-branch>develop</petal.github-branch>
-        <petal.referrer-base-url>https://evolvedbinary.github.io/cityehr-documentation</petal.referrer-base-url>
+        <petal.github-branch>main</petal.github-branch>
+        <petal.referrer-base-url>https://cityehr.github.io/cityehr-documentation</petal.referrer-base-url>
+        <petal.referrer-sub-folder>modelling-guide</petal.referrer-sub-folder>
     </properties>
 
     <dependencies>
@@ -266,6 +267,10 @@
                                                     <name>petal-referrer-base-url</name>
                                                     <value>${petal.referrer-base-url}</value>
                                                 </parameter>
+                                                <parameter>
+                                                    <name>petal-referrer-sub-folder</name>
+                                                    <value>${petal.referrer-sub-folder}</value>
+                                                </parameter>
                                             </parameters>
                                             <outputDir>${html.generated-resources}</outputDir>
                                             <fileMappers>

cityehr-quick-start-guide/pom.xml

@@ -28,10 +28,11 @@
         <website.output.folder>${project.build.directory}/website</website.output.folder>
 
         <petal.api-url>https://petal.evolvedbinary.com</petal.api-url>
-        <petal.github-org-name>evolvedbinary</petal.github-org-name>
+        <petal.github-org-name>cityehr</petal.github-org-name>
         <petal.github-repo-name>cityehr-documentation</petal.github-repo-name>
-        <petal.github-branch>develop</petal.github-branch>
-        <petal.referrer-base-url>https://evolvedbinary.github.io/cityehr-documentation</petal.referrer-base-url>
+        <petal.github-branch>main</petal.github-branch>
+        <petal.referrer-base-url>https://cityehr.github.io/cityehr-documentation</petal.referrer-base-url>
+        <petal.referrer-sub-folder>quick-start-guide</petal.referrer-sub-folder>
     </properties>
 
     <dependencies>
@@ -268,6 +269,10 @@
                                                     <name>petal-referrer-base-url</name>
                                                     <value>${petal.referrer-base-url}</value>
                                                 </parameter>
+                                                <parameter>
+                                                    <name>petal-referrer-sub-folder</name>
+                                                    <value>${petal.referrer-sub-folder}</value>
+                                                </parameter>
                                             </parameters>
                                             <outputDir>${html.generated-resources}</outputDir>
                                             <fileMappers>