You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@freemarker.apache.org by dd...@apache.org on 2020/08/01 16:41:49 UTC

[freemarker-docgen] branch master updated (aa3c920 -> 7414ae8)

This is an automated email from the ASF dual-hosted git repository.

ddekany pushed a change to branch master
in repository https://gitbox.apache.org/repos/asf/freemarker-docgen.git.


    from aa3c920  Improved page header: logo click area shouldn't extend beyond the logo image. Some overall cleanup in header layout.
     new 6f6899d  Show old browser warning for MSIE 10-11 too.
     new b478df0  programlisting (pre) unwanted extra width fix
     new 17d7527  Responsive layout refinements
     new 7414ae8  Always show "bookmarks" next to the breadcrumbs. Other adjustments in that row.

The 4 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.


Summary of changes:
 .../org/freemarker/docgen/core/less/lib/base.less  |  1 +
 .../docgen/core/less/lib/components/bookmarks.less | 11 ++++---
 .../core/less/lib/components/breadcrumb.less       | 23 +++++++++-----
 .../docgen/core/less/lib/layout/header.less        | 13 ++++++++
 .../freemarker/docgen/core/less/lib/utilities.less | 11 ++-----
 .../freemarker/docgen/core/less/lib/variables.less | 16 +++++-----
 .../docgen/core/templates/navigation.ftlh          | 36 ++++++++++++----------
 .../org/freemarker/docgen/core/templates/page.ftlh | 12 ++++++--
 8 files changed, 74 insertions(+), 49 deletions(-)


[freemarker-docgen] 03/04: Responsive layout refinements

Posted by dd...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ddekany pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/freemarker-docgen.git

commit 17d75276bb93002a30e85d889eb8e807c3a20627
Author: ddekany <dd...@apache.org>
AuthorDate: Sat Aug 1 15:51:25 2020 +0200

    Responsive layout refinements
---
 .../org/freemarker/docgen/core/less/lib/utilities.less        | 11 ++---------
 .../org/freemarker/docgen/core/less/lib/variables.less        | 10 ++++------
 2 files changed, 6 insertions(+), 15 deletions(-)

diff --git a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/utilities.less b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/utilities.less
index cdd9092..84fa9f4 100644
--- a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/utilities.less
+++ b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/utilities.less
@@ -18,24 +18,17 @@
  */
 // determines the max-width of the site at various resolutions
 .site-width {
-  margin-left: auto;
-  margin-right: auto;
-
   padding-left: @gutter-width / 4 * 3; // 18px
   padding-right: @gutter-width / 4 * 3;
 
   @media (min-width: @screen-sm-min) {
     padding-left: @gutter-width;
     padding-right: @gutter-width;
-
-    width: @container-sm;
-  }
-
-  @media (min-width: @screen-md-min) {
-    width: @container-md;
   }
 
   @media (min-width: @screen-lg-min) {
+    margin-left: auto;
+    margin-right: auto;
     width: @container-lg;
   }
 }
diff --git a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/variables.less b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/variables.less
index ee15507..7f734d5 100644
--- a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/variables.less
+++ b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/variables.less
@@ -45,9 +45,9 @@
 @gutter-width: 24px;
 
 // breakpoints
-@screen-xs-min:  568px;
-@screen-sm-min:  768px;
-@screen-md-min:  992px;
+@screen-xs-min:  750px;
+@screen-sm-min:  950px;
+@screen-md-min:  1000px;
 @screen-lg-min:  1200px;
 
 @screen-base-max: (@screen-xs-min - 1);
@@ -55,9 +55,7 @@
 @screen-sm-max:   (@screen-md-min - 1);
 @screen-md-max:   (@screen-lg-min - 1);
 
-// container widths
-@container-sm:  @screen-sm-min - (@gutter-width * 2) - 20px; // subtract for scrollbar
-@container-md:  @screen-md-min - (@gutter-width * 2) - 20px; // subtract for scrollbar
+// Limit max container width because of wide screens
 @container-lg:  @screen-lg-min - (@gutter-width * 2) - 20px; // subtract for scrollbar
 
 @hamburger-icon-height: 30px;


[freemarker-docgen] 04/04: Always show "bookmarks" next to the breadcrumbs. Other adjustments in that row.

Posted by dd...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ddekany pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/freemarker-docgen.git

commit 7414ae8a260867916565b26c3f2bd5228ae4ab85
Author: ddekany <dd...@apache.org>
AuthorDate: Sat Aug 1 17:41:19 2020 +0200

    Always show "bookmarks" next to the breadcrumbs. Other adjustments in that row.
---
 .../docgen/core/less/lib/components/bookmarks.less | 11 ++++---
 .../core/less/lib/components/breadcrumb.less       | 23 +++++++++-----
 .../freemarker/docgen/core/less/lib/variables.less |  6 +++-
 .../docgen/core/templates/navigation.ftlh          | 36 ++++++++++++----------
 4 files changed, 45 insertions(+), 31 deletions(-)

diff --git a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/bookmarks.less b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/bookmarks.less
index 32b959c..2c09b84 100644
--- a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/bookmarks.less
+++ b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/bookmarks.less
@@ -17,11 +17,13 @@
  * under the License.
  */
 .bookmarks {
-  text-align: right;
-  display: none;
+  overflow: hidden;
+  white-space: nowrap;
 
-  @media (min-width: @screen-md-min) {
-    display: block;
+  padding-top: @breadcrumb-row-padding-top;
+  font-size: @breadcrumb-row-font-size-xs;
+  @media (min-width: @screen-xs-min) {
+    font-size: @breadcrumb-row-font-size-sm;
   }
 
   &::before {
@@ -41,7 +43,6 @@
     margin: 0;
     padding: 0;
     display: inline-block;
-    font-size: 13px;
 
     li {
       display: inline-block;
diff --git a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/breadcrumb.less b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/breadcrumb.less
index 5c546e8..1d6495d 100644
--- a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/breadcrumb.less
+++ b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/components/breadcrumb.less
@@ -16,17 +16,24 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-.breadcrumb {
-  list-style-type: none;
-  margin: 0;
-  padding: 6px 0 0 0;
-  font-size: 12px;
-  display: block;
+.breadcrumbs {
+  padding-top: @breadcrumb-row-padding-top;
+  // Right padding is the spacing between .breadcrumbs and .bookmarks (this works as overflow is hidden)
+  padding-right: 1.5em;
   white-space: nowrap;
   overflow: hidden;
 
-  @media (min-width: @screen-sm-min) {
-    font-size: 13px;
+  font-size: @breadcrumb-row-font-size-xs;
+  @media (min-width: @screen-xs-min) {
+    font-size: @breadcrumb-row-font-size-sm;
+  }
+
+  ul {
+    display: inline-block;
+    display: block;
+    margin: 0;
+    padding: 0;
+    list-style-type: none;
   }
 
   li {
diff --git a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/variables.less b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/variables.less
index 7f734d5..64bbcdf 100644
--- a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/variables.less
+++ b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/variables.less
@@ -59,4 +59,8 @@
 @container-lg:  @screen-lg-min - (@gutter-width * 2) - 20px; // subtract for scrollbar
 
 @hamburger-icon-height: 30px;
-@hamburger-icon-top: 2px;
\ No newline at end of file
+@hamburger-icon-top: 2px;
+
+@breadcrumb-row-font-size-xs: 11px;
+@breadcrumb-row-font-size-sm: 13px;
+@breadcrumb-row-padding-top: 6px;
diff --git a/freemarker-docgen-core/src/main/resources/org/freemarker/docgen/core/templates/navigation.ftlh b/freemarker-docgen-core/src/main/resources/org/freemarker/docgen/core/templates/navigation.ftlh
index 6d0531e..abbd1c5 100644
--- a/freemarker-docgen-core/src/main/resources/org/freemarker/docgen/core/templates/navigation.ftlh
+++ b/freemarker-docgen-core/src/main/resources/org/freemarker/docgen/core/templates/navigation.ftlh
@@ -62,23 +62,25 @@
     </#if>
     <#local curNode = curNode?parent>
   </#list>
-  <#if (path?size > 1)>
-    <ul class="breadcrumb" itemscope itemtype="http://schema.org/BreadcrumbList"><#t>
-      <#list path as step>
-        <li class="step-${step?index}" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><#t>
-          <a class="label" itemprop="item" href="${CreateLinkFromNode(step)}"><#t>
-            <span itemprop="name"><#recurse u.getRequiredTitleElement(step) using nodeHandlers></span><#t>
-          </a><#t>
+  <div class="breadcrumbs">
+    <#if (path?size > 1)>
+      <ul class="breadcrumb" itemscope itemtype="http://schema.org/BreadcrumbList"><#t>
+        <#list path as step>
+          <li class="step-${step?index}" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><#t>
+            <a class="label" itemprop="item" href="${CreateLinkFromNode(step)}"><#t>
+              <span itemprop="name"><#recurse u.getRequiredTitleElement(step) using nodeHandlers></span><#t>
+            </a><#t>
+          </li><#t>
+        </#list>
+      </ul><#t>
+    <#else>
+      <ul class="breadcrumb" itemscope itemtype="http://schema.org/BreadcrumbList"><#t>
+        <li class="step-0" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><#t>
+          <span itemprop="name">Table of Contents</span><#t>
         </li><#t>
-      </#list>
-    </ul><#t>
-  <#else>
-    <ul class="breadcrumb" itemscope itemtype="http://schema.org/BreadcrumbList"><#t>
-      <li class="step-0" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><#t>
-        <span itemprop="name">Table of Contents</span><#t>
-      </li><#t>
-    </ul><#t>
-  </#if>
+      </ul><#t>
+    </#if>
+  </div>
 </#macro>
 
 
@@ -109,7 +111,7 @@
   <#if internalBookmarks?size != 0 || externalBookmarks?size != 0>
     <div class="bookmarks" title="Bookmarks"><#t>
         <span class="sr-only">Bookmarks:</span><#t>
-        <ul class="bookmark-list"><#t>
+        <ul><#t>
           <#local curHref = CreateLinkFromNode(.node)>
           <#list internalBookmarks?keys as k>
             <li><#t>


[freemarker-docgen] 01/04: Show old browser warning for MSIE 10-11 too.

Posted by dd...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ddekany pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/freemarker-docgen.git

commit 6f6899d4964ca2cb04e65c6cbeaf3a24fdaf48d5
Author: ddekany <dd...@apache.org>
AuthorDate: Fri Jul 31 23:07:27 2020 +0200

    Show old browser warning for MSIE 10-11 too.
---
 .../org/freemarker/docgen/core/less/lib/layout/header.less  | 13 +++++++++++++
 .../org/freemarker/docgen/core/templates/page.ftlh          | 12 +++++++++---
 2 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/layout/header.less b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/layout/header.less
index 6bfc89c..2a7cecd 100644
--- a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/layout/header.less
+++ b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/layout/header.less
@@ -105,3 +105,16 @@
     align-items: flex-end;
   }
 }
+
+.oldBrowserWarning {
+  display: none;
+  background-color: #C00;
+  color: #fff;
+  font-weight: bold;
+  padding: 12px 24px;
+
+  /* IE10-IE11 css: */
+  @media screen and (-ms-high-contrast: active), (-ms-high-contrast: none) {
+     display: block;
+  }
+}
diff --git a/freemarker-docgen-core/src/main/resources/org/freemarker/docgen/core/templates/page.ftlh b/freemarker-docgen-core/src/main/resources/org/freemarker/docgen/core/templates/page.ftlh
index 217ec54..60c7a84 100644
--- a/freemarker-docgen-core/src/main/resources/org/freemarker/docgen/core/templates/page.ftlh
+++ b/freemarker-docgen-core/src/main/resources/org/freemarker/docgen/core/templates/page.ftlh
@@ -34,7 +34,7 @@
     <meta itemprop="url" content="${deployUrl}">
     <meta itemprop="name" content="${siteTitle}">
 
-    <@browserWarning />
+    <@oldBrowserWarning />
     <@header.header />
     <div class="main-content site-width">
       <div class="content-wrapper<#if disableJavaScript> no-toc</#if>">
@@ -103,12 +103,18 @@
 </#macro>
 
 
-<#macro browserWarning>
+<#macro oldBrowserWarning>
   <!--[if lte IE 9]>
-  <div style="background-color: #C00; color: #fff; padding: 12px 24px;">Please use a modern browser to view this website.</div>
+  <@oldBrowserWarning_inner forceDisplay=true />
   <![endif]--><#rt>
+  <@oldBrowserWarning_inner forceDisplay=false />
 </#macro>
 
+<#macro oldBrowserWarning_inner forceDisplay>
+  <div class="oldBrowserWarning"<#if forceDisplay> style="display: block"</#if>>
+    Unsupported web browser - Use a modern browser to view this website!
+  </div>
+</#macro>
 
 <#macro page>
   <!doctype html><#lt>


[freemarker-docgen] 02/04: programlisting (pre) unwanted extra width fix

Posted by dd...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

ddekany pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/freemarker-docgen.git

commit b478df03df9d720bd20da2861b0d8bf6598c0e0a
Author: ddekany <dd...@apache.org>
AuthorDate: Sat Aug 1 15:50:24 2020 +0200

    programlisting (pre) unwanted extra width fix
---
 .../main/resources-gulp/org/freemarker/docgen/core/less/lib/base.less    | 1 +
 1 file changed, 1 insertion(+)

diff --git a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/base.less b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/base.less
index 9173b8f..8fdd6be 100644
--- a/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/base.less
+++ b/freemarker-docgen-core/src/main/resources-gulp/org/freemarker/docgen/core/less/lib/base.less
@@ -92,6 +92,7 @@ pre {
   /* To prevent the pre stretching the width of its parent, and become scrollable instead: */
   width: 0;
   min-width: 100%;
+  box-sizing: border-box;
   overflow-x: auto;
 
   border: 0;