Decompose base.ftl template

Kotlin · Apr 11, 2022 · 9ee0fd2 · 9ee0fd2
1 parent 21a50e2
commit 9ee0fd2
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 30 deletions.
diff --git a/plugins/base/src/main/resources/dokka/templates/article.ftl b/plugins/base/src/main/resources/dokka/templates/article.ftl
@@ -0,0 +1,3 @@
+<#macro display>
+        <@content/>
+</#macro>
diff --git a/plugins/base/src/main/resources/dokka/templates/base.ftl b/plugins/base/src/main/resources/dokka/templates/base.ftl
@@ -1,10 +1,14 @@
+<#import "page_head.ftl" as page_head>
+<#import "header.ftl" as header>
+<#import "footer.ftl" as footer>
+<#import "article.ftl" as article>
 <!DOCTYPE html>
 <html>
 <head>
     <meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
     <title>${pageName}</title>
+    <@page_head.display/>
     <@template_cmd name="pathToRoot">
-    <link href="${pathToRoot}images/logo-icon.svg" rel="icon" type="image/svg">
     <script>var pathToRoot = "${pathToRoot}";</script>
     </@template_cmd>
     <#-- This script doesn't need to be there but it is nice to have
@@ -20,41 +24,16 @@ if(savedDarkMode === true){
 </head>
 <body>
 <div class="navigation-wrapper" id="navigation-wrapper">
-    <div id="leftToggler"><span class="icon-toggler"></span></div>
-    <div class="library-name">
-        <@template_cmd name="pathToRoot">
-            <a href="${pathToRoot}index.html">
-                <@template_cmd name="projectName">
-                    <span>${projectName}</span>
-                </@template_cmd>
-            </a>
-        </@template_cmd>
-    </div>
-    <div>
-        <#-- This can be handled by a versioning plugin -->
-        <@version/>
-    </div>
-    <div class="pull-right d-flex">
-        <#if sourceSets??>
-            <div class="filter-section" id="filter-section">
-                <#list sourceSets as ss>
-                    <button class="platform-tag platform-selector ${ss.platform}-like" data-active="" data-filter="${ss.filter}">${ss.name}</button>
-                </#list>
-            </div>
-        </#if>
-        <button id="theme-toggle-button"><span id="theme-toggle"></span></button>
-        <div id="searchBar"></div>
-    </div>
+    <@header.display/>
 </div>
 <div id="container">
     <div id="leftColumn">
         <div id="sideMenu"></div>
     </div>
     <div id="main">
-        <@content/>
-        <div class="footer"><span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>${footerMessage}</span><span
-                class="pull-right"><span>Generated by </span><a
-                href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
+        <@article.display/>
+        <div class="footer">
+            <@footer.display/>
         </div>
     </div>
 </div>

diff --git a/plugins/base/src/main/resources/dokka/templates/footer.ftl b/plugins/base/src/main/resources/dokka/templates/footer.ftl
@@ -0,0 +1,5 @@
+<#macro display>
+        <span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>${footerMessage}</span><span
+                class="pull-right"><span>Generated by </span><a
+                href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
+</#macro>
diff --git a/plugins/base/src/main/resources/dokka/templates/header.ftl b/plugins/base/src/main/resources/dokka/templates/header.ftl
@@ -0,0 +1,27 @@
+<#macro display>
+    <div id="leftToggler"><span class="icon-toggler"></span></div>
+    <div class="library-name">
+        <@template_cmd name="pathToRoot">
+            <a href="${pathToRoot}index.html">
+                <@template_cmd name="projectName">
+                    <span>${projectName}</span>
+                </@template_cmd>
+            </a>
+        </@template_cmd>
+    </div>
+    <div>
+        <#-- This can be handled by a versioning plugin -->
+        <@version/>
+    </div>
+    <div class="pull-right d-flex">
+        <#if sourceSets??>
+            <div class="filter-section" id="filter-section">
+                <#list sourceSets as ss>
+                    <button class="platform-tag platform-selector ${ss.platform}-like" data-active="" data-filter="${ss.filter}">${ss.name}</button>
+                </#list>
+            </div>
+        </#if>
+        <button id="theme-toggle-button"><span id="theme-toggle"></span></button>
+        <div id="searchBar"></div>
+    </div>
+</#macro>
diff --git a/plugins/base/src/main/resources/dokka/templates/page_head.ftl b/plugins/base/src/main/resources/dokka/templates/page_head.ftl
@@ -0,0 +1,5 @@
+<#macro display>
+    <@template_cmd name="pathToRoot">
+    <link href="${pathToRoot}images/logo-icon.svg" rel="icon" type="image/svg">
+    </@template_cmd>
+</#macro>