Home Explore Help
Sign In
xry111
/
hugo-academic
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Browse Source

refactor: pages as blocks of a base template

Refactor pages as blocks of a base template rather than not using a base template and directly including all necessary elements on each page.

May make Academic more modular and maintainable whilst making it easier for users to apply advanced customizations.

See https://gohugo.io/templates/base/#define-the-base-template

Close #634
Close #1115
George Cushen 6 years ago
parent
316bfe2d8f 9263fcd3c9
commit
5b24f2aa13
26 changed files with 80 additions and 71 deletions
Split View Show Diff Stats
  1. 4 4
      layouts/404.html
  2. 25 0
      layouts/_default/baseof.html
  3. 3 4
      layouts/_default/list.html
  4. 2 4
      layouts/_default/single.html
  5. 2 4
      layouts/authors/list.html
  6. 3 4
      layouts/authors/terms.html
  7. 2 0
      layouts/docs/list.html
  8. 2 0
      layouts/docs/single.html
  9. 3 0
      layouts/index.html
  10. 1 5
      layouts/partials/citation.html
  11. 4 0
      layouts/partials/custom_head.html
  12. 4 0
      layouts/partials/custom_js.html
  13. 1 5
      layouts/partials/docs_layout.html
  14. 0 0
      layouts/partials/head_custom.html
  15. 0 0
      layouts/partials/site_footer.html
  16. 2 5
      layouts/partials/site_head.html
  17. 1 2
      layouts/partials/site_js.html
  18. 0 6
      layouts/partials/widget_page.html
  19. 2 4
      layouts/project/single.html
  20. 3 4
      layouts/publication/single.html
  21. 2 4
      layouts/section/docs.html
  22. 3 4
      layouts/section/post.html
  23. 3 4
      layouts/section/publication.html
  24. 3 4
      layouts/section/talk.html
  25. 3 4
      layouts/talk/single.html
  26. 2 0
      layouts/widget_page/single.html

+ 4 - 4
layouts/404.html
View File 

@@ -1,5 +1,5 @@
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
+{{- define "main" -}}
 
+
 
 <div class="universal-wrapper pt-3">
 
 
   <h1>{{ i18n "page_not_found" }}</h1>
 
@@ -27,5 +27,5 @@
 
   {{ end }}
 
 
 </div>
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}
 
+
 
+{{- end -}}

+ 25 - 0
layouts/_default/baseof.html
View File 

@@ -0,0 +1,25 @@
 
+<!DOCTYPE html>
 
+<html lang="{{ site.LanguageCode | default "en-us" }}">
 
+
 
+{{ partial "site_head.html" . }}
 
+
 
+<body id="top" data-spy="scroll" data-target="{{ if or .IsHome (eq .Type "widget_page") }}#navbar-main{{else}}#TableOfContents{{end}}" data-offset="71" {{ if not (.Scratch.Get "light") }}class="dark"{{end}}>
 
+
 
+  {{ partial "search" . }}
 
+
 
+  {{ partial "navbar.html" . }}
 
+
 
+  {{ block "main" . }}{{ end }}
 
+
 
+  {{ partial "site_js.html" . }}
 
+
 
+  {{ if ne .Type "docs" }}
 
+  <div class="container">
 
+    {{ partial "site_footer.html" . }}
 
+  </div>
 
+  {{ end }}
 
+
 
+  {{ partial "citation.html" . }}
 
+
 
+</body>
 
+</html>

+ 3 - 4
layouts/_default/list.html
View File 

@@ -1,5 +1,4 @@
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
+{{- define "main" -}}
 
 
 {{ partial "page_header.html" . }}
 
 
@@ -26,5 +25,5 @@
 
 
   {{ partial "pagination" . }}
 
 </div>
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}
 
+
 
+{{- end -}}

+ 2 - 4
layouts/_default/single.html
View File 

@@ -1,5 +1,4 @@
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
+{{- define "main" -}}
 
 
 <article class="article" itemscope itemtype="http://schema.org/Article">
 
 
@@ -40,5 +39,4 @@
 
   </div>
 
 </article>
 
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}
 
+{{- end -}}

+ 2 - 4
layouts/authors/list.html
View File 

@@ -1,7 +1,6 @@
 
 {{/* Author profile page. */}}
 
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
+{{- define "main" -}}
 
 
 {{/* If an account has not been created for this user, just display their name as the title. */}}
 
 {{ if not .File }}
 
@@ -38,5 +37,4 @@
 
   {{ end }}
 
 </section>
 
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}
 
+{{- end -}}

+ 3 - 4
layouts/authors/terms.html
View File 

@@ -1,7 +1,6 @@
 
 {{/* List of all authors. */}}
 
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
+{{- define "main" -}}
 
 
 {{ partial "page_header.html" . }}
 
 
@@ -20,5 +19,5 @@
 
 
   {{ partial "pagination" . }}
 
 </div>
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}
 
+
 
+{{- end -}}

+ 2 - 0
layouts/docs/list.html
View File 

@@ -1 +1,3 @@
 
+{{- define "main" -}}
 
 {{ partial "docs_layout.html" . }}
 
+{{- end -}}

+ 2 - 0
layouts/docs/single.html
View File 

@@ -1 +1,3 @@
 
+{{- define "main" -}}
 
 {{ partial "docs_layout.html" . }}
 
+{{- end -}}

+ 3 - 0
layouts/index.html
View File 

@@ -1,4 +1,7 @@
 
 {{ if not (isset site.Params "color_theme") }}
 
   {{ errorf "Please complete the installation of Academic by following the steps at https://sourcethemes.com/academic/docs/install/" }}
 
 {{ end }}
 
+
 
+{{- define "main" -}}
 
 {{ partial "widget_page.html" . }}
 
+{{- end -}}

+ 1 - 5
layouts/partials/footer_container.html → layouts/partials/citation.html
View File 

@@ -1,7 +1,3 @@
 
-<div class="container">
 
-  {{ partial "footer_section.html" . }}
 
-</div>
 
-
 
 <!-- Citation modal -->
 
 <div id="modal" class="modal fade" role="dialog">
 
   <div class="modal-dialog">
 
@@ -26,4 +22,4 @@
 
       </div>
 
     </div>
 
   </div>
 
-</div>
 
+</div>

+ 4 - 0
layouts/partials/custom_head.html
View File 

@@ -0,0 +1,4 @@
 
+{{/* No changes should be made to this file. */}}
 
+{{/* Instead, create or modify your sites layout/partials/custom_head.html. */}}
 
+
 
+{{/* This partial is included in themes/academic/layout/partials/site_head.html. */}}

+ 4 - 0
layouts/partials/custom_js.html
View File 

@@ -0,0 +1,4 @@
 
+{{/* No changes should be made to this file. */}}
 
+{{/* Instead, create or modify your sites layout/partials/custom_js.html. */}}
 
+
 
+{{/* This partial is included in themes/academic/layout/partials/site_js.html. */}}

+ 1 - 5
layouts/partials/docs_layout.html
View File 

@@ -1,5 +1,3 @@
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
 {{ $current_page := . }}
 
 
 <div class="container-fluid docs">
 
@@ -46,10 +44,8 @@
 
 
       </article>
 
 
-      {{ partial "footer_section.html" . }}
 
+      {{ partial "site_footer.html" . }}
 
 
     </main>
 
   </div>
 
 </div>
 
-
 
-{{ partial "footer.html" . }}

+ 0 - 0
layouts/partials/head_custom.html
View File


+ 0 - 0
layouts/partials/footer_section.html → layouts/partials/site_footer.html
View File


+ 2 - 5
layouts/partials/header.html → layouts/partials/site_head.html
View File 

@@ -1,5 +1,3 @@
 
-<!DOCTYPE html>
 
-<html lang="{{ site.LanguageCode | default "en-us" }}">
 
 <head>
 
 
   <meta charset="utf-8">
 
@@ -183,10 +181,9 @@
 
   {{ end }}
 
 
   {{ partial "cookie_consent" . }}
 
-  {{ partial "head_custom" . }}
 
+
 
+  {{ partial "custom_head" . }}
 
 
   <title>{{ if not .IsHome }}{{ .Title }} | {{ end }}{{ site.Title }}</title>
 
 
 </head>
 
-<body id="top" data-spy="scroll" data-target="{{ if or .IsHome (eq .Type "widget_page") }}#navbar-main{{else}}#TableOfContents{{end}}" data-offset="71" {{ if not ($scr.Get "light") }}class="dark"{{end}}>
 
-  {{ partial "search" . }}

+ 1 - 2
layouts/partials/footer.html → layouts/partials/site_js.html
View File 

@@ -150,5 +150,4 @@
 
     {{ $js_bundle := slice $js_bundle_head $js_bundle | resources.Concat "js/academic.min.js" | fingerprint "md5" }}
 
     <script src="{{ $js_bundle.RelPermalink }}"></script>
 
 
-  </body>
 
-</html>
 
+    {{ partial "custom_js" . }}

+ 0 - 6
layouts/partials/widget_page.html
View File 

@@ -1,6 +1,3 @@
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
-
 
 {{/* Notify JS that this is a widget page */}}
 
 <span class="js-widget-page d-none"></span>
 
 
@@ -75,6 +72,3 @@
 
     {{if $use_container}}</div>{{end}}
 
   </section>
 
 {{ end }}
 
-
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}

+ 2 - 4
layouts/project/single.html
View File 

@@ -1,5 +1,4 @@
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
+{{- define "main" -}}
 
 
 <article class="article article-project" itemscope itemtype="http://schema.org/Article">
 
 
@@ -73,5 +72,4 @@
 
 </div>
 
 {{ end }}
 
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}
 
+{{- end -}}

+ 3 - 4
layouts/publication/single.html
View File 

@@ -1,5 +1,5 @@
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
+{{- define "main" -}}
 
+
 
 <div class="pub" itemscope itemtype="http://schema.org/CreativeWork">
 
 
   {{ partial "page_header.html" . }}
 
@@ -62,5 +62,4 @@
 
 </div>
 
 {{ end }}
 
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}
 
+{{- end -}}

+ 2 - 4
layouts/section/docs.html
View File 

@@ -1,5 +1,4 @@
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
+{{- define "main" -}}
 
 
 {{ partial "page_header.html" . }}
 
 
@@ -16,5 +15,4 @@
 
   </ul>
 
 </div>
 
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}
 
+{{- end -}}

+ 3 - 4
layouts/section/post.html
View File 

@@ -1,5 +1,4 @@
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
+{{- define "main" -}}
 
 
 {{ partial "page_header.html" . }}
 
 
@@ -23,5 +22,5 @@
 
   {{ partial "pagination" . }}
 
 
 </div>
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}
 
+
 
+{{- end -}}

+ 3 - 4
layouts/section/publication.html
View File 

@@ -1,5 +1,4 @@
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
+{{- define "main" -}}
 
 
 {{ partial "page_header.html" . }}
 
 
@@ -75,5 +74,5 @@
 
     </div>
 
   </div>
 
 </div>
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}
 
+
 
+{{- end -}}

+ 3 - 4
layouts/section/talk.html
View File 

@@ -1,5 +1,4 @@
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
+{{- define "main" -}}
 
 
 {{ partial "page_header.html" . }}
 
 
@@ -36,5 +35,5 @@
 
   </div>
 
 
 </div>
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}
 
+
 
+{{- end -}}

+ 3 - 4
layouts/talk/single.html
View File 

@@ -1,5 +1,5 @@
 
-{{ partial "header.html" . }}
 
-{{ partial "navbar.html" . }}
 
+{{- define "main" -}}
 
+
 
 <div class="pub" itemscope itemtype="http://schema.org/Event">
 
 
   {{ partial "page_header.html" . }}
 
@@ -84,5 +84,4 @@
 
 </div>
 
 {{ end }}
 
 
-{{ partial "footer_container.html" . }}
 
-{{ partial "footer.html" . }}
 
+{{- end -}}

+ 2 - 0
layouts/widget_page/single.html
View File 

@@ -1 +1,3 @@
 
+{{- define "main" -}}
 
 {{ partial "widget_page.html" . }}
 
+{{- end -}}