Merge branch 'f-doc-link-footer' into 'dev'

ENH: docs link in footer

See merge request !48

CHANGELOG.md

@@ -4,6 +4,38 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Added (for new features, dependecies etc.)
+
+* Documentation link in standard footer
+* Build properties for footer elements:
+  * `BUILD_FOOTER_CONTACT_HREF`
+  * `BUILD_FOOTER_IMPRINT_HREF`
+  * `BUILD_FOOTER_DOCS_HREF`
+  * `BUILD_FOOTER_SOURCES_HREF`
+  * `BUILD_FOOTER_LICENCE_HREF`
+  See `build.properties.d/00_default.properties` for more information
+
+### Changed (for changes in existing functionality)
+
+* Default footer elements contain invalid links for imprint, contact, and data-policy now
+
+### Deprecated (for soon-to-be removed features)
+
+### Removed (for now removed features)
+
+* Build property `BUILD_CUSTOM_IMPRINT`. Please use BUILD_FOOTER_IMPRINT_HREF
+  and link a document instead. You can always put a html page to
+  `src/ext/html/` and link to that.
+
+### Fixed (for any bug fixes)
+
+### Security (in case of vulnerabilities)
+
+### Documentation (for notable additions or changes of the documentation)
+
+
 ## [0.4.1] - 2021-11-04
 
 ### Added (for new features, dependecies etc.)
@@ -12,10 +44,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed (for changes in existing functionality)
 
+* Default footer elements contain invalid links for imprint, contact, and data-policy now
+
 ### Deprecated (for soon-to-be removed features)
 
 ### Removed (for now removed features)
 
+* Build property `BUILD_CUSTOM_IMPRINT`. Please use BUILD_FOOTER_IMPRINT_HREF
+  and link a document instead. You can always put a html page to
+  `src/ext/html/` and link to that.
+
 ### Fixed (for any bug fixes)
 
 ### Security (in case of vulnerabilities)

Makefile

@@ -73,7 +73,7 @@ merge_js:
 	JS_DIST_BUNDLE=$${JS_DIST_BUNDLE} AUTO_DISCOVER_MODULES=$$AUTO_DISCOVER_MODULES misc/merge_js.sh $${MODULE_DEPENDENCIES[*]}
 
 EXCLUDE_EXPR = %~ %.backup
-BUILDFILELIST = $(filter-out $(EXCLUDE_EXPR),$(wildcard build.properties.d/*))
+BUILDFILELIST = $(sort $(filter-out $(EXCLUDE_EXPR),$(wildcard build.properties.d/*)))
 build_properties:
 	@set -a -e ; \
 	pushd build.properties.files ; \

build.properties.d/00_default.properties

@@ -77,7 +77,24 @@ BUILD_FAVICON=pics/caosdb_logo_42.png
 ##############################################################################
 
 # Link to the data policy statement document.
-BUILD_FOOTER_DATA_POLICY_HREF=https://missing-domain.com/missing-page
+BUILD_FOOTER_DATA_POLICY_HREF="Please configure me!"
+
+# Contact mail or link to contact information for the responsible administrator of this caosdb server instance.
+BUILD_FOOTER_CONTACT_HREF="Please configure me!"
+#BUILD_FOOTER_CONTACT_HREF=mailto:info@indiscale.com
+
+# Link to imprint for this caosdb server instance.
+BUILD_FOOTER_IMPRINT_HREF="Please configure me!"
+#BUILD_FOOTER_IMPRINT_HREF=https://www.indiscale.com/imprint/
+
+# Link to docs (should rarely be changed (maybe for additional docs))
+BUILD_FOOTER_DOCS_HREF="https://docs.indiscale.com"
+
+# Link to sources (should almost never be changed (maybe for additional sources))
+BUILD_FOOTER_SOURCES_HREF="https://gitlab.com/caosdb"
+
+# Link to license (should almost never be changed (maybe for other languages))
+BUILD_FOOTER_LICENCE_HREF="https://www.gnu.org/licenses/agpl-3.0.en.html"
 
 # Custom footer elements can be placed here (will be placed inside a <div>
 # element).
@@ -90,7 +107,6 @@ BUILD_FOOTER_CUSTOM_ELEMENT_ONE=
 # ${BUILD_NUMBER}.
 BUILD_FOOTER_CUSTOM_ELEMENT_TWO=
 # BUILD_FOOTER_CUSTOM_ELEMENT_TWO=$(cat footer_element_2.html)
-BUILD_CUSTOM_IMPRINT='<p> Put an imprint note here </p>'
 
 ##############################################################################
 # ext_trigger_crawler_form properties

src/core/xsl/footer.xsl

@@ -35,15 +35,17 @@
       </div>
     </div>
     <div class="container d-flex flex-md-row flex-column justify-content-center">
-      <a href="mailto:info@indiscale.com">Contact</a>
+      <a href="${BUILD_FOOTER_CONTACT_HREF}">Contact</a>
       <span class="caosdb-bulletsep d-none d-md-inline">•</span>
-      <a href="https://www.indiscale.com/imprint/">Imprint/Impressum</a>
+      <a href="${BUILD_FOOTER_IMPRINT_HREF}">Imprint/Impressum</a>
       <span class="caosdb-bulletsep d-none d-md-inline">•</span>
       <a href="${BUILD_FOOTER_DATA_POLICY_HREF}">Data Policy</a>
       <span class="caosdb-bulletsep d-none d-md-inline">•</span>
-      <a href="https://www.gnu.org/licenses/agpl-3.0.en.html" target="_blank">License (AGPL-v3)</a>
+      <a href="${BUILD_FOOTER_LICENCE_HREF}" target="_blank">License (AGPL-v3)</a>
       <span class="caosdb-bulletsep d-none d-md-inline">•</span>
-      <a href="https://gitlab.com/caosdb" target="_blank">Sources</a>
+      <a href="${BUILD_FOOTER_SOURCES_HREF}" target="_blank">Sources</a>
+      <span class="caosdb-bulletsep d-none d-md-inline">•</span>
+      <a href="${BUILD_FOOTER_DOCS_HREF}" target="_blank">Documentation</a>
     </div>
   </xsl:template>
 </xsl:stylesheet>