From 9ee0fd2267cfde79ea10805f859b03a1f3dbbe7c Mon Sep 17 00:00:00 2001 From: vmishenev Date: Tue, 12 Apr 2022 00:44:49 +0300 Subject: [PATCH] Decompose `base.ftl` template --- .../resources/dokka/templates/article.ftl | 3 ++ .../main/resources/dokka/templates/base.ftl | 39 +++++-------------- .../main/resources/dokka/templates/footer.ftl | 5 +++ .../main/resources/dokka/templates/header.ftl | 27 +++++++++++++ .../resources/dokka/templates/page_head.ftl | 5 +++ 5 files changed, 49 insertions(+), 30 deletions(-) create mode 100644 plugins/base/src/main/resources/dokka/templates/article.ftl create mode 100644 plugins/base/src/main/resources/dokka/templates/footer.ftl create mode 100644 plugins/base/src/main/resources/dokka/templates/header.ftl create mode 100644 plugins/base/src/main/resources/dokka/templates/page_head.ftl diff --git a/plugins/base/src/main/resources/dokka/templates/article.ftl b/plugins/base/src/main/resources/dokka/templates/article.ftl new file mode 100644 index 0000000000..7f300881e4 --- /dev/null +++ b/plugins/base/src/main/resources/dokka/templates/article.ftl @@ -0,0 +1,3 @@ +<#macro display> + <@content/> + \ No newline at end of file diff --git a/plugins/base/src/main/resources/dokka/templates/base.ftl b/plugins/base/src/main/resources/dokka/templates/base.ftl index fb8fabd90b..044c2ed597 100644 --- 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> ${pageName} + <@page_head.display/> <@template_cmd name="pathToRoot"> - <#-- This script doesn't need to be there but it is nice to have @@ -20,41 +24,16 @@ if(savedDarkMode === true){
- <@content/> -
${footerMessage}Generated by dokka + <@article.display/> +
+ <@footer.display/>
diff --git a/plugins/base/src/main/resources/dokka/templates/footer.ftl b/plugins/base/src/main/resources/dokka/templates/footer.ftl new file mode 100644 index 0000000000..468929bcf8 --- /dev/null +++ b/plugins/base/src/main/resources/dokka/templates/footer.ftl @@ -0,0 +1,5 @@ +<#macro display> + ${footerMessage}Generated by dokka + \ No newline at end of file diff --git a/plugins/base/src/main/resources/dokka/templates/header.ftl b/plugins/base/src/main/resources/dokka/templates/header.ftl new file mode 100644 index 0000000000..86c58a7d17 --- /dev/null +++ b/plugins/base/src/main/resources/dokka/templates/header.ftl @@ -0,0 +1,27 @@ +<#macro display> +
+
+ <@template_cmd name="pathToRoot"> + + <@template_cmd name="projectName"> + ${projectName} + + + +
+
+ <#-- This can be handled by a versioning plugin --> + <@version/> +
+
+ <#if sourceSets??> +
+ <#list sourceSets as ss> + + +
+ + + +
+ \ No newline at end of file diff --git a/plugins/base/src/main/resources/dokka/templates/page_head.ftl b/plugins/base/src/main/resources/dokka/templates/page_head.ftl new file mode 100644 index 0000000000..d9a923a380 --- /dev/null +++ b/plugins/base/src/main/resources/dokka/templates/page_head.ftl @@ -0,0 +1,5 @@ +<#macro display> + <@template_cmd name="pathToRoot"> + + + \ No newline at end of file